@viu/emporix-sdk 4.6.7 → 4.7.1

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { S as SearchPaging } from './search-DU6tE356.js';
 import { CustomerService } from './customer.js';
 export { Address, AddressCreateInput, AddressUpdateInput, ChangeEmailInput, ConfirmEmailChangeInput, Customer, CustomerSession, CustomerSignupInput, CustomerTokenValidation, CustomerUpdateInput, PasswordChangeInput, PasswordResetConfirmInput, PasswordResetRequestInput, ResendActivationInput } from './customer.js';
 import { ProductService } from './product.js';
-export { Media, Product, ProductBulkCreateInput, ProductBulkResult, ProductBulkUpdateInput, ProductCreateInput, ProductCreated, ProductPatchInput, ProductRecalculationInput, ProductRecalculationJob, ProductRecalculationJobStatus, ProductRecalculationResult, ProductTemplate, ProductTemplateCreateInput, ProductTemplateCreated, ProductTemplateUpdateInput, ProductUpdateInput, ProductWriteOptions } from './product.js';
+export { Media, Product, ProductBulkCreateInput, ProductBulkResult, ProductBulkUpdateInput, ProductCreateInput, ProductCreated, ProductPatchInput, ProductRecalculationInput, ProductRecalculationJob, ProductRecalculationJobStatus, ProductRecalculationResult, ProductTemplate, ProductTemplateCreateInput, ProductTemplateCreated, ProductTemplateUpdateInput, ProductUpdateInput, ProductVariant, ProductWriteOptions } from './product.js';
 import { CategoryService } from './category.js';
 export { Category, CategoryAssignment, CategoryAssignmentBulkInput, CategoryAssignmentBulkResult, CategoryAssignmentCreated, CategoryAssignmentInput, CategoryAssignmentRefBulkInput, CategoryCreateInput, CategoryCreated, CategoryNode, CategoryPatchInput, CategoryTreeSearchInput, CategoryUpdateInput, CategoryWriteOptions } from './category.js';
 import { CartService } from './cart.js';
