@viu/emporix-sdk 2.36.0 → 2.37.0

package/dist/index.d.cts

@@ -21,14 +21,14 @@ export { Segment, SegmentAssignmentBulkResult, SegmentBulkItem, SegmentBulkResul
 import { CompaniesService } from './companies.cjs';
 import { ContactsService } from './contacts.cjs';
 import { LocationsService } from './locations.cjs';
-import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-D0OCm8kJ.cjs';
+import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-BfHDqExS.cjs';
 import { OrdersService, SalesOrdersService } from './orders.cjs';
 export { GetOrderOptions, ListLegalEntityOrdersOptions, ListMyOrdersOptions, ListSalesOrdersOptions, Order, OrderEntry, OrderStatus, OrderTransitionOptions, SalesOrder, SalesOrderCalculationInput, SalesOrderCreateInput, SalesOrderCreated, SalesOrderEntriesInput, SalesOrderHistoricalTransitions, SalesOrderPatch, SalesOrderReplaceInput, SalesOrderSearchInput, SalesOrderSplitInput, SalesOrderSplitResult, Transition, UpdateSalesOrderOptions } from './orders.cjs';
 import { AvailabilityService } from './availability.cjs';
 export { Availability, AvailabilityBulkDeleteInput, AvailabilityBulkInput, AvailabilityBulkResult, AvailabilityCreated, AvailabilityInput, AvailabilityOptions } from './availability.cjs';
 import { a as QueryFor } from './query-mLQs2WFr.cjs';
 export { B as BuiltQuery, Q as QueryCapability, r as resolveQuery } from './query-mLQs2WFr.cjs';
-export { A as AccountLimit, C as ContactAssignment, a as ContactAssignmentCreate, b as ContactAssignmentUpdate, c as ContactDetails, d as CustomerGroup, L as LegalEntity, e as LegalEntityCreate, f as LegalEntityUpdate, g as LegalInfo, h as Location, i as LocationCreate, j as LocationUpdate } from './types.gen-C_wOXYZB.cjs';
+export { A as AccountLimit, C as ContactAssignment, a as ContactAssignmentCreate, b as ContactAssignmentUpdate, c as ContactDetails, d as CustomerGroup, L as LegalEntity, e as LegalEntityCreate, f as LegalEntityUpdate, g as LegalInfo, h as Location, i as LocationCreate, j as LocationUpdate } from './types.gen-fWB4nrso.cjs';
 
 /** Base class for every error thrown by the SDK. */
 declare class EmporixError extends Error {
@@ -235,6 +235,8 @@ declare function createServerStorage(jar: ServerCookieJar): EmporixStorage;
 declare function serverAuth(storage: EmporixStorage): AuthContext;
 
 /**
+ * Address
+ *
  * Site address.
  */
 type AddressDto = {
@@ -254,6 +256,9 @@ type AddressDto = {
  * Currency used by the site, compliant with the ISO 4217 standard.
  */
 type CurrencyDto = string;
+/**
+ * Metadata
+ */
 type DefaultDtoMetadata$1 = {
     /**
      * Mixin schema URLs.
@@ -264,6 +269,8 @@ type DefaultDtoMetadata$1 = {
     version?: number;
 };
 /**
+ * HomeBase
+ *
  * Site location.
  */
 type HomeBaseDto = {
@@ -286,6 +293,8 @@ type HomeBaseDto = {
     timezone?: string;
 };
 /**
+ * Location
+ *
  * Site geographical location.
  */
 type LocationDto = {
@@ -293,6 +302,8 @@ type LocationDto = {
     longitude?: number;
 };
 /**
+ * Site
+ *
  * Information about the site.
  */
 type SiteDto = {
@@ -366,6 +377,9 @@ type SiteDto = {
      */
     cartCalculationScale?: number;
 };
+/**
+ * Service Configuration
+ */
 type ServiceConfigurationDto = {
     /**
      * Service configuration's unique identifier.
@@ -383,6 +397,9 @@ type ServiceConfigurationDto = {
     active?: boolean;
     configuration?: ServiceSettingsDto;
 };
+/**
+ * Service Settings
+ */
 type ServiceSettingsDto = {
     public?: {
         [key: string]: unknown;
@@ -391,6 +408,9 @@ type ServiceSettingsDto = {
         [key: string]: unknown;
     };
 };
+/**
+ * ResourceLocation
+ */
 type ResourceLocation$2 = {
     /**
      * Resource identifier.
@@ -398,17 +418,24 @@ type ResourceLocation$2 = {
     id?: string;
 };
 /**
+ * Mixin
+ *
  * Represents a single mixin. The payload is represented as a map with a single key and value, where key represents a mixin group name and value represents a map with keys and values.
  */
 type Mixin = {
     [key: string]: unknown;
 };
 /**
+ * Mixins
+ *
  * Represents mixins. The object is represented as a map with keys and values, where key represents a mixin group name and value represents a map with keys and values.
  */
 type Mixins = {
     [key: string]: unknown;
 };
+/**
+ * AssistedBuying
+ */
 type AssistedBuying$1 = {
     /**
      * Storefront URL, where an employee should be redirected when the assisted buying mechanism is used.
@@ -510,6 +537,8 @@ declare class SiteService {
 }
 
 /**
+ * ContextAttribute
+ *
  * Context attribute
  */
 type ContextAttribute = {
@@ -530,6 +559,8 @@ type SessionContextGet = SessionContextBase & {
     metadata?: Metadata$9;
 };
 /**
+ * SessionContextPartialUpdateRequest
+ *
  * Request body for partially updating own session context (PATCH /me/context).
  * Only the following fields can be updated; all other fields are ignored.
  *
@@ -554,6 +585,9 @@ type SessionContextPatch$1 = {
     context?: Context;
     metadata: MetadataUpdate$2;
 };
+/**
+ * SessionContextBase
+ */
 type SessionContextBase = {
     /**
      * Unique identifier of the customer's session.
@@ -593,6 +627,9 @@ type SessionContextBase = {
      */
     language?: string;
 };
+/**
+ * Metadata
+ */
 type MetadataUpdate$2 = {
     /**
      * Version of the session context object.
@@ -609,6 +646,9 @@ type Metadata$9 = MetadataUpdate$2 & {
      */
     modifiedAt?: string;
 };
+/**
+ * Context
+ */
 type Context = {
     [key: string]: {
         [key: string]: unknown;
@@ -637,9 +677,18 @@ type SessionContextPatch = Pick<SessionContextPatch$1, "siteCode" | "currency" |
 };
 
 /**
- * Session-context binding for the current storefront session. Both endpoints
- * resolve the session-id from the `Authorization` token — no path/query
- * parameter required.
+ * Session-context binding for the current storefront session. Every method here
+ * hits a `/me/context` path, so the session-id comes from the `Authorization`
+ * token — no path or query parameter required.
+ *
+ * **The service's other half is intentionally not wrapped.** Emporix also exposes
+ * the same four operations addressed by an explicit session id —
+ * `GET`/`PUT /{sessionId}/context`, `POST`/`DELETE` on its attributes. Those are
+ * administrative: they let a caller read and rewrite *someone else's* session,
+ * which is not a storefront capability and needs a service token. Wrapping them
+ * here would put an admin surface on the object a storefront holds. If you need
+ * them, build the request directly — the generated types are in
+ * `../generated/session-context`.
  */
 declare class SessionContextService {
     private readonly ctx;
@@ -706,6 +755,13 @@ declare class IamService {
         update: (userId: string, input: IamUserUpdate, auth: AuthContext) => Promise<void>;
         delete: (userId: string, auth: AuthContext) => Promise<void>;
         getGroups: (userId: string, auth: AuthContext) => Promise<IamGroup[]>;
+        /**
+         * Reads one of a user's groups (`GET /users/{userId}/groups/{groupId}`).
+         * The collection read above returns the same shape per entry; this exists
+         * because Emporix exposes the item separately and a caller holding both ids
+         * should not have to page the collection to resolve one group.
+         */
+        getGroup: (userId: string, groupId: string, auth: AuthContext) => Promise<IamGroup>;
         getScopes: (userId: string, auth: AuthContext) => Promise<IamUserScopes>;
         getMyScopes: (auth: AuthContext) => Promise<IamUserScopes>;
         getAccessControls: (userId: string, auth: AuthContext) => Promise<IamAccessControl[]>;
@@ -737,6 +793,9 @@ declare class IamService {
     };
 }
 
+/**
+ * BaseConfiguration
+ */
 type BaseConfiguration = {
     /**
      * Configuration key.
@@ -934,11 +993,13 @@ type MetadataFilter$1 = {
     key?: string;
     /**
      * Name of the field.
+     *
      * @deprecated
      */
     name?: string;
     /**
      * Description of the field.
+     *
      * @deprecated
      */
     description?: string;
@@ -1248,6 +1309,8 @@ type Fee$2 = {
     yrn?: Yrn;
 };
 /**
+ * Monetary Amount
+ *
  * Schema defining monetary amount in given currency.
  */
 type MonetaryAmount$1 = {
@@ -1261,6 +1324,8 @@ type MonetaryAmount$1 = {
     currency: string;
 };
 /**
+ * Timespan
+ *
  * Restricts the active fees to be only applied in the specified
  * timespan.
  */
@@ -1287,6 +1352,8 @@ type ItemFee$1 = {
     feeIds: Array<string>;
 };
 /**
+ * YRN
+ *
  * A unique identifier of a global resource, which stores information about the resource, such as its type, ID or name of the tenant.
  */
 type Yrn = string;
@@ -1636,6 +1703,8 @@ type WebhookConfigCreation = WebhookConfigUpdate & {
     code: ConfigCode;
 };
 /**
+ * Webhook event
+ *
  * Events that you can subscribe to.
  */
 type WebhookEvent = {
@@ -1669,6 +1738,8 @@ type WebhookEvent = {
     };
 };
 /**
+ * Webhook subscription
+ *
  * Subscription per event.
  */
 type WebhookSubscription$1 = {
@@ -1684,6 +1755,8 @@ type WebhookSubscription$1 = {
     excludedFields?: Array<string>;
 };
 /**
+ * Webhook subscription update item
+ *
  * Object used to subscribe to/unsubscribe from an event.
  */
 type WebhookSubscriptionUpdateItem$1 = {
@@ -1706,6 +1779,8 @@ type WebhookSubscriptionUpdateItem$1 = {
     fieldsToSubscribe?: Array<string>;
 };
 /**
+ * Metadata
+ *
  * Auditing details.
  */
 type Metadata$8 = {
@@ -1723,6 +1798,8 @@ type Metadata$8 = {
     version?: number;
 };
 /**
+ * Metadata for update
+ *
  * Auditing details.
  */
 type MetadataForUpdate = {
@@ -1732,6 +1809,8 @@ type MetadataForUpdate = {
     version?: number;
 };
 /**
+ * Update subscription result response
+ *
  * Object containing the result of event subscription.
  */
 type UpdateSubscriptionResponse = {
@@ -1750,6 +1829,9 @@ type DashboardAccess = {
      */
     token?: string;
 };
+/**
+ * Webhook monthly statistics
+ */
 type MonthStatistics = {
     /**
      * Month for which statistics should be retrieved, provided in the "YYYY-MM" format.
@@ -1760,6 +1842,9 @@ type MonthStatistics = {
      */
     succesfullySentWebhooks?: number;
 };
+/**
+ * Webhooks limit statistics
+ */
 type WebhookStatistics$1 = {
     monthStatistics?: Array<MonthStatistics>;
     /**
@@ -2168,12 +2253,6 @@ type CustomInstanceResponse = {
      * Unique identifier of the custom instance.
      */
     id?: string;
-    /**
-     * Localized custom type name in a form of a map of translations.
-     */
-    name?: {
-        [key: string]: unknown;
-    };
     /**
      * Custom schema type to which custom instance is related.
      */
@@ -2600,6 +2679,8 @@ type AgenticRequest = {
  */
 type AgentType = 'generic' | 'complaint' | 'anti_fraud';
 /**
+ * TextGenerationRequest
+ *
  * Represents a request body for a text generation operation.
  */
 type TextGenerationRequest = {
@@ -3710,7 +3791,29 @@ type ImportedEntity = {
     /**
      * State of the imported entity.
      */
-    state?: 'TO_CREATE' | 'ENABLED' | 'DISABLED' | 'EXISTS';
+    state?: 'TO_CREATE' | 'ENABLED' | 'DISABLED' | 'EXISTS' | 'FAILED';
+    /**
+     * Reasons the entity was skipped, disabled, or failed during import.
+     */
+    details?: Array<ImportDetails>;
+};
+type ImportDetails = {
+    /**
+     * Machine-readable reason code for UI localization.
+     */
+    code?: 'MISSING_FUNCTION' | 'MISSING_TOKEN' | 'NOT_IMPORTABLE' | 'ALREADY_EXISTS' | 'AGENT_IMPORTED_DISABLED' | 'IMPORT_FAILED';
+    /**
+     * ID of the related object, such as a function ID or token ID.
+     */
+    objectId?: string;
+    /**
+     * Display name of the related object, such as a tool name.
+     */
+    objectName?: string;
+    /**
+     * English fallback message when a localized string is not available.
+     */
+    message?: string;
 };
 type AttachmentResponse = {
     /**
@@ -3805,6 +3908,9 @@ type AgentSessionResponse = {
     duration?: number;
     metadata?: MetadataResponse$1;
 };
+/**
+ * CompletionRequest
+ */
 type CompletionRequest$1 = {
     /**
      * Identifier of the request. The value is not mandatory - if provided, then the ID is returned in the text generation response.
@@ -3812,7 +3918,7 @@ type CompletionRequest$1 = {
     id?: string;
     messages: Array<{
         /**
-         * Specifies the role of the message. `SYSTEM` - Provides instructions or context to the AI about the conversation.   `USER` - Represents a message sent by the user.   `ASSISTANT` - Represents a message generated by the AI.
+         * Specifies the role of the message. `SYSTEM` - Provides instructions or context to the AI about the conversation. `USER` - Represents a message sent by the user. `ASSISTANT` - Represents a message generated by the AI.
          */
         role: 'USER' | 'SYSTEM' | 'ASSISTANT';
         /**
@@ -4366,6 +4472,8 @@ type Metadata$7 = {
     version?: number;
 };
 /**
+ * taxCreation
+ *
  * Tax configuration for a specified location. It consists of a country code and a list of tax classes applicable in that country.
  */
 type TaxCreation = {
@@ -4376,6 +4484,8 @@ type TaxCreation = {
     taxClasses: Array<TaxClass>;
 };
 /**
+ * taxRetrieval
+ *
  * Tax configuration for a specified location. It consists of a country code and a list of tax classes applicable in that country.
  */
 type TaxRetrieval = {
@@ -4388,6 +4498,8 @@ type TaxRetrieval = {
     metadata?: Metadata$7;
 };
 /**
+ * taxClass
+ *
  * Single tax class.
  */
 type TaxClass = {
@@ -4434,6 +4546,9 @@ type TaxClass = {
      */
     isDefault?: boolean;
 };
+/**
+ * taxCreationResponse
+ */
 type TaxCreationResponse = {
     /**
      * Code of country for which the tax configuration has been created.
@@ -4557,6 +4672,9 @@ type Location$2 = {
      */
     countryCode: string;
 };
+/**
+ * taxUpdate
+ */
 type TaxUpdate = TaxCreation & {
     metadata: Metadata$7;
 };
@@ -4623,6 +4741,8 @@ declare class TaxService {
 
 type Coupons = Array<CouponWithIdAndStatus>;
 /**
+ * Coupon response/update payload
+ *
  * Coupons describe voucher alike commerce capabilities, e.g. 10% off winter accessories.
  */
 type BaseCoupon = {
@@ -4719,6 +4839,8 @@ type Coupon$2 = BaseCoupon & {
     deleted?: boolean;
 };
 /**
+ * Coupon creation payload
+ *
  * Coupon creation schema.
  */
 type CouponCreation = {
@@ -4800,6 +4922,8 @@ type SegmentRestricted = boolean;
  */
 type CategoryRestricted = boolean;
 /**
+ * Money amount
+ *
  * Defines an amount in a specific currency.
  */
 type CurrencyAmount = {
@@ -4813,6 +4937,8 @@ type CurrencyAmount = {
     currency?: string;
 };
 /**
+ * Coupon Redemption
+ *
  * Defines a coupon redemption response.
  */
 type Redemption = RedemptionCreation & {
@@ -4826,6 +4952,8 @@ type Redemption = RedemptionCreation & {
     redeemedAt?: string;
 };
 /**
+ * Coupon Redemption Request
+ *
  * Defines a coupon redemption request payload that affects a coupon instance.
  */
 type RedemptionCreation = {
@@ -4896,6 +5024,8 @@ type CouponWithIdAndStatus = Coupon$2 & {
     status?: 'VALID' | 'INACTIVE' | 'EXPIRED' | 'USED';
 };
 /**
+ * Coupon
+ *
  * Coupons describe voucher alike commerce capabilities.
  */
 type ReferralCoupon = {
@@ -5058,7 +5188,13 @@ declare class CouponService {
     createReferralCoupon(customerNumber: string, auth?: AuthContext): Promise<ReferralCoupon>;
 }
 
+/**
+ * Collection of Summaries
+ */
 type CustomerSummaryBatchOut = Array<PointsSummaryOut>;
+/**
+ * pointsSummaryOut
+ */
 type PointsSummaryOut = {
     /**
      * Id of the customer to whom the points are assigned
@@ -5070,6 +5206,9 @@ type PointsSummaryOut = {
     activePoints?: number;
     summary?: CustomerSummary;
 };
+/**
+ * addedPoints
+ */
 type AddedPoints = {
     id?: string;
     /**
@@ -5099,6 +5238,9 @@ type AddedPoints = {
     usedPoints?: number;
     usedWith?: Array<string>;
 };
+/**
+ * redeemedPoints
+ */
 type RedeemedPoints = {
     /**
      * Identifier of the redeemed points
@@ -5121,11 +5263,20 @@ type RedeemedPoints = {
      */
     allPointsAfterCreation?: number;
 };
+/**
+ * customerSummary
+ */
 type CustomerSummary = {
     addedPointsList: Array<AddedPoints>;
     redeemedPointsList?: Array<RedeemedPoints>;
 };
+/**
+ * redeemOptions
+ */
 type RedeemOptions = Array<RedeemOption>;
+/**
+ * redeemOption
+ */
 type RedeemOption = {
     /**
      * ID of the redemption option to be used at reward points exchange
@@ -5164,6 +5315,9 @@ type RedeemOption = {
         modifiedAt?: string;
     };
 };
+/**
+ * CouponCode
+ */
 type RedeemCouponOut = {
     /**
      * Coupon code received after exchanging points
@@ -5171,6 +5325,8 @@ type RedeemCouponOut = {
     code?: string;
 };
 /**
+ * Coupon API
+ *
  * Coupons describe voucher-like commerce capabilities.
  */
 type Coupon = {
@@ -5195,6 +5351,8 @@ type Coupon = {
      */
     discountPercentage?: number;
     /**
+     * Money Amount
+     *
      * Must be specified only if type is 'ABSOLUTE'
      */
     discountAbsolute?: {
@@ -5262,6 +5420,9 @@ type NewCustomerIn = {
     customerId?: string;
     startPoints?: AddedPoints;
 };
+/**
+ * Restrictions
+ */
 type Restrictions = {
     /**
      * A list of identifiers of customers that can redeem the coupon. Cannot be specified for coupons which can be redeemed by anonymous users.
@@ -5276,6 +5437,8 @@ type Restrictions = {
      */
     validUntil?: string;
     /**
+     * Money Amount
+     *
      * Minimum order value which entitles the customer to redeem the coupon
      */
     minOrderValue?: {
@@ -5365,7 +5528,13 @@ declare class RewardPointsService {
     deleteRedeemOption(redeemOptionId: string, auth?: AuthContext): Promise<void>;
 }
 
+/**
+ * Collection of Brands
+ */
 type Brands = Array<BrandResponse>;
+/**
+ * Brand
+ */
 type Brand$1 = {
     /**
      * Unique identifier of a brand.
@@ -5392,6 +5561,9 @@ type Brand$1 = {
         [key: string]: string;
     };
 };
+/**
+ * Brand
+ */
 type UpdateBrand = {
     /**
      * Brand name.
@@ -5415,6 +5587,9 @@ type UpdateBrand = {
     };
     metadata?: UpdateMetaData;
 };
+/**
+ * Brand Response
+ */
 type BrandResponse = {
     /**
      * Brand name.
@@ -5454,6 +5629,9 @@ type BrandResponse = {
     id?: string;
     metadata?: MetaData$1;
 };
+/**
+ * Metadata
+ */
 type MetaData$1 = {
     /**
      * Date and time when the object was created compliant with the ISO 8601 standard.
@@ -5468,6 +5646,9 @@ type MetaData$1 = {
      */
     version?: number;
 };
+/**
+ * Metadata
+ */
 type UpdateMetaData = {
     /**
      * Object version.
@@ -5570,6 +5751,8 @@ type Overlay = {
     position: number;
 };
 /**
+ * Metadata
+ *
  * Metadata
  */
 type Metadata$6 = {
@@ -5640,6 +5823,9 @@ type Metadata$5 = {
      */
     version: number;
 };
+/**
+ * Country
+ */
 type Country$1 = {
     /**
      * The country code which consists of two capital letters and is compliant with ISO-3166-1 specification.
@@ -5661,6 +5847,9 @@ type Country$1 = {
     active?: boolean;
     metadata?: Metadata$5;
 };
+/**
+ * Region
+ */
 type Region$1 = {
     /**
      * The region code.
@@ -5674,6 +5863,9 @@ type Region$1 = {
     };
     metadata?: Metadata$5;
 };
+/**
+ * Country update
+ */
 type CountryUpdate$1 = {
     /**
      * The field indicates whether the given country is active for the tenant or not. Only active countries are visible in the system.
@@ -5747,6 +5939,8 @@ type UpdateMetadata$1 = {
     version: number;
 };
 /**
+ * currencyCreation
+ *
  * Represents a single currency creation. The currency consists of a code compliant with the ISO-4217 standard (https://www.iso.org/iso-4217-currency-codes.html) and a currency name. The `name` field is localized.
  */
 type CurrencyCreation = {
@@ -5765,6 +5959,8 @@ type CurrencyCreation = {
     };
 };
 /**
+ * currencyUpdate
+ *
  * Represents a single currency update.
  */
 type CurrencyUpdate$1 = {
@@ -5779,6 +5975,8 @@ type CurrencyUpdate$1 = {
     metadata: UpdateMetadata$1;
 };
 /**
+ * currencyCreationResponse
+ *
  * Represents the response after a successful currency creation.
  */
 type CurrencyCreationResponse = {
@@ -5789,6 +5987,8 @@ type CurrencyCreationResponse = {
     code?: string;
 };
 /**
+ * exchangeRateResponse
+ *
  * Represents the response after a successful exchange rate creation.
  */
 type ExchangeRateResponse = {
@@ -5799,6 +5999,8 @@ type ExchangeRateResponse = {
     code?: string;
 };
 /**
+ * currencyRetrieval
+ *
  * Represents a single currency. The currency consists of a code compliant with ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html) and a currency name. The name field is localized.
  */
 type CurrencyRetrieval = {
@@ -5818,6 +6020,9 @@ type CurrencyRetrieval = {
     };
     metadata?: Metadata$4;
 };
+/**
+ * exchangeRateUpdateRequest
+ */
 type ExchangeRateUpdateRequest = {
     /**
      * Represents the exchange rate.
@@ -5827,6 +6032,9 @@ type ExchangeRateUpdateRequest = {
     rate: string;
     metadata: UpdateMetadata$1;
 };
+/**
+ * exchangeRate
+ */
 type ExchangeRateCreationRequest = {
     /**
      * The source currency code. The currency symbol must consist of three capital letters and must be a valid ISO-4217 code (https://www.iso.org/iso-4217-currency-codes.html) defined in the system.
@@ -5843,6 +6051,9 @@ type ExchangeRateCreationRequest = {
      */
     rate: string;
 };
+/**
+ * exchangeRateRetrieval
+ */
 type ExchangeRateRetrieval = {
     /**
      * Identifier of the exchange rate. The identifier consists of the source currency and the target currency separated by an underscore.
@@ -5922,6 +6133,9 @@ declare class CurrencyService {
     deleteExchangeRate(code: string, auth?: AuthContext): Promise<void>;
 }
 
+/**
+ * Collection of actual delivery windows
+ */
 type ActualDeliveryWindows = Array<ActualDeliveryWindow>;
 type Patch = Array<{
     /**
@@ -5940,6 +6154,8 @@ type Patch = Array<{
     };
 }>;
 /**
+ * Actual delivery window
+ *
  * Delivery window is a range of times when the shipment can be delivered to the customers.
  */
 type ActualDeliveryWindow = {
@@ -5974,6 +6190,9 @@ type ActualDeliveryWindow = {
     slotId?: string;
     metadata?: MetaData;
 };
+/**
+ * Delivery Time
+ */
 type BasicDeliveryTime = {
     /**
      * Delivery Time ID: Autogenerated (if not provided in request) or User-Defined
@@ -6013,9 +6232,15 @@ type BasicDeliveryTime = {
      */
     deliveryDayShift?: number;
 };
+/**
+ * Delivery Time
+ */
 type DeliveryTime$2 = BasicDeliveryTime & {
     metadata?: MetaData;
 };
+/**
+ * Delivery Time
+ */
 type UpdateDeliveryTime = BasicDeliveryTime & {
     /**
      * metadata of the document
@@ -6027,6 +6252,9 @@ type UpdateDeliveryTime = BasicDeliveryTime & {
         version: number;
     };
 };
+/**
+ * Slot
+ */
 type SlotCreation = {
     /**
      * Delivery Time Slot ID: Autogenerated (if not provided in request) or User-Defined
@@ -6044,6 +6272,8 @@ type SlotCreation = {
     capacity: number;
 };
 /**
+ * Delivery Cycle
+ *
  * Object which encapsulates all the fields needed to generate delivery cycle.
  */
 type DeliveryCycle = {
@@ -6061,6 +6291,8 @@ type DeliveryCycle = {
     deliveryDate: string;
 };
 /**
+ * Delivery Day
+ *
  * This attribute holds the time configuration for which the Delivery Time is valid. Only a single attribute can be set at any given moment.
  */
 type DeliveryDay = {
@@ -6087,6 +6319,8 @@ type DeliveryDay = {
     };
 };
 /**
+ * Cut-Off Time
+ *
  * This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. This attribute is key in determining the end of a time window for certain operations and helps maintain efficiency in the delivery process.
  */
 type CutOffTIme = {
@@ -6104,6 +6338,8 @@ type CutOffTIme = {
     deliveryCycleName?: string;
 };
 /**
+ * Time range
+ *
  * A `from` to `to` time range for which the object is valid
  */
 type TimeRange = {
@@ -6117,6 +6353,8 @@ type TimeRange = {
     endTime: string;
 };
 /**
+ * Time range
+ *
  * A `from` to `to` time range for which the object is valid
  */
 type DeliveryTimeRange = {
@@ -6140,8 +6378,13 @@ type MetaData = {
     modifiedAt?: string;
     version?: number;
 };
+/**
+ * Collection of sites.
+ */
 type Sites = Array<Site>;
 /**
+ * Site
+ *
  * A site is a specific virtual or real shop.
  */
 type Site = {
@@ -6156,8 +6399,13 @@ type Site = {
     zones?: Array<ZoneWithActualDeliveryWindows>;
     metadata?: MetaData;
 };
+/**
+ * Collection of zones
+ */
 type Zones = Array<Zone$1>;
 /**
+ * Zone
+ *
  * The zone is an area where shipments can be delivered.
  */
 type Zone$1 = {
@@ -6177,6 +6425,8 @@ type ZoneWithActualDeliveryWindows = Zone$1 & {
     actualDeliveryWindows?: ActualDeliveryWindows;
 };
 /**
+ * Resource created
+ *
  * Link to created resource with unique resource identifier.
  */
 type ResourceCreatedResponse = {
@@ -6185,8 +6435,13 @@ type ResourceCreatedResponse = {
      */
     id?: string;
 };
+/**
+ * Collection of shipping methods
+ */
 type Methods = Array<Method>;
 /**
+ * Shipping method
+ *
  * Shipping methods define the types of deliveries and properties such as delivery fees.
  */
 type Method = {
@@ -6207,8 +6462,13 @@ type Method = {
      */
     shippingGroupId?: string;
 };
+/**
+ * Collection of fees
+ */
 type Fees = Array<Fee>;
 /**
+ * Fee
+ *
  * Fee is a shipping cost for a given shipping method and parameters.
  */
 type Fee = {
@@ -6220,6 +6480,8 @@ type Fee = {
     shippingGroupId?: string;
 };
 /**
+ * Monetary amount
+ *
  * Amount of money in a given currency.
  */
 type MonetaryAmount = {
@@ -6233,6 +6495,8 @@ type MonetaryAmount = {
     amount: number;
 };
 /**
+ * Find site request payload
+ *
  * Payload with parameters for price finding.
  */
 type FindSiteRequest = {
@@ -6246,10 +6510,14 @@ type FindSiteRequest = {
     country?: string;
 };
 /**
+ * ShipTo
+ *
  * Collection of shipping destinations
  */
 type ShipTo = Array<ShipToItem>;
 /**
+ * shipToItem
+ *
  * Shipping destination containing country and postal code.
  */
 type ShipToItem = {
@@ -6263,6 +6531,8 @@ type ShipToItem = {
     postalCode?: string;
 };
 /**
+ * Quote request payload
+ *
  * Example of payload for shipping cost calculation.
  */
 type QuotePayload = {
@@ -6287,6 +6557,8 @@ type QuotePayload = {
     shipToAddress: Address$2;
 };
 /**
+ * Quote slot request schema
+ *
  * Example of payload for shipping cost calculation.
  */
 type QuoteSlot = {
@@ -6319,6 +6591,8 @@ type QuoteSlot = {
     deliveryWindowId: string;
 };
 /**
+ * Address
+ *
  * Address of billing or delivery that contains customer or company name and location including street, street number, zipcode, and country.
  */
 type Address$2 = {
@@ -6337,10 +6611,14 @@ type Address$2 = {
     country: string;
 };
 /**
+ * Quote response
+ *
  * Example quote response which contains a list of fees for various methods and delivery zone.
  */
 type QuoteResponse$1 = Array<QuoteResponseItem>;
 /**
+ * Quote response item
+ *
  * Example quote response which contains fee for specific method and zone.
  */
 type QuoteResponseItem = {
@@ -6354,6 +6632,8 @@ type QuoteResponseItem = {
     methods?: Array<QuoteResponseMethods>;
 };
 /**
+ * Quote response shipping methods
+ *
  * Example quote response which contains fee for specific method.
  */
 type QuoteResponseMethods = {
@@ -6366,12 +6646,16 @@ type LocalizedValue = string | {
     [key: string]: string;
 };
 /**
+ * Minimum fee
+ *
  * Minimum available delivery fee for given parameters.
  */
 type MinimumFee$1 = {
     fee?: MonetaryAmount;
 };
 /**
+ * Group
+ *
  * Shipping groups can be used for customer grouping with use customer group relations.
  */
 type Group = {
@@ -6382,10 +6666,14 @@ type Group = {
     description?: LocalizedValue;
 };
 /**
+ * Collection of groups
+ *
  * Collection of shipping groups.
  */
 type GroupList = Array<Group>;
 /**
+ * Customer-group relation
+ *
  * Customer-group relation allows to assign user for specific group.
  */
 type CgRelation$1 = {
@@ -6398,7 +6686,13 @@ type CgRelation$1 = {
      */
     groupId?: string;
 };
+/**
+ * Collection of customer-group relation
+ */
 type CgRelationList$1 = Array<CgRelation$1>;
+/**
+ * DeliveryWindowValidationDto
+ */
 type DeliveryWindowValidationDto = {
     /**
      * The selected delivery window
@@ -7582,6 +7876,8 @@ type QuoteHistory$1 = Array<{
     modifiedAt?: string;
 }>;
 /**
+ * QuoteCreateFromCartRequest
+ *
  * This schema includes the attributes that are required to be provided when creating a quote from the cart.
  */
 type QuoteCreateFromCartRequest = {
@@ -7738,6 +8034,8 @@ type CalculatedFinalPrice = {
     finalPrice?: CalculatedPrice$1;
 };
 /**
+ * metadataCore
+ *
  * Core metadata fields shared across multiple objects.
  */
 type MetadataCore = {
@@ -7749,6 +8047,8 @@ type MetadataCore = {
     };
 };
 /**
+ * metadataUpdate
+ *
  * Metadata fields required when updating an existing object.
  */
 type MetadataUpdate$1 = MetadataCore & {
@@ -7758,6 +8058,8 @@ type MetadataUpdate$1 = MetadataCore & {
     version: number;
 };
 /**
+ * metadataResponse
+ *
  * Metadata fields returned by the API.
  * Extends `metadataUpdate` with timestamps indicating when the object
  * was created and last modified.
@@ -7774,6 +8076,8 @@ type MetadataResponse = MetadataUpdate$1 & {
     modifiedAt?: string;
 };
 /**
+ * basicReturn
+ *
  * Base schema for a return.
  */
 type BasicReturn = {
@@ -7804,6 +8108,8 @@ type BasicReturn = {
 };
 type BasicCustomerReturn = BasicReturn;
 /**
+ * A return request created on behalf of a customer.
+ *
  * Base schema for returns created by an employee FOR A REGISTERED CUSTOMER.
  */
 type BasicEmployeeReturn = BasicEmployeeReturnBase & {
@@ -7818,6 +8124,8 @@ type BasicEmployeeReturn = BasicEmployeeReturnBase & {
     };
 };
 /**
+ * A return request created on behalf of a customer FOR AN ANONYMOUS ORDER.
+ *
  * Base schema for returns created by an employee for an ANONYMOUS ORDER.
  */
 type EmployeeReturnForAnonymousOrder = BasicEmployeeReturnBase & {
@@ -7840,6 +8148,8 @@ type EmployeeReturnForAnonymousOrder = BasicEmployeeReturnBase & {
     };
 };
 /**
+ * Base schema for returns created by an employee.
+ *
  * Common structure for returns created by an employee on behalf of a customer.
  */
 type BasicEmployeeReturnBase = BasicReturn & {
@@ -7907,6 +8217,8 @@ type BasicEmployeeReturnBase = BasicReturn & {
     expiryDate?: string;
 };
 /**
+ * A return updated by a customer
+ *
  * Base schema for a return requested by a customer.
  */
 type UpdateCustomerReturn = {
@@ -7918,6 +8230,8 @@ type UpdateCustomerReturn = {
     metadata: MetadataUpdate$1;
 };
 /**
+ * A return updated on behalf of a customer.
+ *
  * Base schema for a return requested by an employee.
  */
 type UpdateEmployeeReturn = UpdateCustomerReturn & {
@@ -7976,6 +8290,8 @@ type UpdateEmployeeReturn = UpdateCustomerReturn & {
     expiryDate?: string;
 };
 /**
+ * A customer return object.
+ *
  * Schema for retrieving returns by a customer.
  */
 type FullCustomerReturn = BasicCustomerReturn & AssistedBuying & {
@@ -8001,6 +8317,8 @@ type FullCustomerReturn = BasicCustomerReturn & AssistedBuying & {
     calculatedPrice?: CalculatedFinalPrice;
 };
 /**
+ * A return object for an employee
+ *
  * Schema for retrieving returns by an employee.
  */
 type FullEmployeeReturn = FullCustomerReturn & {
@@ -8143,12 +8461,18 @@ type OrderItem = {
         details?: string;
     };
 };
+/**
+ * returnId
+ */
 type ReturnId = {
     /**
      * Unique identifier of the created return.
      */
     id?: string;
 };
+/**
+ * patchRequest
+ */
 type PatchOperation = {
     /**
      * Indicates an operation which should be done on a return. Available operations: `add` `remove` and `replace`
@@ -8165,6 +8489,9 @@ type PatchOperation = {
         [key: string]: unknown;
     } | string;
 };
+/**
+ * AssistedBuyingEntry
+ */
 type AssistedBuyingEntry = {
     /**
      * Identifier of an employee who performed an action on behalf of a customer.
@@ -8180,6 +8507,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 = {
@@ -8330,6 +8659,9 @@ type ReindexRequest = {
      */
     rag?: boolean;
 };
+/**
+ * IndexPublicConfiguration
+ */
 type IndexPublicConfiguration = {
     /**
      * API Key used for search purposes.
@@ -8352,6 +8684,9 @@ type IndexPublicConfiguration = {
      */
     active?: boolean;
 };
+/**
+ * IndexConfiguration
+ */
 type IndexConfiguration = IndexPublicConfiguration & {
     /**
      * API key used for write purposes.
@@ -8369,12 +8704,18 @@ type IndexConfiguration = IndexPublicConfiguration & {
      */
     includedMixinPaths?: Array<string>;
 };
+/**
+ * IndexCreationResponse
+ */
 type IndexCreationResponse = {
     /**
      * Identifier of a newly created configuration.
      */
     id?: string;
 };
+/**
+ * Reindex
+ */
 type Reindex = {
     /**
      * Indicates reindex mode. Supported modes: `FULL`.
@@ -8460,6 +8801,8 @@ declare class IndexingService {
 }
 
 /**
+ * Import configuration
+ *
  * An import configuration grouping one or more streams.
  */
 type ImportConfig$1 = {
@@ -8501,6 +8844,8 @@ type ImportConfig$1 = {
     updatedAt?: string;
 };
 /**
+ * Stream
+ *
  * A stream that extracts from a source, maps fields, and upserts into an Emporix target type.
  */
 type ImportStream$1 = {
@@ -8538,6 +8883,8 @@ type ImportStream$1 = {
     enabled?: boolean;
 };
 /**
+ * Schedule
+ *
  * A cron schedule for a configuration.
  */
 type Schedule = {
@@ -8567,6 +8914,8 @@ type Schedule = {
     nextFireAt?: string;
 };
 /**
+ * Run
+ *
  * An import run and its reconciled counters.
  */
 type ImportRun$1 = {
@@ -8632,6 +8981,8 @@ type ImportRun$1 = {
     message?: string;
 };
 /**
+ * Run stream progress
+ *
  * The per-stream progress within a run.
  */
 type ImportRunStream$1 = {
@@ -8685,6 +9036,8 @@ type ImportRunStream$1 = {
     message?: string;
 };
 /**
+ * Run detail
+ *
  * A run together with its per-stream progress.
  */
 type RunDetail = {
@@ -8695,6 +9048,8 @@ type RunDetail = {
     streams?: Array<ImportRunStream$1>;
 };
 /**
+ * Cancellation result
+ *
  * The outcome of a cancellation request.
  */
 type CancelResult = {
@@ -8712,6 +9067,8 @@ type CancelResult = {
     accepted?: boolean;
 };
 /**
+ * Error record
+ *
  * A single error recorded during a run.
  */
 type ErrorRecord = {
@@ -8753,6 +9110,8 @@ type ErrorRecord = {
     createdAt?: string;
 };
 /**
+ * Imported record
+ *
  * A record that was imported. Holds keys and outcome; for composite parents it also holds the embedded child arrays.
  */
 type ImportedRecord$1 = {
@@ -9260,8 +9619,8 @@ type Catalog$1 = {
      * Catalog's unique identifier, generated when the catalog is created.
      */
     id: string;
-    name?: _Object & unknown;
-    description?: _Object & unknown;
+    name?: Object$1 & unknown;
+    description?: Object$1 & unknown;
     status?: Status & unknown;
     visibility?: VisibilityInformation;
     /**
@@ -9282,8 +9641,8 @@ type CreateCatalog = {
      * Custom catalog identifier. If not provided, it is automatically generated.
      */
     id?: string;
-    name: _Object;
-    description?: _Object;
+    name: Object$1;
+    description?: Object$1;
     visibility?: VisibilityInformation;
     /**
      * List of site identifiers on which the catalog is published.
@@ -9323,7 +9682,7 @@ type Metadata$2 = {
 /**
  * Localized field that must be provided as a map of language codes to translations.
  */
-type _Object = string | {
+type Object$1 = string | {
     [key: string]: string;
 };
 /**
@@ -9334,8 +9693,8 @@ type Status = 'not_visible' | 'visible';
  * Payload for updating a catalog.
  */
 type UpdateCatalog = {
-    name: _Object;
-    description?: _Object;
+    name: Object$1;
+    description?: Object$1;
     visibility?: VisibilityInformation;
     /**
      * List of site identifiers on which the catalog is published.
@@ -9351,8 +9710,8 @@ type UpdateCatalog = {
  * Payload for partially updating a catalog.
  */
 type UpdateCatalogProperties = {
-    name?: _Object;
-    description?: _Object;
+    name?: Object$1;
+    description?: Object$1;
     visibility?: VisibilityInformation;
     /**
      * List of site identifiers on which the catalog is published.
@@ -9447,12 +9806,18 @@ type Metadata$1 = MetadataUpdate & {
      */
     modifiedAt?: string;
 };
+/**
+ * Resource
+ */
 type ResourceId = {
     /**
      * Id of a resource.
      */
     id?: string;
 };
+/**
+ * Vendor
+ */
 type Vendor$1 = {
     /**
      * The vendor unique identifier.
@@ -9487,6 +9852,9 @@ type Vendor$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * Vendor Legal Information
+ */
 type LegalInfo = {
     /**
      * The legal name of the vendor.
@@ -9505,6 +9873,9 @@ type LegalInfo = {
      */
     taxRegistrationNumber?: string;
 };
+/**
+ * Contact Details
+ */
 type VendorContactDetails = {
     /**
      * The list of contact emails.
@@ -9535,6 +9906,9 @@ type VendorContactDetails = {
      */
     countryCode?: string;
 };
+/**
+ * Vendor create payload
+ */
 type VendorCreate = {
     /**
      * Custom vendor identifier. If not provided, it is automatically generated.
@@ -9568,6 +9942,9 @@ type VendorCreate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Vendor update payload
+ */
 type VendorUpdate$1 = {
     /**
      * The name of the vendor.
@@ -9598,6 +9975,9 @@ type VendorUpdate$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location
+ */
 type Location$1 = {
     /**
      * The location unique identifier.
@@ -9620,6 +10000,9 @@ type Location$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location create payload
+ */
 type LocationCreate = {
     /**
      * Custom location identifier. If not provided, it is automatically generated.
@@ -9641,6 +10024,9 @@ type LocationCreate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location update payload
+ */
 type LocationUpdate = {
     /**
      * The name of the location.
@@ -9659,6 +10045,9 @@ type LocationUpdate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Contact Details
+ */
 type ContactDetails = {
     /**
      * The list of contact emails.
@@ -9879,6 +10268,9 @@ type PackagingProductsChange = {
      */
     packedCount: number;
 };
+/**
+ * Assignee
+ */
 type Assignee$1 = {
     /**
      * Identifier of an assignment
@@ -9897,6 +10289,9 @@ type Assignee$1 = {
      */
     lastName: string;
 };
+/**
+ * Order
+ */
 type Order = {
     /**
      * The id of the packed order
@@ -9950,6 +10345,9 @@ type Order = {
      */
     holdingAreaNumber?: number;
 };
+/**
+ * Entry
+ */
 type Entry = {
     /**
      * The entry id
@@ -10009,6 +10407,9 @@ type Entry = {
     basePrice?: BasePrice;
     mhd?: string;
 };
+/**
+ * Customer
+ */
 type Customer = {
     id?: string;
     title?: string;
@@ -10019,6 +10420,9 @@ type Customer = {
     email?: string;
     phoneNumber?: string;
 };
+/**
+ * Delivery
+ */
 type Delivery = {
     deliveryTimeModel?: DeliveryTime;
     deliveryAddressModel?: DeliveryAddress;
@@ -10026,15 +10430,24 @@ type Delivery = {
     deliveryOptionModel?: DeliveryOption;
     deliveryWindow?: DeliveryWindow$1;
 };
+/**
+ * Payment
+ */
 type Payment$1 = {
     invoiceNumber?: string;
     invoiceAddress?: InvoiceAddress;
     methods?: Array<string>;
 };
+/**
+ * PricingMeasure
+ */
 type PricingMeasure = {
     unitCode?: string;
     value?: string;
 };
+/**
+ * Location
+ */
 type Location = {
     zone?: string;
     rack?: string;
@@ -10043,6 +10456,9 @@ type Location = {
     section?: string;
     bin?: string;
 };
+/**
+ * BasePrice
+ */
 type BasePrice = {
     effectiveAmount?: string;
     originalAmount?: string;
@@ -10050,12 +10466,18 @@ type BasePrice = {
     basePriceFactor?: string;
     measurementUnit?: MeasurementUnit;
 };
+/**
+ * DeliveryTime
+ */
 type DeliveryTime = {
     deliveryDate?: string;
     deliveryTimeFrom?: string;
     deliveryTimeTo?: string;
     deliveryChargeType?: string;
 };
+/**
+ * DeliveryAddress
+ */
 type DeliveryAddress = {
     title?: string;
     contactName?: string;
@@ -10067,10 +10489,16 @@ type DeliveryAddress = {
     city?: string;
     country?: string;
 };
+/**
+ * DeliveryCost
+ */
 type DeliveryCost = {
     amount?: number;
     currency?: string;
 };
+/**
+ * DeliveryOption
+ */
 type DeliveryOption = {
     packaging?: string;
     replacement?: boolean;
@@ -10078,6 +10506,8 @@ type DeliveryOption = {
     deliveryNote?: string;
 };
 /**
+ * DeliveryWindow
+ *
  * 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
  */
 type DeliveryWindow$1 = {
@@ -10094,6 +10524,9 @@ type DeliveryWindow$1 = {
      */
     deliveryTimeTo?: string;
 };
+/**
+ * InvoiceAddress
+ */
 type InvoiceAddress = {
     title?: string;
     contactName?: string;
@@ -10105,11 +10538,17 @@ type InvoiceAddress = {
     city?: string;
     country?: string;
 };
+/**
+ * RecalculationJobOrder
+ */
 type RecalculationJobOrder = {
     orderId?: string;
     message?: string;
     jobOrderStatus?: 'SUCCESS' | 'FAILURE' | 'PENDING';
 };
+/**
+ * RecalculationJob
+ */
 type RecalculationJob$1 = {
     id?: string;
     jobType?: 'AUTOMATIC' | 'MANUAL';
@@ -10118,6 +10557,9 @@ type RecalculationJob$1 = {
     startedAt?: string;
     finishedAt?: string;
 };
+/**
+ * RecalculationJobCreation
+ */
 type RecalculationJobCreation = {
     /**
      * 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.
@@ -10130,6 +10572,9 @@ type RecalculationJobCreation = {
      */
     jobType: 'AUTOMATIC' | 'MANUAL';
 };
+/**
+ * MeasurementUnit
+ */
 type MeasurementUnit = {
     /**
      * The unit code of the measured quantity
@@ -10140,6 +10585,9 @@ type MeasurementUnit = {
      */
     quantity?: number;
 };
+/**
+ * OrderList
+ */
 type OrderList = {
     /**
      * The id of the order
@@ -10286,6 +10734,9 @@ type Address$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * AddressCommonDto
+ */
 type AddressCommonDto = {
     contactName?: string;
     companyName?: string;
@@ -10403,6 +10854,9 @@ type CustomerCreateDto = {
 type CustomerCommonDto = CustomerCreateDto & {
     metadata?: DefaultDtoMetadata;
 };
+/**
+ * CustomerForSellerDto
+ */
 type CustomerForSellerDto = CustomerCommonDto & {
     /**
      * Customer unique number generated when the customer profile is created.
@@ -10576,6 +11030,8 @@ type CustomerPatchBySellerDto = CustomerUpdateBySellerDto & {
     contactEmail?: string;
 };
 /**
+ * DefaultDtoMetadata
+ *
  * Links to mixin schemas.
  */
 type BasicMetadataDto = {
@@ -10583,10 +11039,15 @@ type BasicMetadataDto = {
         [key: string]: unknown;
     };
 };
+/**
+ * DefaultDtoMetadata
+ */
 type DefaultDtoMetadata = BasicMetadataDto & {
     version?: number;
 };
 /**
+ * Resource Location
+ *
  * Schema for showing location of the new resource.
  */
 type ResourceLocation = {
@@ -10770,6 +11231,8 @@ declare class CustomerAdminService {
 }
 
 /**
+ * basicApproval
+ *
  * Base schema for an approval.
  */
 type BasicApproval = GenericApprovalForCreate & {
@@ -10777,6 +11240,8 @@ type BasicApproval = GenericApprovalForCreate & {
     details?: Details;
 };
 /**
+ * basicApproval
+ *
  * Base schema for an approval creation.
  */
 type GenericApprovalForCreate = {
@@ -10796,6 +11261,8 @@ type GenericApprovalForCreate = {
     comment?: string;
 };
 /**
+ * additional information
+ *
  * Checkout details for **cart** approvals. **Required** when `resourceType` is `CART`.
  *
  */
@@ -10835,6 +11302,8 @@ type Address = {
     type?: 'SHIPPING' | 'BILLING';
 };
 /**
+ * Shipping information
+ *
  * Information about the shipping.
  */
 type Shipping = {
@@ -10860,6 +11329,8 @@ type Shipping = {
     shippingTaxCode?: string;
 };
 /**
+ * Payment information
+ *
  * Information about the payment.
  */
 type Payment = {
@@ -10903,6 +11374,9 @@ type PaymentMethod = {
      */
     amount?: number;
 };
+/**
+ * user schema
+ */
 type User = {
     /**
      * An identifier of the user.
@@ -10918,22 +11392,33 @@ type User = {
     lastName: string;
 };
 /**
+ * A type of a resource
+ *
  * Type of resource under approval.
  *
  */
 type ResourceType = 'CART' | 'QUOTE';
 /**
+ * An approval action
+ *
  * Base schema for an approval action type.
  */
 type ApprovalAction = 'CHECKOUT';
 /**
+ * A status of the approval
+ *
  * Base schema for the approval status.
  */
 type ApprovalStatus = 'PENDING' | 'APPROVED' | 'CLOSED' | 'EXPIRED' | 'DECLINED';
 /**
+ * An expiration date
+ *
  * 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`
  */
 type ExpiryDate = string;
+/**
+ * An approval response
+ */
 type GetApprovalResponse = BasicApproval & {
     /**
      * An identifier of the approval document.
@@ -10953,6 +11438,8 @@ type GetApprovalResponse = BasicApproval & {
     metadata?: Metadata;
 };
 /**
+ * Legal entity
+ *
  * Legal entity (company) the approval belongs to. Set when the approval is created from the customer token.
  *
  */
@@ -10963,6 +11450,8 @@ type LegalEntity = {
     id: string;
 };
 /**
+ * Created resource
+ *
  * Resource created when the approval flow completes and the approved action is executed. Present once the downstream system has created the linked entity; omitted until then.
  *
  * For checkout approvals (`action: CHECKOUT`), `id` is typically the order identifier (for example, from Order Service).
@@ -10975,6 +11464,8 @@ type CreatedResource = {
     id: string;
 };
 /**
+ * approval permitted response
+ *
  * Base schema for approval permitted response.
  */
 type ApprovalPermittedResponse = {
@@ -10990,6 +11481,8 @@ type ApprovalPermittedResponse = {
     approvalId?: string;
 };
 /**
+ * Resource
+ *
  * Resource of the approval.
  */
 type ResourceResponse = {
@@ -11008,6 +11501,8 @@ type ResourceResponse = {
     deliveryWindow?: DeliveryWindow;
 };
 /**
+ * Resource item
+ *
  * Item of the resource.
  */
 type ResourceItem = {
@@ -11018,6 +11513,7 @@ type ResourceItem = {
     itemPrice?: ResourceItemPrice;
     /**
      * YRN which identifies the product.
+     *
      * @deprecated
      */
     itemYrn?: string;
@@ -11027,6 +11523,8 @@ type ResourceItem = {
     itemId?: string;
 };
 /**
+ * Resource item price
+ *
  * Per-line price; used for resource line items.
  */
 type ResourceItemPrice = {
@@ -11036,6 +11534,7 @@ type ResourceItemPrice = {
     currency?: string;
     /**
      * Deprecated; prefer `unitPrice`, `newUnitPrice`, or `calculatedPrice`.
+     *
      * @deprecated
      */
     amount?: number;
@@ -11049,6 +11548,9 @@ type ResourceItemPrice = {
     newUnitPrice?: number;
     calculatedPrice?: CalculatedPrice;
 };
+/**
+ * Calculated price breakdown
+ */
 type CalculatedPrice = {
     price?: {
         /**
@@ -11066,6 +11568,8 @@ type CalculatedPrice = {
     };
 };
 /**
+ * Price value
+ *
  * Aggregated price (totals, subtotals) with currency and optional tax breakdown.
  */
 type Price = {
@@ -11075,6 +11579,7 @@ type Price = {
     currency?: string;
     /**
      * Deprecated; use `netValue`, `grossValue`, and `taxValue` when present.
+     *
      * @deprecated
      */
     amount?: number;
@@ -11092,6 +11597,8 @@ type Price = {
     taxValue?: number;
 };
 /**
+ * Taxable price value
+ *
  * Price value with the currency and tax information.
  */
 type TaxablePrice = {
@@ -11113,6 +11620,8 @@ type TaxablePrice = {
     taxValue?: number;
 };
 /**
+ * Delivery Window
+ *
  * delivery window required for order.
  */
 type DeliveryWindow = {
@@ -11129,6 +11638,9 @@ type DeliveryWindow = {
      */
     deliveryDate?: string;
 };
+/**
+ * Create a cart approval
+ */
 type CreateCartApprovalRequest = GenericApprovalForCreate & {
     /**
      * An identifier of the approval document.
@@ -11141,6 +11653,9 @@ type CreateCartApprovalRequest = GenericApprovalForCreate & {
     resourceType: 'CART';
     details: Details;
 };
+/**
+ * Create a quote approval
+ */
 type CreateQuoteApprovalRequest = GenericApprovalForCreate & {
     /**
      * An identifier of the approval document.
@@ -11180,12 +11695,18 @@ type Metadata = BasicMetadata & {
      */
     modifiedAt: string;
 };
+/**
+ * approvalId
+ */
 type ApprovalId = {
     /**
      * Unique identifier of the created approval.
      */
     id?: string;
 };
+/**
+ * approval permitted request
+ */
 type ApprovalPermittedRequest = {
     resourceType: ResourceType;
     /**
@@ -11194,6 +11715,9 @@ type ApprovalPermittedRequest = {
     resourceId: string;
     action: ApprovalAction;
 };
+/**
+ * Search approver users request
+ */
 type SearchUsersRequest = {
     resourceType: ResourceType;
     /**