@viu/emporix-sdk 2.35.0 → 2.36.1

package/dist/index.d.ts

@@ -21,14 +21,14 @@ export { Segment, SegmentAssignmentBulkResult, SegmentBulkItem, SegmentBulkResul
 import { CompaniesService } from './companies.js';
 import { ContactsService } from './contacts.js';
 import { LocationsService } from './locations.js';
-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-WSt4aT62.js';
+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-Cs6-Cwzg.js';
 import { OrdersService, SalesOrdersService } from './orders.js';
 export { GetOrderOptions, ListLegalEntityOrdersOptions, ListMyOrdersOptions, ListSalesOrdersOptions, Order, OrderEntry, OrderStatus, OrderTransitionOptions, SalesOrder, SalesOrderCalculationInput, SalesOrderCreateInput, SalesOrderCreated, SalesOrderEntriesInput, SalesOrderHistoricalTransitions, SalesOrderPatch, SalesOrderReplaceInput, SalesOrderSearchInput, SalesOrderSplitInput, SalesOrderSplitResult, Transition, UpdateSalesOrderOptions } from './orders.js';
 import { AvailabilityService } from './availability.js';
 export { Availability, AvailabilityBulkDeleteInput, AvailabilityBulkInput, AvailabilityBulkResult, AvailabilityCreated, AvailabilityInput, AvailabilityOptions } from './availability.js';
 import { a as QueryFor } from './query-mLQs2WFr.js';
 export { B as BuiltQuery, Q as QueryCapability, r as resolveQuery } from './query-mLQs2WFr.js';
-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.js';
+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.js';
 
 /** 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;
@@ -737,6 +777,9 @@ declare class IamService {
     };
 }
 
+/**
+ * BaseConfiguration
+ */
 type BaseConfiguration = {
     /**
      * Configuration key.
@@ -934,11 +977,13 @@ type MetadataFilter$1 = {
     key?: string;
     /**
      * Name of the field.
+     *
      * @deprecated
      */
     name?: string;
     /**
      * Description of the field.
+     *
      * @deprecated
      */
     description?: string;
@@ -1248,6 +1293,8 @@ type Fee$2 = {
     yrn?: Yrn;
 };
 /**
+ * Monetary Amount
+ *
  * Schema defining monetary amount in given currency.
  */
 type MonetaryAmount$1 = {
@@ -1261,6 +1308,8 @@ type MonetaryAmount$1 = {
     currency: string;
 };
 /**
+ * Timespan
+ *
  * Restricts the active fees to be only applied in the specified
  * timespan.
  */
@@ -1287,6 +1336,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 +1687,8 @@ type WebhookConfigCreation = WebhookConfigUpdate & {
     code: ConfigCode;
 };
 /**
+ * Webhook event
+ *
  * Events that you can subscribe to.
  */
 type WebhookEvent = {
@@ -1669,6 +1722,8 @@ type WebhookEvent = {
     };
 };
 /**
+ * Webhook subscription
+ *
  * Subscription per event.
  */
 type WebhookSubscription$1 = {
@@ -1684,6 +1739,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 +1763,8 @@ type WebhookSubscriptionUpdateItem$1 = {
     fieldsToSubscribe?: Array<string>;
 };
 /**
+ * Metadata
+ *
  * Auditing details.
  */
 type Metadata$8 = {
@@ -1723,6 +1782,8 @@ type Metadata$8 = {
     version?: number;
 };
 /**
+ * Metadata for update
+ *
  * Auditing details.
  */
 type MetadataForUpdate = {
@@ -1732,6 +1793,8 @@ type MetadataForUpdate = {
     version?: number;
 };
 /**
+ * Update subscription result response
+ *
  * Object containing the result of event subscription.
  */
 type UpdateSubscriptionResponse = {
@@ -1750,6 +1813,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 +1826,9 @@ type MonthStatistics = {
      */
     succesfullySentWebhooks?: number;
 };
+/**
+ * Webhooks limit statistics
+ */
 type WebhookStatistics$1 = {
     monthStatistics?: Array<MonthStatistics>;
     /**
@@ -2168,12 +2237,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 +2663,8 @@ type AgenticRequest = {
  */
 type AgentType = 'generic' | 'complaint' | 'anti_fraud';
 /**
+ * TextGenerationRequest
+ *
  * Represents a request body for a text generation operation.
  */
 type TextGenerationRequest = {
@@ -3004,10 +3069,7 @@ type McpServerConfigRequest = McpServerConfig & {
 type McpServerConfigResponse = McpServerConfig & {
     authorizationHeaderToken?: ExpandableTokenResponse;
 };
-/**
- * An object representing customer's own implementation of the MCP server.
- */
-type BaseMcpServer = {
+type BaseManagedMcpServer = {
     /**
      * Name of the MCP server.
      */
@@ -3018,14 +3080,160 @@ type BaseMcpServer = {
     enabled?: boolean;
     transport?: CustomMcpServerTransportType;
 };
-type McpServerRequest = BaseMcpServer & {
+/**
+ * Type of the managed MCP server resource. Possible values:
+ * * `custom`
+ * * `dynamic`
+ *
+ * **The `dynamic` value is in preview mode** - some of the features may not be fully operational yet.
+ */
+type ManagedMcpServerType = 'custom' | 'dynamic';
+/**
+ * HTTP method used to invoke the Automation function.
+ */
+type McpToolInvocationMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Location of the tool arguments in the HTTP request. Defaults to `body` when omitted.
+ */
+type McpToolInvocationArgsLocation = 'body' | 'query';
+type McpToolInvocationRequest = {
+    /**
+     * Identifier of the Automation function to invoke when the tool is called.
+     */
+    functionId: string;
+    method: McpToolInvocationMethod;
+    argsLocation?: McpToolInvocationArgsLocation;
+};
+type McpToolInvocationResponse = {
+    /**
+     * Identifier of the Automation function to invoke when the tool is called.
+     */
+    functionId?: string;
+    method?: McpToolInvocationMethod;
+    argsLocation?: McpToolInvocationArgsLocation;
+};
+type McpToolConfigRequest = {
+    /**
+     * OAuth scopes required to invoke the tool.
+     */
+    requiredScopes?: Array<string>;
+    /**
+     * JSON Schema document describing the tool input, provided as a JSON string.
+     */
+    inputSchema: string;
+    invocation: McpToolInvocationRequest;
+};
+type McpToolConfigResponse = {
+    /**
+     * OAuth scopes required to invoke the tool.
+     */
+    requiredScopes?: Array<string>;
+    /**
+     * JSON Schema document describing the tool input, provided as a JSON string.
+     */
+    inputSchema?: string;
+    invocation?: McpToolInvocationResponse;
+};
+/**
+ * Tool definition for a dynamic MCP server.
+ *
+ * **Dynamic MCP tools are in preview mode** - some of the features may not be fully operational yet.
+ */
+type McpToolRequest = {
+    /**
+     * Unique name of the tool. Must not contain whitespace characters.
+     */
+    name: string;
+    /**
+     * Human-readable description of the tool.
+     */
+    description?: string;
+    /**
+     * Prompt that defines when and why the agent should call this tool.
+     */
+    prompt: string;
+    /**
+     * An indicator whether the tool is enabled.
+     */
+    enabled?: boolean;
+    config: McpToolConfigRequest;
+};
+/**
+ * Tool definition for a dynamic MCP server.
+ *
+ * **Dynamic MCP tools are in preview mode** - some of the features may not be fully operational yet.
+ */
+type McpToolResponse = {
+    /**
+     * Unique name of the tool.
+     */
+    name?: string;
+    /**
+     * Human-readable description of the tool.
+     */
+    description?: string;
+    /**
+     * Prompt that defines when and why the agent should call this tool.
+     */
+    prompt?: string;
+    /**
+     * An indicator whether the tool is enabled.
+     */
+    enabled?: boolean;
+    config?: McpToolConfigResponse;
+};
+type CustomMcpServerRequest = BaseManagedMcpServer & {
+    /**
+     * For custom MCP servers it has to be set to `custom` or omitted. Defaults to `custom`.
+     */
+    type?: ManagedMcpServerType;
     config: McpServerConfigRequest;
     metadata?: MetadataRequest;
 };
-type McpServerResponse = BaseMcpServer & {
+type DynamicMcpServerRequest = BaseManagedMcpServer & {
+    /**
+     * For dynamic MCP servers it has to be set to `dynamic`.
+     */
+    type: ManagedMcpServerType;
+    /**
+     * List of tools exposed by this MCP server.
+     *
+     * **The `tools` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    tools: Array<McpToolRequest>;
+    metadata?: MetadataRequest;
+};
+type McpServerRequest = CustomMcpServerRequest | DynamicMcpServerRequest;
+type CustomMcpServerResponse = BaseManagedMcpServer & {
+    /**
+     * Unique identifier of the MCP server.
+     */
+    id?: string;
+    /**
+     * Type of the managed MCP server resource.
+     */
+    type?: ManagedMcpServerType;
     config?: McpServerConfigResponse;
     metadata?: MetadataResponse$1;
 };
+type DynamicMcpServerResponse = BaseManagedMcpServer & {
+    /**
+     * Unique identifier of the MCP server.
+     */
+    id?: string;
+    /**
+     * For dynamic MCP servers it has to be set to `dynamic`.
+     */
+    type?: ManagedMcpServerType;
+    /**
+     * List of tools exposed by this MCP server.
+     *
+     * **The `tools` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    tools?: Array<McpToolResponse>;
+    metadata?: MetadataResponse$1;
+};
+type McpServerResponse = CustomMcpServerResponse | DynamicMcpServerResponse;
 type CommerceEventsResponse = {
     /**
      * List of events available to use by an agent with the `COMMERCE_EVENTS` trigger.
@@ -3033,9 +3241,9 @@ type CommerceEventsResponse = {
     events?: Array<string>;
 };
 /**
- * Type of the MCP server. The `custom` type allows you to integrate with your own MCP server instance, while the `predefined` type allows you to integrate with one of the instances provided by Emporix.
+ * Type of the MCP server attachment on an agent. The `custom` type references a tenant-managed MCP server with a URL. The `predefined` type references an Emporix domain MCP server. The `dynamic` type references a tenant-managed dynamic MCP server and may include an optional tool-name allow-list.
  */
-type McpServerType = 'custom' | 'predefined';
+type McpServerType = 'custom' | 'predefined' | 'dynamic';
 /**
  * Type of the communication between the agent and the MCP server. The `streamable_http` protocol is recommended, since the `sse` protocol is deprecated.
  */
@@ -3066,17 +3274,42 @@ type CustomAgentMcpServerRequest = BaseAgentMcpServer & {
         id: string;
     };
 };
-type CustomAgentMcpServerResponse = CustomAgentMcpServerRequest & {
+type DynamicAgentMcpServerRequest = BaseAgentMcpServer & {
+    /**
+     * For a dynamic MCP server attachment it has to be set to `dynamic`.
+     */
+    type?: unknown;
+    mcpServer: {
+        /**
+         * ID of the dynamic MCP server.
+         */
+        id: string;
+    };
+    /**
+     * Optional allow-list of tool names from the dynamic MCP server.
+     */
+    tools?: Array<string>;
+};
+type AgentMcpServerResponse = {
+    type: McpServerType;
     mcpServer?: McpServerResponse & unknown;
+    /**
+     * Present for `predefined` attachments.
+     */
+    domain?: 'customer' | 'extensibility' | 'order' | 'product' | 'frontend';
+    /**
+     * Tool-name allow-list. Present for `predefined` attachments and for `dynamic` attachments when a subset is configured. Omitted on `dynamic` means all enabled tools on the MCP server.
+     */
+    tools?: Array<string>;
 };
 /**
  * List of MCP servers which agents should have access to.
  */
-type AgentMcpServersRequest = Array<CustomAgentMcpServerRequest | PredefinedAgentMcpServer>;
+type AgentMcpServersRequest = Array<CustomAgentMcpServerRequest | DynamicAgentMcpServerRequest | PredefinedAgentMcpServer>;
 /**
  * List of MCP servers which agents should have access to.
  */
-type AgentMcpServersResponse = Array<CustomAgentMcpServerResponse | PredefinedAgentMcpServer>;
+type AgentMcpServersResponse = Array<AgentMcpServerResponse>;
 type BaseLlm = {
     /**
      * The exact name of the model.
@@ -3637,6 +3870,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.
@@ -3644,7 +3880,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';
         /**
@@ -4198,6 +4434,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 = {
@@ -4208,6 +4446,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 = {
@@ -4220,6 +4460,8 @@ type TaxRetrieval = {
     metadata?: Metadata$7;
 };
 /**
+ * taxClass
+ *
  * Single tax class.
  */
 type TaxClass = {
@@ -4266,6 +4508,9 @@ type TaxClass = {
      */
     isDefault?: boolean;
 };
+/**
+ * taxCreationResponse
+ */
 type TaxCreationResponse = {
     /**
      * Code of country for which the tax configuration has been created.
@@ -4389,6 +4634,9 @@ type Location$2 = {
      */
     countryCode: string;
 };
+/**
+ * taxUpdate
+ */
 type TaxUpdate = TaxCreation & {
     metadata: Metadata$7;
 };
@@ -4455,6 +4703,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 = {
@@ -4551,6 +4801,8 @@ type Coupon$2 = BaseCoupon & {
     deleted?: boolean;
 };
 /**
+ * Coupon creation payload
+ *
  * Coupon creation schema.
  */
 type CouponCreation = {
@@ -4632,6 +4884,8 @@ type SegmentRestricted = boolean;
  */
 type CategoryRestricted = boolean;
 /**
+ * Money amount
+ *
  * Defines an amount in a specific currency.
  */
 type CurrencyAmount = {
@@ -4645,6 +4899,8 @@ type CurrencyAmount = {
     currency?: string;
 };
 /**
+ * Coupon Redemption
+ *
  * Defines a coupon redemption response.
  */
 type Redemption = RedemptionCreation & {
@@ -4658,6 +4914,8 @@ type Redemption = RedemptionCreation & {
     redeemedAt?: string;
 };
 /**
+ * Coupon Redemption Request
+ *
  * Defines a coupon redemption request payload that affects a coupon instance.
  */
 type RedemptionCreation = {
@@ -4728,6 +4986,8 @@ type CouponWithIdAndStatus = Coupon$2 & {
     status?: 'VALID' | 'INACTIVE' | 'EXPIRED' | 'USED';
 };
 /**
+ * Coupon
+ *
  * Coupons describe voucher alike commerce capabilities.
  */
 type ReferralCoupon = {
@@ -4890,7 +5150,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
@@ -4902,6 +5168,9 @@ type PointsSummaryOut = {
     activePoints?: number;
     summary?: CustomerSummary;
 };
+/**
+ * addedPoints
+ */
 type AddedPoints = {
     id?: string;
     /**
@@ -4931,6 +5200,9 @@ type AddedPoints = {
     usedPoints?: number;
     usedWith?: Array<string>;
 };
+/**
+ * redeemedPoints
+ */
 type RedeemedPoints = {
     /**
      * Identifier of the redeemed points
@@ -4953,11 +5225,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
@@ -4996,6 +5277,9 @@ type RedeemOption = {
         modifiedAt?: string;
     };
 };
+/**
+ * CouponCode
+ */
 type RedeemCouponOut = {
     /**
      * Coupon code received after exchanging points
@@ -5003,6 +5287,8 @@ type RedeemCouponOut = {
     code?: string;
 };
 /**
+ * Coupon API
+ *
  * Coupons describe voucher-like commerce capabilities.
  */
 type Coupon = {
@@ -5027,6 +5313,8 @@ type Coupon = {
      */
     discountPercentage?: number;
     /**
+     * Money Amount
+     *
      * Must be specified only if type is 'ABSOLUTE'
      */
     discountAbsolute?: {
@@ -5094,6 +5382,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.
@@ -5108,6 +5399,8 @@ type Restrictions = {
      */
     validUntil?: string;
     /**
+     * Money Amount
+     *
      * Minimum order value which entitles the customer to redeem the coupon
      */
     minOrderValue?: {
@@ -5197,7 +5490,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.
@@ -5224,6 +5523,9 @@ type Brand$1 = {
         [key: string]: string;
     };
 };
+/**
+ * Brand
+ */
 type UpdateBrand = {
     /**
      * Brand name.
@@ -5247,6 +5549,9 @@ type UpdateBrand = {
     };
     metadata?: UpdateMetaData;
 };
+/**
+ * Brand Response
+ */
 type BrandResponse = {
     /**
      * Brand name.
@@ -5286,6 +5591,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.
@@ -5300,6 +5608,9 @@ type MetaData$1 = {
      */
     version?: number;
 };
+/**
+ * Metadata
+ */
 type UpdateMetaData = {
     /**
      * Object version.
@@ -5402,6 +5713,8 @@ type Overlay = {
     position: number;
 };
 /**
+ * Metadata
+ *
  * Metadata
  */
 type Metadata$6 = {
@@ -5472,6 +5785,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.
@@ -5493,6 +5809,9 @@ type Country$1 = {
     active?: boolean;
     metadata?: Metadata$5;
 };
+/**
+ * Region
+ */
 type Region$1 = {
     /**
      * The region code.
@@ -5506,6 +5825,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.
@@ -5579,6 +5901,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 = {
@@ -5597,6 +5921,8 @@ type CurrencyCreation = {
     };
 };
 /**
+ * currencyUpdate
+ *
  * Represents a single currency update.
  */
 type CurrencyUpdate$1 = {
@@ -5611,6 +5937,8 @@ type CurrencyUpdate$1 = {
     metadata: UpdateMetadata$1;
 };
 /**
+ * currencyCreationResponse
+ *
  * Represents the response after a successful currency creation.
  */
 type CurrencyCreationResponse = {
@@ -5621,6 +5949,8 @@ type CurrencyCreationResponse = {
     code?: string;
 };
 /**
+ * exchangeRateResponse
+ *
  * Represents the response after a successful exchange rate creation.
  */
 type ExchangeRateResponse = {
@@ -5631,6 +5961,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 = {
@@ -5650,6 +5982,9 @@ type CurrencyRetrieval = {
     };
     metadata?: Metadata$4;
 };
+/**
+ * exchangeRateUpdateRequest
+ */
 type ExchangeRateUpdateRequest = {
     /**
      * Represents the exchange rate.
@@ -5659,6 +5994,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.
@@ -5675,6 +6013,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.
@@ -5754,6 +6095,9 @@ declare class CurrencyService {
     deleteExchangeRate(code: string, auth?: AuthContext): Promise<void>;
 }
 
+/**
+ * Collection of actual delivery windows
+ */
 type ActualDeliveryWindows = Array<ActualDeliveryWindow>;
 type Patch = Array<{
     /**
@@ -5772,6 +6116,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 = {
@@ -5806,6 +6152,9 @@ type ActualDeliveryWindow = {
     slotId?: string;
     metadata?: MetaData;
 };
+/**
+ * Delivery Time
+ */
 type BasicDeliveryTime = {
     /**
      * Delivery Time ID: Autogenerated (if not provided in request) or User-Defined
@@ -5845,9 +6194,15 @@ type BasicDeliveryTime = {
      */
     deliveryDayShift?: number;
 };
+/**
+ * Delivery Time
+ */
 type DeliveryTime$2 = BasicDeliveryTime & {
     metadata?: MetaData;
 };
+/**
+ * Delivery Time
+ */
 type UpdateDeliveryTime = BasicDeliveryTime & {
     /**
      * metadata of the document
@@ -5859,6 +6214,9 @@ type UpdateDeliveryTime = BasicDeliveryTime & {
         version: number;
     };
 };
+/**
+ * Slot
+ */
 type SlotCreation = {
     /**
      * Delivery Time Slot ID: Autogenerated (if not provided in request) or User-Defined
@@ -5876,6 +6234,8 @@ type SlotCreation = {
     capacity: number;
 };
 /**
+ * Delivery Cycle
+ *
  * Object which encapsulates all the fields needed to generate delivery cycle.
  */
 type DeliveryCycle = {
@@ -5893,6 +6253,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 = {
@@ -5919,6 +6281,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 = {
@@ -5936,6 +6300,8 @@ type CutOffTIme = {
     deliveryCycleName?: string;
 };
 /**
+ * Time range
+ *
  * A `from` to `to` time range for which the object is valid
  */
 type TimeRange = {
@@ -5949,6 +6315,8 @@ type TimeRange = {
     endTime: string;
 };
 /**
+ * Time range
+ *
  * A `from` to `to` time range for which the object is valid
  */
 type DeliveryTimeRange = {
@@ -5972,8 +6340,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 = {
@@ -5988,8 +6361,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 = {
@@ -6009,6 +6387,8 @@ type ZoneWithActualDeliveryWindows = Zone$1 & {
     actualDeliveryWindows?: ActualDeliveryWindows;
 };
 /**
+ * Resource created
+ *
  * Link to created resource with unique resource identifier.
  */
 type ResourceCreatedResponse = {
@@ -6017,8 +6397,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 = {
@@ -6039,8 +6424,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 = {
@@ -6052,6 +6442,8 @@ type Fee = {
     shippingGroupId?: string;
 };
 /**
+ * Monetary amount
+ *
  * Amount of money in a given currency.
  */
 type MonetaryAmount = {
@@ -6065,6 +6457,8 @@ type MonetaryAmount = {
     amount: number;
 };
 /**
+ * Find site request payload
+ *
  * Payload with parameters for price finding.
  */
 type FindSiteRequest = {
@@ -6078,10 +6472,14 @@ type FindSiteRequest = {
     country?: string;
 };
 /**
+ * ShipTo
+ *
  * Collection of shipping destinations
  */
 type ShipTo = Array<ShipToItem>;
 /**
+ * shipToItem
+ *
  * Shipping destination containing country and postal code.
  */
 type ShipToItem = {
@@ -6095,6 +6493,8 @@ type ShipToItem = {
     postalCode?: string;
 };
 /**
+ * Quote request payload
+ *
  * Example of payload for shipping cost calculation.
  */
 type QuotePayload = {
@@ -6119,6 +6519,8 @@ type QuotePayload = {
     shipToAddress: Address$2;
 };
 /**
+ * Quote slot request schema
+ *
  * Example of payload for shipping cost calculation.
  */
 type QuoteSlot = {
@@ -6151,6 +6553,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 = {
@@ -6169,10 +6573,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 = {
@@ -6186,6 +6594,8 @@ type QuoteResponseItem = {
     methods?: Array<QuoteResponseMethods>;
 };
 /**
+ * Quote response shipping methods
+ *
  * Example quote response which contains fee for specific method.
  */
 type QuoteResponseMethods = {
@@ -6198,12 +6608,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 = {
@@ -6214,10 +6628,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 = {
@@ -6230,7 +6648,13 @@ type CgRelation$1 = {
      */
     groupId?: string;
 };
+/**
+ * Collection of customer-group relation
+ */
 type CgRelationList$1 = Array<CgRelation$1>;
+/**
+ * DeliveryWindowValidationDto
+ */
 type DeliveryWindowValidationDto = {
     /**
      * The selected delivery window
@@ -7414,6 +7838,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 = {
@@ -7570,6 +7996,8 @@ type CalculatedFinalPrice = {
     finalPrice?: CalculatedPrice$1;
 };
 /**
+ * metadataCore
+ *
  * Core metadata fields shared across multiple objects.
  */
 type MetadataCore = {
@@ -7581,6 +8009,8 @@ type MetadataCore = {
     };
 };
 /**
+ * metadataUpdate
+ *
  * Metadata fields required when updating an existing object.
  */
 type MetadataUpdate$1 = MetadataCore & {
@@ -7590,6 +8020,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.
@@ -7606,6 +8038,8 @@ type MetadataResponse = MetadataUpdate$1 & {
     modifiedAt?: string;
 };
 /**
+ * basicReturn
+ *
  * Base schema for a return.
  */
 type BasicReturn = {
@@ -7636,6 +8070,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 & {
@@ -7650,6 +8086,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 & {
@@ -7672,6 +8110,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 & {
@@ -7739,6 +8179,8 @@ type BasicEmployeeReturnBase = BasicReturn & {
     expiryDate?: string;
 };
 /**
+ * A return updated by a customer
+ *
  * Base schema for a return requested by a customer.
  */
 type UpdateCustomerReturn = {
@@ -7750,6 +8192,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 & {
@@ -7808,6 +8252,8 @@ type UpdateEmployeeReturn = UpdateCustomerReturn & {
     expiryDate?: string;
 };
 /**
+ * A customer return object.
+ *
  * Schema for retrieving returns by a customer.
  */
 type FullCustomerReturn = BasicCustomerReturn & AssistedBuying & {
@@ -7833,6 +8279,8 @@ type FullCustomerReturn = BasicCustomerReturn & AssistedBuying & {
     calculatedPrice?: CalculatedFinalPrice;
 };
 /**
+ * A return object for an employee
+ *
  * Schema for retrieving returns by an employee.
  */
 type FullEmployeeReturn = FullCustomerReturn & {
@@ -7975,12 +8423,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`
@@ -7997,6 +8451,9 @@ type PatchOperation = {
         [key: string]: unknown;
     } | string;
 };
+/**
+ * AssistedBuyingEntry
+ */
 type AssistedBuyingEntry = {
     /**
      * Identifier of an employee who performed an action on behalf of a customer.
@@ -8012,6 +8469,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 = {
@@ -8162,6 +8621,9 @@ type ReindexRequest = {
      */
     rag?: boolean;
 };
+/**
+ * IndexPublicConfiguration
+ */
 type IndexPublicConfiguration = {
     /**
      * API Key used for search purposes.
@@ -8184,6 +8646,9 @@ type IndexPublicConfiguration = {
      */
     active?: boolean;
 };
+/**
+ * IndexConfiguration
+ */
 type IndexConfiguration = IndexPublicConfiguration & {
     /**
      * API key used for write purposes.
@@ -8201,12 +8666,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`.
@@ -8292,6 +8763,8 @@ declare class IndexingService {
 }
 
 /**
+ * Import configuration
+ *
  * An import configuration grouping one or more streams.
  */
 type ImportConfig$1 = {
@@ -8333,6 +8806,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 = {
@@ -8370,6 +8845,8 @@ type ImportStream$1 = {
     enabled?: boolean;
 };
 /**
+ * Schedule
+ *
  * A cron schedule for a configuration.
  */
 type Schedule = {
@@ -8399,6 +8876,8 @@ type Schedule = {
     nextFireAt?: string;
 };
 /**
+ * Run
+ *
  * An import run and its reconciled counters.
  */
 type ImportRun$1 = {
@@ -8464,6 +8943,8 @@ type ImportRun$1 = {
     message?: string;
 };
 /**
+ * Run stream progress
+ *
  * The per-stream progress within a run.
  */
 type ImportRunStream$1 = {
@@ -8517,6 +8998,8 @@ type ImportRunStream$1 = {
     message?: string;
 };
 /**
+ * Run detail
+ *
  * A run together with its per-stream progress.
  */
 type RunDetail = {
@@ -8527,6 +9010,8 @@ type RunDetail = {
     streams?: Array<ImportRunStream$1>;
 };
 /**
+ * Cancellation result
+ *
  * The outcome of a cancellation request.
  */
 type CancelResult = {
@@ -8544,6 +9029,8 @@ type CancelResult = {
     accepted?: boolean;
 };
 /**
+ * Error record
+ *
  * A single error recorded during a run.
  */
 type ErrorRecord = {
@@ -8585,6 +9072,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 = {
@@ -9092,8 +9581,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;
     /**
@@ -9114,8 +9603,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.
@@ -9155,7 +9644,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;
 };
 /**
@@ -9166,8 +9655,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.
@@ -9183,8 +9672,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.
@@ -9279,12 +9768,18 @@ type Metadata$1 = MetadataUpdate & {
      */
     modifiedAt?: string;
 };
+/**
+ * Resource
+ */
 type ResourceId = {
     /**
      * Id of a resource.
      */
     id?: string;
 };
+/**
+ * Vendor
+ */
 type Vendor$1 = {
     /**
      * The vendor unique identifier.
@@ -9319,6 +9814,9 @@ type Vendor$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * Vendor Legal Information
+ */
 type LegalInfo = {
     /**
      * The legal name of the vendor.
@@ -9337,6 +9835,9 @@ type LegalInfo = {
      */
     taxRegistrationNumber?: string;
 };
+/**
+ * Contact Details
+ */
 type VendorContactDetails = {
     /**
      * The list of contact emails.
@@ -9367,6 +9868,9 @@ type VendorContactDetails = {
      */
     countryCode?: string;
 };
+/**
+ * Vendor create payload
+ */
 type VendorCreate = {
     /**
      * Custom vendor identifier. If not provided, it is automatically generated.
@@ -9400,6 +9904,9 @@ type VendorCreate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Vendor update payload
+ */
 type VendorUpdate$1 = {
     /**
      * The name of the vendor.
@@ -9430,6 +9937,9 @@ type VendorUpdate$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location
+ */
 type Location$1 = {
     /**
      * The location unique identifier.
@@ -9452,6 +9962,9 @@ type Location$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location create payload
+ */
 type LocationCreate = {
     /**
      * Custom location identifier. If not provided, it is automatically generated.
@@ -9473,6 +9986,9 @@ type LocationCreate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Location update payload
+ */
 type LocationUpdate = {
     /**
      * The name of the location.
@@ -9491,6 +10007,9 @@ type LocationUpdate = {
         [key: string]: unknown;
     };
 };
+/**
+ * Contact Details
+ */
 type ContactDetails = {
     /**
      * The list of contact emails.
@@ -9711,6 +10230,9 @@ type PackagingProductsChange = {
      */
     packedCount: number;
 };
+/**
+ * Assignee
+ */
 type Assignee$1 = {
     /**
      * Identifier of an assignment
@@ -9729,6 +10251,9 @@ type Assignee$1 = {
      */
     lastName: string;
 };
+/**
+ * Order
+ */
 type Order = {
     /**
      * The id of the packed order
@@ -9782,6 +10307,9 @@ type Order = {
      */
     holdingAreaNumber?: number;
 };
+/**
+ * Entry
+ */
 type Entry = {
     /**
      * The entry id
@@ -9841,6 +10369,9 @@ type Entry = {
     basePrice?: BasePrice;
     mhd?: string;
 };
+/**
+ * Customer
+ */
 type Customer = {
     id?: string;
     title?: string;
@@ -9851,6 +10382,9 @@ type Customer = {
     email?: string;
     phoneNumber?: string;
 };
+/**
+ * Delivery
+ */
 type Delivery = {
     deliveryTimeModel?: DeliveryTime;
     deliveryAddressModel?: DeliveryAddress;
@@ -9858,15 +10392,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;
@@ -9875,6 +10418,9 @@ type Location = {
     section?: string;
     bin?: string;
 };
+/**
+ * BasePrice
+ */
 type BasePrice = {
     effectiveAmount?: string;
     originalAmount?: string;
@@ -9882,12 +10428,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;
@@ -9899,10 +10451,16 @@ type DeliveryAddress = {
     city?: string;
     country?: string;
 };
+/**
+ * DeliveryCost
+ */
 type DeliveryCost = {
     amount?: number;
     currency?: string;
 };
+/**
+ * DeliveryOption
+ */
 type DeliveryOption = {
     packaging?: string;
     replacement?: boolean;
@@ -9910,6 +10468,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 = {
@@ -9926,6 +10486,9 @@ type DeliveryWindow$1 = {
      */
     deliveryTimeTo?: string;
 };
+/**
+ * InvoiceAddress
+ */
 type InvoiceAddress = {
     title?: string;
     contactName?: string;
@@ -9937,11 +10500,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';
@@ -9950,6 +10519,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.
@@ -9962,6 +10534,9 @@ type RecalculationJobCreation = {
      */
     jobType: 'AUTOMATIC' | 'MANUAL';
 };
+/**
+ * MeasurementUnit
+ */
 type MeasurementUnit = {
     /**
      * The unit code of the measured quantity
@@ -9972,6 +10547,9 @@ type MeasurementUnit = {
      */
     quantity?: number;
 };
+/**
+ * OrderList
+ */
 type OrderList = {
     /**
      * The id of the order
@@ -10118,6 +10696,9 @@ type Address$1 = {
         [key: string]: unknown;
     };
 };
+/**
+ * AddressCommonDto
+ */
 type AddressCommonDto = {
     contactName?: string;
     companyName?: string;
@@ -10235,6 +10816,9 @@ type CustomerCreateDto = {
 type CustomerCommonDto = CustomerCreateDto & {
     metadata?: DefaultDtoMetadata;
 };
+/**
+ * CustomerForSellerDto
+ */
 type CustomerForSellerDto = CustomerCommonDto & {
     /**
      * Customer unique number generated when the customer profile is created.
@@ -10408,6 +10992,8 @@ type CustomerPatchBySellerDto = CustomerUpdateBySellerDto & {
     contactEmail?: string;
 };
 /**
+ * DefaultDtoMetadata
+ *
  * Links to mixin schemas.
  */
 type BasicMetadataDto = {
@@ -10415,10 +11001,15 @@ type BasicMetadataDto = {
         [key: string]: unknown;
     };
 };
+/**
+ * DefaultDtoMetadata
+ */
 type DefaultDtoMetadata = BasicMetadataDto & {
     version?: number;
 };
 /**
+ * Resource Location
+ *
  * Schema for showing location of the new resource.
  */
 type ResourceLocation = {
@@ -10602,6 +11193,8 @@ declare class CustomerAdminService {
 }
 
 /**
+ * basicApproval
+ *
  * Base schema for an approval.
  */
 type BasicApproval = GenericApprovalForCreate & {
@@ -10609,6 +11202,8 @@ type BasicApproval = GenericApprovalForCreate & {
     details?: Details;
 };
 /**
+ * basicApproval
+ *
  * Base schema for an approval creation.
  */
 type GenericApprovalForCreate = {
@@ -10628,6 +11223,8 @@ type GenericApprovalForCreate = {
     comment?: string;
 };
 /**
+ * additional information
+ *
  * Checkout details for **cart** approvals. **Required** when `resourceType` is `CART`.
  *
  */
@@ -10667,6 +11264,8 @@ type Address = {
     type?: 'SHIPPING' | 'BILLING';
 };
 /**
+ * Shipping information
+ *
  * Information about the shipping.
  */
 type Shipping = {
@@ -10692,6 +11291,8 @@ type Shipping = {
     shippingTaxCode?: string;
 };
 /**
+ * Payment information
+ *
  * Information about the payment.
  */
 type Payment = {
@@ -10735,6 +11336,9 @@ type PaymentMethod = {
      */
     amount?: number;
 };
+/**
+ * user schema
+ */
 type User = {
     /**
      * An identifier of the user.
@@ -10750,22 +11354,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.
@@ -10785,6 +11400,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.
  *
  */
@@ -10795,6 +11412,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).
@@ -10807,6 +11426,8 @@ type CreatedResource = {
     id: string;
 };
 /**
+ * approval permitted response
+ *
  * Base schema for approval permitted response.
  */
 type ApprovalPermittedResponse = {
@@ -10822,6 +11443,8 @@ type ApprovalPermittedResponse = {
     approvalId?: string;
 };
 /**
+ * Resource
+ *
  * Resource of the approval.
  */
 type ResourceResponse = {
@@ -10840,6 +11463,8 @@ type ResourceResponse = {
     deliveryWindow?: DeliveryWindow;
 };
 /**
+ * Resource item
+ *
  * Item of the resource.
  */
 type ResourceItem = {
@@ -10850,6 +11475,7 @@ type ResourceItem = {
     itemPrice?: ResourceItemPrice;
     /**
      * YRN which identifies the product.
+     *
      * @deprecated
      */
     itemYrn?: string;
@@ -10859,6 +11485,8 @@ type ResourceItem = {
     itemId?: string;
 };
 /**
+ * Resource item price
+ *
  * Per-line price; used for resource line items.
  */
 type ResourceItemPrice = {
@@ -10868,6 +11496,7 @@ type ResourceItemPrice = {
     currency?: string;
     /**
      * Deprecated; prefer `unitPrice`, `newUnitPrice`, or `calculatedPrice`.
+     *
      * @deprecated
      */
     amount?: number;
@@ -10881,6 +11510,9 @@ type ResourceItemPrice = {
     newUnitPrice?: number;
     calculatedPrice?: CalculatedPrice;
 };
+/**
+ * Calculated price breakdown
+ */
 type CalculatedPrice = {
     price?: {
         /**
@@ -10898,6 +11530,8 @@ type CalculatedPrice = {
     };
 };
 /**
+ * Price value
+ *
  * Aggregated price (totals, subtotals) with currency and optional tax breakdown.
  */
 type Price = {
@@ -10907,6 +11541,7 @@ type Price = {
     currency?: string;
     /**
      * Deprecated; use `netValue`, `grossValue`, and `taxValue` when present.
+     *
      * @deprecated
      */
     amount?: number;
@@ -10924,6 +11559,8 @@ type Price = {
     taxValue?: number;
 };
 /**
+ * Taxable price value
+ *
  * Price value with the currency and tax information.
  */
 type TaxablePrice = {
@@ -10945,6 +11582,8 @@ type TaxablePrice = {
     taxValue?: number;
 };
 /**
+ * Delivery Window
+ *
  * delivery window required for order.
  */
 type DeliveryWindow = {
@@ -10961,6 +11600,9 @@ type DeliveryWindow = {
      */
     deliveryDate?: string;
 };
+/**
+ * Create a cart approval
+ */
 type CreateCartApprovalRequest = GenericApprovalForCreate & {
     /**
      * An identifier of the approval document.
@@ -10973,6 +11615,9 @@ type CreateCartApprovalRequest = GenericApprovalForCreate & {
     resourceType: 'CART';
     details: Details;
 };
+/**
+ * Create a quote approval
+ */
 type CreateQuoteApprovalRequest = GenericApprovalForCreate & {
     /**
      * An identifier of the approval document.
@@ -11012,12 +11657,18 @@ type Metadata = BasicMetadata & {
      */
     modifiedAt: string;
 };
+/**
+ * approvalId
+ */
 type ApprovalId = {
     /**
      * Unique identifier of the created approval.
      */
     id?: string;
 };
+/**
+ * approval permitted request
+ */
 type ApprovalPermittedRequest = {
     resourceType: ResourceType;
     /**
@@ -11026,6 +11677,9 @@ type ApprovalPermittedRequest = {
     resourceId: string;
     action: ApprovalAction;
 };
+/**
+ * Search approver users request
+ */
 type SearchUsersRequest = {
     resourceType: ResourceType;
     /**