@@ -52,6 +52,9 @@ declare class EmporixNotFoundError extends EmporixError {
 /** 400/422 — request validation failed. */
 declare class EmporixValidationError extends EmporixError {
 }
+/** 409 — conflict: a stale `metadata.version`, or an id that already exists. */
+declare class EmporixConflictError extends EmporixError {
+}
 /** 5xx — server-side failure. */
 declare class EmporixServerError extends EmporixError {
 }
@@ -2307,12 +2310,44 @@ type AbstractSchemaResponse = {
     metadata?: SchemaMetadata;
 };
 type SchemaResponse = AbstractSchemaResponse & {
+    /**
+     * When `true`, custom instances or products that use this mixin may store per-site overlays under keys in the form `{mixinName}__{siteCode}`.
+     * Historical schemas may omit the field (`null`), which behaves like `false`.
+     *
+     */
+    siteAware?: boolean | null;
     /**
      * List of attributes related to the schema.
      */
     attributes?: Array<SchemaAttribute$1>;
 };
 type ReferenceResponse = AbstractSchemaResponse;
+type CustomSchemaTypeCreation = {
+    /**
+     * Unique code for the custom type. Can contain uppercase letters, digits, and underscores. The first character must be a letter.
+     */
+    id: string;
+    /**
+     * Localized custom type name in a form of a map of translations.
+     */
+    name: {
+        [key: string]: unknown;
+    };
+};
+type CustomSchemaTypeUpdate = {
+    /**
+     * Localized custom type name in a form of a map of translations.
+     */
+    name: {
+        [key: string]: unknown;
+    };
+    metadata?: {
+        /**
+         * Version of the custom schema type. If provided, it will be validated against the current entity version.
+         */
+        version?: number;
+    };
+};
 type CustomSchemaTypeResponse = {
     /**
      * Unique id of the custom schema type.
@@ -2355,12 +2390,18 @@ type CustomInstanceCreation = {
     };
     owner?: CustomInstanceOwnerRequest;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. For site-aware schemas, include per-site overlays as additional keys in the form `{mixinName}__{siteCode}`.
+     * Overlay values are validated against the base mixin JSON Schema.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     metadata?: {
         /**
-         * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+         * Key-value map where each key is a base mixin name and each value is a link to the mixin schema.
+         * Do not add `{mixinName}__{siteCode}` keys here. Site overlays reuse the base schema URL.
+         *
          */
         mixins?: {
             [key: string]: unknown;
@@ -2376,16 +2417,22 @@ type CustomInstanceUpdate = {
     };
     owner?: CustomInstanceOwnerRequest;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. For site-aware schemas, include per-site overlays as additional keys in the form `{mixinName}__{siteCode}`.
+     * Overlay values are validated against the base mixin JSON Schema.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     metadata?: {
         /**
          * Version of the custom instance.  If provided, it will be validated against the current entity version.
          */
         version?: number;
         /**
-         * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+         * Key-value map where each key is a base mixin name and each value is a link to the mixin schema.
+         * Do not add `{mixinName}__{siteCode}` keys here. Site overlays reuse the base schema URL.
+         *
          */
         mixins?: {
             [key: string]: unknown;
@@ -2443,9 +2490,13 @@ type CustomInstanceResponse = {
     type?: string;
     owner?: CustomInstanceOwner;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. Without `emporix-site`, base keys and `{mixinName}__{siteCode}` overlay keys are returned as stored.
+     * With `emporix-site`, overlays for that site are deep-merged into the base keys and only the merged base keys are returned.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     /**
      * List of media IDs assigned to the custom instance.
      */
@@ -2540,6 +2591,12 @@ type SchemaAttribute = SchemaAttribute$1;
  * (`PRODUCT`, `CART`, `ORDER`, `CUSTOM_ENTITY`, …).
  */
 type SchemaTypeName = SchemaType;
+/**
+ * An entity type a schema attaches to: a {@link SchemaTypeName} or the id of a
+ * custom entity — the spec's `SchemaType` allows "any custom schema type id",
+ * which its enum cannot express.
+ */
+type SchemaTargetType = SchemaTypeName | (string & {});
 /** A custom-entity definition (a tenant-defined resource type). */
 type CustomEntity = CustomSchemaTypeResponse;
 /**
@@ -2552,11 +2609,14 @@ type CustomInstance<T = Record<string, unknown>> = Omit<CustomInstanceResponse,
 };
 /**
  * Input for creating a schema (server assigns `metadata.version`/`url`).
- * `name`, `types` and `attributes` are the caller-controlled fields.
+ * `name`, `types` and `attributes` are the caller-controlled fields; `id` is
+ * the mixin key the data is stored under (`mixins.<id>`), generated when left
+ * out.
  */
 interface SchemaDraft {
+    id?: string;
     name: Record<string, string>;
-    types: SchemaTypeName[];
+    types: SchemaTargetType[];
     attributes: SchemaAttribute[];
 }
 /**
@@ -2564,27 +2624,48 @@ interface SchemaDraft {
  * upstream API **requires** `metadata.version` for optimistic locking
  * (409 Conflict on a stale version).
  */
-interface SchemaUpdate extends SchemaDraft {
+interface SchemaUpdate extends Omit<SchemaDraft, "id"> {
     metadata: {
         version: number;
     };
 }
-/** Input for creating/updating a custom-entity definition. */
-interface CustomEntityDraft {
-    name: Record<string, string>;
-    attributes: SchemaAttribute[];
-}
-/** Input for creating/replacing a custom instance. `mixins` carries the data. */
-interface CustomInstanceDraft<T = Record<string, unknown>> {
-    name: Record<string, string>;
+/** Id envelope of a `201` from {@link SchemaService.createSchema}. */
+type SchemaCreated = IdResponse$1;
+/**
+ * Input for creating a custom-entity definition. `id` is the type code —
+ * uppercase letters, digits and underscores. Its fields are defined by
+ * schemas attached to the type, not here.
+ */
+type CustomEntityDraft = CustomSchemaTypeCreation;
+/** Input for updating a custom-entity definition (`PUT`, an upsert). */
+type CustomEntityUpdate = CustomSchemaTypeUpdate;
+/** Id envelope of a `201` from creating a custom-entity definition. */
+type CustomEntityCreated = IdResponse$1;
+/**
+ * Input for creating a custom instance. `mixins` carries the data; `id` is
+ * optional (generated when left out); `metadata.mixins` maps each mixin key to
+ * its schema URL.
+ */
+type CustomInstanceDraft<T = Record<string, unknown>> = Omit<CustomInstanceCreation, "mixins"> & {
     mixins: T;
-}
+};
+/**
+ * Input for replacing a custom instance (`PUT`, an upsert). `metadata.version`
+ * enables optimistic locking — a stale one is answered with a 409.
+ */
+type CustomInstanceReplace<T = Record<string, unknown>> = Omit<CustomInstanceUpdate, "mixins"> & {
+    mixins: T;
+};
+/** RFC-6902 operations for {@link SchemaService.patchInstance}. */
+type CustomInstancePatch = PatchOperation$1[];
+/** Id envelope of a `201` from creating a custom instance. */
+type CustomInstanceCreated = IdResponse$1;
 /** Filter / pagination options for {@link SchemaService.listSchemas}. */
 interface ListSchemasQuery {
     /** Emporix `q`-syntax filter (supports `compoundLogicalQuery`). */
     q?: string;
     /** Restrict to schemas attached to this entity type. */
-    type?: SchemaTypeName;
+    type?: SchemaTargetType;
     pageNumber?: number;
     pageSize?: number;
     /** Ask for `X-Total-Count` — becomes a request header, not a query parameter. */
@@ -2686,14 +2767,14 @@ declare class SchemaService {
     listSchemas(query?: ListSchemasQuery, auth?: AuthContext): Promise<PaginatedItems<Schema>>;
     /** Retrieve one schema by id. */
     getSchema(id: string, auth?: AuthContext): Promise<Schema>;
-    /** Create a schema. */
-    createSchema(draft: SchemaDraft, auth?: AuthContext): Promise<Schema>;
+    /** Create a schema. Resolves to the `201`'s id envelope — read the schema back for the rest. */
+    createSchema(draft: SchemaDraft, auth?: AuthContext): Promise<SchemaCreated>;
     /**
-     * Update a schema. The upstream API requires `draft.metadata.version`; a
-     * stale version yields 409 Conflict (propagated as the standard conflict
-     * error).
+     * Update a schema; resolves on the `204`. The upstream API requires
+     * `draft.metadata.version`; a stale version yields a 409
+     * (`EmporixConflictError`).
      */
-    updateSchema(id: string, draft: SchemaUpdate, auth?: AuthContext): Promise<Schema>;
+    updateSchema(id: string, draft: SchemaUpdate, auth?: AuthContext): Promise<void>;
     /** Delete a schema by id. */
     deleteSchema(id: string, auth?: AuthContext): Promise<void>;
     /**
@@ -2704,19 +2785,22 @@ declare class SchemaService {
     /** List entity types that currently have at least one schema. */
     listTypes(auth?: AuthContext): Promise<SchemaTypeName[]>;
     /** Set the entity types a schema applies to (`PUT /schemas/{id}/types`). */
-    setSchemaTypes(id: string, types: SchemaTypeName[], auth?: AuthContext): Promise<Schema>;
+    setSchemaTypes(id: string, types: SchemaTargetType[], auth?: AuthContext): Promise<void>;
     /** List custom-entity definitions. `expandSchemas` inlines each schema body. */
     listCustomEntities(opts?: ListCustomEntitiesOptions, auth?: AuthContext): Promise<CustomEntity[]>;
     /** Retrieve one custom-entity definition by id. */
     getCustomEntity(id: string, auth?: AuthContext): Promise<CustomEntity>;
-    /** Create a custom-entity definition. */
-    createCustomEntity(draft: CustomEntityDraft, auth?: AuthContext): Promise<CustomEntity>;
-    /** Update a custom-entity definition. */
-    updateCustomEntity(id: string, draft: CustomEntityDraft, auth?: AuthContext): Promise<CustomEntity>;
+    /** Create a custom-entity definition. Resolves to the `201`'s id envelope. */
+    createCustomEntity(draft: CustomEntityDraft, auth?: AuthContext): Promise<CustomEntityCreated>;
+    /**
+     * Update a custom-entity definition — an upsert: resolves to the id envelope
+     * when the `PUT` created the type (`201`), to `undefined` when it updated it
+     * (`204`).
+     */
+    updateCustomEntity(id: string, draft: CustomEntityUpdate, auth?: AuthContext): Promise<CustomEntityCreated | undefined>;
     /**
      * Delete a custom-entity definition. The server rejects with 409 if
-     * instances or schemas still reference it (propagated as the standard
-     * conflict error).
+     * instances or schemas still reference it (`EmporixConflictError`).
      */
     deleteCustomEntity(id: string, auth?: AuthContext): Promise<void>;
     /**
@@ -2736,12 +2820,23 @@ declare class SchemaService {
     listAllInstances<T = Record<string, unknown>>(type: string, query?: ListInstancesQuery, auth?: AuthContext): AsyncIterable<CustomInstance<T>>;
     /** Retrieve one instance by id. */
     getInstance<T = Record<string, unknown>>(type: string, id: string, auth?: AuthContext): Promise<CustomInstance<T>>;
-    /** Create an instance of a custom entity. */
-    createInstance<T = Record<string, unknown>>(type: string, draft: CustomInstanceDraft<T>, auth?: AuthContext): Promise<CustomInstance<T>>;
-    /** Replace an instance (full `PUT`). */
-    replaceInstance<T = Record<string, unknown>>(type: string, id: string, draft: CustomInstanceDraft<T>, auth?: AuthContext): Promise<CustomInstance<T>>;
-    /** Partially update an instance (`PATCH`). */
-    patchInstance<T = Record<string, unknown>>(type: string, id: string, patch: Partial<CustomInstanceDraft<T>>, auth?: AuthContext): Promise<CustomInstance<T>>;
+    /**
+     * Create an instance of a custom entity. Resolves to the `201`'s id envelope;
+     * an id that already exists is answered with a 409 (`EmporixConflictError`).
+     */
+    createInstance<T = Record<string, unknown>>(type: string, draft: CustomInstanceDraft<T>, auth?: AuthContext): Promise<CustomInstanceCreated>;
+    /**
+     * Replace an instance (full `PUT`, an upsert). Resolves to the id envelope
+     * when it created the instance (`201`), to `undefined` when it replaced one
+     * (`204`). A stale `metadata.version` is answered with a 409.
+     */
+    replaceInstance<T = Record<string, unknown>>(type: string, id: string, draft: CustomInstanceReplace<T>, auth?: AuthContext): Promise<CustomInstanceCreated | undefined>;
+    /**
+     * Partially update an instance (`PATCH`) with RFC-6902 operations, e.g.
+     * `[{ op: "replace", path: "/mixins/shoe/size", value: 44 }]`. Resolves on
+     * the `204`.
+     */
+    patchInstance(type: string, id: string, patch: CustomInstancePatch, auth?: AuthContext): Promise<void>;
     /**
      * Patch up to 200 custom instances of `type` in one call
      * (`PATCH /custom-entities/{type}/instances/bulk`). Returns a 207 envelope:
@@ -13557,4 +13652,4 @@ declare function productIdFromYrn(yrn: string | undefined): string;
  */
 declare function productYrn(tenant: string, productId: string): string;
 
-export { type AddedPoints, type AdminCustomer, type AdminCustomerAddress, type AdminCustomerAddressInput, type AdminCustomerAddressList, type AdminCustomerAddressUpdate, type AdminCustomerCreated, type AdminCustomerImport, type AdminCustomerImportAccount, type AdminCustomerImportResult, type AdminCustomerInput, type AdminCustomerLegacyAuth, type AdminCustomerList, type AdminCustomerPatch, type AdminCustomerSearchQuery, type AdminCustomerUpdate, type AdminPasswordMigrationRetention, type AdminPasswordMigrationRetentionInput, type Agent, type AgentAnalytics, type AgentExecutions, type AgentFromTemplate, type AgentInput, type AgentPatchOp, type AgentRequestLog, type AgentSearchQuery, type AgentSessionLog, type AgentTemplate, AgenticCrudResource, type AgenticPatchOp, type AgentsExport, type AgentsExportRequest, type AgentsImport, type AgentsImportRequest, AiService, type AnalyticsQuery, AnalyticsResource, type Approval, type ApprovalCreated, type ApprovalDecision, type ApprovalInput, type ApprovalList, type ApprovalPatch, type ApprovalPermittedInput, type ApprovalPermittedResult, ApprovalService, type ApprovalUsersQuery, type ApprovalUsersResult, type Attachment, type AttachmentOptions, type AttachmentReuseOptions, type AuditLogChangeType, type AuditLogEntry, type AuditLogPage, type AuditLogPathChange, type AuditLogQuery, type AuditLogRelatedEntity, AuditLogService, AuthContext, AvailabilityService, type BatchNextIdEntry, type Brand, type BrandInput, type BrandList, BrandService, type BrandUpdate, type BulkInstanceResult, type BulkPatchInstanceItem, CartService, type Catalog, type CatalogCreated, type CatalogInput, type CatalogList, type CatalogPatch, CatalogService, type CatalogUpdate, CategoryService, type CgRelation, type CgRelationList, type ChatOptions, type ChatRequest, type ChatResponse, type ChatStreamOptions, CheckoutService, ClientConfigService, type ClientConfiguration, ClientContext, CloudFunctionsService, type CommerceEvents, CompaniesService, type CompletionMessage, type CompletionRequest, type CompletionResponse, type Configuration$1 as Configuration, type ConfigurationDraft, ContactsService, type Conversation, type ConversationSearchQuery, type ConversionFactorInput, type ConversionFactorResult, type ConvertUnitInput, type ConvertUnitResult, type CookieIo, type Country, type CountryList, CountryService, type CountryUpdate, type Coupon$1 as Coupon, type CouponCreated, type CouponInput, type CouponList, CouponService, type CouponUpdate, type Created, type Currency, type CurrencyCreated, type CurrencyInput, type CurrencyList, CurrencyService, type CurrencyUpdate, type CustomEntity, type CustomEntityDraft, type CustomInstance, type CustomInstanceDraft, CustomerAdminService, CustomerGroupsService, CustomerService, type CustomerSessionState, type CustomerSessionStore, type CustomerSummaryBatch, CustomerTokenRefresher, type DeleteAgentOptions, type DeleteConfigOptions, type DeliveryCreated, type DeliveryCycleInput, type DeliverySlot, type DeliverySlotList, type DeliveryTime, type DeliveryTimeInput, type DeliveryTimeList, type DeliveryTimeUpdate, type DeliveryWindow$1 as DeliveryWindow, type DeliveryWindowList, type DeliveryWindowValidation, EmporixAuthError, EmporixClient, EmporixConfig, type EmporixCore, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNetworkError, EmporixNotFoundError, EmporixServerError, type EmporixStorage, type EmporixStorageKey, EmporixTimeoutError, EmporixValidationError, type ExchangeRate, type ExchangeRateCreated, type ExchangeRateInput, type ExchangeRateList, type ExchangeRateUpdate, type ExecutionsQuery, type Fee$1 as Fee, type FeeDraft, FeeService, type FindSiteInput, type GetOptions, type IamAccessControl, type IamAccessControlCreated, type IamAccessControlUpsert, type IamGroup, type IamGroupCreate, type IamGroupCreated, AssignmentCreateRequest as IamGroupMemberAssignment, type IamGroupMemberCreated, type IamGroupMemberInput, type IamGroupUpdate, type IamScope, type IamScopeCreated, type IamScopeUpsert, IamService, type IamUser, type IamUserCreate, type IamUserCreated, type IamUserDetail, type IamUserScopes, type IamUserUpdate, type ImportCancelResult, type ImportConfig, type ImportDiagnosticKind, type ImportDiagnosticRecord, type ImportErrorRecord, type ImportHealthThresholds, type ImportJobGroup, type ImportLicense, type ImportPage, type ImportPageOptions, type ImportRecordOutcome, type ImportRun, type ImportRunDetail, type ImportRunDiagnostics, type ImportRunDiagnosticsQuery, type ImportRunEvent, type ImportRunInput, type ImportRunMode, type ImportRunStatus, type ImportRunStream, type ImportSchedule, ImportService, type ImportStats, type ImportStatsQuery, type ImportStream, type ImportStreamOrder, type ImportedRecord, type IndexConfig, type IndexConfigCreated, type IndexPublicConfig, IndexingService, type InstanceSearchBody, type InvoiceJob, type InvoiceJobCreated, type InvoiceJobDraft, InvoiceService, type InvokeCloudFunctionOptions, type ItemFee, type ItemFeeDraft, type ItemFeeSearch, type ItemFeeSearchByProductId, type ItemFeeSearchByProductIds, type Job, type JobIdResponse, JobsResource, type Label, type LabelInput, type LabelList, LabelService, type LabelUpdate, type ListConfigOptions, type ListCustomEntitiesOptions, type ListFeesQuery, type ListInstancesQuery, type ListQuery, type ListQuoteReasonsQuery, type ListQuotesQuery, type ListReindexJobsOptions, type ListSchemaReferencesQuery, type ListSchemasQuery, LocationsService, LogLevel, LogsResource, type McpServer, type McpServerInput, MediaService, type MetadataFilter, type MinimumFee, type MutateOptions, type NewPointsEntry, type NextIdCommandRequest, type NextIdOptions, type NextIdResponse, type NextIdsBatchRequest, type NextIdsBatchResponse, type OAuthConfig, type OAuthInput, OrdersService, PaginatedItems, PaymentGatewayService, type PersistedAnonymousSession, type PointsSummary, PriceService, ProductService, type ProviderModels, QueryFor, type Quote, type QuoteCreated, type QuoteDraft, type QuoteHistory, type QuoteInput, type QuoteReason, type QuoteReasonCreated, type QuoteReasonDraft, type QuoteReasonUpdate, QuoteReasonsResource, type QuoteResult, QuoteService, type QuoteSlotInput, type QuoteUpdate, RagIndexerService, type RagType, type RedeemCouponResult, type RedeemMyPointsInput, type RedeemOption, type RedeemOptionList, type RedeemedPoints, type Redemption, type RedemptionCreated, type RedemptionInput, type ReferralCoupon, type Region, type RegionList, type ReindexEntityType, type ReindexInput, type ReindexJob, type ReindexJobInput, type ReindexJobStatus, ResolvedConfig, type ResourceCreated, type Return, type ReturnCreated, type ReturnInput, type ReturnList, type ReturnPatch, type ReturnUpdate, ReturnsService, RewardPointsService, STORAGE_KEYS, SalesOrdersService, type SavedSearch, type SavedSearchCreated, type SavedSearchInput, type Schema, type SchemaAttribute, type SchemaDraft, type SchemaExport, type SchemaImportInput, type SchemaInstanceBulkCreateItem, type SchemaInstanceBulkUpsertItem, type SchemaReference, type SchemaReferenceCreated, type SchemaReferenceInput, type SchemaReferenceUpdateInput, SchemaService, type SchemaTypeName, type SchemaUpdate, type SearchFilterNode, type SearchHit, type SearchImportedRecordsOptions, type SearchIndex, type SearchIndexExport, type SearchIndexField, type SearchIndexImportResult, type SearchIndexInput, type SearchIndexJob, type SearchIndexJobRef, type SearchIndexSelection, type SearchInput, type SearchInstancesQuery, type SearchListOptions, type SearchOptions, SearchPaging, type SearchQuery, type SearchQueryNode, SearchService, type SearchStreamRecordsOptions, type SearchTypeListOptions, SegmentService, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, type ServerCookieJar, type ServiceClass, ServiceName, type SessionAttributeInput, type SessionContext, type SessionContextData, type SessionContextPatch, SessionContextService, type SetItemFeesOptions, type ShippingFee, type ShippingGroup, type ShippingGroupList, type ShippingMethod, type ShippingMethodList, type ShippingPatch, ShippingService, type ShoppingList, type ShoppingListDraft, type ShoppingListItem, ShoppingListService, type Site$1 as Site, type SiteAddress, type SiteCreated, type SiteFields, type SiteHomeBase, type SiteInput, type SiteList, type SiteMixin, type SiteMixinCreated, type SiteMixins, SiteService, StoredAnonymousSession, type TaxCalculationInput, type TaxCalculationRequest, type TaxCalculationResult, type TaxClass, type TaxConfig, type TaxConfigCreated, type TaxCreation as TaxConfigInput, type TaxUpdate as TaxConfigUpdate, type TaxLocation, TaxService, TemplatesResource, TenantConfigService, type TextRequest, type TextResponse, type Token, type TokenInput, TokenProvider, type TokenStorage, type Tool, type ToolInput, type Unit, type UnitCreated, UnitHandlingService, type UnitInput, type UnitUpdate, type Vendor, type VendorCreated, type VendorInput, type VendorList, type VendorLocation, type VendorLocationInput, type VendorLocationList, type VendorLocationUpdate, type VendorSearchQuery, VendorService, type VendorUpdate, type WebhookConfig, type WebhookConfigCreated, type WebhookConfigDraft, type WebhookConfigPatch, type WebhookDashboardAccess, WebhookService, type WebhookStatistics, type WebhookStatisticsQuery, type WebhookSubscription, type WebhookSubscriptionUpdateItem, type WebhookSubscriptionUpdateResultItem, type Zone, type ZoneList, approvalStatusPatch, createCookieBackedStorage, createCookieStorage, createCore, createEmporixClient, createListenerSet, createLocalStorage, createLocalStorageStorage, createMemoryStorage, createServerStorage, createSessionStorage, emporixKey, errorFromResponse, fromWebStorage, getCustomerSessionStore, parseAnonymousSession, pickFee, productIdFromYrn, productYrn, resolveZone, serverAuth, siteMeta };
+export { type AddedPoints, type AdminCustomer, type AdminCustomerAddress, type AdminCustomerAddressInput, type AdminCustomerAddressList, type AdminCustomerAddressUpdate, type AdminCustomerCreated, type AdminCustomerImport, type AdminCustomerImportAccount, type AdminCustomerImportResult, type AdminCustomerInput, type AdminCustomerLegacyAuth, type AdminCustomerList, type AdminCustomerPatch, type AdminCustomerSearchQuery, type AdminCustomerUpdate, type AdminPasswordMigrationRetention, type AdminPasswordMigrationRetentionInput, type Agent, type AgentAnalytics, type AgentExecutions, type AgentFromTemplate, type AgentInput, type AgentPatchOp, type AgentRequestLog, type AgentSearchQuery, type AgentSessionLog, type AgentTemplate, AgenticCrudResource, type AgenticPatchOp, type AgentsExport, type AgentsExportRequest, type AgentsImport, type AgentsImportRequest, AiService, type AnalyticsQuery, AnalyticsResource, type Approval, type ApprovalCreated, type ApprovalDecision, type ApprovalInput, type ApprovalList, type ApprovalPatch, type ApprovalPermittedInput, type ApprovalPermittedResult, ApprovalService, type ApprovalUsersQuery, type ApprovalUsersResult, type Attachment, type AttachmentOptions, type AttachmentReuseOptions, type AuditLogChangeType, type AuditLogEntry, type AuditLogPage, type AuditLogPathChange, type AuditLogQuery, type AuditLogRelatedEntity, AuditLogService, AuthContext, AvailabilityService, type BatchNextIdEntry, type Brand, type BrandInput, type BrandList, BrandService, type BrandUpdate, type BulkInstanceResult, type BulkPatchInstanceItem, CartService, type Catalog, type CatalogCreated, type CatalogInput, type CatalogList, type CatalogPatch, CatalogService, type CatalogUpdate, CategoryService, type CgRelation, type CgRelationList, type ChatOptions, type ChatRequest, type ChatResponse, type ChatStreamOptions, CheckoutService, ClientConfigService, type ClientConfiguration, ClientContext, CloudFunctionsService, type CommerceEvents, CompaniesService, type CompletionMessage, type CompletionRequest, type CompletionResponse, type Configuration$1 as Configuration, type ConfigurationDraft, ContactsService, type Conversation, type ConversationSearchQuery, type ConversionFactorInput, type ConversionFactorResult, type ConvertUnitInput, type ConvertUnitResult, type CookieIo, type Country, type CountryList, CountryService, type CountryUpdate, type Coupon$1 as Coupon, type CouponCreated, type CouponInput, type CouponList, CouponService, type CouponUpdate, type Created, type Currency, type CurrencyCreated, type CurrencyInput, type CurrencyList, CurrencyService, type CurrencyUpdate, type CustomEntity, type CustomEntityCreated, type CustomEntityDraft, type CustomEntityUpdate, type CustomInstance, type CustomInstanceCreated, type CustomInstanceDraft, type CustomInstancePatch, type CustomInstanceReplace, CustomerAdminService, CustomerGroupsService, CustomerService, type CustomerSessionState, type CustomerSessionStore, type CustomerSummaryBatch, CustomerTokenRefresher, type DeleteAgentOptions, type DeleteConfigOptions, type DeliveryCreated, type DeliveryCycleInput, type DeliverySlot, type DeliverySlotList, type DeliveryTime, type DeliveryTimeInput, type DeliveryTimeList, type DeliveryTimeUpdate, type DeliveryWindow$1 as DeliveryWindow, type DeliveryWindowList, type DeliveryWindowValidation, EmporixAuthError, EmporixClient, EmporixConfig, EmporixConflictError, type EmporixCore, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNetworkError, EmporixNotFoundError, EmporixServerError, type EmporixStorage, type EmporixStorageKey, EmporixTimeoutError, EmporixValidationError, type ExchangeRate, type ExchangeRateCreated, type ExchangeRateInput, type ExchangeRateList, type ExchangeRateUpdate, type ExecutionsQuery, type Fee$1 as Fee, type FeeDraft, FeeService, type FindSiteInput, type GetOptions, type IamAccessControl, type IamAccessControlCreated, type IamAccessControlUpsert, type IamGroup, type IamGroupCreate, type IamGroupCreated, AssignmentCreateRequest as IamGroupMemberAssignment, type IamGroupMemberCreated, type IamGroupMemberInput, type IamGroupUpdate, type IamScope, type IamScopeCreated, type IamScopeUpsert, IamService, type IamUser, type IamUserCreate, type IamUserCreated, type IamUserDetail, type IamUserScopes, type IamUserUpdate, type ImportCancelResult, type ImportConfig, type ImportDiagnosticKind, type ImportDiagnosticRecord, type ImportErrorRecord, type ImportHealthThresholds, type ImportJobGroup, type ImportLicense, type ImportPage, type ImportPageOptions, type ImportRecordOutcome, type ImportRun, type ImportRunDetail, type ImportRunDiagnostics, type ImportRunDiagnosticsQuery, type ImportRunEvent, type ImportRunInput, type ImportRunMode, type ImportRunStatus, type ImportRunStream, type ImportSchedule, ImportService, type ImportStats, type ImportStatsQuery, type ImportStream, type ImportStreamOrder, type ImportedRecord, type IndexConfig, type IndexConfigCreated, type IndexPublicConfig, IndexingService, type InstanceSearchBody, type InvoiceJob, type InvoiceJobCreated, type InvoiceJobDraft, InvoiceService, type InvokeCloudFunctionOptions, type ItemFee, type ItemFeeDraft, type ItemFeeSearch, type ItemFeeSearchByProductId, type ItemFeeSearchByProductIds, type Job, type JobIdResponse, JobsResource, type Label, type LabelInput, type LabelList, LabelService, type LabelUpdate, type ListConfigOptions, type ListCustomEntitiesOptions, type ListFeesQuery, type ListInstancesQuery, type ListQuery, type ListQuoteReasonsQuery, type ListQuotesQuery, type ListReindexJobsOptions, type ListSchemaReferencesQuery, type ListSchemasQuery, LocationsService, LogLevel, LogsResource, type McpServer, type McpServerInput, MediaService, type MetadataFilter, type MinimumFee, type MutateOptions, type NewPointsEntry, type NextIdCommandRequest, type NextIdOptions, type NextIdResponse, type NextIdsBatchRequest, type NextIdsBatchResponse, type OAuthConfig, type OAuthInput, OrdersService, PaginatedItems, PaymentGatewayService, type PersistedAnonymousSession, type PointsSummary, PriceService, ProductService, type ProviderModels, QueryFor, type Quote, type QuoteCreated, type QuoteDraft, type QuoteHistory, type QuoteInput, type QuoteReason, type QuoteReasonCreated, type QuoteReasonDraft, type QuoteReasonUpdate, QuoteReasonsResource, type QuoteResult, QuoteService, type QuoteSlotInput, type QuoteUpdate, RagIndexerService, type RagType, type RedeemCouponResult, type RedeemMyPointsInput, type RedeemOption, type RedeemOptionList, type RedeemedPoints, type Redemption, type RedemptionCreated, type RedemptionInput, type ReferralCoupon, type Region, type RegionList, type ReindexEntityType, type ReindexInput, type ReindexJob, type ReindexJobInput, type ReindexJobStatus, ResolvedConfig, type ResourceCreated, type Return, type ReturnCreated, type ReturnInput, type ReturnList, type ReturnPatch, type ReturnUpdate, ReturnsService, RewardPointsService, STORAGE_KEYS, SalesOrdersService, type SavedSearch, type SavedSearchCreated, type SavedSearchInput, type Schema, type SchemaAttribute, type SchemaCreated, type SchemaDraft, type SchemaExport, type SchemaImportInput, type SchemaInstanceBulkCreateItem, type SchemaInstanceBulkUpsertItem, type SchemaReference, type SchemaReferenceCreated, type SchemaReferenceInput, type SchemaReferenceUpdateInput, SchemaService, type SchemaTargetType, type SchemaTypeName, type SchemaUpdate, type SearchFilterNode, type SearchHit, type SearchImportedRecordsOptions, type SearchIndex, type SearchIndexExport, type SearchIndexField, type SearchIndexImportResult, type SearchIndexInput, type SearchIndexJob, type SearchIndexJobRef, type SearchIndexSelection, type SearchInput, type SearchInstancesQuery, type SearchListOptions, type SearchOptions, SearchPaging, type SearchQuery, type SearchQueryNode, SearchService, type SearchStreamRecordsOptions, type SearchTypeListOptions, SegmentService, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, type ServerCookieJar, type ServiceClass, ServiceName, type SessionAttributeInput, type SessionContext, type SessionContextData, type SessionContextPatch, SessionContextService, type SetItemFeesOptions, type ShippingFee, type ShippingGroup, type ShippingGroupList, type ShippingMethod, type ShippingMethodList, type ShippingPatch, ShippingService, type ShoppingList, type ShoppingListDraft, type ShoppingListItem, ShoppingListService, type Site$1 as Site, type SiteAddress, type SiteCreated, type SiteFields, type SiteHomeBase, type SiteInput, type SiteList, type SiteMixin, type SiteMixinCreated, type SiteMixins, SiteService, StoredAnonymousSession, type TaxCalculationInput, type TaxCalculationRequest, type TaxCalculationResult, type TaxClass, type TaxConfig, type TaxConfigCreated, type TaxCreation as TaxConfigInput, type TaxUpdate as TaxConfigUpdate, type TaxLocation, TaxService, TemplatesResource, TenantConfigService, type TextRequest, type TextResponse, type Token, type TokenInput, TokenProvider, type TokenStorage, type Tool, type ToolInput, type Unit, type UnitCreated, UnitHandlingService, type UnitInput, type UnitUpdate, type Vendor, type VendorCreated, type VendorInput, type VendorList, type VendorLocation, type VendorLocationInput, type VendorLocationList, type VendorLocationUpdate, type VendorSearchQuery, VendorService, type VendorUpdate, type WebhookConfig, type WebhookConfigCreated, type WebhookConfigDraft, type WebhookConfigPatch, type WebhookDashboardAccess, WebhookService, type WebhookStatistics, type WebhookStatisticsQuery, type WebhookSubscription, type WebhookSubscriptionUpdateItem, type WebhookSubscriptionUpdateResultItem, type Zone, type ZoneList, approvalStatusPatch, createCookieBackedStorage, createCookieStorage, createCore, createEmporixClient, createListenerSet, createLocalStorage, createLocalStorageStorage, createMemoryStorage, createServerStorage, createSessionStorage, emporixKey, errorFromResponse, fromWebStorage, getCustomerSessionStore, parseAnonymousSession, pickFee, productIdFromYrn, productYrn, resolveZone, serverAuth, siteMeta };

package/dist/index.js

@@ -1,29 +1,29 @@
 import { LocationsService } from './chunk-IAOWDMTA.js';
 export { LocationsService } from './chunk-IAOWDMTA.js';
-import { MediaService } from './chunk-NFSO7WUA.js';
-export { MediaService } from './chunk-NFSO7WUA.js';
-import { OrdersService, SalesOrdersService } from './chunk-IYNT5BQW.js';
-export { OrdersService, SalesOrdersService } from './chunk-IYNT5BQW.js';
-import { auth, resolveToken, DefaultTokenProvider, CustomerRefreshRegistry, PaymentGatewayService } from './chunk-4VRUMCS2.js';
-export { CustomerRefreshRegistry, DefaultTokenProvider, PaymentGatewayService, auth, resolveToken } from './chunk-4VRUMCS2.js';
-import { PriceService } from './chunk-K4KXT6NX.js';
-export { PriceService } from './chunk-K4KXT6NX.js';
-import { ProductService } from './chunk-J2AN2FMK.js';
-export { ProductService } from './chunk-J2AN2FMK.js';
-import { SegmentService } from './chunk-N2CE3J4M.js';
-export { SegmentService } from './chunk-N2CE3J4M.js';
-import { AvailabilityService } from './chunk-XQAOHHXL.js';
-export { AvailabilityService } from './chunk-XQAOHHXL.js';
-import { CartService } from './chunk-S2ERKGYL.js';
-export { CartService } from './chunk-S2ERKGYL.js';
+import { MediaService } from './chunk-SIGXBN4F.js';
+export { MediaService } from './chunk-SIGXBN4F.js';
+import { OrdersService, SalesOrdersService } from './chunk-CXTVY4SI.js';
+export { OrdersService, SalesOrdersService } from './chunk-CXTVY4SI.js';
+import { auth, resolveToken, DefaultTokenProvider, CustomerRefreshRegistry, PaymentGatewayService } from './chunk-PK4DQHJO.js';
+export { CustomerRefreshRegistry, DefaultTokenProvider, PaymentGatewayService, auth, resolveToken } from './chunk-PK4DQHJO.js';
+import { PriceService } from './chunk-ENMMDGUB.js';
+export { PriceService } from './chunk-ENMMDGUB.js';
+import { ProductService } from './chunk-3JO2O4BY.js';
+export { ProductService } from './chunk-3JO2O4BY.js';
+import { SegmentService } from './chunk-U3ZIJZYH.js';
+export { SegmentService } from './chunk-U3ZIJZYH.js';
+import { AvailabilityService } from './chunk-ZZ3X3DDL.js';
+export { AvailabilityService } from './chunk-ZZ3X3DDL.js';
+import { CartService } from './chunk-ZLGLI4KC.js';
+export { CartService } from './chunk-ZLGLI4KC.js';
 import { CategoryService } from './chunk-KJEBG7MP.js';
 export { CategoryService } from './chunk-KJEBG7MP.js';
 export { iterateAll } from './chunk-W6SLZNRX.js';
 import { resolveQuery } from './chunk-S5HEIQDK.js';
 export { resolveQuery } from './chunk-S5HEIQDK.js';
 import { requestPage } from './chunk-LKHKFF7B.js';
-import { CheckoutService } from './chunk-RYQVMR26.js';
-export { CheckoutService } from './chunk-RYQVMR26.js';
+import { CheckoutService } from './chunk-BHNYGUSD.js';
+export { CheckoutService } from './chunk-BHNYGUSD.js';
 import { CompaniesService } from './chunk-2OTFVTG6.js';
 export { CompaniesService } from './chunk-2OTFVTG6.js';
 import { splitQuery, SEARCH_PAGING } from './chunk-ZWJUDXTK.js';
@@ -31,11 +31,11 @@ import { ContactsService } from './chunk-27NLS646.js';
 export { ContactsService } from './chunk-27NLS646.js';
 import { CustomerGroupsService, IamService } from './chunk-VXORPTMP.js';
 export { CustomerGroupsService, IamService } from './chunk-VXORPTMP.js';
-import { CustomerService } from './chunk-UA4BM6OP.js';
-export { CustomerService } from './chunk-UA4BM6OP.js';
-import './chunk-3BDDYX3V.js';
-import { EmporixTimeoutError, EmporixNetworkError, errorFromResponse, EmporixNotFoundError, EmporixError } from './chunk-UWGGF4MC.js';
-export { EmporixAuthError, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNetworkError, EmporixNotFoundError, EmporixServerError, EmporixTimeoutError, EmporixValidationError, errorFromResponse } from './chunk-UWGGF4MC.js';
+import { CustomerService } from './chunk-EQE5WGME.js';
+export { CustomerService } from './chunk-EQE5WGME.js';
+import './chunk-ZVIEFW3X.js';
+import { EmporixTimeoutError, EmporixNetworkError, errorFromResponse, EmporixNotFoundError, EmporixError } from './chunk-4Q76UV4J.js';
+export { EmporixAuthError, EmporixConflictError, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNetworkError, EmporixNotFoundError, EmporixServerError, EmporixTimeoutError, EmporixValidationError, errorFromResponse } from './chunk-4Q76UV4J.js';
 
 // src/core/config.ts
 var DEFAULT_HOST = "https://api.emporix.io";
@@ -948,7 +948,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "4.6.7";
+var version = "4.7.1";
 
 // src/version.ts
 var SDK_VERSION = version;
@@ -2040,7 +2040,7 @@ var SchemaService = class {
       auth: auth2
     });
   }
-  /** Create a schema. */
+  /** Create a schema. Resolves to the `201`'s id envelope — read the schema back for the rest. */
   async createSchema(draft, auth2 = SERVICE8) {
     return this.ctx.http.request({
       method: "POST",
@@ -2050,12 +2050,12 @@ var SchemaService = class {
     });
   }
   /**
-   * Update a schema. The upstream API requires `draft.metadata.version`; a
-   * stale version yields 409 Conflict (propagated as the standard conflict
-   * error).
+   * Update a schema; resolves on the `204`. The upstream API requires
+   * `draft.metadata.version`; a stale version yields a 409
+   * (`EmporixConflictError`).
    */
   async updateSchema(id, draft, auth2 = SERVICE8) {
-    return this.ctx.http.request({
+    await this.ctx.http.request({
       method: "PUT",
       path: `${this.schemasBase()}/${encodeURIComponent(id)}`,
       auth: auth2,
@@ -2093,7 +2093,7 @@ var SchemaService = class {
   }
   /** Set the entity types a schema applies to (`PUT /schemas/{id}/types`). */
   async setSchemaTypes(id, types, auth2 = SERVICE8) {
-    return this.ctx.http.request({
+    await this.ctx.http.request({
       method: "PUT",
       path: `${this.schemasBase()}/${encodeURIComponent(id)}/types`,
       auth: auth2,
@@ -2118,7 +2118,7 @@ var SchemaService = class {
       auth: auth2
     });
   }
-  /** Create a custom-entity definition. */
+  /** Create a custom-entity definition. Resolves to the `201`'s id envelope. */
   async createCustomEntity(draft, auth2 = SERVICE8) {
     return this.ctx.http.request({
       method: "POST",
@@ -2127,7 +2127,11 @@ var SchemaService = class {
       body: draft
     });
   }
-  /** Update a custom-entity definition. */
+  /**
+   * Update a custom-entity definition — an upsert: resolves to the id envelope
+   * when the `PUT` created the type (`201`), to `undefined` when it updated it
+   * (`204`).
+   */
   async updateCustomEntity(id, draft, auth2 = SERVICE8) {
     return this.ctx.http.request({
       method: "PUT",
@@ -2138,8 +2142,7 @@ var SchemaService = class {
   }
   /**
    * Delete a custom-entity definition. The server rejects with 409 if
-   * instances or schemas still reference it (propagated as the standard
-   * conflict error).
+   * instances or schemas still reference it (`EmporixConflictError`).
    */
   async deleteCustomEntity(id, auth2 = SERVICE8) {
     await this.ctx.http.request({
@@ -2200,7 +2203,10 @@ var SchemaService = class {
       auth: auth2
     });
   }
-  /** Create an instance of a custom entity. */
+  /**
+   * Create an instance of a custom entity. Resolves to the `201`'s id envelope;
+   * an id that already exists is answered with a 409 (`EmporixConflictError`).
+   */
   async createInstance(type, draft, auth2 = SERVICE8) {
     return this.ctx.http.request({
       method: "POST",
@@ -2209,7 +2215,11 @@ var SchemaService = class {
       body: draft
     });
   }
-  /** Replace an instance (full `PUT`). */
+  /**
+   * Replace an instance (full `PUT`, an upsert). Resolves to the id envelope
+   * when it created the instance (`201`), to `undefined` when it replaced one
+   * (`204`). A stale `metadata.version` is answered with a 409.
+   */
   async replaceInstance(type, id, draft, auth2 = SERVICE8) {
     return this.ctx.http.request({
       method: "PUT",
@@ -2218,9 +2228,13 @@ var SchemaService = class {
       body: draft
     });
   }
-  /** Partially update an instance (`PATCH`). */
+  /**
+   * Partially update an instance (`PATCH`) with RFC-6902 operations, e.g.
+   * `[{ op: "replace", path: "/mixins/shoe/size", value: 44 }]`. Resolves on
+   * the `204`.
+   */
   async patchInstance(type, id, patch, auth2 = SERVICE8) {
-    return this.ctx.http.request({
+    await this.ctx.http.request({
       method: "PATCH",
       path: `${this.instancesBase(type)}/${encodeURIComponent(id)}`,
       auth: auth2,