@viu/emporix-sdk 2.36.0 → 2.37.0

package/dist/price.d.cts

@@ -1,5 +1,8 @@
 import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.cjs';
 
+/**
+ * Price
+ */
 type CreatePrice = {
     /**
      * Custom price identifier. If not provided, it is automatically generated.
@@ -60,6 +63,9 @@ type CreatePrice = {
         };
     };
 };
+/**
+ * Price
+ */
 type GetPrice = {
     /**
      * A price identifier.
@@ -113,6 +119,8 @@ type GetPrice = {
     metadata?: PriceMetadata;
 };
 /**
+ * error
+ *
  * Schema for API-specific errors.
  */
 type ErrorMessage = {
@@ -192,9 +200,14 @@ type SalePrice = {
     description?: string;
 };
 /**
+ * currency
+ *
  * Currency code, compliant with the ISO 4217 standard.
  */
 type Currency = string;
+/**
+ * Price matching (by session context) request body
+ */
 type MatchByContext = {
     /**
      * List of items (products or prices) for which the prices should be matched.
@@ -221,6 +234,9 @@ type MatchByContext = {
         quantity?: MatchMeasurementUnit;
     }>;
 };
+/**
+ * Price matching (by criteria) request body
+ */
 type Match = {
     /**
      * Code of the currency in which the prices should be matched, as defined in the Currency Service.
@@ -451,6 +467,8 @@ type TierValueRetrieval = {
     priceValue: number;
 };
 /**
+ * priceModelDefinitionCreation
+ *
  * 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 = {
@@ -561,6 +579,9 @@ type TierDetailsDefinitionCreation = {
         [key: string]: unknown;
     };
 };
+/**
+ * matchResponse
+ */
 type MatchResponse = {
     /**
      * Price's unique identifier, generated when the price is created.
@@ -736,6 +757,9 @@ type Location = {
      */
     countryCode: string;
 };
+/**
+ * priceListCore
+ */
 type PriceListCore = {
     currency?: Currency;
     /**
@@ -776,6 +800,9 @@ type PriceListCore = {
         [key: string]: unknown;
     };
 };
+/**
+ * priceListCreation
+ */
 type PriceListCreation = {
     /**
      * Custom price list identifier. If not provided, it is automatically generated.
@@ -803,6 +830,9 @@ type PriceListCreation = {
         };
     };
 };
+/**
+ * priceListUpdate
+ */
 type PriceListUpdate = PriceListCreation & {
     metadata?: {
         /**
@@ -817,6 +847,9 @@ type PriceListUpdate = PriceListCreation & {
         };
     };
 };
+/**
+ * priceList
+ */
 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.
@@ -838,6 +871,9 @@ type PriceList$1 = {
         };
     };
 };
+/**
+ * priceListPriceCore
+ */
 type PriceListPriceCore = {
     /**
      * Item for which the price is defined.
@@ -871,6 +907,9 @@ type PriceListPriceCore = {
         priceValue?: number;
     }>;
 };
+/**
+ * priceListPriceCreation
+ */
 type PriceListPriceCreation = PriceListPriceCore & {
     /**
      * Custom price identifier. If not provided, it is automatically generated.
@@ -880,6 +919,9 @@ type PriceListPriceCreation = PriceListPriceCore & {
         [key: string]: unknown;
     };
 };
+/**
+ * priceListPriceUpdate
+ */
 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.
@@ -893,6 +935,9 @@ type PriceListPriceUpdate = {
         version: number;
     };
 };
+/**
+ * priceListPrice
+ */
 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.

package/dist/price.d.ts

@@ -1,5 +1,8 @@
 import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.js';
 
+/**
+ * Price
+ */
 type CreatePrice = {
     /**
      * Custom price identifier. If not provided, it is automatically generated.
@@ -60,6 +63,9 @@ type CreatePrice = {
         };
     };
 };
+/**
+ * Price
+ */
 type GetPrice = {
     /**
      * A price identifier.
@@ -113,6 +119,8 @@ type GetPrice = {
     metadata?: PriceMetadata;
 };
 /**
+ * error
+ *
  * Schema for API-specific errors.
  */
 type ErrorMessage = {
@@ -192,9 +200,14 @@ type SalePrice = {
     description?: string;
 };
 /**
+ * currency
+ *
  * Currency code, compliant with the ISO 4217 standard.
  */
 type Currency = string;
+/**
+ * Price matching (by session context) request body
+ */
 type MatchByContext = {
     /**
      * List of items (products or prices) for which the prices should be matched.
@@ -221,6 +234,9 @@ type MatchByContext = {
         quantity?: MatchMeasurementUnit;
     }>;
 };
+/**
+ * Price matching (by criteria) request body
+ */
 type Match = {
     /**
      * Code of the currency in which the prices should be matched, as defined in the Currency Service.
@@ -451,6 +467,8 @@ type TierValueRetrieval = {
     priceValue: number;
 };
 /**
+ * priceModelDefinitionCreation
+ *
  * 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 = {
@@ -561,6 +579,9 @@ type TierDetailsDefinitionCreation = {
         [key: string]: unknown;
     };
 };
+/**
+ * matchResponse
+ */
 type MatchResponse = {
     /**
      * Price's unique identifier, generated when the price is created.
@@ -736,6 +757,9 @@ type Location = {
      */
     countryCode: string;
 };
+/**
+ * priceListCore
+ */
 type PriceListCore = {
     currency?: Currency;
     /**
@@ -776,6 +800,9 @@ type PriceListCore = {
         [key: string]: unknown;
     };
 };
+/**
+ * priceListCreation
+ */
 type PriceListCreation = {
     /**
      * Custom price list identifier. If not provided, it is automatically generated.
@@ -803,6 +830,9 @@ type PriceListCreation = {
         };
     };
 };
+/**
+ * priceListUpdate
+ */
 type PriceListUpdate = PriceListCreation & {
     metadata?: {
         /**
@@ -817,6 +847,9 @@ type PriceListUpdate = PriceListCreation & {
         };
     };
 };
+/**
+ * priceList
+ */
 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.
@@ -838,6 +871,9 @@ type PriceList$1 = {
         };
     };
 };
+/**
+ * priceListPriceCore
+ */
 type PriceListPriceCore = {
     /**
      * Item for which the price is defined.
@@ -871,6 +907,9 @@ type PriceListPriceCore = {
         priceValue?: number;
     }>;
 };
+/**
+ * priceListPriceCreation
+ */
 type PriceListPriceCreation = PriceListPriceCore & {
     /**
      * Custom price identifier. If not provided, it is automatically generated.
@@ -880,6 +919,9 @@ type PriceListPriceCreation = PriceListPriceCore & {
         [key: string]: unknown;
     };
 };
+/**
+ * priceListPriceUpdate
+ */
 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.
@@ -893,6 +935,9 @@ type PriceListPriceUpdate = {
         version: number;
     };
 };
+/**
+ * priceListPrice
+ */
 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.

package/dist/product.d.cts

@@ -19,12 +19,18 @@ type ProductTemplateBase = {
      */
     attributes: Array<ProductTemplateAttribute>;
 };
+/**
+ * productTemplateCreation
+ */
 type ProductTemplateCreation = ProductTemplateBase & {
     /**
      * Identifier of the product template.
      */
     id?: string;
 };
+/**
+ * productTemplateAttribute
+ */
 type ProductTemplateAttribute = {
     /**
      * An identifier of the attribute. The key is used as a field name in a product instance created based on the product template. The key can contain only alphanumeric characters.
@@ -62,6 +68,9 @@ type ProductTemplateAttribute = {
         [key: string]: unknown;
     };
 };
+/**
+ * productTemplateMetadata
+ */
 type ProductTemplateMetadata = {
     /**
      * Schema url of the variant attributes.
@@ -87,6 +96,9 @@ type ProductTemplateMetadata = {
 type ProductTemplateResponse = ProductTemplateCreation & {
     metadata?: ProductTemplateMetadata;
 };
+/**
+ * productTemplateUpdate
+ */
 type ProductTemplateUpdate = ProductTemplateBase & {
     metadata: {
         /**
@@ -149,6 +161,8 @@ type ResourceLocation = {
     yrn?: Yrn;
 };
 /**
+ * YRN (attribute)
+ *
  * In YaaS, a global resource identifier is a Uniform Resource Name (URN) with a custom YaaS schema and is called a YaaS Resource Name, or YRN.
  *
  * It is a unique identifier, which stores information about a resource, such as its type, ID or name of the tenant.
@@ -710,6 +724,9 @@ type Vendor = {
      */
     name?: string;
 };
+/**
+ * relatedItem
+ */
 type RelatedItem = {
     /**
      * Identifier of a product which is in the relationship with the main product. The product identifier has to exist.
@@ -720,6 +737,9 @@ type RelatedItem = {
      */
     type: string;
 };
+/**
+ * bulkResponse
+ */
 type BulkResponse = {
     /**
      * Index of the processed product, matching the price position in request body.

package/dist/product.d.ts

@@ -19,12 +19,18 @@ type ProductTemplateBase = {
      */
     attributes: Array<ProductTemplateAttribute>;
 };
+/**
+ * productTemplateCreation
+ */
 type ProductTemplateCreation = ProductTemplateBase & {
     /**
      * Identifier of the product template.
      */
     id?: string;
 };
+/**
+ * productTemplateAttribute
+ */
 type ProductTemplateAttribute = {
     /**
      * An identifier of the attribute. The key is used as a field name in a product instance created based on the product template. The key can contain only alphanumeric characters.
@@ -62,6 +68,9 @@ type ProductTemplateAttribute = {
         [key: string]: unknown;
     };
 };
+/**
+ * productTemplateMetadata
+ */
 type ProductTemplateMetadata = {
     /**
      * Schema url of the variant attributes.
@@ -87,6 +96,9 @@ type ProductTemplateMetadata = {
 type ProductTemplateResponse = ProductTemplateCreation & {
     metadata?: ProductTemplateMetadata;
 };
+/**
+ * productTemplateUpdate
+ */
 type ProductTemplateUpdate = ProductTemplateBase & {
     metadata: {
         /**
@@ -149,6 +161,8 @@ type ResourceLocation = {
     yrn?: Yrn;
 };
 /**
+ * YRN (attribute)
+ *
  * In YaaS, a global resource identifier is a Uniform Resource Name (URN) with a custom YaaS schema and is called a YaaS Resource Name, or YRN.
  *
  * It is a unique identifier, which stores information about a resource, such as its type, ID or name of the tenant.
@@ -710,6 +724,9 @@ type Vendor = {
      */
     name?: string;
 };
+/**
+ * relatedItem
+ */
 type RelatedItem = {
     /**
      * Identifier of a product which is in the relationship with the main product. The product identifier has to exist.
@@ -720,6 +737,9 @@ type RelatedItem = {
      */
     type: string;
 };
+/**
+ * bulkResponse
+ */
 type BulkResponse = {
     /**
      * Index of the processed product, matching the price position in request body.

package/dist/{types.gen-C_wOXYZB.d.cts → types.gen-fWB4nrso.d.cts}

@@ -20,6 +20,9 @@ type Metadata = MetadataUpdate & {
      */
     modifiedAt?: string;
 };
+/**
+ * Customer group
+ */
 type CustomerGroup = {
     /**
      * The unique identifier of the customer group.
@@ -34,12 +37,18 @@ type CustomerGroup = {
      */
     role?: string;
 };
+/**
+ * Resource
+ */
 type ResourceId = {
     /**
      * Id of a resource.
      */
     id?: string;
 };
+/**
+ * Legal Entity
+ */
 type LegalEntity = {
     /**
      * The legal entity unique identifier.
@@ -80,6 +89,9 @@ type LegalEntity = {
         [key: string]: unknown;
     };
 };
+/**
+ * Account Limit additional information
+ */
 type AccountLimit = {
     /**
      * The account limit currency.
@@ -90,6 +102,9 @@ type AccountLimit = {
      */
     value?: number;
 };
+/**
+ * Legal Entity additional information
+ */
 type LegalInfo = {
     /**
      * The legal name of the entity.
@@ -117,9 +132,14 @@ type LegalInfo = {
     registrationId?: string;
 };
 /**
+ * Restriction
+ *
  * List of restrictions which determine who can view or manage the Legal Entity.
  */
 type Restrictions = Array<string> | null;
+/**
+ * Legal Entity create payload
+ */
 type LegalEntityCreate = {
     /**
      * Custom legal entity identifier. If not provided, it is automatically generated.
@@ -160,6 +180,9 @@ type LegalEntityCreate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Legal Entity update payload
+ */
 type LegalEntityUpdate = {
     /**
      * The name of the legal entity.
@@ -196,6 +219,9 @@ type LegalEntityUpdate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Customer
+ */
 type Customer = {
     /**
      * The customer unique identifier.
@@ -218,6 +244,9 @@ type Customer = {
      */
     phone?: string;
 };
+/**
+ * Contact Assignment
+ */
 type ContactAssignment = {
     /**
      * The customer assignment unique identifier.
@@ -241,6 +270,9 @@ type ContactAssignment = {
         [key: string]: unknown;
     };
 };
+/**
+ * Contact Assignment
+ */
 type ContactAssignmentWithoutExpandedLegalEntity = {
     /**
      * The customer assignment unique identifier.
@@ -266,6 +298,9 @@ type ContactAssignmentWithoutExpandedLegalEntity = {
     primary?: boolean;
     metadata?: Metadata;
 };
+/**
+ * Contact Assignment create payload
+ */
 type ContactAssignmentCreate = {
     /**
      * Custom assignment identifier. If not provided, it is automatically generated.
@@ -305,6 +340,9 @@ type ContactAssignmentCreate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Contact Assignment update payload
+ */
 type ContactAssignmentUpdate = {
     /**
      * The legal entity unique identifier.
@@ -340,6 +378,9 @@ type ContactAssignmentUpdate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location
+ */
 type Location = {
     /**
      * The location unique identifier.
@@ -362,6 +403,9 @@ type Location = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location create payload
+ */
 type LocationCreate = {
     /**
      * Custom location identifier. If not provided, it is automatically generated.
@@ -384,6 +428,9 @@ type LocationCreate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location update payload
+ */
 type LocationUpdate = {
     /**
      * The name of the location
@@ -402,6 +449,9 @@ type LocationUpdate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Contact Details
+ */
 type ContactDetails = {
     /**
      * The list of contact emails.
@@ -441,6 +491,8 @@ type ContactDetails = {
     tags?: Array<string>;
 };
 /**
+ * metadata_create
+ *
  * Metadata request.
  */
 type MetadataCreate = {