@viu/emporix-sdk 2.36.0 → 2.36.1

package/dist/orders.d.ts

@@ -22,6 +22,9 @@ type Restriction = string | null;
 type LocalizedValue = string | {
     [key: string]: string;
 };
+/**
+ * Aggregate Fee
+ */
 type AggregateFee = {
     total: {
         subTotal?: number;
@@ -62,6 +65,9 @@ type AggregateFee = {
     }>;
 };
 type OrderEntriesDto = {
+    /**
+     * Entries of the order
+     */
     entries: Array<{
         /**
          * Order entry id. Required if `productId` is not provided. Use for entry modification. Cannot be provided along with `productId`.
@@ -79,11 +85,15 @@ type OrderEntriesDto = {
 };
 type OrderCalculationDto = {
     /**
+     * Order Calculation DTO
+     *
      * Order recalculation DTO contains a list of entries, where each entry contains entry ID and delivered amount of items.
      */
     entries?: Array<OrderCalculationEntryDto>;
 };
 /**
+ * Order Calculation Entry DTO
+ *
  * Order Calculation DTO contains information to recalculate a single entry. Required information is ID of entry and (new) delivered amount of items.
  */
 type OrderCalculationEntryDto = {
@@ -104,11 +114,16 @@ type OrderCalculationEntryDto = {
      */
     unit?: string;
 };
+/**
+ * Channel
+ */
 type Channel = {
     name?: string;
     source?: string;
 };
 /**
+ * Order entry
+ *
  * The ordered item.
  */
 type OrderEntry = {
@@ -138,16 +153,19 @@ type OrderEntry = {
     effectiveQuantity?: number;
     /**
      * The original amount. **This field is deprecated**. Please use `calculatedUnitPrice` instead. The `calculatedUnitPrice` field provides the same value with updated functionality.
+     *
      * @deprecated
      */
     originalAmount?: number;
     /**
      * The original price. **This field is deprecated**. Please use `calculatedUnitPrice` instead. The `calculatedUnitPrice` field provides the same value with updated functionality.
+     *
      * @deprecated
      */
     originalPrice?: number;
     /**
      * **This field is deprecated**. Please use `calculatedUnitPrice` instead. The `calculatedUnitPrice` field provides the same value with updated functionality.
+     *
      * @deprecated
      */
     unitPrice?: number;
@@ -161,16 +179,19 @@ type OrderEntry = {
     link?: string;
     /**
      * The discount list. **This field is deprecated**. Please use `calculatedPrice.totalDiscount` instead. The `calculatedPrice.totalDiscount` field provides the same value with updated functionality.
+     *
      * @deprecated
      */
     discounts?: unknown;
     /**
      * The total price of items. **This field is deprecated**. Please use `calculatedPrice.finalPrice` instead. The `calculatedPrice.finalPrice` field provides the same value with updated functionality.
+     *
      * @deprecated
      */
     totalPrice?: number;
     /**
      * The authorized amount. **This field is deprecated**. Please use `calculatedPrice.upliftValue` instead. The `calculatedPrice.upliftValue` field how much payment authorization should be increased for given item.
+     *
      * @deprecated
      */
     authorizedAmount?: number;
@@ -196,6 +217,9 @@ type OrderEntry = {
      */
     externalFees?: Array<ExternalFee>;
 };
+/**
+ * Delivery Window
+ */
 type DeliveryWindow = {
     /**
      * Id of the delivery window
@@ -219,6 +243,9 @@ type DeliveryWindow = {
      */
     deliveryCycleName?: string;
 };
+/**
+ * Delivery Time Range
+ */
 type DeliveryTimeRange = {
     /**
      * Start Time
@@ -229,6 +256,9 @@ type DeliveryTimeRange = {
      */
     timeTo?: string;
 };
+/**
+ * Discount
+ */
 type Discount = {
     /**
      * Discount's code.
@@ -277,6 +307,9 @@ type Discount = {
         [key: string]: unknown;
     };
 };
+/**
+ * Discount Restrictions
+ */
 type DiscountRestrictions = {
     /**
      * The date from which the discount restriction is valid.
@@ -298,6 +331,9 @@ type DiscountRestrictions = {
      */
     excludedCategories?: Array<string>;
 };
+/**
+ * Discount Restrictions Price
+ */
 type DiscountRestrictionsPrice = {
     /**
      * The amount of discount price
@@ -308,6 +344,9 @@ type DiscountRestrictionsPrice = {
      */
     currency?: string;
 };
+/**
+ * Link
+ */
 type Reference = {
     /**
      * Unique identifier of a link.
@@ -323,6 +362,8 @@ type Reference = {
     url: string;
 };
 /**
+ * Customer
+ *
  * Customer data.
  *
  * One of these properties needs to be provided:
@@ -374,6 +415,8 @@ type Customer = {
     };
 };
 /**
+ * Address
+ *
  * Customer's address.
  */
 type Address = {
@@ -444,6 +487,8 @@ type Address = {
     };
 };
 /**
+ * Payment
+ *
  * Payment details.
  */
 type Payment = {
@@ -489,6 +534,8 @@ type Payment = {
     provider?: string;
 };
 /**
+ * Shipping
+ *
  * Shipping details.
  */
 type Shipping = {
@@ -511,6 +558,8 @@ type Shipping = {
     lines?: Array<ShippingLine>;
 };
 /**
+ * Shipping line
+ *
  * Shipping line.
  */
 type ShippingLine = {
@@ -545,6 +594,8 @@ type ShippingLine = {
     shippingTaxCode?: string;
 };
 /**
+ * Shipment
+ *
  * Shippment details.
  */
 type Shipment = {
@@ -566,6 +617,8 @@ type Shipment = {
     expectDeliveryOn?: string;
 };
 /**
+ * Tax
+ *
  * Tax details.
  */
 type Tax = {
@@ -573,6 +626,8 @@ type Tax = {
     total: TaxTotal;
 };
 /**
+ * Tax
+ *
  * Tax details.
  */
 type ShippingTax = {
@@ -584,6 +639,8 @@ type ShippingTax = {
     rate?: number;
 };
 /**
+ * taxLine
+ *
  * Tax line details.
  */
 type TaxLine = {
@@ -621,6 +678,8 @@ type TaxLine = {
     inclusive: boolean;
 };
 /**
+ * Tax total
+ *
  * The tax total tax amount.
  */
 type TaxTotal = {
@@ -638,6 +697,8 @@ type TaxTotal = {
     inclusive: boolean;
 };
 /**
+ * Product
+ *
  * Product details stored on the order entry as a creation-time snapshot.
  * For `DYNAMIC_VARIANT` products, the snapshot includes `parentVariantId`, `parentVariantPath`, `ownVariantAttributes`, `inheritedVariantAttributes`, and `sellable` when those fields are present on the source product. The fields are omitted when they are not present, for example on `BASIC` or `VARIANT` products.
  *
@@ -721,6 +782,8 @@ type Product = {
     };
 };
 /**
+ * Bundle Product
+ *
  * Represents the product used in a bundle.
  */
 type BundleProduct = {
@@ -734,6 +797,8 @@ type BundleProduct = {
     productId?: string;
 };
 /**
+ * Price
+ *
  * Price details.
  */
 type Price = {
@@ -762,6 +827,8 @@ type Price = {
     };
 };
 /**
+ * Media
+ *
  * The media.
  */
 type Media = {
@@ -779,6 +846,8 @@ type Media = {
     stored?: boolean;
 };
 /**
+ * Sale Price
+ *
  * The sale price.
  */
 type SalePrice = {
@@ -796,6 +865,8 @@ type SalePrice = {
     description?: string;
 };
 /**
+ * Product Metadata
+ *
  * Product Metadata
  */
 type MixinsMetadata = {
@@ -809,11 +880,11 @@ type MixinsMetadata = {
      * The document version number.
      */
     version?: number;
-    [key: string]: unknown | {
-        [key: string]: unknown;
-    } | number | undefined;
+    [key: string]: unknown;
 };
 /**
+ * Measurement Unit
+ *
  * The entry measurement unit
  */
 type MeasurementUnit = {
@@ -827,6 +898,8 @@ type MeasurementUnit = {
     value: number;
 };
 /**
+ * Resource location
+ *
  * Resource location is a response object which contains ID and link to created resource.
  */
 type ResourceLocation = {
@@ -847,6 +920,8 @@ type Vendor = {
     name?: string;
 };
 /**
+ * Order Common DTO
+ *
  * The base order fields. This object is inherited by all of other order objects as Order Creation DTO, Order Update DTO etc.
  */
 type OrderCommonDto = {
@@ -901,11 +976,13 @@ type OrderCommonDto = {
     } & unknown;
     /**
      * Order sub total price. **This field is deprecated**. Please use `calculatedPrice.price` or `calculatedPrice.discountedPrice` instead. These fields provide the same value with updated functionality.
+     *
      * @deprecated
      */
     subTotalPrice?: number;
     /**
      * Order total price. **This field is deprecated**. Please use `calculatedPrice.finalPrice` instead. The `calculatedPrice.finalPrice` field provides the same value with updated functionality.
+     *
      * @deprecated
      */
     totalPrice?: number;
@@ -921,6 +998,7 @@ type OrderCommonDto = {
      * Order cycle date.
      *
      * **This field is deprecated**. Please use the `deliveryWindow.deliveryCycle` attribute instead.
+     *
      * @deprecated
      */
     orderCycle?: string;
@@ -928,6 +1006,7 @@ type OrderCommonDto = {
      * Delivery window's unique identifier.
      *
      * **This field is deprecated**. Please use the `deliveryWindow.id` attribute instead.
+     *
      * @deprecated
      */
     deliveryWindowId?: string;
@@ -944,6 +1023,9 @@ type OrderCommonDto = {
      */
     legalEntityId?: string;
 };
+/**
+ * Order
+ */
 type Order = {
     /**
      * Order's unique identifier.
@@ -990,6 +1072,9 @@ type SalesOrder = {
      */
     checkout?: boolean;
 } & OrderUpdateDto;
+/**
+ * Order Creation DTO
+ */
 type SalesOrderCreationDto = {
     /**
      * Identifier of the quote from which the order has been created
@@ -1013,9 +1098,15 @@ type SearchRequest = {
      */
     q?: string;
 };
+/**
+ * Order Creation DTO
+ */
 type OrderCreationDto = {
     channel?: Channel;
 } & OrderCommonDto;
+/**
+ * Order Update DTO
+ */
 type OrderUpdateDto = {
     channel?: Channel;
     /**
@@ -1086,12 +1177,16 @@ type OrderSplitResponse = {
  */
 type PaymentStatus = 'PENDING' | 'AUTHORIZATION_SUCCESS' | 'AUTHORIZATION_FAILURE' | 'CAPTURE_SUCCESS' | 'CAPTURE_FAILURE' | 'SUCCESS' | 'FAILURE' | 'CANCELLATION_SUCCESS' | 'CANCELLATION_FAILURE' | 'REFUND_SUCCESS' | 'REFUND_FAILURE';
 /**
+ * Transition
+ *
  * Order status transition.
  */
 type Transition = {
     status?: OrderStatus;
 };
 /**
+ * Historical Transition
+ *
  * A historical order status transition entry.
  */
 type HistoricalTransition = {
@@ -1102,6 +1197,8 @@ type HistoricalTransition = {
     timestamp: string;
 };
 /**
+ * Historical Transitions Metadata
+ *
  * Metadata related to historical order status transitions.
  */
 type HistoricalTransitionsMetadata = {
@@ -1119,6 +1216,8 @@ type HistoricalTransitionsMetadata = {
     modifiedAt: string;
 };
 /**
+ * Historical Transitions Response
+ *
  * Historical order status transitions with metadata.
  */
 type HistoricalTransitionsResponse = {
@@ -1128,21 +1227,27 @@ type HistoricalTransitionsResponse = {
     transitions: Array<HistoricalTransition>;
     metadata: HistoricalTransitionsMetadata;
 };
+/**
+ * Metadata DTO
+ */
 type MetadataMixins = {
     mixins?: {
         [key: string]: unknown;
     };
     version?: number;
-    [key: string]: unknown | {
-        [key: string]: unknown;
-    } | number | undefined;
+    [key: string]: unknown;
 };
 /**
+ * YRN
+ *
  * 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.
  */
 type Yrn = string;
+/**
+ * AssistedBuyingEntry
+ */
 type AssistedBuyingEntry = {
     /**
      * Identifier of an employee who performed an action on behalf of a customer.
@@ -1158,6 +1263,8 @@ type AssistedBuyingEntry = {
     timestamp?: string;
 };
 /**
+ * assistedBuying
+ *
  * The field is populated only if an assisted buying operation was performed. The field is read-only. There is no possibility to update it by PUT/PATCH operation.
  */
 type AssistedBuying = {
@@ -1491,6 +1598,9 @@ type CalculatedFee = {
     price?: CalculatedPrice;
     discountedPrice?: CalculatedPriceWithDiscounts;
 };
+/**
+ * calculatedPaymentFee
+ */
 type CalculatedPaymentFee = {
     /**
      * Unique identifier of the fee.
@@ -1860,6 +1970,8 @@ type ExternalFee = {
     taxCode?: string;
 };
 /**
+ * priceMatchDetails
+ *
  * This model represents the price value retrieved from the price service
  */
 type PriceMatchDetails = {

package/dist/payment.d.cts

@@ -1,5 +1,8 @@
 import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.cjs';
 
+/**
+ * paymentModeRequest
+ */
 type PaymentModeRequest = {
     /**
      * Indicates a code of a given method.
@@ -38,6 +41,9 @@ type PaymentModeRequest = {
         [key: string]: string;
     };
 };
+/**
+ * paymentMethodUpdateRequest
+ */
 type PaymentMethodUpdateRequest = {
     /**
      * Indicates whether a give mode is active.
@@ -59,6 +65,9 @@ type PaymentMethodUpdateRequest = {
     };
 };
 type Provider = 'INVOICE' | 'CASH_ON_DELIVERY' | 'SPREEDLY' | 'SPREEDLY_SAFERPAY' | 'UNZER';
+/**
+ * paymentModeResponse
+ */
 type PaymentModeResponse = {
     /**
      * Indicates an autogenerated identifier of a given payment method.
@@ -89,6 +98,9 @@ type PaymentModeResponse = {
         [key: string]: string;
     };
 };
+/**
+ * paymentModeFrontendResponse
+ */
 type PaymentModeFrontendResponse = {
     /**
      * Indicates an autogenerated identifier of a given payment method.
@@ -131,6 +143,9 @@ type PaymentModeFrontendResponse = {
      */
     receiverId?: string;
 };
+/**
+ * initializePaymentRequest
+ */
 type InitializePaymentRequest = {
     order?: {
         /**
@@ -147,6 +162,9 @@ type InitializePaymentRequest = {
      */
     creditCardToken?: string;
 };
+/**
+ * authorizeFrontendPaymentRequest
+ */
 type AuthorizeFrontendPaymentRequest = InitializePaymentRequest & {
     /**
      * Contains a token generated during the 3DS authentication process.
@@ -161,6 +179,9 @@ type AuthorizeFrontendPaymentRequest = InitializePaymentRequest & {
      */
     clientIP?: string;
 };
+/**
+ * authorizePaymentRequest
+ */
 type AuthorizePaymentRequest = AuthorizeFrontendPaymentRequest & {
     /**
      * Amount that should be authorized.
@@ -171,6 +192,9 @@ type AuthorizePaymentRequest = AuthorizeFrontendPaymentRequest & {
      */
     currency?: string;
 };
+/**
+ * initializePaymentResponse
+ */
 type InitializePaymentResponse = {
     /**
      * Indicates if the authorization process finished with success.
@@ -199,12 +223,18 @@ type InitializePaymentResponse = {
         [key: string]: string;
     };
 };
+/**
+ * authorizePaymentResponse
+ */
 type AuthorizePaymentResponse = InitializePaymentResponse & {
     /**
      * Indicates if a redirect to an external site is required in order to finish the authorization flow.
      */
     requiresExternalPayment?: boolean;
 };
+/**
+ * captureRequest
+ */
 type CaptureRequest = {
     /**
      * Amount that should be captured. The amount should not be greater than amount that was authorized.
@@ -215,6 +245,9 @@ type CaptureRequest = {
      */
     currency?: string;
 };
+/**
+ * commonPaymentResponse
+ */
 type CommonPaymentResponse = {
     /**
      * Indicates if the operation finished with success or not.
@@ -225,6 +258,9 @@ type CommonPaymentResponse = {
      */
     message?: string;
 };
+/**
+ * refundRequest
+ */
 type RefundRequest = {
     /**
      * Amount that should be refunded. The amount should not be greater than amount that was captured.
@@ -239,6 +275,9 @@ type RefundRequest = {
      */
     captureId?: string;
 };
+/**
+ * paymentTransactionResponse
+ */
 type PaymentTransactionResponse = {
     /**
      * A unique identifier of a payment transaction.

package/dist/payment.d.ts

@@ -1,5 +1,8 @@
 import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.js';
 
+/**
+ * paymentModeRequest
+ */
 type PaymentModeRequest = {
     /**
      * Indicates a code of a given method.
@@ -38,6 +41,9 @@ type PaymentModeRequest = {
         [key: string]: string;
     };
 };
+/**
+ * paymentMethodUpdateRequest
+ */
 type PaymentMethodUpdateRequest = {
     /**
      * Indicates whether a give mode is active.
@@ -59,6 +65,9 @@ type PaymentMethodUpdateRequest = {
     };
 };
 type Provider = 'INVOICE' | 'CASH_ON_DELIVERY' | 'SPREEDLY' | 'SPREEDLY_SAFERPAY' | 'UNZER';
+/**
+ * paymentModeResponse
+ */
 type PaymentModeResponse = {
     /**
      * Indicates an autogenerated identifier of a given payment method.
@@ -89,6 +98,9 @@ type PaymentModeResponse = {
         [key: string]: string;
     };
 };
+/**
+ * paymentModeFrontendResponse
+ */
 type PaymentModeFrontendResponse = {
     /**
      * Indicates an autogenerated identifier of a given payment method.
@@ -131,6 +143,9 @@ type PaymentModeFrontendResponse = {
      */
     receiverId?: string;
 };
+/**
+ * initializePaymentRequest
+ */
 type InitializePaymentRequest = {
     order?: {
         /**
@@ -147,6 +162,9 @@ type InitializePaymentRequest = {
      */
     creditCardToken?: string;
 };
+/**
+ * authorizeFrontendPaymentRequest
+ */
 type AuthorizeFrontendPaymentRequest = InitializePaymentRequest & {
     /**
      * Contains a token generated during the 3DS authentication process.
@@ -161,6 +179,9 @@ type AuthorizeFrontendPaymentRequest = InitializePaymentRequest & {
      */
     clientIP?: string;
 };
+/**
+ * authorizePaymentRequest
+ */
 type AuthorizePaymentRequest = AuthorizeFrontendPaymentRequest & {
     /**
      * Amount that should be authorized.
@@ -171,6 +192,9 @@ type AuthorizePaymentRequest = AuthorizeFrontendPaymentRequest & {
      */
     currency?: string;
 };
+/**
+ * initializePaymentResponse
+ */
 type InitializePaymentResponse = {
     /**
      * Indicates if the authorization process finished with success.
@@ -199,12 +223,18 @@ type InitializePaymentResponse = {
         [key: string]: string;
     };
 };
+/**
+ * authorizePaymentResponse
+ */
 type AuthorizePaymentResponse = InitializePaymentResponse & {
     /**
      * Indicates if a redirect to an external site is required in order to finish the authorization flow.
      */
     requiresExternalPayment?: boolean;
 };
+/**
+ * captureRequest
+ */
 type CaptureRequest = {
     /**
      * Amount that should be captured. The amount should not be greater than amount that was authorized.
@@ -215,6 +245,9 @@ type CaptureRequest = {
      */
     currency?: string;
 };
+/**
+ * commonPaymentResponse
+ */
 type CommonPaymentResponse = {
     /**
      * Indicates if the operation finished with success or not.
@@ -225,6 +258,9 @@ type CommonPaymentResponse = {
      */
     message?: string;
 };
+/**
+ * refundRequest
+ */
 type RefundRequest = {
     /**
      * Amount that should be refunded. The amount should not be greater than amount that was captured.
@@ -239,6 +275,9 @@ type RefundRequest = {
      */
     captureId?: string;
 };
+/**
+ * paymentTransactionResponse
+ */
 type PaymentTransactionResponse = {
     /**
      * A unique identifier of a payment transaction.