@viu/emporix-sdk 2.21.0 → 2.23.0

package/dist/price.d.ts

@@ -1,5 +1,142 @@
 import { C as ClientContext, b as AuthContext } from './context-CfXJcYKP.js';
 
+type CreatePrice = {
+    /**
+     * Custom price identifier. If not provided, it is automatically generated.
+     */
+    id?: string;
+    /**
+     * Item for which the price is defined.
+     */
+    itemId: {
+        /**
+         * Type of the referenced item. Possible values:
+         * * `PRODUCT`
+         * * `SKU`
+         *
+         * **The `SKU` value is in preview mode** - the system does not fully operate on the SKU concept yet.
+         *
+         */
+        itemType: string;
+        /**
+         * Product's unique identifier - ID or SKU.
+         *
+         * **The `SKU` value is in preview mode** - the system does not fully operate on the SKU concept yet.
+         *
+         */
+        id: string;
+    };
+    /**
+     * Product's uniform resource name.
+     */
+    itemYrn?: string;
+    currency: Currency;
+    location: Location;
+    salePrice?: SalePrice;
+    restrictions?: Restrictions;
+    /**
+     * ID of the price model to which the price should assigned. If the ID is not provided, the default price model is used.
+     */
+    priceModelId?: string;
+    /**
+     * Prices for tiers specified in the price model. The prices will be assigned to tiers based on the entered order (the first value will be assigned to the first tier, the second value to second tier).
+     *
+     * **Note**: If this field does not contain values for all tiers defined in the price model, the endpoint responds with an error.
+     *
+     */
+    tierValues: Array<TierValueCreation>;
+    /**
+     * Map of custom price attributes.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+    metadata?: {
+        /**
+         * Schemas for custom price attributes.
+         */
+        mixins?: {
+            [key: string]: unknown;
+        };
+    };
+};
+type GetPrice = {
+    /**
+     * A price identifier.
+     */
+    id?: string;
+    /**
+     * Item for which the price is defined.
+     */
+    itemId?: {
+        /**
+         * Type of the referenced item. Possible values:
+         * * `PRODUCT`
+         * * `SKU`
+         *
+         * **The `SKU` value is in preview mode** - the system does not fully operate on the SKU concept yet.
+         *
+         */
+        itemType?: string;
+        /**
+         * Product's unique identifier, generated when the product is created through the Product Service.
+         *
+         */
+        id?: string;
+    };
+    /**
+     * Product's uniform resource name.
+     */
+    itemYrn?: string;
+    /**
+     * Currency code, as defined in the Currency Service.
+     */
+    currency?: string;
+    location?: Location;
+    salePrice?: SalePrice;
+    /**
+     * ID of the price model to which the price is assigned. If the ID is not provided, the default price model is used.
+     */
+    priceModelId?: string;
+    restrictions?: Restrictions;
+    tierValues?: Array<TierValueRetrieval>;
+    /**
+     * Id of a vendor to which the price belongs.
+     */
+    vendorId?: string;
+    /**
+     * Custom price attributes.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+    metadata?: PriceMetadata;
+};
+/**
+ * Schema for API-specific errors.
+ */
+type ErrorMessage = {
+    /**
+     * Original HTTP error code, should be consistent with the response HTTP code.
+     */
+    code?: number;
+    /**
+     * Original HTTP error reason.
+     */
+    status?: string;
+    /**
+     * Descriptive error message for debugging
+     */
+    message?: string;
+    /**
+     * List of problems causing this error.
+     */
+    details?: Array<string>;
+    /**
+     * Additional error code.
+     */
+    errorCode?: string;
+};
 type Metadata = {
     /**
      * Date and time when the price was created.
@@ -54,6 +191,10 @@ type SalePrice = {
      */
     description?: string;
 };
+/**
+ * Currency code, compliant with the ISO 4217 standard.
+ */
+type Currency = string;
 type MatchByContext = {
     /**
      * List of items (products or prices) for which the prices should be matched.
@@ -164,6 +305,19 @@ type Match = {
      */
     legalEntityId?: string;
 };
+/**
+ * Date range in which the object is valid.
+ */
+type DateValidity = {
+    /**
+     * Date from which the object is valid, compliant with the ISO 8601 standard.
+     */
+    from?: string;
+    /**
+     * Date to which the object is valid, compliant with the ISO 8601 standard.
+     */
+    to?: string;
+};
 /**
  * Price model holds additional attributes that are extending price. For example it's possible to define a price which will be specific for a given customer or customer group.
  *
@@ -232,6 +386,181 @@ type PriceModelRetrieval = {
     isDefault?: boolean;
     metadata?: Metadata;
 };
+/**
+ * Customers or customer groups for whom the price is valid.
+ */
+type Principal = {
+    /**
+     * Customer or customer group for whom the price is valid. Possible values:
+     * * `CUSTOMER`
+     * * `GROUP`
+     *
+     * **The `GROUP` value is in preview mode** - the system does not fully operate on the customer groups concept yet.
+     */
+    type: string;
+    /**
+     * Unique identifier of the customer or customer group.
+     */
+    id: string;
+};
+/**
+ * Restrictions that limit the validity of the price model and prices assigned to it.
+ *
+ */
+type Restrictions = {
+    /**
+     * List of customers and customer groups for whom the price is valid.
+     *
+     * **The `GROUP` principals are in preview mode** - the system does not fully operate on the customer groups concept yet.
+     */
+    principals?: Array<Principal>;
+    validity?: DateValidity;
+    /**
+     * Codes of sites to which the price applies.
+     */
+    siteCodes: Array<string>;
+    /**
+     * Unique identifier of the price list to which the price should be assigned.
+     *
+     * **The `priceListId` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    priceListId?: string;
+};
+type TierValueCreation = {
+    /**
+     * An identifier of a tier. The ID is required only if the priceModelId is provided. If the price model is the default, the tier value is automatically assigned according to the default price model.
+     */
+    id?: string;
+    /**
+     * Gross price (if the `includesTax` field is set to `true`) or net price (if the `includesTax` field is set to `false`).
+     *
+     * This field should contain by a number where the cent part is separated by a dot sign - such as `12.99`.
+     *
+     * **Note**: The cent part of the price is not limited to two digits. You can specify the price with any precision.
+     */
+    priceValue: number;
+};
+type TierValueRetrieval = {
+    /**
+     * An identifier of a tier. The ID is required only if the `priceModelId` is provided. If the price model is the default, the tier value is automatically assigned according to the default price model.
+     */
+    id?: string;
+    /**
+     * Gross price (if the `includesTax` field is set to `true`) or net price (if the `includesTax` field is set to `false`).
+     */
+    priceValue: number;
+};
+/**
+ * A price model can be defined as a repeatable way to sell products in a market with the intention of making a profit. Price models define basic structures for prices.
+ */
+type PriceModelDefinitionCreation = {
+    /**
+     * Custom price model identifier. If not provided, it is automatically generated.
+     */
+    id?: string;
+    /**
+     * Flag indicating whether prices assigned to the price model will be expressed as net or gross.
+     *
+     * | Value | Description |
+     * | --- | --- |
+     * | `true` | Prices will be expressed as gross values. |
+     * | `false` | Prices will be expressed as net values. |
+     *
+     */
+    includesTax: boolean;
+    /**
+     * Flag indicating whether prices assigned to the price model include markup.
+     *
+     * **The `includesMarkup` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    includesMarkup?: boolean;
+    /**
+     * Indicates whether the price model is default one or not.
+     */
+    default?: boolean;
+    /**
+     * Price model name. It should be a brief, human-readable name that describes purposes of the model.
+     *
+     * * If the `Content-Language` header is set to `*`, then the name should be provided as a map of translations, where each key is a language code and the value is the name in its respective language.
+     * * If the `Content-Language` header is set to a specific language, the name should be provided as a string.
+     * * If the `Content-Language` header is empty, the endpoint will asume that the name is provided in the default language defined in the Configuration Service.
+     *
+     * **Note**: You can provide the names only in languages defined in the Configuration Service. In case the name is provided in a language that is not defined in the Configuration Service, the request will be rejected.
+     */
+    name: {
+        [key: string]: unknown;
+    } | string;
+    /**
+     * Price model description. It can contain details about the price model.
+     *
+     * * If the `Content-Language` header is set to `*`, then the description should be provided as a map of translations, where each key is a language code and the value is the description in its respective language.
+     * * If the `Content-Language` header is set to a specific language, the description should be provided as a string.
+     * * If the `Content-Language` header is empty, the endpoint will asume that the description is provided in the default language defined in the Configuration Service.
+     *
+     * **Note**: You can provide the descriptions only in languages defined in the Configuration Service. In case the description is provided in a language that is not defined in the Configuration Service, the request will be rejected.
+     */
+    description?: {
+        [key: string]: unknown;
+    } | string;
+    tierDefinition: TierDefinitionCreation & {
+        [key: string]: unknown;
+    };
+    measurementUnit: MeasurementUnit & {
+        [key: string]: unknown;
+    };
+};
+type TierDefinitionCreation = {
+    /**
+     * Possible values:
+     * * `BASIC`
+     * * `VOLUME`
+     * * `TIERED`
+     *
+     * `BASIC`: Used to offer the same price per unit, regardless of the ordered quantity.
+     *
+     * **Note**: When using basic pricing, you need to define a single tier and set its `minQuantity` field to `0`.
+     *
+     * `VOLUME`: Used to offer a lower price per unit depending on the total ordered quantity.
+     *
+     * `TIERED`: Used to offer a lower price per unit based on the tiers that the total ordered quantity falls into.
+     *
+     * **Example**: You defined three tiers, starting at 5, 10, and 15 pieces respectively. A customer orders 16 pieces. In this pricing model, the first 5 pieces will be priced according to the first tier, the next 5 according to the second tier, and the 16th piece will be priced according to the third tier.
+     */
+    tierType: string;
+    /**
+     * Tier quantities.
+     *
+     * Each tier contains information about the minimum quantity from which it (and its price) is valid.
+     *
+     * **Example**: For two tiers with the following `minQuantity` values: 0 pieces and 10 pieces, the effective ranges will be `<0, 9)` and `<10, infinity)`.
+     *
+     * **Note**: When defining tiers, be aware of the following restrictions to the `PriceModel` object:
+     * * For `BASIC` tier type:
+     * * Only one tier should be defined. If the tier is not defined, it will be automatically generated.
+     * * The tier's `minQuantity.quantity` should be set to `0`.
+     * * For `VOLUME` and `TIERED` type:
+     * * Each `minQuantity.quantity` field must contain a unique value.
+     * * The tiers must be defined in an ascending order based on their `quantity` value.
+     * * The `quantity` field in the first tier must be set to `0`.
+     * * All `unitCode` fields must contain the same value.
+     */
+    tiers?: Array<TierDetailsDefinitionCreation>;
+};
+/**
+ * Quantity that indicates the tier's range:
+ * * The `minQuantity` of the tier defines the left side of the range (inclusive).
+ * * The `minQuantity` of the next tier defines the right side of the range (exclusive).
+ *
+ */
+type TierDetailsDefinitionCreation = {
+    /**
+     * An identifier of the tier. If the value is not provided then it is automatically generated. The id is used during an update operation for recognizing whether a particular tier has been changed, removed or added.
+     */
+    id?: string;
+    minQuantity: MeasurementUnit & {
+        [key: string]: unknown;
+    };
+};
 type MatchResponse = {
     /**
      * Price's unique identifier, generated when the price is created.
@@ -401,6 +730,189 @@ type MatchResponse = {
         priceValue?: number;
     }>;
 };
+type Location = {
+    /**
+     * Code of the country to which the price applies, as defined in the Country Service.
+     */
+    countryCode: string;
+};
+type PriceListCore = {
+    currency?: Currency;
+    /**
+     * Codes of countries to which the price list applies, as defined in the Country Service.
+     *
+     * **Note** If not specified, the price list will be applicable to users from all locations.
+     */
+    countries?: Array<string>;
+    /**
+     * List of the regions to which the price list applies.
+     *
+     * **Note** If not specified, the price list will be applicable to users from all locations.
+     */
+    regions?: Array<string>;
+    /**
+     * List of customer groups IDs for which the price list is valid. If not specified, the price list is applicable to all customer groups.
+     *
+     * **Note**: Customer groups cannot be provided if there is a legal entity specified for the price list.
+     *
+     * **The `customerGroups` field is in preview mode** - the system does not fully operate on the customer groups concept yet.
+     */
+    customerGroups?: Array<unknown>;
+    /**
+     * ID of the legal entity to which the price list applies.
+     * **Note**: Price list assigned to legal entity is also applicable for all the subsidiaries.
+     */
+    legalEntityId?: string;
+    /**
+     * Code of the site to which the price list applies.
+     */
+    siteCode?: string;
+    validity?: DateValidity;
+    /**
+     * Map of custom price lists attributes.
+     *
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type PriceListCreation = {
+    /**
+     * Custom price list identifier. If not provided, it is automatically generated.
+     */
+    id?: string;
+    /**
+     * Price list name. It should be a brief, human-readable name that describes the purpose of the price list, specified in a form of a map of translations.
+     *
+     * * If the `Content-Language` header is set to `*`, then the name should be provided as a map of translations, where each key is a language code and the value is the name in its respective language.
+     * * If the `Content-Language` header is set to a specific language, then the name should be provided as a map of single translation, where the key is a language code and the value is the name in its respective language.
+     * * If the `Content-Language` header is empty, then the name should be provided as a map of single translation, where the key is a language code and the value is the name in its respective language. The endpoint will asume that the name is provided in the default language defined in the Configuration Service.
+     *
+     * **Note**: You can provide the names only in languages defined in the Configuration Service. In case the name is provided in a language that is not defined in the Configuration Service, the request will be rejected.
+     */
+    name: {
+        [key: string]: unknown;
+    };
+} & PriceListCore & {
+    metadata?: {
+        /**
+         * Mixins schemas
+         */
+        mixins?: {
+            [key: string]: string;
+        };
+    };
+};
+type PriceListUpdate = PriceListCreation & {
+    metadata?: {
+        /**
+         * Current version of the object.
+         */
+        version?: number;
+        /**
+         * Mixins schemas.
+         */
+        mixins?: {
+            [key: string]: string;
+        };
+    };
+};
+type PriceList$1 = {
+    /**
+     * Unique identifier of the price that belongs to a price list, generated when the price is created and added to the price list.
+     */
+    id?: string;
+    /**
+     * Price list's name, expressed as a map of translations.
+     */
+    name?: {
+        [key: string]: unknown;
+    };
+} & PriceListCore & {
+    metadata?: Metadata & {
+        /**
+         * Mixins schemas
+         */
+        mixins?: {
+            [key: string]: string;
+        };
+    };
+};
+type PriceListPriceCore = {
+    /**
+     * Item for which the price is defined.
+     */
+    itemId?: {
+        /**
+         * Type of the referenced item. Possible values:
+         * * `PRODUCT`
+         * * `SKU`
+         *
+         * **The `SKU` value is in preview mode** - the system does not fully operate on the SKU concept yet.
+         *
+         */
+        itemType?: string;
+        /**
+         * Product's unique identifier, generated when the product is created through the Product Service.
+         *
+         */
+        id?: string;
+    };
+    /**
+     * ID of the price model to which the price is assigned. If the ID is not provided, the default price model is used.
+     */
+    priceModelId?: string;
+    tierValues?: Array<TierValueCreation & {
+        /**
+         * This field should contain a net price given by a number where the cent part is separated by a dot sign - such as `12.99`.
+         *
+         * **Note**: The cent part of the price is not limited to two digits. You can specify the price with any precision.
+         */
+        priceValue?: number;
+    }>;
+};
+type PriceListPriceCreation = PriceListPriceCore & {
+    /**
+     * Custom price identifier. If not provided, it is automatically generated.
+     */
+    id?: string;
+    itemId: {
+        [key: string]: unknown;
+    };
+};
+type PriceListPriceUpdate = {
+    /**
+     * Unique identifier of the price that belongs to a price list, generated when the price is created and added to the price list.
+     */
+    id: string;
+} & PriceListPriceCore & {
+    metadata: {
+        /**
+         * Current version of the object.
+         */
+        version: number;
+    };
+};
+type PriceListPrice$1 = {
+    /**
+     * Unique identifier of the price that belongs to a price list, generated when the price is created and added to the price list.
+     */
+    id?: string;
+} & PriceListPriceCore & {
+    metadata?: Metadata;
+};
+type PriceBulkResponseEntry = {
+    index?: number;
+    id?: string;
+} & ErrorMessage;
+type PriceMetadata = Metadata & {
+    /**
+     * Mixins schemas
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
 
 /** Session-context match request body (generated). */
 type PriceMatchByContextInput = MatchByContext;
@@ -438,6 +950,28 @@ interface MatchByContextChunkedOptions {
     /** When true, the first failing chunk rejects the whole call. Default false. */
     throwOnAnyChunkError?: boolean;
 }
+/** A resolved/stored price (generated read shape). */
+type Price = GetPrice;
+/** Create/upsert body for a flat price (generated). */
+type PriceCreateInput = CreatePrice;
+/** A price model (read). */
+type PriceModel = PriceModelRetrieval;
+/** Create/upsert body for a price model (generated). */
+type PriceModelInput = PriceModelDefinitionCreation;
+/** A price list (read). */
+type PriceList = PriceList$1;
+/** Create body for a price list (generated). */
+type PriceListInput = PriceListCreation;
+/** Upsert body for a price list (generated). */
+type PriceListUpdateInput = PriceListUpdate;
+/** A price inside a price list (read). */
+type PriceListPrice = PriceListPrice$1;
+/** Add body for a price-list price (generated). */
+type PriceListPriceInput = PriceListPriceCreation;
+/** Upsert body for a price-list price (generated). */
+type PriceListPriceUpdateInput = PriceListPriceUpdate;
+/** Per-entry result of a bulk price operation (generated). */
+type PriceBulkResult = PriceBulkResponseEntry;
 /**
  * Price matching. The Cart service does not resolve prices — call this
  * explicitly before rendering money and again right before placing an order.
@@ -472,6 +1006,48 @@ declare class PriceService {
      * `priceId` / `itemId.id`.
      */
     matchByContextChunked(input: PriceMatchByContextInput, opts?: MatchByContextChunkedOptions, auth?: AuthContext): Promise<PriceMatch[]>;
+    /** Creates a flat price. Default auth: service. */
+    create(input: PriceCreateInput, authCtx?: AuthContext): Promise<Price>;
+    /** Lists flat prices. Default auth: service. */
+    list(query?: Record<string, string | number>, authCtx?: AuthContext): Promise<Price[]>;
+    /** Retrieves one flat price by id. Default auth: service. */
+    get(priceId: string, authCtx?: AuthContext): Promise<Price>;
+    /** Upserts a flat price by id (PUT). Default auth: service. */
+    upsert(priceId: string, input: PriceCreateInput, authCtx?: AuthContext): Promise<Price>;
+    /** Deletes a flat price by id. Default auth: service. */
+    delete(priceId: string, authCtx?: AuthContext): Promise<void>;
+    /** Searches flat prices (POST body query). Default auth: service. */
+    search(query: Record<string, unknown>, authCtx?: AuthContext): Promise<Price[]>;
+    /** Creates multiple flat prices in one request. Default auth: service. */
+    bulkCreate(inputs: PriceCreateInput[], authCtx?: AuthContext): Promise<PriceBulkResult[]>;
+    /** Upserts multiple flat prices in one request (PUT). Default auth: service. */
+    bulkUpsert(inputs: PriceCreateInput[], authCtx?: AuthContext): Promise<PriceBulkResult[]>;
+    /** Price-model admin CRUD (`/priceModels`). Default auth: service. */
+    readonly models: {
+        list: (query?: Record<string, string | number>, authCtx?: AuthContext) => Promise<PriceModel[]>;
+        create: (input: PriceModelInput, authCtx?: AuthContext) => Promise<PriceModel>;
+        get: (modelId: string, authCtx?: AuthContext) => Promise<PriceModel>;
+        upsert: (modelId: string, input: PriceModelInput, authCtx?: AuthContext) => Promise<PriceModel>;
+        delete: (modelId: string, authCtx?: AuthContext) => Promise<void>;
+    };
+    /** Price-list admin CRUD (`/price-lists`) + nested price management. Default auth: service. */
+    readonly lists: {
+        list: (query?: Record<string, string | number>, authCtx?: AuthContext) => Promise<PriceList[]>;
+        create: (input: PriceListInput, authCtx?: AuthContext) => Promise<PriceList>;
+        search: (query: Record<string, unknown>, authCtx?: AuthContext) => Promise<PriceList[]>;
+        get: (listId: string, authCtx?: AuthContext) => Promise<PriceList>;
+        upsert: (listId: string, input: PriceListUpdateInput, authCtx?: AuthContext) => Promise<PriceList>;
+        delete: (listId: string, authCtx?: AuthContext) => Promise<void>;
+        listPrices: (listId: string, query?: Record<string, string | number>, authCtx?: AuthContext) => Promise<PriceListPrice[]>;
+        addPrice: (listId: string, input: PriceListPriceInput, authCtx?: AuthContext) => Promise<PriceListPrice>;
+        getPrice: (listId: string, priceId: string, authCtx?: AuthContext) => Promise<PriceListPrice>;
+        upsertPrice: (listId: string, priceId: string, input: PriceListPriceUpdateInput, authCtx?: AuthContext) => Promise<PriceListPrice>;
+        deletePrice: (listId: string, priceId: string, authCtx?: AuthContext) => Promise<void>;
+        searchPrices: (listId: string, query: Record<string, unknown>, authCtx?: AuthContext) => Promise<PriceListPrice[]>;
+        bulkCreatePrices: (listId: string, inputs: PriceListPriceInput[], authCtx?: AuthContext) => Promise<PriceBulkResult[]>;
+        bulkUpsertPrices: (listId: string, inputs: PriceListPriceInput[], authCtx?: AuthContext) => Promise<PriceBulkResult[]>;
+        bulkDeletePrices: (listId: string, body: Record<string, unknown>, authCtx?: AuthContext) => Promise<PriceBulkResult[]>;
+    };
 }
 
-export { type MatchByContextChunkedOptions, type PriceMatch, type PriceMatchByContextInput, type PriceMatchInput, type PriceMatchItemRef, PriceService };
+export { type MatchByContextChunkedOptions, type Price, type PriceBulkResult, type PriceCreateInput, type PriceList, type PriceListInput, type PriceListPrice, type PriceListPriceInput, type PriceListPriceUpdateInput, type PriceListUpdateInput, type PriceMatch, type PriceMatchByContextInput, type PriceMatchInput, type PriceMatchItemRef, type PriceModel, type PriceModelInput, PriceService };

package/dist/price.js

@@ -1,4 +1,4 @@
-export { PriceService } from './chunk-A3LYJUD4.js';
+export { PriceService } from './chunk-ZOFGDNSX.js';
 import './chunk-UWGGF4MC.js';
 //# sourceMappingURL=price.js.map
 //# sourceMappingURL=price.js.map