From d22b639e812f5b784842bd7d5ae94d7aa19d0ce6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 3 Jul 2023 12:35:45 +0200 Subject: [PATCH] Update generated SDKs (#487) * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * build(codegen): updating SDK * Create mighty-dogs-fetch.md Add changeset and release notes. --------- Co-authored-by: Auto Mation Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> --- .changeset/mighty-dogs-fetch.md | 326 ++ changes.md | 351 +- ...-by-resource-type-by-id-request-builder.ts | 3 + ...ct-key-by-resource-type-request-builder.ts | 5 +- .../client/by-project-key-request-builder.ts | 4 + .../src/generated/models/change-history.ts | 140 +- .../src/generated/models/change-value.ts | 123 +- .../src/generated/models/change.ts | 3356 +++++++++++++---- .../src/generated/models/common.ts | 70 + .../history-sdk/src/generated/models/label.ts | 62 + ...y-by-resource-type-request-builder.test.ts | 4 +- .../by-project-key-request-builder.test.ts | 15 +- .../src/generated/models/types.ts | 2 + .../src/generated/models/business-unit.ts | 2 +- .../src/generated/models/cart-discount.ts | 2 +- .../platform-sdk/src/generated/models/cart.ts | 160 +- .../src/generated/models/common.ts | 3 + .../src/generated/models/error.ts | 4 +- .../platform-sdk/src/generated/models/me.ts | 131 +- .../src/generated/models/message.ts | 615 ++- .../src/generated/models/order-edit.ts | 158 +- .../src/generated/models/order.ts | 92 +- .../src/generated/models/product-selection.ts | 28 - .../src/generated/models/product-type.ts | 2 +- .../src/generated/models/standalone-price.ts | 112 +- .../src/generated/models/subscription.ts | 48 + .../platform-sdk/src/generated/models/type.ts | 2 + reference.txt | 1 + references.txt | 43 + 29 files changed, 4875 insertions(+), 989 deletions(-) create mode 100644 .changeset/mighty-dogs-fetch.md create mode 100644 reference.txt diff --git a/.changeset/mighty-dogs-fetch.md b/.changeset/mighty-dogs-fetch.md new file mode 100644 index 000000000..0d04e92d8 --- /dev/null +++ b/.changeset/mighty-dogs-fetch.md @@ -0,0 +1,326 @@ +--- +"@commercetools/history-sdk": patch +"@commercetools/importapi-sdk": patch +"@commercetools/platform-sdk": patch +--- + +Update generated SDKs + +# Api (Platform) changes +
+Added Property(s) + +- added property `perMethodTaxRate` to type `CustomLineItem` +- added property `key` to type `LineItem` +- added property `key` to type `LineItemDraft` +- added property `key` to type `CartAddLineItemAction` +- added property `lineItemKey` to type `CartApplyDeltaToLineItemShippingDetailsTargetsAction` +- added property `lineItemKey` to type `CartChangeLineItemQuantityAction` +- added property `lineItemKey` to type `CartRemoveLineItemAction` +- added property `lineItemKey` to type `CartSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `CartSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `CartSetLineItemDistributionChannelAction` +- added property `lineItemKey` to type `CartSetLineItemInventoryModeAction` +- added property `lineItemKey` to type `CartSetLineItemPriceAction` +- added property `lineItemKey` to type `CartSetLineItemShippingDetailsAction` +- added property `lineItemKey` to type `CartSetLineItemSupplyChannelAction` +- added property `lineItemKey` to type `CartSetLineItemTaxAmountAction` +- added property `lineItemKey` to type `CartSetLineItemTaxRateAction` +- added property `lineItemKey` to type `CartSetLineItemTotalPriceAction` +- added property `key` to type `MyLineItemDraft` +- added property `key` to type `MyCartAddLineItemAction` +- added property `lineItemKey` to type `MyCartApplyDeltaToLineItemShippingDetailsTargetsAction` +- added property `lineItemKey` to type `MyCartChangeLineItemQuantityAction` +- added property `lineItemKey` to type `MyCartRemoveLineItemAction` +- added property `lineItemKey` to type `MyCartSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `MyCartSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `MyCartSetLineItemDistributionChannelAction` +- added property `lineItemKey` to type `MyCartSetLineItemShippingDetailsAction` +- added property `lineItemKey` to type `MyCartSetLineItemSupplyChannelAction` +- added property `lineItemKey` to type `MyShoppingListChangeLineItemQuantityAction` +- added property `sku` to type `StandalonePriceDeletedMessage` +- added property `sku` to type `StandalonePriceDeletedMessagePayload` +- added property `key` to type `StagedOrderAddLineItemAction` +- added property `parcelKey` to type `StagedOrderAddParcelToDeliveryAction` +- added property `lineItemKey` to type `StagedOrderChangeLineItemQuantityAction` +- added property `lineItemKey` to type `StagedOrderRemoveLineItemAction` +- added property `parcelKey` to type `StagedOrderRemoveParcelFromDeliveryAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemDistributionChannelAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemPriceAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemShippingDetailsAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemTaxAmountAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemTaxRateAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemTotalPriceAction` +- added property `parcelKey` to type `StagedOrderSetParcelCustomFieldAction` +- added property `parcelKey` to type `StagedOrderSetParcelCustomTypeAction` +- added property `parcelKey` to type `StagedOrderSetParcelItemsAction` +- added property `parcelKey` to type `StagedOrderSetParcelMeasurementsAction` +- added property `parcelKey` to type `StagedOrderSetParcelTrackingDataAction` +- added property `key` to type `Parcel` +- added property `key` to type `ParcelDraft` +- added property `parcelKey` to type `OrderAddParcelToDeliveryAction` +- added property `parcelKey` to type `OrderRemoveParcelFromDeliveryAction` +- added property `lineItemKey` to type `OrderSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `OrderSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `OrderSetLineItemShippingDetailsAction` +- added property `parcelKey` to type `OrderSetParcelCustomFieldAction` +- added property `parcelKey` to type `OrderSetParcelCustomTypeAction` +- added property `parcelKey` to type `OrderSetParcelItemsAction` +- added property `parcelKey` to type `OrderSetParcelMeasurementsAction` +- added property `parcelKey` to type `OrderSetParcelTrackingDataAction` +
+ +
+Required Property(s) + +- changed property `lineItemId` of type `CartApplyDeltaToLineItemShippingDetailsTargetsAction` to be optional +- changed property `lineItemId` of type `CartChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `CartRemoveLineItemAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemDistributionChannelAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemInventoryModeAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemPriceAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemShippingDetailsAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemSupplyChannelAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemTaxAmountAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemTaxRateAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemTotalPriceAction` to be optional +- changed property `lineItemId` of type `MyCartApplyDeltaToLineItemShippingDetailsTargetsAction` to be optional +- changed property `lineItemId` of type `MyCartChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `MyCartRemoveLineItemAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemDistributionChannelAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemShippingDetailsAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemSupplyChannelAction` to be optional +- changed property `lineItemId` of type `MyShoppingListChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `StagedOrderChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `StagedOrderRemoveLineItemAction` to be optional +- changed property `parcelId` of type `StagedOrderRemoveParcelFromDeliveryAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemDistributionChannelAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemPriceAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemShippingDetailsAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemTaxAmountAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemTaxRateAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemTotalPriceAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelCustomFieldAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelCustomTypeAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelItemsAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelMeasurementsAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelTrackingDataAction` to be optional +- changed property `parcelId` of type `OrderRemoveParcelFromDeliveryAction` to be optional +- changed property `lineItemId` of type `OrderSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `OrderSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `OrderSetLineItemShippingDetailsAction` to be optional +- changed property `parcelId` of type `OrderSetParcelCustomFieldAction` to be optional +- changed property `parcelId` of type `OrderSetParcelCustomTypeAction` to be optional +- changed property `parcelId` of type `OrderSetParcelItemsAction` to be optional +- changed property `parcelId` of type `OrderSetParcelMeasurementsAction` to be optional +- changed property `parcelId` of type `OrderSetParcelTrackingDataAction` to be optional +
+ +
+Deprecated Property(s) + +- property `MyCartChangeLineItemQuantityAction::externalPrice` is removed +- property `MyCartChangeLineItemQuantityAction::externalTotalPrice` is removed +
+ +
+Deprecated Type(s) + +- type `ProductVariantSelectionExclusion` is removed +- type `ProductVariantSelectionInclusion` is removed +
+ +
+Removed Type(s) + +- :warning: removed type `MyCartSetDirectDiscountsAction` +
+ +
+Added Type(s) + +- added type `StandalonePriceTierAddedMessage` +- added type `StandalonePriceTierRemovedMessage` +- added type `StandalonePriceTiersSetMessage` +- added type `StandalonePriceValidFromAndUntilSetMessage` +- added type `StandalonePriceValidFromSetMessage` +- added type `StandalonePriceValidUntilSetMessage` +- added type `StandalonePriceTierAddedMessagePayload` +- added type `StandalonePriceTierRemovedMessagePayload` +- added type `StandalonePriceTiersSetMessagePayload` +- added type `StandalonePriceValidFromAndUntilSetMessagePayload` +- added type `StandalonePriceValidFromSetMessagePayload` +- added type `StandalonePriceValidUntilSetMessagePayload` +- added type `StandalonePriceAddPriceTierAction` +- added type `StandalonePriceRemovePriceTierAction` +- added type `StandalonePriceSetPriceTiersAction` +- added type `StandalonePriceSetValidFromAction` +- added type `StandalonePriceSetValidFromAndUntilAction` +- added type `StandalonePriceSetValidUntilAction` +- added type `ConfluentCloudDestination` +
+ +
+Added Enum(s) + +- added enum `associate-role` to type `CustomFieldReferenceValue` +- added enum `business-unit` to type `CustomFieldReferenceValue` +
+ +# Import changes +
+Added Enum(s) + +- added enum `associate-role` to type `CustomFieldReferenceValue` +- added enum `business-unit` to type `CustomFieldReferenceValue` +
+ +# History change + +
+Added Property(s) + +- added property `variantSelection` to type `AddProductChange` +
+ +
+Changed Property(s) + +- :warning: changed property `resource` of type `Record` from type `Reference` to `ResourceIdentifier` +
+ +
+Added QueryParameter(s) + +- added query parameter `resourceKey` to method `get /{projectKey}` +- added query parameter `resourceKey` to method `get /{projectKey}/{resourceType}` +
+ +
+Removed QueryParameter(s) + +- :warning: removed query parameter `resourceId` from method `get /{projectKey}/{resourceType}` +
+ +
+Added Type(s) + +- added type `AddAssociateChange` +- added type `AddProductSelectionChange` +- added type `Associate` +- added type `AssociateRoleAssignment` +- added type `AssociateRoleInheritanceMode` +- added type `BusinessUnitAssociateMode` +- added type `BusinessUnitLabel` +- added type `BusinessUnitStatus` +- added type `BusinessUnitStoreMode` +- added type `ChangeAssociateChange` +- added type `ChangeAssociateModeChange` +- added type `ChangeParentUnitChange` +- added type `ChangeProductSelectionActiveChange` +- added type `ChangeStatusChange` +- added type `ProductVariantSelection` +- added type `ProductVariantSelectionTypeEnum` +- added type `RemoveAssociateChange` +- added type `RemoveProductSelectionChange` +- added type `RequestQuoteRenegotiationChange` +- added type `ResourceIdentifier` +- added type `SetAddressCustomFieldChange` +- added type `SetAddressCustomTypeChange` +- added type `SetContactEmailChange` +- added type `SetStoreModeChange` +- added type `SetVariantSelectionChange` +
+ +
+Added Enum(s) + +- added enum `business-unit` to type `ChangeHistoryResourceType` +- added enum `addAssociate` to type `UpdateType` +- added enum `addCustomLineItem` to type `UpdateType` +- added enum `addDiscountCode` to type `UpdateType` +- added enum `addProduct` to type `UpdateType` +- added enum `addProductSelection` to type `UpdateType` +- added enum `addProperty` to type `UpdateType` +- added enum `changeAmountAuthorized` to type `UpdateType` +- added enum `changeAssociate` to type `UpdateType` +- added enum `changeAssociateMode` to type `UpdateType` +- added enum `changeCustomLineItemQuantity` to type `UpdateType` +- added enum `changeLineItemName` to type `UpdateType` +- added enum `changeParentUnit` to type `UpdateType` +- added enum `changeProductSelectionActive` to type `UpdateType` +- added enum `changeQuoteRequestState` to type `UpdateType` +- added enum `changeQuoteState` to type `UpdateType` +- added enum `changeStagedQuoteState` to type `UpdateType` +- added enum `changeStatus` to type `UpdateType` +- added enum `changeTaxCalculationMode` to type `UpdateType` +- added enum `changeTaxMode` to type `UpdateType` +- added enum `changeTaxRoundingMode` to type `UpdateType` +- added enum `moveImageToPosition` to type `UpdateType` +- added enum `removeAssociate` to type `UpdateType` +- added enum `removeCustomLineItem` to type `UpdateType` +- added enum `removeDiscountCode` to type `UpdateType` +- added enum `removeProduct` to type `UpdateType` +- added enum `removeProductSelection` to type `UpdateType` +- added enum `removeProperty` to type `UpdateType` +- added enum `requestQuoteRenegotiation` to type `UpdateType` +- added enum `setAddressCustomField` to type `UpdateType` +- added enum `setAddressCustomType` to type `UpdateType` +- added enum `setApplicationVersion` to type `UpdateType` +- added enum `setAuthenticationMode` to type `UpdateType` +- added enum `setContactEmail` to type `UpdateType` +- added enum `setCountries` to type `UpdateType` +- added enum `setCountry` to type `UpdateType` +- added enum `setCustomLineItemMoney` to type `UpdateType` +- added enum `setCustomLineItemTaxAmount` to type `UpdateType` +- added enum `setCustomLineItemTaxCategory` to type `UpdateType` +- added enum `setCustomLineItemTaxRate` to type `UpdateType` +- added enum `setCustomLineItemTaxedPrice` to type `UpdateType` +- added enum `setCustomLineItemTotalPrice` to type `UpdateType` +- added enum `setCustomShippingMethod` to type `UpdateType` +- added enum `setIsValid` to type `UpdateType` +- added enum `setLineItemDeactivatedAt` to type `UpdateType` +- added enum `setLineItemDiscountedPrice` to type `UpdateType` +- added enum `setLineItemDiscountedPricePerQuantity` to type `UpdateType` +- added enum `setLineItemDistributionChannel` to type `UpdateType` +- added enum `setLineItemPrice` to type `UpdateType` +- added enum `setLineItemProductKey` to type `UpdateType` +- added enum `setLineItemProductSlug` to type `UpdateType` +- added enum `setLineItemTaxAmount` to type `UpdateType` +- added enum `setLineItemTaxRate` to type `UpdateType` +- added enum `setLineItemTaxedPrice` to type `UpdateType` +- added enum `setLineItemTotalPrice` to type `UpdateType` +- added enum `setOrderTaxedPrice` to type `UpdateType` +- added enum `setOrderTotalPrice` to type `UpdateType` +- added enum `setOrderTotalTax` to type `UpdateType` +- added enum `setPrices` to type `UpdateType` +- added enum `setProductCount` to type `UpdateType` +- added enum `setProductSelections` to type `UpdateType` +- added enum `setProperty` to type `UpdateType` +- added enum `setPurchaseOrderNumber` to type `UpdateType` +- added enum `setReservations` to type `UpdateType` +- added enum `setSellerComment` to type `UpdateType` +- added enum `setShippingInfoPrice` to type `UpdateType` +- added enum `setShippingInfoTaxedPrice` to type `UpdateType` +- added enum `setShippingMethod` to type `UpdateType` +- added enum `setShippingMethodTaxAmount` to type `UpdateType` +- added enum `setShippingMethodTaxRate` to type `UpdateType` +- added enum `setShippingRate` to type `UpdateType` +- added enum `setShippingRateInput` to type `UpdateType` +- added enum `setStoreMode` to type `UpdateType` +- added enum `setSupplyChannels` to type `UpdateType` +- added enum `setValidTo` to type `UpdateType` +- added enum `setValue` to type `UpdateType` +- added enum `setVariantSelection` to type `UpdateType` +- added enum `DeclinedForRenegotiation` to type `QuoteState` +- added enum `associate-role` to type `ReferenceTypeId` +- added enum `business-unit` to type `ReferenceTypeId` +
diff --git a/changes.md b/changes.md index 1864b65dc..9f6b4f7aa 100644 --- a/changes.md +++ b/changes.md @@ -3,87 +3,318 @@
Added Property(s) -- added property `shippingKey` to type `CartSetShippingMethodTaxAmountAction` -- added property `shippingKey` to type `CartSetShippingMethodTaxRateAction` -- added property `deliveryKey` to type `StagedOrderAddDeliveryAction` -- added property `deliveryKey` to type `StagedOrderAddParcelToDeliveryAction` -- added property `deliveryKey` to type `StagedOrderRemoveDeliveryAction` -- added property `deliveryKey` to type `StagedOrderSetDeliveryAddressAction` -- added property `deliveryKey` to type `StagedOrderSetDeliveryAddressCustomFieldAction` -- added property `deliveryKey` to type `StagedOrderSetDeliveryAddressCustomTypeAction` -- added property `deliveryKey` to type `StagedOrderSetDeliveryCustomFieldAction` -- added property `deliveryKey` to type `StagedOrderSetDeliveryCustomTypeAction` -- added property `deliveryKey` to type `StagedOrderSetDeliveryItemsAction` -- added property `shippingKey` to type `StagedOrderSetShippingMethodTaxAmountAction` -- added property `shippingKey` to type `StagedOrderSetShippingMethodTaxRateAction` -- added property `key` to type `Delivery` -- added property `key` to type `DeliveryDraft` -- added property `deliveryKey` to type `OrderAddDeliveryAction` -- added property `deliveryKey` to type `OrderAddParcelToDeliveryAction` -- added property `deliveryKey` to type `OrderRemoveDeliveryAction` -- added property `deliveryKey` to type `OrderSetDeliveryAddressAction` -- added property `deliveryKey` to type `OrderSetDeliveryAddressCustomFieldAction` -- added property `deliveryKey` to type `OrderSetDeliveryAddressCustomTypeAction` -- added property `deliveryKey` to type `OrderSetDeliveryCustomFieldAction` -- added property `deliveryKey` to type `OrderSetDeliveryCustomTypeAction` -- added property `deliveryKey` to type `OrderSetDeliveryItemsAction` -- added property `sku` to type `ProductRemovePriceAction` -- added property `variantId` to type `ProductRemovePriceAction` -- added property `price` to type `ProductRemovePriceAction` +- added property `perMethodTaxRate` to type `CustomLineItem` +- added property `key` to type `LineItem` +- added property `key` to type `LineItemDraft` +- added property `key` to type `CartAddLineItemAction` +- added property `lineItemKey` to type `CartApplyDeltaToLineItemShippingDetailsTargetsAction` +- added property `lineItemKey` to type `CartChangeLineItemQuantityAction` +- added property `lineItemKey` to type `CartRemoveLineItemAction` +- added property `lineItemKey` to type `CartSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `CartSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `CartSetLineItemDistributionChannelAction` +- added property `lineItemKey` to type `CartSetLineItemInventoryModeAction` +- added property `lineItemKey` to type `CartSetLineItemPriceAction` +- added property `lineItemKey` to type `CartSetLineItemShippingDetailsAction` +- added property `lineItemKey` to type `CartSetLineItemSupplyChannelAction` +- added property `lineItemKey` to type `CartSetLineItemTaxAmountAction` +- added property `lineItemKey` to type `CartSetLineItemTaxRateAction` +- added property `lineItemKey` to type `CartSetLineItemTotalPriceAction` +- added property `key` to type `MyLineItemDraft` +- added property `key` to type `MyCartAddLineItemAction` +- added property `lineItemKey` to type `MyCartApplyDeltaToLineItemShippingDetailsTargetsAction` +- added property `lineItemKey` to type `MyCartChangeLineItemQuantityAction` +- added property `lineItemKey` to type `MyCartRemoveLineItemAction` +- added property `lineItemKey` to type `MyCartSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `MyCartSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `MyCartSetLineItemDistributionChannelAction` +- added property `lineItemKey` to type `MyCartSetLineItemShippingDetailsAction` +- added property `lineItemKey` to type `MyCartSetLineItemSupplyChannelAction` +- added property `lineItemKey` to type `MyShoppingListChangeLineItemQuantityAction` +- added property `sku` to type `StandalonePriceDeletedMessage` +- added property `sku` to type `StandalonePriceDeletedMessagePayload` +- added property `key` to type `StagedOrderAddLineItemAction` +- added property `parcelKey` to type `StagedOrderAddParcelToDeliveryAction` +- added property `lineItemKey` to type `StagedOrderChangeLineItemQuantityAction` +- added property `lineItemKey` to type `StagedOrderRemoveLineItemAction` +- added property `parcelKey` to type `StagedOrderRemoveParcelFromDeliveryAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemDistributionChannelAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemPriceAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemShippingDetailsAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemTaxAmountAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemTaxRateAction` +- added property `lineItemKey` to type `StagedOrderSetLineItemTotalPriceAction` +- added property `parcelKey` to type `StagedOrderSetParcelCustomFieldAction` +- added property `parcelKey` to type `StagedOrderSetParcelCustomTypeAction` +- added property `parcelKey` to type `StagedOrderSetParcelItemsAction` +- added property `parcelKey` to type `StagedOrderSetParcelMeasurementsAction` +- added property `parcelKey` to type `StagedOrderSetParcelTrackingDataAction` +- added property `key` to type `Parcel` +- added property `key` to type `ParcelDraft` +- added property `parcelKey` to type `OrderAddParcelToDeliveryAction` +- added property `parcelKey` to type `OrderRemoveParcelFromDeliveryAction` +- added property `lineItemKey` to type `OrderSetLineItemCustomFieldAction` +- added property `lineItemKey` to type `OrderSetLineItemCustomTypeAction` +- added property `lineItemKey` to type `OrderSetLineItemShippingDetailsAction` +- added property `parcelKey` to type `OrderSetParcelCustomFieldAction` +- added property `parcelKey` to type `OrderSetParcelCustomTypeAction` +- added property `parcelKey` to type `OrderSetParcelItemsAction` +- added property `parcelKey` to type `OrderSetParcelMeasurementsAction` +- added property `parcelKey` to type `OrderSetParcelTrackingDataAction`
Required Property(s) -- changed property `deliveryId` of type `StagedOrderAddParcelToDeliveryAction` to be optional -- changed property `deliveryId` of type `StagedOrderRemoveDeliveryAction` to be optional -- changed property `deliveryId` of type `StagedOrderSetDeliveryAddressAction` to be optional -- changed property `deliveryId` of type `StagedOrderSetDeliveryAddressCustomFieldAction` to be optional -- changed property `deliveryId` of type `StagedOrderSetDeliveryAddressCustomTypeAction` to be optional -- changed property `deliveryId` of type `StagedOrderSetDeliveryCustomFieldAction` to be optional -- changed property `deliveryId` of type `StagedOrderSetDeliveryCustomTypeAction` to be optional -- changed property `deliveryId` of type `StagedOrderSetDeliveryItemsAction` to be optional -- changed property `deliveryId` of type `OrderAddParcelToDeliveryAction` to be optional -- changed property `deliveryId` of type `OrderRemoveDeliveryAction` to be optional -- changed property `deliveryId` of type `OrderSetDeliveryAddressAction` to be optional -- changed property `deliveryId` of type `OrderSetDeliveryAddressCustomFieldAction` to be optional -- changed property `deliveryId` of type `OrderSetDeliveryAddressCustomTypeAction` to be optional -- changed property `deliveryId` of type `OrderSetDeliveryCustomFieldAction` to be optional -- changed property `deliveryId` of type `OrderSetDeliveryCustomTypeAction` to be optional -- changed property `deliveryId` of type `OrderSetDeliveryItemsAction` to be optional +- changed property `lineItemId` of type `CartApplyDeltaToLineItemShippingDetailsTargetsAction` to be optional +- changed property `lineItemId` of type `CartChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `CartRemoveLineItemAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemDistributionChannelAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemInventoryModeAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemPriceAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemShippingDetailsAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemSupplyChannelAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemTaxAmountAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemTaxRateAction` to be optional +- changed property `lineItemId` of type `CartSetLineItemTotalPriceAction` to be optional +- changed property `lineItemId` of type `MyCartApplyDeltaToLineItemShippingDetailsTargetsAction` to be optional +- changed property `lineItemId` of type `MyCartChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `MyCartRemoveLineItemAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemDistributionChannelAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemShippingDetailsAction` to be optional +- changed property `lineItemId` of type `MyCartSetLineItemSupplyChannelAction` to be optional +- changed property `lineItemId` of type `MyShoppingListChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `StagedOrderChangeLineItemQuantityAction` to be optional +- changed property `lineItemId` of type `StagedOrderRemoveLineItemAction` to be optional +- changed property `parcelId` of type `StagedOrderRemoveParcelFromDeliveryAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemDistributionChannelAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemPriceAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemShippingDetailsAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemTaxAmountAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemTaxRateAction` to be optional +- changed property `lineItemId` of type `StagedOrderSetLineItemTotalPriceAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelCustomFieldAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelCustomTypeAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelItemsAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelMeasurementsAction` to be optional +- changed property `parcelId` of type `StagedOrderSetParcelTrackingDataAction` to be optional +- changed property `parcelId` of type `OrderRemoveParcelFromDeliveryAction` to be optional +- changed property `lineItemId` of type `OrderSetLineItemCustomFieldAction` to be optional +- changed property `lineItemId` of type `OrderSetLineItemCustomTypeAction` to be optional +- changed property `lineItemId` of type `OrderSetLineItemShippingDetailsAction` to be optional +- changed property `parcelId` of type `OrderSetParcelCustomFieldAction` to be optional +- changed property `parcelId` of type `OrderSetParcelCustomTypeAction` to be optional +- changed property `parcelId` of type `OrderSetParcelItemsAction` to be optional +- changed property `parcelId` of type `OrderSetParcelMeasurementsAction` to be optional +- changed property `parcelId` of type `OrderSetParcelTrackingDataAction` to be optional +
+ +
+Deprecated Property(s) + +- property `MyCartChangeLineItemQuantityAction::externalPrice` is removed +- property `MyCartChangeLineItemQuantityAction::externalTotalPrice` is removed +
+ +
+Deprecated Type(s) + +- type `ProductVariantSelectionExclusion` is removed +- type `ProductVariantSelectionInclusion` is removed +
+ +
+Removed Type(s) + +- :warning: removed type `MyCartSetDirectDiscountsAction`
Added Type(s) -- added type `CartSetLineItemInventoryModeAction` -- added type `MoneyOverflowError` -- added type `GraphQLMoneyOverflowError` -- added type `MyCartSetDirectDiscountsAction` -- added type `QuoteCustomerChangedMessage` -- added type `QuoteRequestCustomerChangedMessage` -- added type `QuoteCustomerChangedMessagePayload` -- added type `QuoteRequestCustomerChangedMessagePayload` -- added type `QuoteRequestChangeCustomerAction` -- added type `QuoteChangeCustomerAction` +- added type `StandalonePriceTierAddedMessage` +- added type `StandalonePriceTierRemovedMessage` +- added type `StandalonePriceTiersSetMessage` +- added type `StandalonePriceValidFromAndUntilSetMessage` +- added type `StandalonePriceValidFromSetMessage` +- added type `StandalonePriceValidUntilSetMessage` +- added type `StandalonePriceTierAddedMessagePayload` +- added type `StandalonePriceTierRemovedMessagePayload` +- added type `StandalonePriceTiersSetMessagePayload` +- added type `StandalonePriceValidFromAndUntilSetMessagePayload` +- added type `StandalonePriceValidFromSetMessagePayload` +- added type `StandalonePriceValidUntilSetMessagePayload` +- added type `StandalonePriceAddPriceTierAction` +- added type `StandalonePriceRemovePriceTierAction` +- added type `StandalonePriceSetPriceTiersAction` +- added type `StandalonePriceSetValidFromAction` +- added type `StandalonePriceSetValidFromAndUntilAction` +- added type `StandalonePriceSetValidUntilAction` +- added type `ConfluentCloudDestination`
-Added Resource(s) +Added Enum(s) -- added resource `/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate` +- added enum `associate-role` to type `CustomFieldReferenceValue` +- added enum `business-unit` to type `CustomFieldReferenceValue`
+**Import changes** +
Added Enum(s) -- added enum `ReassignMyQuotes` to type `Permission` -- added enum `ReassignOthersQuotes` to type `Permission` -- added enum `RenegotiationAddressed` to type `QuoteState` +- added enum `associate-role` to type `CustomFieldReferenceValue` +- added enum `business-unit` to type `CustomFieldReferenceValue` +
+ +**History changes** + +
+Added Property(s) + +- added property `variantSelection` to type `AddProductChange` +
+ +
+Changed Property(s) + +- :warning: changed property `resource` of type `Record` from type `Reference` to `ResourceIdentifier`
-Added Method(s) +Added QueryParameter(s) + +- added query parameter `resourceKey` to method `get /{projectKey}` +- added query parameter `resourceKey` to method `get /{projectKey}/{resourceType}` +
+ +
+Removed QueryParameter(s) + +- :warning: removed query parameter `resourceId` from method `get /{projectKey}/{resourceType}` +
+ +
+Added Type(s) + +- added type `AddAssociateChange` +- added type `AddProductSelectionChange` +- added type `Associate` +- added type `AssociateRoleAssignment` +- added type `AssociateRoleInheritanceMode` +- added type `BusinessUnitAssociateMode` +- added type `BusinessUnitLabel` +- added type `BusinessUnitStatus` +- added type `BusinessUnitStoreMode` +- added type `ChangeAssociateChange` +- added type `ChangeAssociateModeChange` +- added type `ChangeParentUnitChange` +- added type `ChangeProductSelectionActiveChange` +- added type `ChangeStatusChange` +- added type `ProductVariantSelection` +- added type `ProductVariantSelectionTypeEnum` +- added type `RemoveAssociateChange` +- added type `RemoveProductSelectionChange` +- added type `RequestQuoteRenegotiationChange` +- added type `ResourceIdentifier` +- added type `SetAddressCustomFieldChange` +- added type `SetAddressCustomTypeChange` +- added type `SetContactEmailChange` +- added type `SetStoreModeChange` +- added type `SetVariantSelectionChange` +
+ +
+Added Enum(s) -- added method `apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().replicate().post()` +- added enum `business-unit` to type `ChangeHistoryResourceType` +- added enum `addAssociate` to type `UpdateType` +- added enum `addCustomLineItem` to type `UpdateType` +- added enum `addDiscountCode` to type `UpdateType` +- added enum `addProduct` to type `UpdateType` +- added enum `addProductSelection` to type `UpdateType` +- added enum `addProperty` to type `UpdateType` +- added enum `changeAmountAuthorized` to type `UpdateType` +- added enum `changeAssociate` to type `UpdateType` +- added enum `changeAssociateMode` to type `UpdateType` +- added enum `changeCustomLineItemQuantity` to type `UpdateType` +- added enum `changeLineItemName` to type `UpdateType` +- added enum `changeParentUnit` to type `UpdateType` +- added enum `changeProductSelectionActive` to type `UpdateType` +- added enum `changeQuoteRequestState` to type `UpdateType` +- added enum `changeQuoteState` to type `UpdateType` +- added enum `changeStagedQuoteState` to type `UpdateType` +- added enum `changeStatus` to type `UpdateType` +- added enum `changeTaxCalculationMode` to type `UpdateType` +- added enum `changeTaxMode` to type `UpdateType` +- added enum `changeTaxRoundingMode` to type `UpdateType` +- added enum `moveImageToPosition` to type `UpdateType` +- added enum `removeAssociate` to type `UpdateType` +- added enum `removeCustomLineItem` to type `UpdateType` +- added enum `removeDiscountCode` to type `UpdateType` +- added enum `removeProduct` to type `UpdateType` +- added enum `removeProductSelection` to type `UpdateType` +- added enum `removeProperty` to type `UpdateType` +- added enum `requestQuoteRenegotiation` to type `UpdateType` +- added enum `setAddressCustomField` to type `UpdateType` +- added enum `setAddressCustomType` to type `UpdateType` +- added enum `setApplicationVersion` to type `UpdateType` +- added enum `setAuthenticationMode` to type `UpdateType` +- added enum `setContactEmail` to type `UpdateType` +- added enum `setCountries` to type `UpdateType` +- added enum `setCountry` to type `UpdateType` +- added enum `setCustomLineItemMoney` to type `UpdateType` +- added enum `setCustomLineItemTaxAmount` to type `UpdateType` +- added enum `setCustomLineItemTaxCategory` to type `UpdateType` +- added enum `setCustomLineItemTaxRate` to type `UpdateType` +- added enum `setCustomLineItemTaxedPrice` to type `UpdateType` +- added enum `setCustomLineItemTotalPrice` to type `UpdateType` +- added enum `setCustomShippingMethod` to type `UpdateType` +- added enum `setIsValid` to type `UpdateType` +- added enum `setLineItemDeactivatedAt` to type `UpdateType` +- added enum `setLineItemDiscountedPrice` to type `UpdateType` +- added enum `setLineItemDiscountedPricePerQuantity` to type `UpdateType` +- added enum `setLineItemDistributionChannel` to type `UpdateType` +- added enum `setLineItemPrice` to type `UpdateType` +- added enum `setLineItemProductKey` to type `UpdateType` +- added enum `setLineItemProductSlug` to type `UpdateType` +- added enum `setLineItemTaxAmount` to type `UpdateType` +- added enum `setLineItemTaxRate` to type `UpdateType` +- added enum `setLineItemTaxedPrice` to type `UpdateType` +- added enum `setLineItemTotalPrice` to type `UpdateType` +- added enum `setOrderTaxedPrice` to type `UpdateType` +- added enum `setOrderTotalPrice` to type `UpdateType` +- added enum `setOrderTotalTax` to type `UpdateType` +- added enum `setPrices` to type `UpdateType` +- added enum `setProductCount` to type `UpdateType` +- added enum `setProductSelections` to type `UpdateType` +- added enum `setProperty` to type `UpdateType` +- added enum `setPurchaseOrderNumber` to type `UpdateType` +- added enum `setReservations` to type `UpdateType` +- added enum `setSellerComment` to type `UpdateType` +- added enum `setShippingInfoPrice` to type `UpdateType` +- added enum `setShippingInfoTaxedPrice` to type `UpdateType` +- added enum `setShippingMethod` to type `UpdateType` +- added enum `setShippingMethodTaxAmount` to type `UpdateType` +- added enum `setShippingMethodTaxRate` to type `UpdateType` +- added enum `setShippingRate` to type `UpdateType` +- added enum `setShippingRateInput` to type `UpdateType` +- added enum `setStoreMode` to type `UpdateType` +- added enum `setSupplyChannels` to type `UpdateType` +- added enum `setValidTo` to type `UpdateType` +- added enum `setValue` to type `UpdateType` +- added enum `setVariantSelection` to type `UpdateType` +- added enum `DeclinedForRenegotiation` to type `QuoteState` +- added enum `associate-role` to type `ReferenceTypeId` +- added enum `business-unit` to type `ReferenceTypeId`
diff --git a/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-by-id-request-builder.ts b/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-by-id-request-builder.ts index 6991c6a6b..5024c0a28 100644 --- a/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-by-id-request-builder.ts +++ b/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-by-id-request-builder.ts @@ -23,6 +23,9 @@ export class ByProjectKeyByResourceTypeByIDRequestBuilder { baseUri?: string } ) {} + /** + * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted. + */ public get(methodArgs?: { queryArgs?: { 'date.from'?: any diff --git a/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-request-builder.ts b/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-request-builder.ts index 46287b66b..fc3ee8938 100644 --- a/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-request-builder.ts +++ b/packages/history-sdk/src/generated/client/by-project-key-by-resource-type-request-builder.ts @@ -36,6 +36,9 @@ export class ByProjectKeyByResourceTypeRequestBuilder { }) } + /** + * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted. + */ public get(methodArgs?: { queryArgs?: { 'date.from'?: any @@ -45,7 +48,7 @@ export class ByProjectKeyByResourceTypeRequestBuilder { userId?: string type?: string clientId?: string - resourceId?: string + resourceKey?: string source?: string changes?: string | string[] stores?: string | string[] diff --git a/packages/history-sdk/src/generated/client/by-project-key-request-builder.ts b/packages/history-sdk/src/generated/client/by-project-key-request-builder.ts index d7160a639..47acee3d8 100644 --- a/packages/history-sdk/src/generated/client/by-project-key-request-builder.ts +++ b/packages/history-sdk/src/generated/client/by-project-key-request-builder.ts @@ -36,6 +36,9 @@ export class ByProjectKeyRequestBuilder { }) } + /** + * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted. + */ public get(methodArgs?: { queryArgs?: { resourceTypes?: ChangeHistoryResourceType | ChangeHistoryResourceType[] @@ -47,6 +50,7 @@ export class ByProjectKeyRequestBuilder { type?: string clientId?: string resourceId?: string + resourceKey?: string source?: string changes?: string | string[] stores?: string | string[] diff --git a/packages/history-sdk/src/generated/models/change-history.ts b/packages/history-sdk/src/generated/models/change-history.ts index b73bac2d1..d89e7bf21 100644 --- a/packages/history-sdk/src/generated/models/change-history.ts +++ b/packages/history-sdk/src/generated/models/change-history.ts @@ -5,18 +5,22 @@ */ import { Change } from './change' -import { KeyReference, Reference } from './common' +import { KeyReference, Reference, ResourceIdentifier } from './common' import { Label } from './label' /** - * A Record captures the differences in a resource between one version and the next. - * (Recall that the version number is not always incremented by one; see [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control).) + * Captures the differences between the previous and next version of a resource. + * + * The maximum number of Records that can be stored and their retention period are subject to a [limit](/../api/limits#records). * */ export interface Record { /** * Version of the resource after the change. * + * For more information on how the version is incremented, see [Optimistic Concurrency Control](/../api/general-concepts#optimistic-concurrency-control). + * + * */ readonly version: number /** @@ -25,17 +29,19 @@ export interface Record { */ readonly previousVersion: number /** - * Type of the change (creation, update or deletion). + * Indicates the type of change. + * For creation, update, or deletion, the value is `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"` respectively. + * * */ readonly type: string /** - * Information about the user or the API client who performed the change. + * Information about the user or API Client who performed the change. * */ readonly modifiedBy: ModifiedBy /** - * Date and time when the change was made. + * Date and time (UTC) when the change was made. * */ readonly modifiedAt: string @@ -51,25 +57,27 @@ export interface Record { readonly previousLabel: Label /** * Shows the differences in the resource between `previousVersion` and `version`. + * * The value is not identical to the actual array of update actions sent and is not limited to update actions (see, for example, [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control)). * * */ readonly changes: Change[] /** - * Reference to the changed resource. + * ResourceIdentifier of the changed resource. * * */ - readonly resource: Reference + readonly resource: ResourceIdentifier /** - * References to the [Stores](ctp:api:type:Store) attached to the [Change](ctp:history:type:Change). + * References to the [Stores](ctp:api:type:Store) associated with the [Change](ctp:history:type:Change). * * */ readonly stores: KeyReference[] /** * `true` if no change was detected. + * * The version number of the resource can be increased even without any change in the resource. * * @@ -77,7 +85,7 @@ export interface Record { readonly withoutChanges: boolean } /** - * Response to a query request for [Record](#record). + * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Record](ctp:history:type:Record). * */ export interface RecordPagedQueryResponse { @@ -95,7 +103,7 @@ export interface RecordPagedQueryResponse { readonly count: number /** * Total number of results matching the query. - * This number is an estimation and not [strongly consistent](/general-concepts#strong-consistency). + * This number is an estimation and not [strongly consistent](/../api/general-concepts#strong-consistency). * * */ @@ -107,6 +115,8 @@ export interface RecordPagedQueryResponse { */ readonly offset: number /** + * Records matching the query. + * * */ readonly results: Record[] @@ -117,6 +127,7 @@ export interface RecordPagedQueryResponse { * */ export type ChangeHistoryResourceType = + | 'business-unit' | 'cart-discount' | 'category' | 'channel' @@ -180,56 +191,59 @@ export interface ErrorResponse { readonly errors?: ErrorObject[] } /** - * Information about the user or the API client who performed the change. This is a variant of - * [LastModifiedBy](/types#lastmodifiedby). + * Information about the user or API Client who performed the change. This is a variant of [LastModifiedBy](ctp:api:type:LastModifiedBy). * */ export interface ModifiedBy { /** * [ID](/general-concepts#identifier) of the Merchant Center user who made the change. + * * Present only if the change was made in the Merchant Center. * * */ readonly id: string /** - * Indicates whether the change was made by a user or the API client with or without an - * [External user ID](/client-logging#external-user-ids). + * Indicates who performed the change. + * + * - If the change was made by a user, the value is `"user"`. + * - If the change was made by an API Client with or without an [external user ID](/client-logging#external-user-ids), the value is `"external-user"`. * * */ readonly type: string /** - * [Reference](/types#reference) to the - * [Customer](/projects/customers#customer) who made the change. Present only if - * the change was made using a token from the [Password - * Flow](/authorization#password-flow). + * [Reference](ctp:api:type:Reference) to the [Customer](ctp:api:type:Customer) who made the change. + * + * Present only if the change was made using a token from the [password flow](/authorization#password-flow). * * */ readonly customer?: Reference /** - * Present only if the change was made using a token from an [Anonymous - * Session](/authorization#tokens-for-anonymous-sessions). + * Present only if the change was made using a token from an [anonymous session](/authorization#tokens-for-anonymous-sessions). * * */ readonly anonymousId?: string /** - * [ID](/general-concepts#identifier) of the [API - * Client](/projects/api-clients#apiclient) that made the change. Present only if - * the change was made using an API Client. + * [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change. + * + * Present only if the change was made using an API Client. * * */ readonly clientId?: string /** - * `true` if the change was made via Merchant Center or [ImpEx](https://impex.europe-west1.gcp.commercetools.com/). + * `true` if the change was made using the Merchant Center or [ImpEx](https://impex.europe-west1.gcp.commercetools.com/). * * */ readonly isPlatformClient: boolean } +/** + * Updates that are triggered automatically as a result of a user-initiated change. + */ export type PlatformInitiatedChange = | 'changeLineItemName' | 'changeReviewRatingStatistics' @@ -245,9 +259,12 @@ export type Source = 'ApiClient' | 'ImpEx' | 'MerchantCenter' | string export type UpdateType = | 'addAddress' | 'addAsset' + | 'addAssociate' | 'addAttributeDefinition' | 'addBillingAddressId' + | 'addCustomLineItem' | 'addDelivery' + | 'addDiscountCode' | 'addEnumValue' | 'addExternalImage' | 'addFieldDefinition' @@ -260,6 +277,9 @@ export type UpdateType = | 'addPayment' | 'addPlainEnumValue' | 'addPrice' + | 'addProduct' + | 'addProductSelection' + | 'addProperty' | 'addReturnInfo' | 'addRoles' | 'addShippingAddressId' @@ -269,14 +289,18 @@ export type UpdateType = | 'addTransaction' | 'addVariant' | 'changeAddress' + | 'changeAmountAuthorized' | 'changeAmountPlanned' | 'changeAssetName' | 'changeAssetOrder' + | 'changeAssociate' + | 'changeAssociateMode' | 'changeAttributeConstraint' | 'changeAttributeName' | 'changeAttributeOrderByName' | 'changeCartDiscounts' | 'changeCartPredicate' + | 'changeCustomLineItemQuantity' | 'changeDescription' | 'changeEmail' | 'changeEnumKey' @@ -290,6 +314,7 @@ export type UpdateType = | 'changeIsSearchable' | 'changeKey' | 'changeLabel' + | 'changeLineItemName' | 'changeLineItemQuantity' | 'changeLineItemsOrder' | 'changeLocalizedEnumValueLabel' @@ -299,18 +324,27 @@ export type UpdateType = | 'changeOrderHint' | 'changeOrderState' | 'changeParent' + | 'changeParentUnit' | 'changePaymentState' | 'changePlainEnumValueLabel' | 'changePredicate' | 'changePrice' + | 'changeProductSelectionActive' | 'changeQuantity' + | 'changeQuoteRequestState' + | 'changeQuoteState' | 'changeRequiresDiscountCode' | 'changeReviewRatingStatistics' | 'changeShipmentState' | 'changeSlug' | 'changeSortOrder' | 'changeStackingMode' + | 'changeStagedQuoteState' + | 'changeStatus' | 'changeTarget' + | 'changeTaxCalculationMode' + | 'changeTaxMode' + | 'changeTaxRoundingMode' | 'changeTextLineItemName' | 'changeTextLineItemQuantity' | 'changeTextLineItemsOrder' @@ -319,12 +353,16 @@ export type UpdateType = | 'changeTransactionTimestamp' | 'changeType' | 'changeValue' + | 'moveImageToPosition' | 'publish' | 'removeAddress' | 'removeAsset' + | 'removeAssociate' | 'removeAttributeDefinition' | 'removeBillingAddressId' + | 'removeCustomLineItem' | 'removeDelivery' + | 'removeDiscountCode' | 'removeEnumValues' | 'removeFieldDefinition' | 'removeFromCategory' @@ -335,13 +373,20 @@ export type UpdateType = | 'removeParcelFromDelivery' | 'removePayment' | 'removePrice' + | 'removeProduct' + | 'removeProductSelection' + | 'removeProperty' | 'removeRoles' | 'removeShippingAddressId' | 'removeTaxRate' | 'removeTextLineItem' | 'removeVariant' + | 'requestQuoteRenegotiation' | 'setAddress' + | 'setAddressCustomField' + | 'setAddressCustomType' | 'setAnonymousId' + | 'setApplicationVersion' | 'setAssetCustomField' | 'setAssetCustomType' | 'setAssetDescription' @@ -349,15 +394,26 @@ export type UpdateType = | 'setAssetTags' | 'setAsssetKey' | 'setAttribute' + | 'setAuthenticationMode' | 'setAuthorName' | 'setBillingAddress' | 'setCartPredicate' | 'setCategoryOrderHint' | 'setCompanyName' + | 'setContactEmail' + | 'setCountries' + | 'setCountry' | 'setCustomField' | 'setCustomLineItemCustomField' | 'setCustomLineItemCustomType' + | 'setCustomLineItemMoney' | 'setCustomLineItemShippingDetails' + | 'setCustomLineItemTaxAmount' + | 'setCustomLineItemTaxCategory' + | 'setCustomLineItemTaxRate' + | 'setCustomLineItemTaxedPrice' + | 'setCustomLineItemTotalPrice' + | 'setCustomShippingMethod' | 'setCustomType' | 'setCustomer' | 'setCustomerEmail' @@ -380,12 +436,24 @@ export type UpdateType = | 'setImageLabel' | 'setInputTip' | 'setInterfaceId' + | 'setIsValid' | 'setKey' | 'setLanguages' | 'setLastName' | 'setLineItemCustomField' | 'setLineItemCustomType' + | 'setLineItemDeactivatedAt' + | 'setLineItemDiscountedPrice' + | 'setLineItemDiscountedPricePerQuantity' + | 'setLineItemDistributionChannel' + | 'setLineItemPrice' + | 'setLineItemProductKey' + | 'setLineItemProductSlug' | 'setLineItemShippingDetails' + | 'setLineItemTaxAmount' + | 'setLineItemTaxRate' + | 'setLineItemTaxedPrice' + | 'setLineItemTotalPrice' | 'setLocale' | 'setMaxApplications' | 'setMaxApplicationsPerCustomer' @@ -398,28 +466,47 @@ export type UpdateType = | 'setMiddleName' | 'setName' | 'setOrderNumber' + | 'setOrderTaxedPrice' + | 'setOrderTotalPrice' + | 'setOrderTotalTax' | 'setParcelItems' | 'setParcelMeasurements' | 'setParcelTrackingData' | 'setPassword' + | 'setPrices' + | 'setProductCount' | 'setProductPriceCustomField' | 'setProductPriceCustomType' + | 'setProductSelections' | 'setProductVariantKey' + | 'setProperty' + | 'setPurchaseOrderNumber' | 'setRating' + | 'setReservations' | 'setRestockableInDays' | 'setReturnPaymentState' | 'setReturnShipmentState' | 'setRoles' | 'setSalutation' | 'setSearchKeywords' + | 'setSellerComment' | 'setShippingAddress' + | 'setShippingInfoPrice' + | 'setShippingInfoTaxedPrice' + | 'setShippingMethod' + | 'setShippingMethodTaxAmount' + | 'setShippingMethodTaxRate' + | 'setShippingRate' + | 'setShippingRateInput' | 'setSku' | 'setSlug' | 'setStatusInterfaceCode' | 'setStatusInterfaceText' | 'setStore' + | 'setStoreMode' | 'setStores' | 'setSupplyChannel' + | 'setSupplyChannels' | 'setTarget' | 'setTaxCategory' | 'setText' @@ -430,8 +517,11 @@ export type UpdateType = | 'setTransitions' | 'setValidFrom' | 'setValidFromAndUntil' + | 'setValidTo' | 'setValidUntil' + | 'setValue' | 'setVariantAvailability' + | 'setVariantSelection' | 'setVatId' | 'transitionCustomLineItemState' | 'transitionLineItemState' diff --git a/packages/history-sdk/src/generated/models/change-value.ts b/packages/history-sdk/src/generated/models/change-value.ts index 30e39103a..a67d16868 100644 --- a/packages/history-sdk/src/generated/models/change-value.ts +++ b/packages/history-sdk/src/generated/models/change-value.ts @@ -29,345 +29,372 @@ export type ChangeValueChangeValue = | ChangeValueRelativeChangeValue export interface AssetChangeValue { /** + * `id` of the [Asset](ctp:api:type:Asset). + * * */ readonly id: string /** + * Name of the Asset. * */ readonly name: LocalizedString } export interface AttributeValue { /** + * Name of the Attribute set. * */ readonly name: string /** + * Value set for the Attribute determined by the [AttributeType](ctp:api:type:AttributeType): + * + * - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType), `value` is the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects, + * or the complete objects. + * - For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), `value` is the [LocalizedString](ctp:api:type:LocalizedString) object. + * - For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, `value` is the [Money](ctp:api:type:Money) object. + * - For [Set Type](ctp:api:type:AttributeSetType) Attributes, `value` is the entire `set` object. + * - For [Nested Type](ctp:api:type:AttributeNestedType) Attributes, `value` is the list of values of all Attributes of the nested Product. + * - For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, `value` is the [Reference](ctp:api:type:Reference) object. + * * */ readonly value: any } -/** - * Shape of the value for cart discounts line item and custom line items target. - */ export interface ChangeTargetCustomLineItemsChangeValue { readonly type: 'customLineItems' /** + * Valid [CustomLineItem target predicate](/../api/projects/predicates#customlineitem-field-identifiers). * */ readonly predicate: string } -/** - * Shape of the value for cart discounts line item target. - */ export interface ChangeTargetLineItemsChangeValue { readonly type: 'lineItems' /** + * Valid [LineItem target predicate](/../api/projects/predicates#lineitem-field-identifiers). * */ readonly predicate: string } -/** - * Shape of the value for cart discounts multiBuyCustomLineItems target. - */ export interface ChangeTargetMultiBuyCustomLineItemsChangeValue { readonly type: 'multiBuyCustomLineItems' /** + * Valid [CustomLineItem target predicate](/../api/projects/predicates#customlineitem-field-identifiers). * */ readonly predicate: string /** - * Quantity of line items that need to be present in order to trigger an application of this discount. + * Quantity of Custom Line Items that triggered the application of the discount. * */ readonly triggerQuantity: number /** - * Quantity of line items that are discounted per application of this discount. + * Quantity of Custom Line Items discounted per application of this discount. * */ readonly discountedQuantity: number /** - * Maximum number of applications of this discount. + * Maximum number of times the discount is applicable. * */ readonly maxOccurrence: number /** + * SelectionMode based on which particular Custom Line Items were discounted. * */ readonly selectionMode: SelectionMode } -/** - * Shape of the value for cart discounts multiBuyLineItems target. - */ export interface ChangeTargetMultiBuyLineItemsChangeValue { readonly type: 'multiBuyLineItems' /** + * Valid [LineItem target predicate](/../api/projects/predicates#lineitem-field-identifiers). * */ readonly predicate: string /** - * Quantity of line items that need to be present in order to trigger an application of this discount. + * Quantity of Line Items that triggered the application of the discount. * */ readonly triggerQuantity: number /** - * Quantity of line items that are discounted per application of this discount. + * Quantity of Line Items discounted per application of this discount. * */ readonly discountedQuantity: number /** - * Maximum number of applications of this discount. + * Maximum number of times the discount is applicable. * */ readonly maxOccurrence: number /** + * SelectionMode based on which particular Line Items were discounted. * */ readonly selectionMode: SelectionMode } -/** - * Shape of the value for cart discounts shipping target. - */ export interface ChangeTargetShippingChangeValue { readonly type: 'shipping' } -/** - * Shape of the value for cart discounts absolute value. - */ export interface ChangeValueAbsoluteChangeValue { readonly type: 'absolute' /** + * Money values in different currencies. * */ readonly money: Money[] } -/** - * Shape of the value for product discounts external value. - */ export interface ChangeValueExternalChangeValue { readonly type: 'external' } -/** - * Shape of the value for cart discounts gift line item value. - */ export interface ChangeValueGiftLineItemChangeValue { readonly type: 'giftLineItem' /** + * Reference to a [Product](ctp:api:type:Product). * */ readonly product: Reference /** + * `id` of the [ProductVariant](ctp:api:type:ProductVariant). + * * */ readonly variantId: number /** + * Channel with [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum) `InventorySupply`. * */ readonly supplyChannel?: Reference /** + * Channel with [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum) `ProductDistribution`. * */ readonly distributionChannel: Reference } -/** - * Shape of the value for cart discounts relative value. - */ export interface ChangeValueRelativeChangeValue { readonly type: 'relative' /** + * Fraction (per ten thousand) the price is reduced by. For example, 1000 results in a 10% price reduction. * */ readonly permyriad: number } /** - * Only available if `expand` is set to true + * Only present if `expand` is set to `true`. */ export interface CustomFieldExpandedValue { /** - * Name of a custom field. + * Name of the Custom Field. * */ readonly name: string /** + * [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). + * * */ readonly value: any /** + * User-defined label of the Custom Field. * */ readonly label: LocalizedString } export interface CustomShippingMethodChangeValue { /** + * Name of the Custom ShippingMethod. * */ readonly name: string } export interface DeliveryChangeValue { /** + * Line Items or Custom Line Items shipped in the [Delivery](ctp:api:type:Delivery). * */ readonly items: DeliveryItem[] /** + * Address to which the parcels are delivered. * */ readonly address: Address /** + * Parcels included in the [Delivery](ctp:api:type:Delivery). * */ readonly parcels: Parcel[] } export interface EnumValue { /** + * Key of the value used as a programmatic identifier. * */ readonly key: string /** + * Descriptive label of the value. * */ readonly label: string } -/** - * Shape of the value for action `changeFieldDefinitionOrder` - */ export interface FieldDefinitionOrderValue { /** + * Name of the [FieldDefinition](ctp:api:type:FieldDefinition). * */ readonly name: string /** + * Descriptive label of the field. * */ readonly label: LocalizedString } export interface InventoryQuantityValue { /** + * Overall amount of stock (`availableQuantity` + reserved). * */ readonly quantityOnStock: number /** + * Available amount of stock (`quantityOnStock` - reserved). * */ readonly availableQuantity: number } export interface LocalizedEnumValue { /** + * Key of the value used as a programmatic identifier. * */ readonly key: string /** + * Descriptive localized label of the value. * */ readonly label: LocalizedString } export interface ParcelChangeValue { /** + * `id` of the [Parcel](ctp:api:type:Parcel). + * * */ readonly id: string /** + * Date and time (UTC) the Parcel was created. * */ readonly createdAt: string } -/** - * Shape of the cart classification shipping input rate value. - */ export interface SetCartClassificationShippingRateInputValue { /** * */ readonly type: string /** + * Key of the value used as a programmatic identifier. * */ readonly key: string /** + * Descriptive localized label of the value. * */ readonly label: LocalizedString } -/** - * Shape of the cart score shipping input rate value. - */ export interface SetCartScoreShippingRateInputValue { /** * */ readonly type: string /** + * Abstract value for categorizing a Cart. * */ readonly score: number } export interface ShippingMethodChangeValue { /** + * `id` of the [ShippingMethod](ctp:api:type:ShippingMethod). + * * */ readonly id: string /** + * Name of the ShippingMethod. * */ readonly name: string } export interface ShippingMethodTaxAmountChangeValue { /** + * Taxed price for the Shipping Method based on `taxRate`. * */ readonly taxedPrice: TaxedPrice /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * Tax rate set externally for the Shipping Method. * */ readonly taxRate: TaxRate } export interface ShoppingListLineItemValue { /** + * `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem). + * * */ readonly id: string /** + * Name of the corresponding Product the Product Variant belongs to. * */ readonly name: LocalizedString /** + * `id` of the [ProductVariant](ctp:api:type:ProductVariant) the ShoppingListLineItem refers to. + * * */ readonly variantId: number } export interface TextLineItemValue { /** + * `id` of the [TextLineItem](ctp:api:type:TextLineItem). + * * */ readonly id: string /** + * Name of the TextLineItem. * */ readonly name: LocalizedString } export interface TransactionChangeValue { /** + * `id` of the [Transaction](ctp:api:type:Transaction). + * * */ readonly id: string /** + * Identifier used by the interface that manages the Transaction (usually the PSP). * */ readonly interactionId: string /** + * Date and time (UTC) the Transaction took place. * */ readonly timestamp: string } -/** - * Shape of the value for `setValidFromAndUntil` action - */ export interface ValidFromAndUntilValue { /** + * Date and time (UTC) from when the Discount is effective. * */ readonly validFrom: string /** + * Date and time (UTC) until when the Discount is effective. * */ readonly validUntil: string diff --git a/packages/history-sdk/src/generated/models/change.ts b/packages/history-sdk/src/generated/models/change.ts index 0df2ea026..7e138821d 100644 --- a/packages/history-sdk/src/generated/models/change.ts +++ b/packages/history-sdk/src/generated/models/change.ts @@ -30,9 +30,13 @@ import { Address, Asset, AssetSource, + Associate, AttributeConstraintEnum, AttributeDefinition, AuthenticationMode, + BusinessUnitAssociateMode, + BusinessUnitStatus, + BusinessUnitStoreMode, CategoryOrderHints, ChannelRole, CustomFields, @@ -47,6 +51,7 @@ import { Image, ItemShippingDetails, ItemState, + KeyReference, LineItem, LocalizedString, Location, @@ -59,6 +64,7 @@ import { Price, ProductSelectionSetting, ProductVariantAvailability, + ProductVariantSelection, QuoteRequestState, QuoteState, Reference, @@ -89,9 +95,16 @@ import { Variant, } from './common' +/** + * Difference between the previous and next version of a resource represented by `previousValue` (omitted, for example, on creations) and `nextValue` of the associated change. A Change can also contain extra fields that provide further information. + * + * They are not identical to the actual update actions sent. + * + */ export type Change = | AddAddressChange | AddAssetChange + | AddAssociateChange | AddAttributeDefinitionChange | AddBillingAddressIdChange | AddChannelRolesChange @@ -111,6 +124,7 @@ export type Change = | AddPlainEnumValueChange | AddPriceChange | AddProductChange + | AddProductSelectionChange | AddPropertyChange | AddReturnInfoChange | AddShippingAddressIdChange @@ -126,6 +140,8 @@ export type Change = | ChangeAmountPlannedChange | ChangeAssetNameChange | ChangeAssetOrderChange + | ChangeAssociateChange + | ChangeAssociateModeChange | ChangeAttributeConstraintChange | ChangeAttributeOrderByNameChange | ChangeCartDiscountsChange @@ -153,11 +169,13 @@ export type Change = | ChangeOrderHintChange | ChangeOrderStateChange | ChangeParentChange + | ChangeParentUnitChange | ChangePaymentStateChange | ChangePlainEnumValueLabelChange | ChangePlainEnumValueOrderChange | ChangePredicateChange | ChangePriceChange + | ChangeProductSelectionActiveChange | ChangeQuantityChange | ChangeQuoteRequestStateChange | ChangeQuoteStateChange @@ -171,6 +189,7 @@ export type Change = | ChangeStackingModeChange | ChangeStagedQuoteStateChange | ChangeStateTypeChange + | ChangeStatusChange | ChangeTargetChange | ChangeTaxCalculationModeChange | ChangeTaxModeChange @@ -186,6 +205,7 @@ export type Change = | PublishChange | RemoveAddressChange | RemoveAssetChange + | RemoveAssociateChange | RemoveAttributeDefinitionChange | RemoveBillingAddressIdChange | RemoveChannelRolesChange @@ -204,6 +224,7 @@ export type Change = | RemovePaymentChange | RemovePriceChange | RemoveProductChange + | RemoveProductSelectionChange | RemovePropertyChange | RemoveShippingAddressIdChange | RemoveShoppingListLineItemChange @@ -211,7 +232,10 @@ export type Change = | RemoveTaxRateChange | RemoveTextLineItemChange | RemoveVariantChange + | RequestQuoteRenegotiationChange | SetAddressChange + | SetAddressCustomFieldChange + | SetAddressCustomTypeChange | SetAnonymousIdChange | SetApplicationVersionChange | SetAssetCustomFieldChange @@ -228,6 +252,7 @@ export type Change = | SetCategoryOrderHintChange | SetChannelRolesChange | SetCompanyNameChange + | SetContactEmailChange | SetCountriesChange | SetCountryChange | SetCustomFieldChange @@ -332,6 +357,7 @@ export type Change = | SetStatusInterfaceCodeChange | SetStatusInterfaceTextChange | SetStoreChange + | SetStoreModeChange | SetStoresChange | SetSupplyChannelChange | SetSupplyChannelsChange @@ -349,6 +375,7 @@ export type Change = | SetValidUntilChange | SetValueChange | SetVariantAvailabilityChange + | SetVariantSelectionChange | SetVatIdChange | TransitionCustomLineItemStateChange | TransitionLineItemStateChange @@ -357,70 +384,108 @@ export type Change = | UnpublishChange | UpdateSyncInfoChange | VerifyEmailChange +/** + * Change triggered by the [Add Address](ctp:api:type:CustomerAddAddressAction) update action. + */ export interface AddAddressChange { readonly type: 'AddAddressChange' /** - * Update action for `setAddress` action. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } +/** + * Change triggered by the following update actions: + * + * - [Add Asset](ctp:api:type:CategoryAddAssetAction) on Categories. + * - [Add Asset](ctp:api:type:ProductAddAssetAction) on Products. + * + */ export interface AddAssetChange { readonly type: 'AddAssetChange' /** - * Update action for `addAsset` * */ readonly change: string /** + * Value before the change. + * + */ + readonly previousValue: Asset + /** + * Value after the change. * */ readonly nextValue: Asset +} +/** + * Change triggered by the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action. + */ +export interface AddAssociateChange { + readonly type: 'AddAssociateChange' /** * */ - readonly previousValue: Asset + readonly change: string + /** + * Value after the change. + * + */ + readonly nextValue: Associate } +/** + * Change triggered by the [Add Attribute Definition](ctp:api:type:ProductTypeAddAttributeDefinitionAction) update action. + */ export interface AddAttributeDefinitionChange { readonly type: 'AddAttributeDefinitionChange' /** - * Update action for `addAttributeDefinition` on product types * */ readonly change: string /** + * Value after the change. * */ readonly nextValue: AttributeDefinition } +/** + * Change triggered by the [Add Billing Address ID](ctp:api:type:CustomerAddBillingAddressIdAction) update action. + */ export interface AddBillingAddressIdChange { readonly type: 'AddBillingAddressIdChange' /** - * Update action for `addBillingAddressId` action on customers. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: string[] + readonly previousValue: string[] /** + * Value after the change. * */ - readonly previousValue: string[] + readonly nextValue: string[] /** + * Address added to `billingAddressIds`. * */ readonly address: Address } +/** + * Change triggered by the [Add Roles](ctp:api:type:ChannelAddRolesAction) update action. + */ export interface AddChannelRolesChange { readonly type: 'AddChannelRolesChange' /** @@ -428,176 +493,224 @@ export interface AddChannelRolesChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: ChannelRole[] /** + * Value after the change. * */ readonly nextValue: ChannelRole[] } +/** + * Change triggered by the [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action. + */ export interface AddCustomLineItemChange { readonly type: 'AddCustomLineItemChange' /** - * Update action for adding and removing custom line items * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: CustomLineItem + readonly previousValue: CustomLineItem /** + * Value after the change. * */ - readonly previousValue: CustomLineItem + readonly nextValue: CustomLineItem } +/** + * Change triggered by the [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action. + */ export interface AddDeliveryChange { readonly type: 'AddDeliveryChange' /** - * Update action for `addDelivery` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: DeliveryChangeValue + readonly previousValue: DeliveryChangeValue /** + * Value after the change. * */ - readonly previousValue: DeliveryChangeValue + readonly nextValue: DeliveryChangeValue } +/** + * Change triggered by the [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action. + */ export interface AddDiscountCodeChange { readonly type: 'AddDiscountCodeChange' /** - * Update action for `addDiscountCode` * */ readonly change: string /** + * Value after the change. * */ readonly nextValue: DiscountCodeInfo } +/** + * Change triggered by the [Add EnumValue to FieldDefinition](ctp:api:type:TypeAddEnumValueAction) update action. + */ export interface AddEnumValueChange { readonly type: 'AddEnumValueChange' /** - * Update action for `addEnumValue` on types * */ readonly change: string /** - * The name of the field/attribute definition updated. + * Value after the change. * */ - readonly fieldName: string + readonly nextValue: EnumValue /** + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition). * */ - readonly nextValue: EnumValue + readonly fieldName: string } +/** + * Change triggered by the [Add External Image](ctp:api:type:ProductAddExternalImageAction) update action. + */ export interface AddExternalImageChange { readonly type: 'AddExternalImageChange' /** - * Update actions for adding an external image * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Image[] /** + * Value after the change. * */ - readonly previousValue: Image[] + readonly nextValue: Image[] /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: Image[] + readonly catalogData: string } +/** + * Change triggered by the [Add FieldDefinition](ctp:api:type:TypeAddFieldDefinitionAction) update action. + */ export interface AddFieldDefinitionChange { readonly type: 'AddFieldDefinitionChange' /** - * Update action for `addFieldDefinition` on payments * */ readonly change: string /** + * Value after the change. * */ readonly nextValue: FieldDefinition } +/** + * Change triggered by the [Add InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) update action. + */ export interface AddInterfaceInteractionChange { readonly type: 'AddInterfaceInteractionChange' /** - * Update action for `addInterfaceInteraction` on payments * */ readonly change: string /** - * Only available if `expand` is set to true + * Value after the change. * */ readonly nextValue: CustomFieldExpandedValue } +/** + * Change triggered by the following update actions: + * + * - [Add ItemShippingAddress](ctp:api:type:OrderAddItemShippingAddressAction) on Orders. + * - [Add ItemShippingAddress](ctp:api:type:StagedOrderAddItemShippingAddressAction) on Staged Orders. + * + */ export interface AddItemShippingAddressesChange { readonly type: 'AddItemShippingAddressesChange' /** - * Update action for `addItemShippingAddress` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } +/** + * Change triggered by the following update actions: + * + * - [Add LocalizableEnumValue to AttributeDefinition](ctp:api:type:ProductTypeAddLocalizedEnumValueAction) on Product Types. + * - [Add LocalizedEnumValue to FieldDefinition](ctp:api:type:TypeAddLocalizedEnumValueAction) on Types. + * + */ export interface AddLocalizedEnumValueChange { readonly type: 'AddLocalizedEnumValueChange' /** - * Update action for `addLocalizedEnumValue` on types * */ readonly change: string /** - * The name of the field definition updated. + * Value after the change. * */ - readonly fieldName: string + readonly nextValue: LocalizedEnumValue /** - * The name of the attribute updated. + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types. * */ - readonly attributeName: string + readonly fieldName: string /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types. * */ - readonly nextValue: LocalizedEnumValue + readonly attributeName: string } +/** + * Change triggered by the [Add Location](ctp:api:type:ZoneAddLocationAction) update action. + */ export interface AddLocationChange { readonly type: 'AddLocationChange' /** - * Update action for `addLocation` on zones * */ readonly change: string /** - * Shape of the value for `addLocation` and `removeLocation` actions + * Value before the change. * */ readonly previousValue: Location /** - * Shape of the value for `addLocation` and `removeLocation` actions + * Value after the change. * */ readonly nextValue: Location } +/** + * Change triggered by the [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action. + */ export interface AddOrderLineItemChange { readonly type: 'AddOrderLineItemChange' /** @@ -605,144 +718,218 @@ export interface AddOrderLineItemChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LineItem /** + * Value after the change. * */ readonly nextValue: LineItem } +/** + * Change triggered by the following update actions: + * + * - [Add Parcel](ctp:api:type:OrderAddParcelToDeliveryAction) on Orders. + * - [Add Parcel](ctp:api:type:StagedOrderAddParcelToDeliveryAction) on Staged Orders. + * + */ export interface AddParcelToDeliveryChange { readonly type: 'AddParcelToDeliveryChange' /** - * Update action for `addParcelToDelivery` * */ readonly change: string /** + * Value after the change. * */ - readonly deliveryId: string + readonly nextValue: Parcel /** + * `id` of the [Delivery](ctp:api:type:Delivery) to which the Parcel was added. + * * */ - readonly nextValue: Parcel + readonly deliveryId: string } +/** + * Change triggered by the following update actions: + * + * - [Add Payment](ctp:api:type:OrderAddPaymentAction) on Orders. + * - [Add Payment](ctp:api:type:StagedOrderAddPaymentAction) on Staged Orders. + * + */ export interface AddPaymentChange { readonly type: 'AddPaymentChange' /** - * Update action for `addPayment` & `removePayment` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: PaymentInfo + readonly previousValue: PaymentInfo /** + * Value after the change. * */ - readonly previousValue: PaymentInfo + readonly nextValue: PaymentInfo } +/** + * Change triggered by the [Add PlainEnumValue to AttributeDefinition](ctp:api:type:ProductTypeAddPlainEnumValueAction) update action. + */ export interface AddPlainEnumValueChange { readonly type: 'AddPlainEnumValueChange' /** - * Update action for `addPlainEnumValue` on product types * */ readonly change: string /** - * The name of the attribute updated. + * Value after the change. * */ - readonly attributeName: string + readonly nextValue: EnumValue /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). * */ - readonly nextValue: EnumValue + readonly attributeName: string } +/** + * Change triggered by the [Add Price](ctp:api:type:ProductAddPriceAction) update action. + */ export interface AddPriceChange { readonly type: 'AddPriceChange' /** - * Update action for adding prices * */ readonly change: string /** + * Value after the change. * */ - readonly catalogData: string + readonly nextValue: Price /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly priceId: string + readonly catalogData: string /** + * `id` of the Embedded [Price](ctp:api:type:Price). + * * */ - readonly nextValue: Price + readonly priceId: string } +/** + * Change triggered by the [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action. + */ export interface AddProductChange { readonly type: 'AddProductChange' /** - * Update action for when a product is assigned to a product selection * */ readonly change: string /** + * Value after the change. * */ readonly nextValue: Reference + /** + * The [Product Variants](ctp:api:type:ProductVariant) included in the [Product Selection](ctp:api:type:ProductSelection). + * + */ + readonly variantSelection: ProductVariantSelection +} +/** + * Change triggered by the [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction) update action. + */ +export interface AddProductSelectionChange { + readonly type: 'AddProductSelectionChange' + /** + * + */ + readonly change: string + /** + * + */ + readonly previousValue: ProductSelectionSetting + /** + * + */ + readonly nextValue: ProductSelectionSetting } +/** + * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when a new property is added. + */ export interface AddPropertyChange { readonly type: 'AddPropertyChange' /** - * Update action for `addProperty` on custom objects * */ readonly change: string /** - * Value path to the property that was added + * Value after the change. * */ - readonly path: string + readonly nextValue: any /** + * Path to the new property that was added. * */ - readonly nextValue: any + readonly path: string } +/** + * Change triggered by the following update actions: + * + * - [Add ReturnInfo](ctp:api:type:OrderAddReturnInfoAction) on Orders. + * - [Add ReturnInfo](ctp:api:type:StagedOrderAddReturnInfoAction) on Staged Orders. + * + */ export interface AddReturnInfoChange { readonly type: 'AddReturnInfoChange' /** - * Update action for `addReturnInfo` * */ readonly change: string /** + * Value after the change. * */ readonly nextValue: ReturnInfo } +/** + * Change triggered by the [Add Shipping Address ID](ctp:api:type:CustomerAddShippingAddressIdAction) update action. + */ export interface AddShippingAddressIdChange { readonly type: 'AddShippingAddressIdChange' /** - * Update action for `addShippingAddressId` action on customers. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: string[] + readonly previousValue: string[] /** + * Value after the change. * */ - readonly previousValue: string[] + readonly nextValue: string[] /** + * Address added to `shippingAddressIds`. * */ readonly address: Address } +/** + * Change triggered by the [Add ShoppingListLineItem](ctp:api:type:ShoppingListAddLineItemAction) update action. + */ export interface AddShoppingListLineItemChange { readonly type: 'AddShoppingListLineItemChange' /** @@ -750,14 +937,19 @@ export interface AddShoppingListLineItemChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LineItem /** + * Value after the change. * */ readonly nextValue: LineItem } +/** + * Change triggered by the [Add State roles](ctp:api:type:StateAddRolesAction) update action. + */ export interface AddStateRolesChange { readonly type: 'AddStateRolesChange' /** @@ -765,27 +957,34 @@ export interface AddStateRolesChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: StateRole[] /** + * Value after the change. * */ readonly nextValue: StateRole[] } +/** + * Change triggered by the [Add TaxRate](ctp:api:type:TaxCategoryAddTaxRateAction) update action. + */ export interface AddTaxRateChange { readonly type: 'AddTaxRateChange' /** - * Update action for `addTaxRate` on tax categories * */ readonly change: string /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * Value after the change. * */ readonly nextValue: TaxRate } +/** + * Change triggered by the [Add TextLineItem](ctp:api:type:ShoppingListAddTextLineItemAction) update action. + */ export interface AddTextLineItemChange { readonly type: 'AddTextLineItemChange' /** @@ -793,94 +992,121 @@ export interface AddTextLineItemChange { */ readonly change: string /** + * Value after the change. * */ readonly nextValue: TextLineItem } +/** + * Change triggered by the [Add to Category](ctp:api:type:ProductAddToCategoryAction) update action. + */ export interface AddToCategoryChange { readonly type: 'AddToCategoryChange' /** - * Update action for `addToCategory` * */ readonly change: string /** + * Value before the change. * */ - readonly category: Reference + readonly previousValue: Reference[] /** + * Value after the change. * */ - readonly previousValue: Reference[] + readonly nextValue: Reference[] /** + * Category to which the Product was added. * */ - readonly nextValue: Reference[] + readonly category: Reference } +/** + * Change triggered by the [Add Transaction](ctp:api:type:PaymentAddTransactionAction) update action. + */ export interface AddTransactionChange { readonly type: 'AddTransactionChange' /** - * Update action for `addTransaction` on payments * */ readonly change: string /** + * Value after the change. * */ readonly nextValue: Transaction } +/** + * Change triggered by the [Add ProductVariant](ctp:api:type:ProductAddVariantAction) update action. + */ export interface AddVariantChange { readonly type: 'AddVariantChange' /** - * Update action for `addVariant` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Variant /** + * Value after the change. * */ - readonly previousValue: Variant + readonly nextValue: Variant /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: Variant + readonly catalogData: string } +/** + * Change triggered by the [Change Address](ctp:api:type:CustomerChangeAddressAction) update action. + */ export interface ChangeAddressChange { readonly type: 'ChangeAddressChange' /** - * Update action `changeAddress` action. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } +/** + * Change triggered automatically due to a user-initiated change. + */ export interface ChangeAmountAuthorizedChange { readonly type: 'ChangeAmountAuthorizedChange' /** - * Internal Update action for `changeAmountAuthorized` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Money /** + * Value after the change. * */ readonly nextValue: Money } +/** + * Change triggered by the [Change AmountPlanned](ctp:api:type:PaymentChangeAmountPlannedAction) update action. + */ export interface ChangeAmountPlannedChange { readonly type: 'ChangeAmountPlannedChange' /** @@ -888,34 +1114,52 @@ export interface ChangeAmountPlannedChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Money /** + * Value after the change. * */ readonly nextValue: Money } +/** + * Change triggered by the following update actions: + * + * - [Change Asset Name](ctp:api:type:CategoryChangeAssetNameAction) on Categories. + * - [Change Asset Name](ctp:api:type:ProductChangeAssetNameAction) on Products. + * + */ export interface ChangeAssetNameChange { readonly type: 'ChangeAssetNameChange' /** - * Update action for `changeAssetName` * */ readonly change: string /** + * Value before the change. * */ - readonly asset: AssetChangeValue + readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString /** + * Information about the updated Asset. * */ - readonly previousValue: LocalizedString + readonly asset: AssetChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Change Asset Order](ctp:api:type:CategoryChangeAssetOrderAction) on Categories. + * - [Change Asset Order](ctp:api:type:ProductChangeAssetOrderAction) on Products. + * + */ export interface ChangeAssetOrderChange { readonly type: 'ChangeAssetOrderChange' /** @@ -923,642 +1167,940 @@ export interface ChangeAssetOrderChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString[] /** + * Value after the change. * */ readonly nextValue: LocalizedString[] } -export interface ChangeAttributeConstraintChange { - readonly type: 'ChangeAttributeConstraintChange' +/** + * Change triggered by the [Change Associate](ctp:api:type:BusinessUnitChangeAssociateAction) update action. + */ +export interface ChangeAssociateChange { + readonly type: 'ChangeAssociateChange' /** * */ readonly change: string /** - * name of the updated attribute + * Value before the change. * */ - readonly attributeName: string + readonly previousValue: Associate + /** + * Value after the change. + * + */ + readonly nextValue: Associate +} +/** + * Change triggered by the [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action. + */ +export interface ChangeAssociateModeChange { + readonly type: 'ChangeAssociateModeChange' + /** + * + */ + readonly change: string + /** + * Value before the change. + * + */ + readonly previousValue: BusinessUnitAssociateMode + /** + * Value after the change. + * + */ + readonly nextValue: BusinessUnitAssociateMode +} +/** + * Change triggered by the [Change AttributeDefinition AttributeConstraint](ctp:api:type:ProductTypeChangeAttributeConstraintAction) update action. + */ +export interface ChangeAttributeConstraintChange { + readonly type: 'ChangeAttributeConstraintChange' + /** + * + */ + readonly change: string /** + * Value before the change. * */ readonly previousValue: AttributeConstraintEnum /** + * Value after the change. * */ readonly nextValue: AttributeConstraintEnum + /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). + * + */ + readonly attributeName: string } +/** + * Change triggered by the [Change the order of AttributeDefinitions](ctp:api:type:ProductTypeChangeAttributeOrderByNameAction) update action. + */ export interface ChangeAttributeOrderByNameChange { readonly type: 'ChangeAttributeOrderByNameChange' /** - * Update action for `changeAttributeOrderByName` on product types * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string[] /** + * Value after the change. * */ readonly nextValue: string[] } +/** + * Change triggered by the [Change CartDiscounts](ctp:api:type:DiscountCodeChangeCartDiscountsAction) update action. + */ export interface ChangeCartDiscountsChange { readonly type: 'ChangeCartDiscountsChange' /** - * Shape of the action for `changeCartDiscounts` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference[] /** + * Value after the change. * */ readonly nextValue: Reference[] } +/** + * Change triggered by the [Change Cart Predicate](ctp:api:type:CartDiscountChangeCartPredicateAction) update action. + */ export interface ChangeCartPredicateChange { readonly type: 'ChangeCartPredicateChange' /** - * Shape of the action for `changeCartPredicate` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action. + */ export interface ChangeCustomLineItemQuantityChange { readonly type: 'ChangeCustomLineItemQuantityChange' /** - * Update action for `changeCustomLineItemQuantity` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: number /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: number /** + * Name of the CustomLineItem. * */ - readonly nextValue: number + readonly customLineItem: LocalizedString /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: number + readonly customLineItemId: string } +/** + * Change triggered by the following update actions: + * + * - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels. + * - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types. + * + */ export interface ChangeDescriptionChange { readonly type: 'ChangeDescriptionChange' /** - * Shape of the action for `changeDescription` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Change Email](ctp:api:type:CustomerChangeEmailAction) update action. + */ export interface ChangeEmailChange { readonly type: 'ChangeEmailChange' /** - * Shape of the action for `changeEmail` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Change EnumValue Label](ctp:api:type:TypeChangeEnumValueLabelAction) update action. + */ export interface ChangeEnumValueLabelChange { readonly type: 'ChangeEnumValueLabelChange' /** - * Update action for `changeEnumValueLabel` on types * */ readonly change: string /** - * The name of the field definition updated. + * Value before the change. * */ - readonly fieldName: string + readonly previousValue: string /** - * Key of the values that was updated + * Value after the change. * */ - readonly valueKey: string + readonly nextValue: string /** + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition). * */ - readonly previousValue: string + readonly fieldName: string /** + * Key of the updated values. * */ - readonly nextValue: string + readonly valueKey: string } +/** + * Change triggered by the [Change the order of EnumValues](ctp:api:type:TypeChangeEnumValueOrderAction) update action. + */ export interface ChangeEnumValueOrderChange { readonly type: 'ChangeEnumValueOrderChange' /** - * Update action for `changeEnumValueOrder` on types * */ readonly change: string /** - * The name of the field/attribute definition updated. + * Value before the change. * */ - readonly fieldName: string + readonly previousValue: EnumValue[] /** + * Value after the change. * */ readonly nextValue: EnumValue[] /** + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition). * */ - readonly previousValue: EnumValue[] + readonly fieldName: string } +/** + * Change triggered by the [Change the order of FieldDefinitions](ctp:api:type:TypeChangeFieldDefinitionOrderAction) update action. + */ export interface ChangeFieldDefinitionOrderChange { readonly type: 'ChangeFieldDefinitionOrderChange' /** - * Update action for `changeFieldDefinitionOrder` on types * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: FieldDefinitionOrderValue[] /** + * Value after the change. * */ readonly nextValue: FieldDefinitionOrderValue[] } +/** + * Change triggered by the [Change Groups](ctp:api:type:DiscountCodeChangeGroupsAction) update action. + */ export interface ChangeGroupsChange { readonly type: 'ChangeGroupsChange' /** - * Update action for `changeGroups` on stores * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string[] /** + * Value after the change. * */ readonly nextValue: string[] } +/** + * Change triggered by the [Change initial State](ctp:api:type:StateChangeInitialAction) update action. + */ export interface ChangeInitialChange { readonly type: 'ChangeInitialChange' /** - * Shape of the action for `changeInitial` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: boolean /** + * Value after the change. * */ readonly nextValue: boolean } +/** + * Change triggered by the following update actions: + * + * - [Change AttributeDefinition InputHint](ctp:api:type:ProductTypeChangeInputHintAction) on Product Types. + * - [Change InputHint](ctp:api:type:TypeChangeInputHintAction) on Types. + * + */ export interface ChangeInputHintChange { readonly type: 'ChangeInputHintChange' /** - * Update action for `changeInputHint` on product types and types * */ readonly change: string /** - * The name of the field definition updated. + * Value before the change. * */ - readonly fieldName: string + readonly previousValue: TextInputHint /** - * The name of the attribute updated. + * Value after the change. * */ - readonly attributeName: string + readonly nextValue: TextInputHint /** + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types. * */ - readonly nextValue: TextInputHint + readonly fieldName: string /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types. * */ - readonly previousValue: TextInputHint + readonly attributeName: string } +/** + * Change triggered by the following update actions: + * + * - [Change IsActive](ctp:api:type:CartDiscountChangeIsActiveAction) on Cart Discounts. + * - [Change IsActive](ctp:api:type:DiscountCodeChangeIsActiveAction) on Discount Codes. + * - [Change IsActive](ctp:api:type:ProductDiscountChangeIsActiveAction) on Product Discounts. + * + */ export interface ChangeIsActiveChange { readonly type: 'ChangeIsActiveChange' /** - * Shape of the action for `changeIsActive` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: boolean /** + * Value after the change. * */ readonly nextValue: boolean } +/** + * Change triggered by the [Change AttributeDefinition IsSearchable](ctp:api:type:ProductTypeChangeIsSearchableAction) update action. + */ export interface ChangeIsSearchableChange { readonly type: 'ChangeIsSearchableChange' /** - * Update action for `changeIsSearchable` on product types * */ readonly change: string /** - * The name of the updated attribute. + * Value before the change. * */ - readonly attributeName: string + readonly previousValue: boolean /** + * Value after the change. * */ readonly nextValue: boolean /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). * */ - readonly previousValue: boolean + readonly attributeName: string } +/** + * Change triggered by the following update actions: + * + * - [Change Key](ctp:api:type:ChannelChangeKeyAction) on Channels. + * - [Change State key](ctp:api:type:StateChangeKeyAction) on States. + * - [Change Key](ctp:api:type:TypeChangeKeyAction) on Types. + * + */ export interface ChangeKeyChange { readonly type: 'ChangeKeyChange' /** - * Shape of the action for `changeKey` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Change AttributeDefinition Label](ctp:api:type:ProductTypeChangeLabelAction) on Product Types. + * - [Change FieldDefinition Label](ctp:api:type:TypeChangeLabelAction) on Types. + * + */ export interface ChangeLabelChange { readonly type: 'ChangeLabelChange' /** - * Update action for `changeLabel` on product types and types * */ readonly change: string /** - * The name of the field definition to update (types). + * Value before the change. * */ - readonly fieldName: string + readonly previousValue: LocalizedString /** - * The name of the attribute definition to update (product-type). + * Value after the change. * */ - readonly attributeName: string + readonly nextValue: LocalizedString /** + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types). * */ - readonly nextValue: LocalizedString + readonly fieldName: string /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types. * */ - readonly previousValue: LocalizedString + readonly attributeName: string } +/** + * Change triggered by the [Change LineItem Quantity](ctp:api:type:StagedOrderChangeLineItemQuantityAction) update action. + */ export interface ChangeLineItemQuantityChange { readonly type: 'ChangeLineItemQuantityChange' /** - * Update action for `changeLineItemQuantity` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: number /** + * Value after the change * */ - readonly lineItemId: string + readonly nextValue: number /** - * The amount of a LineItem in the cart. Must be a positive integer. + * Name of the [Product](ctp:api:type:Product) the updated Line Item is based on. * */ - readonly nextValue: number + readonly lineItem: LocalizedString /** - * The amount of a LineItem in the cart. Must be a positive integer. + * `id` of the updated [LineItem](ctp:api:type:LineItem). + * * */ - readonly previousValue: number + readonly lineItemId: string } +/** + * Change triggered by the following update actions: + * + * - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types. + * - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels. + * + */ export interface ChangeLocalizedDescriptionChange { readonly type: 'ChangeLocalizedDescriptionChange' /** - * Shape of the action for `changeDescription` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the following update actions: + * + * - [Change the label of a LocalizedEnumValue](ctp:api:type:ProductTypeChangeLocalizedEnumValueLabelAction) on Product Types. + * - [Change LocalizedEnumValue Label](ctp:api:type:TypeChangeLocalizedEnumValueLabelAction) on Types. + * + */ export interface ChangeLocalizedEnumValueLabelChange { readonly type: 'ChangeLocalizedEnumValueLabelChange' /** - * Update action for `changeLocalizedEnumValueLabel` on types * */ readonly change: string /** - * The name of the field definition updated. + * Value before the change. * */ - readonly fieldName: string + readonly previousValue: LocalizedString /** - * The name of the attribute updated. + * Value after the change. * */ - readonly attributeName: string + readonly nextValue: LocalizedString /** - * Key of the values that was updated + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types. * */ - readonly valueKey: string + readonly fieldName: string /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types. * */ - readonly previousValue: LocalizedString + readonly attributeName: string /** + * Key of the updated values. * */ - readonly nextValue: LocalizedString + readonly valueKey: string } +/** + * Change triggered by the following update actions: + * + * - [Change the order of LocalizedEnumValues](ctp:api:type:ProductTypeChangeLocalizedEnumValueOrderAction) on Product Types. + * - [Change the order of LocalizedEnumValues](ctp:api:type:TypeChangeLocalizedEnumValueOrderAction) on Types. + * + */ export interface ChangeLocalizedEnumValueOrderChange { readonly type: 'ChangeLocalizedEnumValueOrderChange' /** - * Update action for `changeLocalizedEnumValueOrder` on types and product types * */ readonly change: string /** - * The name of the field definition updated. + * Value before the change. * */ - readonly fieldName: string + readonly previousValue: LocalizedEnumValue[] /** - * The name of the attribute updated. + * Value after the change. * */ - readonly attributeName: string + readonly nextValue: LocalizedEnumValue[] /** + * Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types. * */ - readonly nextValue: LocalizedEnumValue[] + readonly fieldName: string /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types. * */ - readonly previousValue: LocalizedEnumValue[] + readonly attributeName: string } +/** + * Change triggered by the following update actions: + * + * - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts. + * - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories. + * - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels. + * - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups. + * - [Change Name](ctp:api:type:ProductChangeNameAction) on Products. + * - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts. + * - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections. + * - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types. + * - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists. + * - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories. + * - [Change Name](ctp:api:type:TypeChangeNameAction) on Types. + * - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. + * + */ export interface ChangeLocalizedNameChange { readonly type: 'ChangeLocalizedNameChange' /** - * Shape of the action for `changeName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the [Change Master Variant](ctp:api:type:ProductChangeMasterVariantAction) update action. + */ export interface ChangeMasterVariantChange { readonly type: 'ChangeMasterVariantChange' /** - * Update action for `changeMasterVariant` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Variant /** + * Value after the change. * */ - readonly previousValue: Variant + readonly nextValue: Variant /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: Variant + readonly catalogData: string } +/** + * Change triggered by the following update actions: + * + * - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts. + * - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories. + * - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels. + * - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups. + * - [Change Name](ctp:api:type:ProductChangeNameAction) on Products. + * - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts. + * - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections. + * - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types. + * - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists. + * - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories. + * - [Change Name](ctp:api:type:TypeChangeNameAction) on Types. + * - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. + * + */ export interface ChangeNameChange { readonly type: 'ChangeNameChange' /** - * Shape of the action for `changeName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Change OrderHint](ctp:api:type:CategoryChangeOrderHintAction) update action. + */ export interface ChangeOrderHintChange { readonly type: 'ChangeOrderHintChange' /** - * Shape of the action for `changeOrderHint` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Change OrderState](ctp:api:type:OrderChangeOrderStateAction) on Orders. + * - [Change OrderState](ctp:api:type:StagedOrderChangeOrderStateAction) on Staged Orders. + * + */ export interface ChangeOrderStateChange { readonly type: 'ChangeOrderStateChange' /** - * Update action for `changeOrderState` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: OrderState + readonly previousValue: OrderState /** + * Value after the change. * */ - readonly previousValue: OrderState + readonly nextValue: OrderState } +/** + * Change triggered by the [Change Parent](ctp:api:type:CategoryChangeParentAction) update action. + */ export interface ChangeParentChange { readonly type: 'ChangeParentChange' /** - * Shape of the action for `changeParent` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered by the [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action. + */ +export interface ChangeParentUnitChange { + readonly type: 'ChangeParentUnitChange' + /** + * + */ + readonly change: string + /** + * Value before the change. + * + */ + readonly previousValue: KeyReference + /** + * Value after the change. + * + */ + readonly nextValue: KeyReference +} +/** + * Change triggered by the following update actions: + * + * - [Change PaymentState](ctp:api:type:OrderChangePaymentStateAction) on Orders. + * - [Change PaymentState](ctp:api:type:StagedOrderChangePaymentStateAction) on Staged Orders. + * + */ export interface ChangePaymentStateChange { readonly type: 'ChangePaymentStateChange' /** - * Update action for `changePaymentState` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: PaymentState + readonly previousValue: PaymentState /** + * Value after the change. * */ - readonly previousValue: PaymentState + readonly nextValue: PaymentState } +/** + * Change triggered by the [Change the label of an EnumValue](ctp:api:type:ProductTypeChangePlainEnumValueLabelAction) update action. + */ export interface ChangePlainEnumValueLabelChange { readonly type: 'ChangePlainEnumValueLabelChange' /** - * Update action for `changePlainEnumValueLabel` on types * */ readonly change: string /** - * The name of the attribute updated. + * Value before the change. * */ - readonly attributeName: string + readonly previousValue: string /** - * Key of the values that was updated + * Value after the change. * */ - readonly valueKey: string + readonly nextValue: string /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). * */ - readonly previousValue: string + readonly attributeName: string /** + * Key of the updated values. * */ - readonly nextValue: string + readonly valueKey: string } +/** + * Change triggered by the [Change the order of EnumValues](ctp:api:type:ProductTypeChangePlainEnumValueOrderAction) update action. + */ export interface ChangePlainEnumValueOrderChange { readonly type: 'ChangePlainEnumValueOrderChange' /** - * Update action for `changePlainEnumValueOrder` on product types * */ readonly change: string /** - * The name of the attribute updated. + * Value before the change. * */ - readonly attributeName: string + readonly previousValue: EnumValue[] /** + * Value after the change. * */ readonly nextValue: EnumValue[] /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). * */ - readonly previousValue: EnumValue[] + readonly attributeName: string } +/** + * Change triggered by the [Change Predicate](ctp:api:type:ProductDiscountChangePredicateAction) update action. + */ export interface ChangePredicateChange { readonly type: 'ChangePredicateChange' /** - * Shape of the action for `changePredicate` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Change Price](ctp:api:type:ProductChangePriceAction) update action. + */ export interface ChangePriceChange { readonly type: 'ChangePriceChange' /** - * Update action for changing prices * */ readonly change: string /** + * Value before the change. + * + */ + readonly previousValue: Price + /** + * Value after the change. + * + */ + readonly nextValue: Price + /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ readonly catalogData: string /** + * `id` of the Embedded [Price](ctp:api:type:Price). + * * */ readonly priceId: string +} +/** + * Change triggered by the [Change Product Selection Active](ctp:api:type:StoreChangeProductSelectionAction) update action. + */ +export interface ChangeProductSelectionActiveChange { + readonly type: 'ChangeProductSelectionActiveChange' /** * */ - readonly previousValue: Price + readonly change: string /** + * Reference to the Product Selection which was changed. * */ - readonly nextValue: Price + readonly productSelection: Reference + /** + * Value before the change. + * + */ + readonly previousValue: boolean + /** + * Value after the change. + * + */ + readonly nextValue: boolean } /** - * Update action for `changeQuantity` on inventories + * Change triggered by the [Change Quantity](ctp:api:type:InventoryEntryChangeQuantityAction) update action. */ export interface ChangeQuantityChange { readonly type: 'ChangeQuantityChange' @@ -1567,16 +2109,18 @@ export interface ChangeQuantityChange { */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: InventoryQuantityValue + readonly previousValue: InventoryQuantityValue /** + * Value after the change. * */ - readonly previousValue: InventoryQuantityValue + readonly nextValue: InventoryQuantityValue } /** - * Update action for `changeQuoteRequestState` on `quote-request` + * Change triggered by the [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action. */ export interface ChangeQuoteRequestStateChange { readonly type: 'ChangeQuoteRequestStateChange' @@ -1585,16 +2129,18 @@ export interface ChangeQuoteRequestStateChange { */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: QuoteRequestState + readonly previousValue: QuoteRequestState /** + * Value after the change. * */ - readonly previousValue: QuoteRequestState + readonly nextValue: QuoteRequestState } /** - * Update action for `changeQuoteState` on `quote` + * Change triggered by the [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action. */ export interface ChangeQuoteStateChange { readonly type: 'ChangeQuoteStateChange' @@ -1603,26 +2149,32 @@ export interface ChangeQuoteStateChange { */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: QuoteState + readonly previousValue: QuoteState /** + * Value after the change. * */ - readonly previousValue: QuoteState + readonly nextValue: QuoteState } +/** + * Change triggered by the [Change Requires DiscountCode](ctp:api:type:CartDiscountChangeRequiresDiscountCodeAction) update action. + */ export interface ChangeRequiresDiscountCodeChange { readonly type: 'ChangeRequiresDiscountCodeChange' /** - * Shape of the action for `changeRequiresDiscountCode` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: boolean /** + * Value after the change. * */ readonly nextValue: boolean @@ -1630,35 +2182,47 @@ export interface ChangeRequiresDiscountCodeChange { export interface ChangeReviewRatingStatisticsChange { readonly type: 'ChangeReviewRatingStatisticsChange' /** - * Update action for `changeReviewRatingStatistics` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: ReviewRatingStatistics + readonly previousValue: ReviewRatingStatistics /** + * Value after the change. * */ - readonly previousValue: ReviewRatingStatistics + readonly nextValue: ReviewRatingStatistics } +/** + * Change triggered by the following update actions: + * + * - [Change ShipmentState](ctp:api:type:OrderChangeShipmentStateAction) on Orders. + * - [Change ShipmentState](ctp:api:type:StagedOrderChangeShipmentStateAction) on Staged Orders. + * + */ export interface ChangeShipmentStateChange { readonly type: 'ChangeShipmentStateChange' /** - * Update action for `changeShipmentState` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: ShipmentState + readonly previousValue: ShipmentState /** + * Value after the change. * */ - readonly previousValue: ShipmentState + readonly nextValue: ShipmentState } +/** + * Change triggered by the [Change ShoppingListLineItem Quantity](ctp:api:type:ShoppingListChangeLineItemQuantityAction) update action. + */ export interface ChangeShoppingListLineItemQuantityChange { readonly type: 'ChangeShoppingListLineItemQuantityChange' /** @@ -1666,18 +2230,24 @@ export interface ChangeShoppingListLineItemQuantityChange { */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: ShoppingListLineItemValue + readonly previousValue: number /** + * Value after the change. * */ - readonly previousValue: number + readonly nextValue: number /** + * Holds information about the updated Shopping List Line Item. * */ - readonly nextValue: number + readonly lineItem: ShoppingListLineItemValue } +/** + * Change triggered by the [Change ShoppingListLineItems Order](ctp:api:type:ShoppingListChangeLineItemsOrderAction) update action. + */ export interface ChangeShoppingListLineItemsOrderChange { readonly type: 'ChangeShoppingListLineItemsOrderChange' /** @@ -1685,64 +2255,86 @@ export interface ChangeShoppingListLineItemsOrderChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: ShoppingListLineItemValue[] /** + * Value after the change. * */ readonly nextValue: ShoppingListLineItemValue[] } +/** + * Change triggered by the following update actions: + * + * - [Change Slug](ctp:api:type:CategoryChangeSlugAction) on Categories. + * - [Change Slug](ctp:api:type:ProductChangeSlugAction) on Products. + * + */ export interface ChangeSlugChange { readonly type: 'ChangeSlugChange' /** - * Shape of the action for `changeSlug` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the following update actions: + * + * - [Change Sort Order](ctp:api:type:CartDiscountChangeSortOrderAction) on Cart Discounts. + * - [Change Sort Order](ctp:api:type:ProductDiscountChangeSortOrderAction) on Product Discounts. + * + */ export interface ChangeSortOrderChange { readonly type: 'ChangeSortOrderChange' /** - * Shape of the action for `changeSortOrder` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Change Stacking Mode](ctp:api:type:CartDiscountChangeStackingModeAction) update action. + */ export interface ChangeStackingModeChange { readonly type: 'ChangeStackingModeChange' /** - * Update action for `changeStackingMode` on cart discounts * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: StackingMode + readonly previousValue: StackingMode /** + * Value after the change. * */ - readonly previousValue: StackingMode + readonly nextValue: StackingMode } /** - * Update action for `changeStagedQuoteState` on `staged-quote` + * Change triggered by the [ChangeStagedQuoteState](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action. */ export interface ChangeStagedQuoteStateChange { readonly type: 'ChangeStagedQuoteStateChange' @@ -1751,114 +2343,164 @@ export interface ChangeStagedQuoteStateChange { */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: StagedQuoteState + readonly previousValue: StagedQuoteState /** + * Value after the change. * */ - readonly previousValue: StagedQuoteState + readonly nextValue: StagedQuoteState } +/** + * Change triggered by the [Change State Type](ctp:api:type:StateChangeTypeAction) update action. + */ export interface ChangeStateTypeChange { readonly type: 'ChangeStateTypeChange' /** - * Update action for `changeType` on state * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: StateType /** + * Value after the change. * */ readonly nextValue: StateType } +/** + * Change triggered by the [Change Status](ctp:api:type:BusinessUnitChangeStatusAction) update action. + */ +export interface ChangeStatusChange { + readonly type: 'ChangeStatusChange' + /** + * + */ + readonly change: string + /** + * Value before the change. + * + */ + readonly previousValue: BusinessUnitStatus + /** + * Value after the change. + * + */ + readonly nextValue: BusinessUnitStatus +} +/** + * Change triggered by the [Change Target](ctp:api:type:CartDiscountChangeTargetAction) update action. + */ export interface ChangeTargetChange { readonly type: 'ChangeTargetChange' /** - * Update action for `changeTarget` on cart discounts * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: ChangeTargetChangeValue + readonly previousValue: ChangeTargetChangeValue /** + * Value after the change. * */ - readonly previousValue: ChangeTargetChangeValue + readonly nextValue: ChangeTargetChangeValue } +/** + * Change triggered by the [Change TaxCalculationMode](ctp:api:type:StagedOrderChangeTaxCalculationModeAction) update action. + */ export interface ChangeTaxCalculationModeChange { readonly type: 'ChangeTaxCalculationModeChange' /** - * Shape of the action for `changeTaxCalculationMode` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: TaxCalculationMode /** + * Value after the change. * */ readonly nextValue: TaxCalculationMode } +/** + * Change triggered by the [Change TaxMode](ctp:api:type:StagedOrderChangeTaxModeAction) update action. + */ export interface ChangeTaxModeChange { readonly type: 'ChangeTaxModeChange' /** - * Shape of the action for `changeTaxMode` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: TaxMode /** + * Value after the change. * */ readonly nextValue: TaxMode } +/** + * Change triggered by the [Change Tax RoundingMode](ctp:api:type:StagedOrderChangeTaxRoundingModeAction) update action. + */ export interface ChangeTaxRoundingModeChange { readonly type: 'ChangeTaxRoundingModeChange' /** - * Shape of the action for `changeTaxRoundingMode` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: RoundingMode /** + * Value after the change. * */ readonly nextValue: RoundingMode } +/** + * Change triggered by the [Change TextLineItem Name](ctp:api:type:ShoppingListChangeTextLineItemNameAction) update action. + */ export interface ChangeTextLineItemNameChange { readonly type: 'ChangeTextLineItemNameChange' /** - * Update action for `changeTextLineItemName` * */ readonly change: string /** + * Value before the change. * */ - readonly textLineItem: TextLineItemValue + readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString /** + * Holds information about the updated Text Line Item. * */ - readonly previousValue: LocalizedString + readonly textLineItem: TextLineItemValue } +/** + * Change triggered by the [Change TextLineItem Quantity](ctp:api:type:ShoppingListChangeTextLineItemQuantityAction) update action. + */ export interface ChangeTextLineItemQuantityChange { readonly type: 'ChangeTextLineItemQuantityChange' /** @@ -1866,18 +2508,24 @@ export interface ChangeTextLineItemQuantityChange { */ readonly change: string /** + * Value before the change. * */ - readonly textLineItem: TextLineItemValue + readonly previousValue: number /** + * Value after the change. * */ - readonly previousValue: number + readonly nextValue: number /** + * Holds information about the updated Text Line Item. * */ - readonly nextValue: number + readonly textLineItem: TextLineItemValue } +/** + * Change triggered by the [Change TextLineItems Order](ctp:api:type:ShoppingListChangeTextLineItemsOrderAction) update action. + */ export interface ChangeTextLineItemsOrderChange { readonly type: 'ChangeTextLineItemsOrderChange' /** @@ -1885,110 +2533,145 @@ export interface ChangeTextLineItemsOrderChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: TextLineItemValue[] /** + * Value after the change. * */ readonly nextValue: TextLineItemValue[] } +/** + * Change triggered by the [Change TransactionInteractionId](ctp:api:type:PaymentChangeTransactionInteractionIdAction) update action. + */ export interface ChangeTransactionInteractionIdChange { readonly type: 'ChangeTransactionInteractionIdChange' /** - * Update action for `changeTransactionInteractionId` on payments * */ readonly change: string /** + * Value after the change. * */ - readonly transaction: TransactionChangeValue + readonly previousValue: string /** + * Value before the change. * */ readonly nextValue: string /** + * Holds information about the updated Transaction. * */ - readonly previousValue: string + readonly transaction: TransactionChangeValue } +/** + * Change triggered by the [Change TransactionState](ctp:api:type:PaymentChangeTransactionStateAction) update action. + */ export interface ChangeTransactionStateChange { readonly type: 'ChangeTransactionStateChange' /** - * Update action for `changeTransactionState` on payments * */ readonly change: string /** + * Value before the change. * */ - readonly transaction: TransactionChangeValue + readonly previousValue: TransactionState /** + * Value after the change. * */ readonly nextValue: TransactionState /** + * Holds information about the updated Transaction. * */ - readonly previousValue: TransactionState + readonly transaction: TransactionChangeValue } +/** + * Change triggered by the [Change TransactionTimestamp](ctp:api:type:PaymentChangeTransactionTimestampAction) update action. + */ export interface ChangeTransactionTimestampChange { readonly type: 'ChangeTransactionTimestampChange' /** - * Update action for `changeTransactionTimestamp` on payments * */ readonly change: string /** + * Value before the change. * */ - readonly transaction: TransactionChangeValue + readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string /** + * Holds information about the updated Transaction. * */ - readonly previousValue: string + readonly transaction: TransactionChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Change Value](ctp:api:type:CartDiscountChangeValueAction) on Cart Discounts. + * - [Change Value](ctp:api:type:ProductDiscountChangeValueAction) on Product Discounts. + * + */ export interface ChangeValueChange { readonly type: 'ChangeValueChange' /** - * Update action for `changeValue` on cart discounts and product discounts * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: ChangeValueChangeValue + readonly previousValue: ChangeValueChangeValue /** + * Value after the change. * */ - readonly previousValue: ChangeValueChangeValue + readonly nextValue: ChangeValueChangeValue } +/** + * Change triggered by the [Move image to position](ctp:api:type:ProductMoveImageToPositionAction) update action. + */ export interface MoveImageToPositionChange { readonly type: 'MoveImageToPositionChange' /** - * Update actions for moving images * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Image[] /** + * Value after the change. * */ - readonly previousValue: Image[] + readonly nextValue: Image[] /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: Image[] + readonly catalogData: string } +/** + * Change triggered by the [Publish](ctp:api:type:ProductPublishAction) update action. + */ export interface PublishChange { readonly type: 'PublishChange' /** @@ -1996,62 +2679,98 @@ export interface PublishChange { */ readonly change: string } +/** + * Change triggered by the [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action. + */ export interface RemoveAddressChange { readonly type: 'RemoveAddressChange' /** - * Update action for `removeAddress` action. * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Address } +/** + * Change triggered by the following update actions: + * + * - [Remove Asset](ctp:api:type:CategoryRemoveAssetAction) on Categories. + * - [Remove Asset](ctp:api:type:ProductRemoveAssetAction) on Products. + * + */ export interface RemoveAssetChange { readonly type: 'RemoveAssetChange' /** - * Update action for `removeAsset` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Asset } +/** + * Change triggered by the [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action. + */ +export interface RemoveAssociateChange { + readonly type: 'RemoveAssociateChange' + /** + * + */ + readonly change: string + /** + * Value before the change. + * + */ + readonly previousValue: Associate +} +/** + * Change triggered by the [Remove AttributeDefinition](ctp:api:type:ProductTypeRemoveAttributeDefinitionAction) update action. + */ export interface RemoveAttributeDefinitionChange { readonly type: 'RemoveAttributeDefinitionChange' /** - * Update action for `removeAttributeDefinition` on product types * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: AttributeDefinition } +/** + * Change triggered by the [Remove Billing Address ID](ctp:api:type:CustomerRemoveBillingAddressIdAction) update action. + */ export interface RemoveBillingAddressIdChange { readonly type: 'RemoveBillingAddressIdChange' /** - * Update action for `removeBillingAddressId` action on customers. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: string[] + readonly previousValue: string[] /** + * Value after the change. * */ - readonly previousValue: string[] + readonly nextValue: string[] /** + * Address removed from `billingAddressesIds`. * */ readonly address: Address } +/** + * Change triggered by the [Remove Roles](ctp:api:type:ChannelRemoveRolesAction) update action. + */ export interface RemoveChannelRolesChange { readonly type: 'RemoveChannelRolesChange' /** @@ -2059,174 +2778,216 @@ export interface RemoveChannelRolesChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: ChannelRole[] /** + * Value after the change. * */ readonly nextValue: ChannelRole[] } +/** + * Change triggered by the [Remove CustomLineItem](ctp:api:type:StagedOrderRemoveCustomLineItemAction) update action. + */ export interface RemoveCustomLineItemChange { readonly type: 'RemoveCustomLineItemChange' /** - * Update action for adding and removing custom line items * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: CustomLineItem + readonly previousValue: CustomLineItem /** + * Value after the change. * */ - readonly previousValue: CustomLineItem + readonly nextValue: CustomLineItem } +/** + * Change triggered by the [Remove Delivery](ctp:api:type:OrderRemoveDeliveryAction) update action. + */ export interface RemoveDeliveryItemsChange { readonly type: 'RemoveDeliveryItemsChange' /** - * Update action for `removeDelivery` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Delivery } +/** + * Change triggered by the [Remove DiscountCode](ctp:api:type:StagedOrderRemoveDiscountCodeAction) update action. + */ export interface RemoveDiscountCodeChange { readonly type: 'RemoveDiscountCodeChange' /** - * Update action for `removeDiscountCode` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: DiscountCodeInfo } +/** + * Change triggered by the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action. + */ export interface RemoveEnumValuesChange { readonly type: 'RemoveEnumValuesChange' /** - * Update action for `removeEnumValues` on product types * */ readonly change: string /** - * The name of the attribute updated. + * Value before the change. * */ - readonly attributeName: string + readonly previousValue: EnumValue /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). * */ - readonly previousValue: EnumValue + readonly attributeName: string } +/** + * Change triggered by the [Remove FieldDefinition](ctp:api:type:TypeRemoveFieldDefinitionAction) update action. + */ export interface RemoveFieldDefinitionChange { readonly type: 'RemoveFieldDefinitionChange' /** - * Update action for `removeFieldDefinition` on payments * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: FieldDefinition } +/** + * Change triggered by the [Remove from Category](ctp:api:type:ProductRemoveFromCategoryAction) update action. + */ export interface RemoveFromCategoryChange { readonly type: 'RemoveFromCategoryChange' /** - * Update action for `addToCategory` * */ readonly change: string /** + * Value before the change. * */ - readonly category: Reference + readonly previousValue: Reference[] /** + * Value after the change. * */ - readonly previousValue: Reference[] + readonly nextValue: Reference[] /** + * Category from which the Product was removed. * */ - readonly nextValue: Reference[] + readonly category: Reference } +/** + * Change triggered by the [Remove Image](ctp:api:type:ProductRemoveImageAction) update action. + */ export interface RemoveImageChange { readonly type: 'RemoveImageChange' /** - * Update actions for removing images * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Image[] /** + * Value after the change. * */ - readonly previousValue: Image[] + readonly nextValue: Image[] /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: Image[] + readonly catalogData: string } +/** + * Change triggered by the [Remove Item Shipping Address](ctp:api:type:OrderRemoveItemShippingAddressAction) update action. + */ export interface RemoveItemShippingAddressesChange { readonly type: 'RemoveItemShippingAddressesChange' /** - * Update action for `removeItemShippingAddress` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } +/** + * Change triggered by the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action. + */ export interface RemoveLocalizedEnumValuesChange { readonly type: 'RemoveLocalizedEnumValuesChange' /** - * Update action for `removeEnumValues` on product types * */ readonly change: string /** - * The name of the attribute updated. + * Value before the change. * */ - readonly attributeName: string + readonly previousValue: LocalizedEnumValue /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). * */ - readonly previousValue: LocalizedEnumValue + readonly attributeName: string } +/** + * Change triggered by the [Remove Location](ctp:api:type:ZoneRemoveLocationAction) update action. + */ export interface RemoveLocationChange { readonly type: 'RemoveLocationChange' /** - * Update action for `removeLocation` on zones * */ readonly change: string /** - * Shape of the value for `addLocation` and `removeLocation` actions + * Value before the change. * */ readonly previousValue: Location /** - * Shape of the value for `addLocation` and `removeLocation` actions + * Value after the change. * */ readonly nextValue: Location } +/** + * Change triggered by the [Remove Parcel From Delivery](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + */ export interface RemoveOrderLineItemChange { readonly type: 'RemoveOrderLineItemChange' /** @@ -2234,119 +2995,176 @@ export interface RemoveOrderLineItemChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LineItem /** + * Value after the change. * */ readonly nextValue: LineItem } +/** + * Change triggered by the following update actions: + * + * - [Remove Parcel From Delivery](ctp:api:type:OrderRemoveParcelFromDeliveryAction) on Orders. + * - [Remove Parcel From Delivery](ctp:api:type:StagedOrderRemoveParcelFromDeliveryAction) on Staged Orders. + * + */ export interface RemoveParcelFromDeliveryChange { readonly type: 'RemoveParcelFromDeliveryChange' /** - * Update action for `removeParcelFromDelivery` * */ readonly change: string /** + * Value before the change. * */ - readonly deliveryId: string + readonly previousValue: Parcel /** + * `id` of the [Delivery](ctp:api:type:Delivery) from which the Parcel was removed. + * * */ - readonly previousValue: Parcel + readonly deliveryId: string } +/** + * Change triggered by the following update actions: + * + * - [Remove Payment](ctp:api:type:OrderRemovePaymentAction) on Orders. + * - [Remove Payment](ctp:api:type:StagedOrderRemovePaymentAction) on Staged Orders. + * + */ export interface RemovePaymentChange { readonly type: 'RemovePaymentChange' /** - * Update action for `addPayment` & `removePayment` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: PaymentInfo + readonly previousValue: PaymentInfo /** + * Value after the change. * */ - readonly previousValue: PaymentInfo + readonly nextValue: PaymentInfo } +/** + * Change triggered by the [Remove Embedded Price](ctp:api:type:ProductRemovePriceAction) update action. + */ export interface RemovePriceChange { readonly type: 'RemovePriceChange' /** - * Update action for removing prices * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Price /** + * Value after the change. * */ - readonly priceId: string + readonly nextValue: Price /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly previousValue: Price + readonly catalogData: string /** + * `id` of the Embedded [Price](ctp:api:type:Price). + * * */ - readonly nextValue: Price + readonly priceId: string } +/** + * Change triggered by the [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action. + */ export interface RemoveProductChange { readonly type: 'RemoveProductChange' /** - * Update action for when a product is unassigned from a product selection * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference } +/** + * Change triggered by the [Remove Product Selection](ctp:api:type:StoreRemoveProductSelectionAction) update action. + */ +export interface RemoveProductSelectionChange { + readonly type: 'RemoveProductSelectionChange' + /** + * + */ + readonly change: string + /** + * Value before the change. + * + */ + readonly previousValue: ProductSelectionSetting +} +/** + * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when an existing property is removed. + */ export interface RemovePropertyChange { readonly type: 'RemovePropertyChange' /** - * Update action for `removeProperty` on custom objects * */ readonly change: string /** - * Value path to the property that was removed + * Value before the change. * */ - readonly path: string + readonly previousValue: any /** + * Path to the property that was removed. * */ - readonly previousValue: any + readonly path: string } +/** + * Change triggered by the [Remove Shipping Address ID](ctp:api:type:CustomerRemoveShippingAddressIdAction) update action. + */ export interface RemoveShippingAddressIdChange { readonly type: 'RemoveShippingAddressIdChange' /** - * Update action for `removeShippingAddressId` action on customers. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: string[] + readonly previousValue: string[] /** + * Value after the change. * */ - readonly previousValue: string[] + readonly nextValue: string[] /** + * Address removed from `shippingAddressesIds`. * */ readonly address: Address } +/** + * Change triggered by the [Remove ShoppingListLineItem](ctp:api:type:ShoppingListRemoveLineItemAction) update action. + */ export interface RemoveShoppingListLineItemChange { readonly type: 'RemoveShoppingListLineItemChange' /** @@ -2354,14 +3172,19 @@ export interface RemoveShoppingListLineItemChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LineItem /** + * Value after the change. * */ readonly nextValue: LineItem } +/** + * Change triggered by the [Remove State roles](ctp:api:type:StateRemoveRolesAction) update action. + */ export interface RemoveStateRolesChange { readonly type: 'RemoveStateRolesChange' /** @@ -2369,32 +3192,39 @@ export interface RemoveStateRolesChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: StateRole[] /** + * Value after the change. * */ readonly nextValue: StateRole[] } +/** + * Change triggered by the [Remove TaxRate](ctp:api:type:TaxCategoryRemoveTaxRateAction) update action. + */ export interface RemoveTaxRateChange { readonly type: 'RemoveTaxRateChange' /** - * Update action for `removeTaxRate` on tax categories * */ readonly change: string /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * Value before the change. * */ readonly previousValue: TaxRate /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * Value after the change. * */ readonly nextValue: TaxRate } +/** + * Change triggered by the [Remove TextLineItem](ctp:api:type:ShoppingListRemoveTextLineItemAction) update action. + */ export interface RemoveTextLineItemChange { readonly type: 'RemoveTextLineItemChange' /** @@ -2402,318 +3232,529 @@ export interface RemoveTextLineItemChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: TextLineItem /** + * Value after the change. * */ readonly nextValue: TextLineItem } +/** + * Change triggered by the [Remove ProductVariant](ctp:api:type:ProductRemoveVariantAction) update action. + */ export interface RemoveVariantChange { readonly type: 'RemoveVariantChange' /** - * Update action for `removeVariant` * */ readonly change: string /** + * Value before the change. + * + */ + readonly previousValue: Variant + /** + * Value after the change. + * + */ + readonly nextValue: Variant + /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ readonly catalogData: string +} +/** + * Change triggered by the [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action. + * + */ +export interface RequestQuoteRenegotiationChange { + readonly type: 'RequestQuoteRenegotiationChange' /** * */ - readonly previousValue: Variant + readonly change: string /** + * Value before the change. * */ - readonly nextValue: Variant + readonly previousValue: QuoteState + /** + * Value after the change. + * + */ + readonly nextValue: QuoteState + /** + * Message from the [Buyer](/../api/quotes-overview#buyer) regarding the [Quote](ctp:api:type:Quote) renegotiation request. + * + */ + readonly buyerComment: string } +/** + * Change triggered by the [Set Address](ctp:api:type:ChannelSetAddressAction) update action. + */ export interface SetAddressChange { readonly type: 'SetAddressChange' /** - * Update action for `setAddress` action. * */ readonly change: string /** + * Value before the change. + * + */ + readonly previousValue: Address + /** + * Value after the change. * */ readonly nextValue: Address +} +/** + * Change triggered by the [Set Address Custom Field](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. + * + */ +export interface SetAddressCustomFieldChange { + readonly type: 'SetAddressCustomFieldChange' /** * */ - readonly previousValue: Address + readonly change: string + /** + * [Address](ctp:api:type:Address) which was extended. + * + * + */ + readonly address: Address + /** + * Name of the [Custom Field](ctp:api:type:CustomFields). + * + */ + readonly name: string + /** + * `id` of the referenced [Type](ctp:api:type:Type). + * + * + */ + readonly customTypeId: string + /** + * Value before the change. + * + */ + readonly previousValue: any + /** + * Value after the change. + * + */ + readonly nextValue: any } +/** + * Change triggered by the [Set Address Custom Type](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. + */ +export interface SetAddressCustomTypeChange { + readonly type: 'SetAddressCustomTypeChange' + /** + * + */ + readonly change: string + /** + * [Address](ctp:api:type:Address) which was extended. + * + * + */ + readonly address: Address + /** + * Value before the change. + * + */ + readonly previousValue: CustomFields + /** + * Value after the change. + * + */ + readonly nextValue: CustomFields +} +/** + * Change triggered by the following update actions: + * + * - [Set AnonymousId](ctp:api:type:PaymentSetAnonymousIdAction) on Payments. + * - [Set AnonymousId](ctp:api:type:ShoppingListSetAnonymousIdAction) on Shopping Lists. + * + */ export interface SetAnonymousIdChange { readonly type: 'SetAnonymousIdChange' /** - * Shape of the action for `setAnonymousId` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered automatically due to a user-initiated change. + */ export interface SetApplicationVersionChange { readonly type: 'SetApplicationVersionChange' /** - * Internal Update action for `setApplicationVersion` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: number /** + * Value after the change. * */ readonly nextValue: number } +/** + * Change triggered by the following update actions: + * + * - [Set Asset CustomField](ctp:api:type:CategorySetAssetCustomFieldAction) on Categories. + * - [Set Asset CustomField](ctp:api:type:ProductSetAssetCustomFieldAction) on Products. + * + */ export interface SetAssetCustomFieldChange { readonly type: 'SetAssetCustomFieldChange' /** - * Update action for `setAssetCustomField` * */ readonly change: string /** + * Value before the change. * */ - readonly name: string + readonly previousValue: any /** + * Value after the change. * */ - readonly customTypeId: string + readonly nextValue: any /** + * Name of the [Custom Field](/../api/projects/custom-fields). * */ - readonly asset: AssetChangeValue + readonly name: string /** + * `id` of the referenced [Type](ctp:api:type:Type). + * * */ - readonly nextValue: any + readonly customTypeId: string /** + * Information about the updated Asset. * */ - readonly previousValue: any + readonly asset: AssetChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Set Asset Custom Type](ctp:api:type:CategorySetAssetCustomTypeAction) on Categories. + * - [Set Asset Custom Type](ctp:api:type:ProductSetAssetCustomTypeAction) on Products. + * + */ export interface SetAssetCustomTypeChange { readonly type: 'SetAssetCustomTypeChange' /** - * Update action for `setAssetCustomType` * */ readonly change: string /** + * Value before the change. * */ - readonly asset: AssetChangeValue + readonly previousValue: CustomFields /** + * Value after the change. * */ readonly nextValue: CustomFields /** + * Information about the updated Asset. * */ - readonly previousValue: CustomFields + readonly asset: AssetChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Set Asset Description](ctp:api:type:CategorySetAssetDescriptionAction) on Categories. + * - [Set Asset Description](ctp:api:type:ProductSetAssetDescriptionAction) on Products. + * + */ export interface SetAssetDescriptionChange { readonly type: 'SetAssetDescriptionChange' /** - * Update action for `setAssetDescription` * */ readonly change: string /** + * Value before the change. * */ - readonly asset: AssetChangeValue + readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString /** + * Information about the updated Asset. * */ - readonly previousValue: LocalizedString + readonly asset: AssetChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Set Asset Key](ctp:api:type:CategorySetAssetKeyAction) on Categories. + * - [Set Asset Key](ctp:api:type:ProductSetAssetKeyAction) on Products. + * + */ export interface SetAssetKeyChange { readonly type: 'SetAssetKeyChange' /** - * Update action for `setAssetKey` * */ readonly change: string /** + * Value before the change. * */ - readonly asset: AssetChangeValue + readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string /** + * Information about the updated Asset. * */ - readonly previousValue: string + readonly asset: AssetChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Set Asset Sources](ctp:api:type:CategorySetAssetSourcesAction) on Categories. + * - [Set Asset Sources](ctp:api:type:ProductSetAssetSourcesAction) on Products. + * + */ export interface SetAssetSourcesChange { readonly type: 'SetAssetSourcesChange' /** - * Update action for `setAssetSources` * */ readonly change: string /** + * Value before the change. * */ - readonly asset: AssetChangeValue + readonly previousValue: AssetSource[] /** + * Value after the change. * */ readonly nextValue: AssetSource[] /** + * Information about the updated Asset. * */ - readonly previousValue: AssetSource[] + readonly asset: AssetChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Change Asset Tags](ctp:api:type:CategorySetAssetTagsAction) on Categories. + * - [Change Asset Tags](ctp:api:type:ProductSetAssetTagsAction) on Products. + * + */ export interface SetAssetTagsChange { readonly type: 'SetAssetTagsChange' /** - * Update action for `setAssetTags` * */ readonly change: string /** + * Value before the change. * */ - readonly asset: AssetChangeValue + readonly previousValue: string[] /** + * Value after the change. * */ readonly nextValue: string[] /** + * Information about the updated Asset. * */ - readonly previousValue: string[] + readonly asset: AssetChangeValue } +/** + * Change triggered by the [Set Attribute](ctp:api:type:ProductSetAttributeAction) update action. + */ export interface SetAttributeChange { readonly type: 'SetAttributeChange' /** - * Update action for `setAttribute` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: AttributeValue /** + * Value after the change. * */ - readonly previousValue: AttributeValue + readonly nextValue: AttributeValue /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: AttributeValue + readonly catalogData: string } +/** + * Change triggered by the [Set AuthenticationMode](ctp:api:type:CustomerSetAuthenticationModeAction) update action. + */ export interface SetAuthenticationModeChange { readonly type: 'SetAuthenticationModeChange' /** - * Update action for `setAuthenticationMode` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: AuthenticationMode /** + * Value after the change. * */ readonly nextValue: AuthenticationMode } +/** + * Change triggered by the [Set Author Name](ctp:api:type:ReviewSetAuthorNameAction) update action. + */ export interface SetAuthorNameChange { readonly type: 'SetAuthorNameChange' /** - * Shape of the action for `setAuthorName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) on Orders. + * - [Set Billing Address](ctp:api:type:StagedOrderSetBillingAddressAction) on Staged Orders. + * + */ export interface SetBillingAddressChange { readonly type: 'SetBillingAddressChange' /** - * Update action for `setBillingAddress` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } +/** + * Change triggered by the [Set Cart Predicate](ctp:api:type:DiscountCodeSetCartPredicateAction) update action. + */ export interface SetCartPredicateChange { readonly type: 'SetCartPredicateChange' /** - * Shape of the action for `setCartPredicate` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Category Order Hint](ctp:api:type:ProductSetCategoryOrderHintAction) update action. + */ export interface SetCategoryOrderHintChange { readonly type: 'SetCategoryOrderHintChange' /** - * Update action for `setCategoryOrderHint` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: CategoryOrderHints /** + * Value after the change. * */ - readonly categoryId: string + readonly nextValue: CategoryOrderHints /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly previousValue: CategoryOrderHints + readonly catalogData: string /** + * `id` of the updated [Category](ctp:api:type:Category). + * * */ - readonly nextValue: CategoryOrderHints + readonly categoryId: string } +/** + * Change triggered by the [Set Roles](ctp:api:type:ChannelSetRolesAction) update action. + */ export interface SetChannelRolesChange { readonly type: 'SetChannelRolesChange' /** @@ -2721,778 +3762,1091 @@ export interface SetChannelRolesChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: ChannelRole[] /** + * Value after the change. * */ readonly nextValue: ChannelRole[] } +/** + * Change triggered by the [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action. + */ export interface SetCompanyNameChange { readonly type: 'SetCompanyNameChange' /** - * Shape of the action for `setCompanyName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } -export interface SetCountryChange { - readonly type: 'SetCountryChange' +/** + * Change triggered by the [Set Contact Email](ctp:api:type:BusinessUnitSetContactEmailAction) update action. + */ +export interface SetContactEmailChange { + readonly type: 'SetContactEmailChange' /** - * Update action for `setCountry` * */ readonly change: string /** - * Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - * + * Value before the change. * */ readonly previousValue: string /** - * Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - * + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Countries](ctp:api:type:StoreSetCountriesAction) update action. + */ export interface SetCountriesChange { readonly type: 'SetCountriesChange' /** - * Update action for `setCountries`. * */ readonly change: string /** - * Countries defined for the Store prior to the update action. + * Value before the change. * */ readonly previousValue: StoreCountry[] /** - * Countries defined for the Store after the update action. + * Value after the change. * */ readonly nextValue: StoreCountry[] } +/** + * Change triggered by the [Set Country](ctp:api:type:StagedOrderSetCountryAction) update action. + */ +export interface SetCountryChange { + readonly type: 'SetCountryChange' + /** + * + */ + readonly change: string + /** + * Value before the change. + * + */ + readonly previousValue: string + /** + * Value after the change. + * + */ + readonly nextValue: string +} +/** + * Change triggered by the following update actions: + * + * - [Set CustomField](ctp:api:type:CartDiscountSetCustomFieldAction) on Cart Discounts. + * - [Set CustomField](ctp:api:type:CategorySetCustomFieldAction) on Categories. + * - [Set CustomField](ctp:api:type:ChannelSetCustomFieldAction) on Channels. + * - [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) on Customers. + * - [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) on Customer Groups. + * - [Set CustomField](ctp:api:type:DiscountCodeSetCustomFieldAction) on Discount Codes. + * - [Set CustomField](ctp:api:type:InventoryEntrySetCustomFieldAction) on Inventories. + * - [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) on Orders. + * - [Set CustomField](ctp:api:type:OrderEditSetCustomFieldAction) on Order Edits. + * - [Set CustomField](ctp:api:type:PaymentSetCustomFieldAction) on Payments. + * - [Set CustomField](ctp:api:type:ProductSelectionSetCustomFieldAction) on Product Selections. + * - [Set CustomField](ctp:api:type:QuoteSetCustomFieldAction) on Quotes. + * - [Set CustomField](ctp:api:type:QuoteRequestSetCustomFieldAction) on Quote Requests. + * - [Set CustomField](ctp:api:type:ReviewSetCustomFieldAction) on Reviews. + * - [Set CustomField](ctp:api:type:ShoppingListSetCustomFieldAction) on Shopping Lists. + * - [Set CustomField](ctp:api:type:StagedOrderSetCustomFieldAction) on Staged Orders. + * - [Set CustomField](ctp:api:type:StagedQuoteSetCustomFieldAction) on Staged Quotes. + * - [Set CustomField](ctp:api:type:StoreSetCustomFieldAction) on Stores. + * + */ export interface SetCustomFieldChange { readonly type: 'SetCustomFieldChange' /** - * Update action for setting a custom field * */ readonly change: string /** - * Custom field name + * Value before the change. * */ - readonly name: string + readonly previousValue: any /** + * Value after the change. * */ - readonly customTypeId: string + readonly nextValue: any /** + * Name of the [Custom Field](/../api/projects/custom-fields). * */ - readonly nextValue: any + readonly name: string /** + * `id` of the referenced [Type](ctp:api:type:Type). + * * */ - readonly previousValue: any + readonly customTypeId: string } +/** + * Change triggered by the following update actions: + * + * - [Set CustomLineItem Custom Type](ctp:api:type:OrderSetCustomLineItemCustomFieldAction) on Orders. + * - [Set CustomLineItem Custom Type](ctp:api:type:StagedOrderSetCustomLineItemCustomFieldAction) on Staged Orders. + * + */ export interface SetCustomLineItemCustomFieldChange { readonly type: 'SetCustomLineItemCustomFieldChange' /** - * Update action for `setCustomLineItemCustomField` * */ readonly change: string /** + * Value before the change. * */ - readonly name: string + readonly previousValue: any /** + * Value after the change. * */ - readonly customLineItem: LocalizedString + readonly nextValue: any /** + * Name of the [Custom Field](/../api/projects/custom-fields). * */ - readonly customLineItemId: string + readonly name: string /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly nextValue: any + readonly customLineItem: LocalizedString /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: any + readonly customLineItemId: string } +/** + * Change triggered by the following update actions: + * + * - [Set CustomLineItem CustomField](ctp:api:type:OrderSetCustomLineItemCustomTypeAction) on Orders. + * - [Set CustomLineItem CustomField](ctp:api:type:StagedOrderSetCustomLineItemCustomTypeAction) on Staged Orders. + * + */ export interface SetCustomLineItemCustomTypeChange { readonly type: 'SetCustomLineItemCustomTypeChange' /** - * Update action for `setCustomLineItemCustomType` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: CustomFields /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: CustomFields /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly nextValue: CustomFields + readonly customLineItem: LocalizedString /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: CustomFields + readonly customLineItemId: string } +/** + * Change triggered by the [Set CustomLineItem Money](ctp:api:type:StagedOrderChangeCustomLineItemMoneyAction) update action. + */ export interface SetCustomLineItemMoneyChange { readonly type: 'SetCustomLineItemMoneyChange' /** - * Update action for `setCustomLineItemMoney` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: Money /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: Money /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly nextValue: Money + readonly customLineItem: LocalizedString /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: Money + readonly customLineItemId: string } +/** + * Change triggered by the following update actions: + * + * - [Set CustomLineItemShippingDetails](ctp:api:type:OrderSetCustomLineItemShippingDetailsAction) on Orders. + * - [Set CustomLineItemShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction) on Staged Orders. + * + */ export interface SetCustomLineItemShippingDetailsChange { readonly type: 'SetCustomLineItemShippingDetailsChange' /** - * Update action for `setCustomLineItemShippingDetails` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItemId: string + readonly previousValue: ItemShippingDetails /** + * Value after the change. * */ readonly nextValue: ItemShippingDetails /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: ItemShippingDetails + readonly customLineItemId: string } +/** + * Change triggered by the [Set CustomLineItem TaxAmount](ctp:api:type:StagedOrderSetCustomLineItemTaxAmountAction) update action. + */ export interface SetCustomLineItemTaxAmountChange { readonly type: 'SetCustomLineItemTaxAmountChange' /** - * Update action for `setCustomLineItemTaxAmount` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: TaxRate /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: TaxRate /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly taxMode: TaxMode + readonly customLineItem: LocalizedString /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly nextValue: TaxRate + readonly customLineItemId: string /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `"ExternalAmount"` + * * */ - readonly previousValue: TaxRate + readonly taxMode: TaxMode } export interface SetCustomLineItemTaxCategoryChange { readonly type: 'SetCustomLineItemTaxCategoryChange' /** - * Update action for `setCustomLineItemTaxCategory` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: Reference /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: Reference /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly nextValue: Reference + readonly customLineItem: LocalizedString /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: Reference + readonly customLineItemId: string } +/** + * Change triggered by the [Set CustomLineItem TaxRate](ctp:api:type:StagedOrderSetCustomLineItemTaxRateAction) update action. + */ export interface SetCustomLineItemTaxRateChange { readonly type: 'SetCustomLineItemTaxRateChange' /** - * Update action for `setCustomLineItemTaxRate` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: TaxRate /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: TaxRate /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly taxMode: TaxMode + readonly customLineItem: LocalizedString /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly nextValue: TaxRate + readonly customLineItemId: string /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `"External"` + * * */ - readonly previousValue: TaxRate + readonly taxMode: TaxMode } export interface SetCustomLineItemTaxedPriceChange { readonly type: 'SetCustomLineItemTaxedPriceChange' /** - * Update action for `setCustomLineItemTaxedPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: Money /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: Money /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly nextValue: Money + readonly customLineItem: LocalizedString /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: Money + readonly customLineItemId: string } export interface SetCustomLineItemTotalPriceChange { readonly type: 'SetCustomLineItemTotalPriceChange' /** - * Update action for `setCustomLineItemTotalPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly customLineItem: LocalizedString + readonly previousValue: Money /** + * Value after the change. * */ - readonly customLineItemId: string + readonly nextValue: Money /** + * Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem). * */ - readonly nextValue: Money + readonly customLineItem: LocalizedString /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly previousValue: Money + readonly customLineItemId: string } +/** + * Change triggered by the [Set Custom ShippingMethod](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update action. + */ export interface SetCustomShippingMethodChange { readonly type: 'SetCustomShippingMethodChange' /** - * Update action for `setCustomShippingMethod` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: CustomShippingMethodChangeValue + readonly previousValue: CustomShippingMethodChangeValue /** + * Value after the change. * */ - readonly previousValue: CustomShippingMethodChangeValue + readonly nextValue: CustomShippingMethodChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Set Custom Type](ctp:api:type:CartDiscountSetCustomTypeAction) on Cart Discounts. + * - [Set Custom Type](ctp:api:type:CategorySetCustomTypeAction) on Categories. + * - [Set Custom Type](ctp:api:type:ChannelSetCustomTypeAction) on Channels. + * - [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) on Customers. + * - [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) on Customer Groups. + * - [Set Custom Type](ctp:api:type:DiscountCodeSetCustomTypeAction) on Discount Codes. + * - [Set Custom Type](ctp:api:type:InventoryEntrySetCustomTypeAction) on Inventories. + * - [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction) on Orders. + * - [Set Custom Type](ctp:api:type:OrderEditSetCustomTypeAction) on Order Edits. + * - [Set Custom Type](ctp:api:type:StagedOrderSetCustomTypeAction) on Staged Orders. + * - [Set Custom Type](ctp:api:type:PaymentSetCustomTypeAction) on Payments. + * - [Set Custom Type](ctp:api:type:ProductSelectionSetCustomTypeAction) on Product Selections. + * - [Set Custom Type](ctp:api:type:QuoteSetCustomTypeAction) on Quotes. + * - [Set Custom Type](ctp:api:type:StagedQuoteSetCustomTypeAction) on Staged Quotes. + * - [Set Custom Type](ctp:api:type:QuoteRequestSetCustomTypeAction) on Quote Requests. + * - [Set Custom Type](ctp:api:type:ReviewSetCustomTypeAction) on Reviews. + * - [Set Custom Type](ctp:api:type:ShoppingListSetCustomTypeAction) on Shopping Lists. + * - [Set Custom Type](ctp:api:type:StoreSetCustomTypeAction) on Stores. + * + */ export interface SetCustomTypeChange { readonly type: 'SetCustomTypeChange' /** - * Update action for setting a custom type * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: CustomFields + readonly previousValue: CustomFields /** + * Value after the change. * */ - readonly previousValue: CustomFields + readonly nextValue: CustomFields } +/** + * Change triggered by the following update actions: + * + * - [Set Customer](ctp:api:type:PaymentSetCustomerAction) on Payments. + * - [Set Customer](ctp:api:type:ReviewSetCustomerAction) on Reviews. + * - [Set Customer](ctp:api:type:ShoppingListSetCustomerAction) on Shopping Lists. + * + */ export interface SetCustomerChange { readonly type: 'SetCustomerChange' /** - * Shape of the action for `setCustomer` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered by the following update actions: + * + * - [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) on Orders. + * - [Set Customer Email](ctp:api:type:StagedOrderSetCustomerEmailAction) on Staged Orders. + * + */ export interface SetCustomerEmailChange { readonly type: 'SetCustomerEmailChange' /** - * Shape of the action for `setCustomerEmail` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action. + */ export interface SetCustomerGroupChange { readonly type: 'SetCustomerGroupChange' /** - * Shape of the action for `setCustomerGroup` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered by the following update actions: + * + * - [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) on Orders. + * - [Set Customer ID](ctp:api:type:StagedOrderSetCustomerIdAction) on Staged Orders. + * + */ export interface SetCustomerIdChange { readonly type: 'SetCustomerIdChange' /** - * Shape of the action for `setCustomerId` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Customer Number](ctp:api:type:CustomerSetCustomerNumberAction) update action. + */ export interface SetCustomerNumberChange { readonly type: 'SetCustomerNumberChange' /** - * Shape of the action for `setCustomerNumber` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action. + */ export interface SetDateOfBirthChange { readonly type: 'SetDateOfBirthChange' /** - * Shape of the action for `setDateOfBirth` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Default Billing Address](ctp:api:type:CustomerSetDefaultBillingAddressAction) update action. + */ export interface SetDefaultBillingAddressChange { readonly type: 'SetDefaultBillingAddressChange' /** - * Update action for `setDefaultBillingAddress` action. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } +/** + * Change triggered by the [Set Default Shipping Address](ctp:api:type:CustomerSetDefaultShippingAddressAction) update action. + */ export interface SetDefaultShippingAddressChange { readonly type: 'SetDefaultShippingAddressChange' /** - * Update action for `setDefaultShippingAddress` action. * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } +/** + * Change triggered by the [Set DeleteDaysAfterLastModification](ctp:api:type:ShoppingListSetDeleteDaysAfterLastModificationAction) update action. + */ export interface SetDeleteDaysAfterLastModificationChange { readonly type: 'SetDeleteDaysAfterLastModificationChange' /** - * Shape of the action for `setDeleteDaysAfterLastModification` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: number /** + * Value after the change. * */ readonly nextValue: number } +/** + * Change triggered by the following update actions: + * + * - [Set DeliveryAddress](ctp:api:type:OrderSetDeliveryAddressAction) on Orders. + * - [Set DeliveryAddress](ctp:api:type:StagedOrderSetDeliveryAddressAction) on Staged Orders. + * + */ export interface SetDeliveryAddressChange { readonly type: 'SetDeliveryAddressChange' /** - * Update action for `setDeliveryAddress` * */ readonly change: string /** + * Value before the change. * */ - readonly deliveryId: string + readonly previousValue: Address /** + * Value after the change. * */ readonly nextValue: Address /** + * `id` of the updated [Delivery](ctp:api:type:Delivery). + * * */ - readonly previousValue: Address + readonly deliveryId: string } +/** + * Change triggered by the following update actions: + * + * - [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) on Orders. + * - [Set Delivery Items](ctp:api:type:StagedOrderSetDeliveryItemsAction) on Staged Orders. + * + */ export interface SetDeliveryItemsChange { readonly type: 'SetDeliveryItemsChange' /** - * Update action for `setDeliveryItems` * */ readonly change: string /** + * Value before the change. * */ - readonly deliveryId: string + readonly previousValue: DeliveryItem[] /** + * Value after the change. * */ readonly nextValue: DeliveryItem[] /** + * `id` of the updated [Delivery](ctp:api:type:Delivery). + * * */ - readonly previousValue: DeliveryItem[] + readonly deliveryId: string } +/** + * Change triggered by the following update actions: + * + * - [Set Description](ctp:api:type:CartDiscountSetDescriptionAction) on Cart Discounts. + * - [Set Description](ctp:api:type:CategorySetDescriptionAction) on Categories. + * - [Set Description](ctp:api:type:DiscountCodeSetDescriptionAction) on Discount Codes. + * - [Set Description](ctp:api:type:ProductSetDescriptionAction) on Products. + * - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts. + * - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists. + * - [Set Description](ctp:api:type:StateSetDescriptionAction) on States. + * - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories. + * - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types. + * - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones. + * + */ export interface SetDescriptionChange { readonly type: 'SetDescriptionChange' /** - * Shape of the action for `setDescription` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Discounted Embedded Price](ctp:api:type:ProductSetDiscountedPriceAction) update action. + */ export interface SetDiscountedPriceChange { readonly type: 'SetDiscountedPriceChange' /** - * Update action for `setDiscountedPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Price /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: Price /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly priceId: string + readonly catalogData: string /** + * `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly previousValue: Price + readonly variant: string /** + * `id` of the Embedded [Price](ctp:api:type:Price). + * * */ - readonly nextValue: Price + readonly priceId: string } +/** + * Change triggered by the [Set Distribution Channels](ctp:api:type:StoreSetDistributionChannelsAction) update action. + */ export interface SetDistributionChannelsChange { readonly type: 'SetDistributionChannelsChange' /** - * Shape of the action for `setDistributionChannels` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference[] /** + * Value after the change. * */ readonly nextValue: Reference[] } +/** + * Change triggered by the [Set ExpectedDelivery](ctp:api:type:InventoryEntrySetExpectedDeliveryAction) update action. + */ export interface SetExpectedDeliveryChange { readonly type: 'SetExpectedDeliveryChange' /** - * Shape of the action for `setExpectedDelivery` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Set External ID](ctp:api:type:CategorySetExternalIdAction) on Categories. + * - [Set External ID](ctp:api:type:CustomerSetExternalIdAction) on Customers. + * + */ export interface SetExternalIdChange { readonly type: 'SetExternalIdChange' /** - * Shape of the action for `setExternalId` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action. + */ export interface SetFirstNameChange { readonly type: 'SetFirstNameChange' /** - * Shape of the action for `setFirstName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set GeoLocation](ctp:api:type:ChannelSetGeoLocationAction) update action. + */ export interface SetGeoLocationChange { readonly type: 'SetGeoLocationChange' /** - * Update action for `setGeoLocation` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: GeoLocation + readonly previousValue: GeoLocation /** + * Value after the change. * */ - readonly previousValue: GeoLocation + readonly nextValue: GeoLocation } +/** + * Change triggered by the [Set Image Label](ctp:api:type:ProductSetImageLabelAction) update action. + */ export interface SetImageLabelChange { readonly type: 'SetImageLabelChange' /** - * Update action for `setImageLabel` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: Image /** + * Value after the change. * */ - readonly previousValue: Image + readonly nextValue: Image /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: Image + readonly catalogData: string } +/** + * Change triggered by the [Set AttributeDefinition InputTip](ctp:api:type:ProductTypeSetInputTipAction) update action. + */ export interface SetInputTipChange { readonly type: 'SetInputTipChange' /** - * Update action for `setInputTip` on product types * */ readonly change: string /** - * The name of the updated attribute. + * Value before the change. * */ - readonly attributeName: string + readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString /** + * Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition). * */ - readonly previousValue: LocalizedString + readonly attributeName: string } +/** + * Change triggered by the [Set InterfaceId](ctp:api:type:PaymentSetInterfaceIdAction) update action. + */ export interface SetInterfaceIdChange { readonly type: 'SetInterfaceIdChange' /** - * Shape of the action for `setInterfaceId` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered automatically due to a user-initiated change. + */ export interface SetIsValidChange { readonly type: 'SetIsValidChange' /** - * Shape of the action for `setIsValid` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: boolean /** + * Value after the change. * */ readonly nextValue: boolean } +/** + * Change triggered by the following update actions: + * + * - [Set Key](ctp:api:type:CartDiscountSetKeyAction) on Cart Discounts. + * - [Set Key](ctp:api:type:CategorySetKeyAction) on Categories. + * - [Set Key](ctp:api:type:CustomerSetKeyAction) on Customers. + * - [Set Key](ctp:api:type:CustomerGroupSetKeyAction) on Customer Groups. + * - [Set Key](ctp:api:type:PaymentSetKeyAction) on Payments. + * - [Set Key](ctp:api:type:ProductSetKeyAction) on Products. + * - [Set Key](ctp:api:type:ProductDiscountSetKeyAction) on Product Discounts. + * - [Set Key](ctp:api:type:ProductSelectionSetKeyAction) on Product Selections. + * - [Set Key](ctp:api:type:ProductTypeSetKeyAction) on Product Types. + * - [Set Key](ctp:api:type:ReviewSetKeyAction) on Reviews. + * - [Set Key](ctp:api:type:ShoppingListSetKeyAction) on Shopping Lists. + * - [Set Key](ctp:api:type:ZoneSetKeyAction) on Zones. + * + */ export interface SetKeyChange { readonly type: 'SetKeyChange' /** - * Shape of the action for `setKey` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action. + */ export interface SetLanguagesChange { readonly type: 'SetLanguagesChange' /** - * Update action for `setLanguages` on stores * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string[] /** + * Value after the change. * */ readonly nextValue: string[] } +/** + * Change triggered by [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action. + */ export interface SetLastNameChange { readonly type: 'SetLastNameChange' /** - * Shape of the action for `setLastName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string @@ -3500,553 +4854,735 @@ export interface SetLastNameChange { export interface SetLineItemDeactivatedAtChange { readonly type: 'SetLineItemDeactivatedAtChange' /** - * Update action for `setLineItemDeactivatedAt` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: ShoppingListLineItemValue + readonly previousValue: string /** + * Value after the change. * */ - readonly previousValue: string + readonly nextValue: string /** + * Holds information about the updated Shopping List Line Item. * */ - readonly nextValue: string + readonly lineItem: ShoppingListLineItemValue } export interface SetLineItemDiscountedPriceChange { readonly type: 'SetLineItemDiscountedPriceChange' /** - * Update action for `setLineItemDiscountedPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: DiscountedLineItemPrice /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: DiscountedLineItemPrice /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly nextValue: DiscountedLineItemPrice + readonly lineItem: LocalizedString /** + * `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly previousValue: DiscountedLineItemPrice + readonly variant: string } export interface SetLineItemDiscountedPricePerQuantityChange { readonly type: 'SetLineItemDiscountedPricePerQuantityChange' /** - * Update action for `setLineItemDiscountedPricePerQuantity` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: DiscountedLineItemPriceForQuantity /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: DiscountedLineItemPriceForQuantity /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly nextValue: DiscountedLineItemPriceForQuantity + readonly lineItem: LocalizedString /** + * `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly previousValue: DiscountedLineItemPriceForQuantity + readonly variant: string } +/** + * Change triggered by the [Set LineItem DistributionChannel](ctp:api:type:StagedOrderSetLineItemDistributionChannelAction) update action. + */ export interface SetLineItemDistributionChannelChange { readonly type: 'SetLineItemDistributionChannelChange' /** - * Update action for `setLineItemDistributionChannel` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: Reference /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: Reference /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly nextValue: Reference + readonly lineItem: LocalizedString /** + * `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly previousValue: Reference + readonly variant: string } +/** + * Change triggered by the [Set LineItem Price](ctp:api:type:StagedOrderSetLineItemPriceAction) update action. + */ export interface SetLineItemPriceChange { readonly type: 'SetLineItemPriceChange' /** - * Update action for `setLineItemPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: Price /** + * Value after the change. * */ readonly nextValue: Price /** + * Name of the [Product](ctp:api:type:Product) the updated Line Item is based on. * */ - readonly previousValue: Price + readonly lineItem: LocalizedString } export interface SetLineItemProductKeyChange { readonly type: 'SetLineItemProductKeyChange' /** - * Update action for `setLineItemProductKey` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: string /** + * Value after the change. * */ - readonly lineItemId: string + readonly nextValue: string /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly variant: string + readonly lineItem: LocalizedString /** + * `id` of the updated [LineItem](ctp:api:type:LineItem). + * * */ - readonly previousValue: string + readonly lineItemId: string /** + * `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly nextValue: string + readonly variant: string } +/** + * Change triggered automatically due to a user-initiated change. + */ export interface SetLineItemProductSlugChange { readonly type: 'SetLineItemProductSlugChange' /** - * Update action for `setLineItemProductSlug` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: LocalizedString /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: LocalizedString /** + * Name of the [Product](ctp:api:type:Product) the updated Line Item is based on. * */ - readonly nextValue: LocalizedString + readonly lineItem: LocalizedString /** + * `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly previousValue: LocalizedString + readonly variant: string } +/** + * Change triggered by the following update actions: + * + * - [Set LineItemShippingDetails](ctp:api:type:OrderSetLineItemShippingDetailsAction) on Orders. + * - [Set LineItemShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction) on Staged Orders. + * + */ export interface SetLineItemShippingDetailsChange { readonly type: 'SetLineItemShippingDetailsChange' /** - * Update action for `setLineItemShippingDetails` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItemId: string + readonly previousValue: ItemShippingDetails /** + * Value after the change. * */ readonly nextValue: ItemShippingDetails /** + * `id` of the updated [LineItem](ctp:api:type:LineItem). + * * */ - readonly previousValue: ItemShippingDetails + readonly lineItemId: string } +/** + * Change triggered by the [Set LineItem TaxAmount](ctp:api:type:StagedOrderSetLineItemTaxAmountAction) update action. + */ export interface SetLineItemTaxAmountChange { readonly type: 'SetLineItemTaxAmountChange' /** - * Update action for `setLineItemTaxAmount` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: TaxRate /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: TaxRate /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly taxMode: TaxMode + readonly lineItem: LocalizedString /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly nextValue: TaxRate + readonly variant: string /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `"ExternalAmount"` + * * */ - readonly previousValue: TaxRate + readonly taxMode: TaxMode } +/** + * Change triggered by the [Set LineItemTaxRate](ctp:api:type:StagedOrderSetLineItemTaxRateAction) update action. + */ export interface SetLineItemTaxRateChange { readonly type: 'SetLineItemTaxRateChange' /** - * Update action for `setLineItemTaxRate` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: TaxRate /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: TaxRate /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly taxMode: TaxMode + readonly lineItem: LocalizedString /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly nextValue: TaxRate + readonly variant: string /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `"External"` + * * */ - readonly previousValue: TaxRate + readonly taxMode: TaxMode } export interface SetLineItemTaxedPriceChange { readonly type: 'SetLineItemTaxedPriceChange' /** - * Update action for `setLineItemTaxedPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: TaxedItemPrice /** + * Value after the change. * */ - readonly lineItemId: string + readonly nextValue: TaxedItemPrice /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly nextValue: TaxedItemPrice + readonly lineItem: LocalizedString /** + * `id` of the updated [LineItem](ctp:api:type:LineItem). + * * */ - readonly previousValue: TaxedItemPrice + readonly lineItemId: string } +/** + * Change triggered by the [Set LineItemTotalPrice](ctp:api:type:StagedOrderSetLineItemTotalPriceAction) update action. + */ export interface SetLineItemTotalPriceChange { readonly type: 'SetLineItemTotalPriceChange' /** - * Update action for `setLineItemTotalPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: Money /** + * Value after the change. * */ readonly nextValue: Money /** + * Name of the [Product](ctp:api:type:Product) the updated Line Item is based on. * */ - readonly previousValue: Money + readonly lineItem: LocalizedString } +/** + * Change triggered by the following update actions: + * + * - [Set Locale](ctp:api:type:CustomerSetLocaleAction) on Customers. + * - [Set Locale](ctp:api:type:OrderSetLocaleAction) on Orders. + * - [Set Locale](ctp:api:type:StagedOrderSetLocaleAction) on Staged Orders. + * - [Set Locale](ctp:api:type:ReviewSetLocaleAction) on Reviews. + * + */ export interface SetLocaleChange { readonly type: 'SetLocaleChange' /** - * Update action for `setLocale` on reviews * */ readonly change: string /** - * A locale of [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). + * Value before the change. * */ readonly previousValue: string /** - * A locale of [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Set Description](ctp:api:type:CartDiscountSetDescriptionAction) on Cart Discounts. + * - [Set Description](ctp:api:type:CategorySetDescriptionAction) on Categories. + * - [Set Description](ctp:api:type:DiscountCodeSetDescriptionAction) on Discount Codes. + * - [Set Description](ctp:api:type:ProductSetDescriptionAction) on Products. + * - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts. + * - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists. + * - [Set Description](ctp:api:type:StateSetDescriptionAction) on States. + * - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories. + * - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types. + * - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones. + * + */ export interface SetLocalizedDescriptionChange { readonly type: 'SetLocalizedDescriptionChange' /** - * Shape of the action for `setDescription` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the [Set Max Applications](ctp:api:type:DiscountCodeSetMaxApplicationsAction) update action. + */ export interface SetMaxApplicationsChange { readonly type: 'SetMaxApplicationsChange' /** - * Shape of the action for `setMaxApplications` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: number /** + * Value after the change. * */ readonly nextValue: number } +/** + * Change triggered by the [Set Max Applications Per Customer](ctp:api:type:DiscountCodeSetMaxApplicationsPerCustomerAction) update action. + */ export interface SetMaxApplicationsPerCustomerChange { readonly type: 'SetMaxApplicationsPerCustomerChange' /** - * Shape of the action for `setMaxApplicationsPerCustomer` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: number /** + * Value after the change. * */ readonly nextValue: number } +/** + * Change triggered by the following update actions: + * + * - [Set Meta Description](ctp:api:type:CategorySetMetaDescriptionAction) on Categories. + * - [Set Meta Description](ctp:api:type:ProductSetMetaDescriptionAction) on Products. + * + */ export interface SetMetaDescriptionChange { readonly type: 'SetMetaDescriptionChange' /** - * Shape of the action for `setMetaDescription` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the following update actions: + * + * - [Set Meta Keywords](ctp:api:type:CategorySetMetaKeywordsAction) on Categories. + * - [Set Meta Keywords](ctp:api:type:ProductSetMetaKeywordsAction) on Products. + * + */ export interface SetMetaKeywordsChange { readonly type: 'SetMetaKeywordsChange' /** - * Shape of the action for `setMetaKeywords` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the following update actions: + * + * - [Set Meta Title](ctp:api:type:CategorySetMetaTitleAction) on Categories. + * - [Set Meta Title](ctp:api:type:ProductSetMetaTitleAction) on Products. + * + */ export interface SetMetaTitleChange { readonly type: 'SetMetaTitleChange' /** - * Shape of the action for `setMetaTitle` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the [Set MethodInfoInterface](ctp:api:type:PaymentSetMethodInfoInterfaceAction) update action. + */ export interface SetMethodInfoInterfaceChange { readonly type: 'SetMethodInfoInterfaceChange' /** - * Shape of the action for `setMethodInfoInterface` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set MethodInfoInterface](ctp:api:type:PaymentSetMethodInfoMethodAction) update action. + */ export interface SetMethodInfoMethodChange { readonly type: 'SetMethodInfoMethodChange' /** - * Shape of the action for `setMethodInfoMethod` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set MethodInfoName](ctp:api:type:PaymentSetMethodInfoNameAction) update action. + */ export interface SetMethodInfoNameChange { readonly type: 'SetMethodInfoNameChange' /** - * Shape of the action for `setMethodInfoName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the [Set Middle Name](ctp:api:type:CustomerSetMiddleNameAction) update action. + */ export interface SetMiddleNameChange { readonly type: 'SetMiddleNameChange' /** - * Shape of the action for `setMiddleName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Set Name](ctp:api:type:DiscountCodeSetNameAction) on Discount Codes. + * - [Set Name](ctp:api:type:StateSetNameAction) on States. + * - [Set Name](ctp:api:type:StoreSetNameAction) on Stores. + * + */ export interface SetNameChange { readonly type: 'SetNameChange' /** - * Shape of the action for `setName` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the following update actions: + * + * - [Set LineItem CustomField](ctp:api:type:OrderSetLineItemCustomFieldAction) on Orders. + * - [Set LineItem CustomField](ctp:api:type:StagedOrderSetLineItemCustomFieldAction) on Staged Orders. + * + */ export interface SetOrderLineItemCustomFieldChange { readonly type: 'SetOrderLineItemCustomFieldChange' /** - * Update action for `setLineItemCustomField` * */ readonly change: string /** + * Value before the change. * */ - readonly customTypeId: string + readonly previousValue: any /** + * Value after the change. * */ - readonly name: string + readonly nextValue: any /** + * `id` of the referenced [Type](ctp:api:type:Type). + * * */ - readonly variant: string + readonly customTypeId: string /** + * Name of the [Custom Field](/../api/projects/custom-fields). * */ - readonly lineItem: LocalizedString + readonly name: string /** + * Name of the [Product](ctp:api:type:Product) the Line Item is based on. * */ - readonly nextValue: any + readonly lineItem: LocalizedString /** + * `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly previousValue: any + readonly variant: string } +/** + * Change triggered by the following update actions: + * + * - [Set LineItem Custom Type](ctp:api:type:OrderSetLineItemCustomTypeAction) on Orders. + * - [Set LineItem Custom Type](ctp:api:type:StagedOrderSetLineItemCustomTypeAction) on Staged Orders. + * + */ export interface SetOrderLineItemCustomTypeChange { readonly type: 'SetOrderLineItemCustomTypeChange' /** - * Update action for `setLineItemCustomType` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: LocalizedString + readonly previousValue: CustomFields /** + * Value after the change. * */ - readonly variant: string + readonly nextValue: CustomFields /** + * Name of the [Product](ctp:api:type:Product) the updated Line Item is based on. * */ - readonly nextValue: CustomFields + readonly lineItem: LocalizedString /** + * `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant). + * * */ - readonly previousValue: CustomFields + readonly variant: string } +/** + * Change triggered by the following update actions: + * + * - [Set Order Number](ctp:api:type:OrderSetOrderNumberAction) on Orders. + * - [Set Order Number](ctp:api:type:StagedOrderSetOrderNumberAction) on Staged Order. + * + */ export interface SetOrderNumberChange { readonly type: 'SetOrderNumberChange' /** - * Shape of the action for `setOrderNumber` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string @@ -4054,286 +5590,376 @@ export interface SetOrderNumberChange { export interface SetOrderTaxedPriceChange { readonly type: 'SetOrderTaxedPriceChange' /** - * Update action for `setOrderTaxedPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly taxMode: TaxMode + readonly previousValue: TaxedItemPrice /** + * Value after the change. * */ readonly nextValue: TaxedItemPrice /** * */ - readonly previousValue: TaxedItemPrice + readonly taxMode: TaxMode } +/** + * Change triggered automatically due to a user-initiated change. + */ export interface SetOrderTotalPriceChange { readonly type: 'SetOrderTotalPriceChange' /** - * Update action for `setOrderTotalPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Money + readonly previousValue: Money /** + * Value after the change. * */ - readonly previousValue: Money + readonly nextValue: Money } +/** + * Change triggered by the [Set OrderTotalTax](ctp:api:type:StagedOrderSetOrderTotalTaxAction) update action. + */ export interface SetOrderTotalTaxChange { readonly type: 'SetOrderTotalTaxChange' /** - * Update action for `setOrderTotalTax` * */ readonly change: string /** + * Value before the change. * */ - readonly taxMode: TaxMode + readonly previousValue: Money /** + * Value after the change. * */ readonly nextValue: Money /** + * `"ExternalAmount"` + * * */ - readonly previousValue: Money + readonly taxMode: TaxMode } +/** + * Change triggered by the following update actions: + * + * - [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) on Orders. + * - [Set Parcel Items](ctp:api:type:StagedOrderSetParcelItemsAction) on Staged Orders. + * + */ export interface SetParcelItemsChange { readonly type: 'SetParcelItemsChange' /** - * Update action for `setParcelItems` * */ readonly change: string /** + * Value before the change. * */ - readonly parcel: ParcelChangeValue + readonly previousValue: DeliveryItem[] /** + * Value after the change. * */ readonly nextValue: DeliveryItem[] /** + * Information about the updated Parcel. * */ - readonly previousValue: DeliveryItem[] + readonly parcel: ParcelChangeValue } +/** + * Change triggered by the following update actions: + * + * - [SetParcelMeasurements](ctp:api:type:OrderSetParcelMeasurementsAction) on Orders. + * - [SetParcelMeasurements](ctp:api:type:StagedOrderSetParcelMeasurementsAction) on Staged Orders. + * + */ export interface SetParcelMeasurementsChange { readonly type: 'SetParcelMeasurementsChange' /** - * Update action for `setParcelMeasurements` * */ readonly change: string /** + * Value before the change. * */ - readonly parcel: ParcelChangeValue + readonly previousValue: ParcelMeasurements /** + * Value after the change. * */ readonly nextValue: ParcelMeasurements /** + * Information about the updated Parcel. * */ - readonly previousValue: ParcelMeasurements + readonly parcel: ParcelChangeValue } +/** + * Change triggered by the following update actions: + * + * - [Set Parcel Tracking Data](ctp:api:type:OrderSetParcelTrackingDataAction) on Orders. + * - [Set Parcel Tracking Data](ctp:api:type:StagedOrderSetParcelTrackingDataAction) on Staged Orders. + * + */ export interface SetParcelTrackingDataChange { readonly type: 'SetParcelTrackingDataChange' /** - * Update action for `setParcelTrackingData` * */ readonly change: string /** + * Value before the change. * */ - readonly parcel: ParcelChangeValue + readonly previousValue: TrackingData /** + * Value after the change. * */ readonly nextValue: TrackingData /** + * Information about the updated Parcel. * */ - readonly previousValue: TrackingData + readonly parcel: ParcelChangeValue } -export interface SetPurchaseOrderNumberChange { - readonly type: 'SetPurchaseOrderNumberChange' +/** + * Change triggered by the [Set Prices](ctp:api:type:ProductSetPricesAction) update action. + */ +export interface SetPricesChange { + readonly type: 'SetPricesChange' /** - * Update action for `setPurchaseOrderNumber`. * */ readonly change: string /** - * Purchase Order number prior to the update action. + * Value before the change. * */ - readonly previousValue: string + readonly previousValue: Price[] /** - * Purchase Order number after the update action. + * Value after the change. * */ - readonly nextValue: string -} -export interface SetPricesChange { - readonly type: 'SetPricesChange' + readonly nextValue: Price[] /** - * Update action for `setPrices` + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. * - */ - readonly change: string - /** * */ readonly catalogData: string /** + * `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant). * - */ - readonly variant: string - /** - * - */ - readonly previousValue: Price[] - /** * */ - readonly nextValue: Price[] + readonly variant: string } +/** + * Change triggered automatically by the [Add Product](ctp:api:type:ProductSelectionAddProductAction) or [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action. + */ export interface SetProductCountChange { readonly type: 'SetProductCountChange' /** - * Update action for `setProductCount` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: number /** + * Value after the change. * */ readonly nextValue: number } +/** + * Change triggered by the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action. + */ export interface SetProductPriceCustomFieldChange { readonly type: 'SetProductPriceCustomFieldChange' /** - * Update action for `setProductPriceCustomField` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: CustomFields /** + * Value after the change. * */ - readonly previousValue: CustomFields + readonly nextValue: CustomFields /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: CustomFields + readonly catalogData: string } +/** + * Change triggered by the [Set Price Custom Type](ctp:api:type:ProductSetProductPriceCustomTypeAction) update action. + */ export interface SetProductPriceCustomTypeChange { readonly type: 'SetProductPriceCustomTypeChange' /** - * Update action for `setProductPriceCustomType` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: CustomFields /** + * Value after the change. * */ - readonly previousValue: CustomFields + readonly nextValue: CustomFields /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: CustomFields + readonly catalogData: string } +/** + * Change triggered by the [Set Product Selections](ctp:api:type:StoreSetProductSelectionsAction) update action. + */ export interface SetProductSelectionsChange { readonly type: 'SetProductSelectionsChange' /** - * Update action for `setProductSelections` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: ProductSelectionSetting[] /** + * Value after the change. * */ readonly nextValue: ProductSelectionSetting[] } +/** + * Change triggered by the [Set ProductVariant Key](ctp:api:type:ProductSetProductVariantKeyAction) update action. + */ export interface SetProductVariantKeyChange { readonly type: 'SetProductVariantKeyChange' /** - * Update action for `setProductVariantKey` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: string /** + * Value after the change. * */ - readonly previousValue: string + readonly nextValue: string /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: string + readonly catalogData: string } +/** + * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when an existing property is updated. + */ export interface SetPropertyChange { readonly type: 'SetPropertyChange' /** - * Update action for `setProperty` on custom objects * */ readonly change: string /** - * Value path to the property that was changed + * Value before the change. + * + */ + readonly previousValue: any + /** + * Value after the change. + * + */ + readonly nextValue: any + /** + * Path to the property that was updated. * */ readonly path: string +} +/** + * Change triggered by the following update actions: + * + * - [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) on Orders. + * - [Set Purchase Order Number](ctp:api:type:StagedOrderSetPurchaseOrderNumberAction) on Staged Orders. + * + */ +export interface SetPurchaseOrderNumberChange { + readonly type: 'SetPurchaseOrderNumberChange' + /** + * + */ + readonly change: string /** + * Value before the change. * */ - readonly nextValue: any + readonly previousValue: string /** + * Value after the change. * */ - readonly previousValue: any + readonly nextValue: string } +/** + * Change triggered by the [Set Rating](ctp:api:type:ReviewSetRatingAction) update action. + */ export interface SetRatingChange { readonly type: 'SetRatingChange' /** - * Shape of the action for `setRating` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: number /** + * Value after the change. * */ readonly nextValue: number @@ -4341,345 +5967,437 @@ export interface SetRatingChange { export interface SetReservationsChange { readonly type: 'SetReservationsChange' /** - * Update action for `setReservations` on inventories * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Reservation[] + readonly previousValue: Reservation[] /** + * Value after the change. * */ - readonly previousValue: Reservation[] + readonly nextValue: Reservation[] } +/** + * Change triggered by the [Set RestockableInDays](ctp:api:type:InventoryEntrySetRestockableInDaysAction) update action. + */ export interface SetRestockableInDaysChange { readonly type: 'SetRestockableInDaysChange' /** - * Shape of the action for `setRestockableInDays` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: number /** + * Value after the change. * */ readonly nextValue: number } +/** + * Change triggered by the following update actions: + * + * - [Set PaymentShipmentState](ctp:api:type:OrderSetReturnPaymentStateAction) on Orders. + * - [Set PaymentShipmentState](ctp:api:type:StagedOrderSetReturnPaymentStateAction) on Staged Orders. + * + */ export interface SetReturnPaymentStateChange { readonly type: 'SetReturnPaymentStateChange' /** - * Update action for `setReturnPaymentState` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: ReturnPaymentState + readonly previousValue: ReturnPaymentState /** + * Value after the change. * */ - readonly previousValue: ReturnPaymentState + readonly nextValue: ReturnPaymentState } +/** + * Change triggered by the following update actions: + * + * - [Set ReturnShipmentState](ctp:api:type:OrderSetReturnShipmentStateAction) on Orders. + * - [Set ReturnShipmentState](ctp:api:type:StagedOrderSetReturnShipmentStateAction) on Staged Orders. + * + */ export interface SetReturnShipmentStateChange { readonly type: 'SetReturnShipmentStateChange' /** - * Update action for `setReturnShipmentState` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: ReturnShipmentState + readonly previousValue: ReturnShipmentState /** + * Value after the change. * */ - readonly previousValue: ReturnShipmentState + readonly nextValue: ReturnShipmentState } +/** + * Change triggered by the [Set Salutation](ctp:api:type:CustomerSetSalutationAction) update action. + */ export interface SetSalutationChange { readonly type: 'SetSalutationChange' /** - * Shape of the action for `setSalutation` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set SearchKeywords](ctp:api:type:ProductSetSearchKeywordsAction) update action. + */ export interface SetSearchKeywordsChange { readonly type: 'SetSearchKeywordsChange' /** - * Update action for `setSearchKeywords` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: SearchKeywords /** + * Value after the change. * */ - readonly previousValue: SearchKeywords + readonly nextValue: SearchKeywords /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: SearchKeywords + readonly catalogData: string } +/** + * Change triggered by the [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action. + */ export interface SetSellerCommentChange { readonly type: 'SetSellerCommentChange' /** - * Shape of the action for `setSellerComment` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) on Orders. + * - [Set Shipping Address](ctp:api:type:StagedOrderSetShippingAddressAction) on Staged Orders. + * + */ export interface SetShippingAddressChange { readonly type: 'SetShippingAddressChange' /** - * Update action for `setShippingAddress` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Address + readonly previousValue: Address /** + * Value after the change. * */ - readonly previousValue: Address + readonly nextValue: Address } export interface SetShippingInfoPriceChange { readonly type: 'SetShippingInfoPriceChange' /** - * Update action for `setShippingInfoPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Money + readonly previousValue: Money /** + * Value after the change. * */ - readonly previousValue: Money + readonly nextValue: Money } export interface SetShippingInfoTaxedPriceChange { readonly type: 'SetShippingInfoTaxedPriceChange' /** - * Update action for `setShippingInfoTaxedPrice` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: TaxedPrice + readonly previousValue: TaxedPrice /** + * Value after the change. * */ - readonly previousValue: TaxedPrice + readonly nextValue: TaxedPrice } +/** + * Change triggered by the [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) update action. + */ export interface SetShippingMethodChange { readonly type: 'SetShippingMethodChange' /** - * Update action for `setShippingMethod` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: ShippingMethodChangeValue + readonly previousValue: ShippingMethodChangeValue /** + * Value after the change. * */ - readonly previousValue: ShippingMethodChangeValue + readonly nextValue: ShippingMethodChangeValue } +/** + * Change triggered by the [Set ShippingMethod TaxAmount](ctp:api:type:StagedOrderSetShippingMethodTaxAmountAction) update action. + */ export interface SetShippingMethodTaxAmountChange { readonly type: 'SetShippingMethodTaxAmountChange' /** - * Update action for `setShippingMethodTaxAmount` * */ readonly change: string /** + * Value before the change. * */ - readonly taxMode: TaxMode + readonly previousValue: ShippingMethodTaxAmountChangeValue /** + * Value after the change. * */ readonly nextValue: ShippingMethodTaxAmountChangeValue /** + * `"ExternalAmount"` + * * */ - readonly previousValue: ShippingMethodTaxAmountChangeValue + readonly taxMode: TaxMode } +/** + * Change triggered by the [Set ShippingMethod TaxRate](ctp:api:type:StagedOrderSetShippingMethodTaxRateAction) update action. + */ export interface SetShippingMethodTaxRateChange { readonly type: 'SetShippingMethodTaxRateChange' /** - * Update action for `setShippingMethodTaxRate` * */ readonly change: string /** + * Value before the change. * */ - readonly taxMode: TaxMode + readonly previousValue: TaxRate /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * Value after the change. * */ readonly nextValue: TaxRate /** - * Shape of the value for `addTaxRate` and `removeTaxRate` actions + * `"External"` + * * */ - readonly previousValue: TaxRate + readonly taxMode: TaxMode } export interface SetShippingRateChange { readonly type: 'SetShippingRateChange' /** - * Update action for `setShippingRate` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: Money + readonly previousValue: Money /** + * Value after the change. * */ - readonly previousValue: Money + readonly nextValue: Money } +/** + * Change triggered by the [Set Shipping Rate Input](ctp:api:type:StagedOrderSetShippingRateInputAction) update action. + */ export interface SetShippingRateInputChange { readonly type: 'SetShippingRateInputChange' /** - * Update action for `setShippingRateInput` * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: + readonly previousValue: | SetCartClassificationShippingRateInputValue | SetCartScoreShippingRateInputValue /** + * Value after the change. * */ - readonly previousValue: + readonly nextValue: | SetCartClassificationShippingRateInputValue | SetCartScoreShippingRateInputValue } +/** + * Change triggered by the [Set ShoppingListLineItem Custom Field](ctp:api:type:ShoppingListSetLineItemCustomFieldAction) update action. + */ export interface SetShoppingListLineItemCustomFieldChange { readonly type: 'SetShoppingListLineItemCustomFieldChange' /** - * Update action for `setLineItemCustomField` * */ readonly change: string /** + * Value before the change. * */ - readonly name: string + readonly previousValue: any /** + * Value after the change. * */ - readonly customTypeId: string + readonly nextValue: any /** + * Name of the [Custom Field](/../api/projects/custom-fields). * */ - readonly lineItem: ShoppingListLineItemValue + readonly name: string /** + * `id` of the referenced [Type](ctp:api:type:Type). + * * */ - readonly nextValue: any + readonly customTypeId: string /** + * Holds information about the updated Shopping List Line Item. * */ - readonly previousValue: any + readonly lineItem: ShoppingListLineItemValue } +/** + * Change triggered by the [Set ShoppingListLineItem Custom Type](ctp:api:type:ShoppingListSetLineItemCustomTypeAction) update action. + */ export interface SetShoppingListLineItemCustomTypeChange { readonly type: 'SetShoppingListLineItemCustomTypeChange' /** - * Update action for `setLineItemCustomType` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItem: ShoppingListLineItemValue + readonly previousValue: CustomFields /** + * Value after the change. * */ readonly nextValue: CustomFields /** + * Holds information about the updated Shopping List Line Item. * */ - readonly previousValue: CustomFields + readonly lineItem: ShoppingListLineItemValue } +/** + * Change triggered by the [Set SKU](ctp:api:type:ProductSetSkuAction) update action. + */ export interface SetSkuChange { readonly type: 'SetSkuChange' /** - * Update action for `setSku` * */ readonly change: string /** + * Value before the change. * */ - readonly catalogData: string + readonly previousValue: string /** + * Value after the change. * */ - readonly previousValue: string + readonly nextValue: string /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ - readonly nextValue: string + readonly catalogData: string } +/** + * Change triggered by the [Set Slug](ctp:api:type:ShoppingListSetSlugAction) update action. + */ export interface SetSlugChange { readonly type: 'SetSlugChange' /** - * Shape of the action for `setSlug` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: LocalizedString /** + * Value after the change. * */ readonly nextValue: LocalizedString } +/** + * Change triggered by the [Set State roles](ctp:api:type:StateSetRolesAction) update action. + */ export interface SetStateRolesChange { readonly type: 'SetStateRolesChange' /** @@ -4687,206 +6405,284 @@ export interface SetStateRolesChange { */ readonly change: string /** + * Value before the change. * */ readonly previousValue: StateRole[] /** + * Value after the change. * */ readonly nextValue: StateRole[] } +/** + * Change triggered by the [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action. + */ export interface SetStatusInterfaceCodeChange { readonly type: 'SetStatusInterfaceCodeChange' /** - * Shape of the action for `setStatusInterfaceCode` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set StatusInterfaceText](ctp:api:type:PaymentSetStatusInterfaceTextAction) update action. + */ export interface SetStatusInterfaceTextChange { readonly type: 'SetStatusInterfaceTextChange' /** - * Shape of the action for `setStatusInterfaceText` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Set Store](ctp:api:type:OrderSetStoreAction) on Orders. + * - [Set Store](ctp:api:type:ShoppingListSetStoreAction) on Shopping Lists. + * + */ export interface SetStoreChange { readonly type: 'SetStoreChange' /** - * Shape of the action for `setStore` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered by the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action. + */ +export interface SetStoreModeChange { + readonly type: 'SetStoreModeChange' + /** + * + */ + readonly change: string + /** + * Value before the change. + * + */ + readonly previousValue: BusinessUnitStoreMode + /** + * Value after the change. + * + */ + readonly nextValue: BusinessUnitStoreMode +} +/** + * Change triggered by the [Set Stores](ctp:api:type:CustomerSetStoresAction) update action. + */ export interface SetStoresChange { readonly type: 'SetStoresChange' /** - * Shape of the action for `setStores` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference[] /** + * Value after the change. * */ readonly nextValue: Reference[] } +/** + * Change triggered by the [Set SupplyChannel](ctp:api:type:InventoryEntrySetSupplyChannelAction) update action. + */ export interface SetSupplyChannelChange { readonly type: 'SetSupplyChannelChange' /** - * Shape of the action for `setSupplyChannel` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered by the [Set Supply Channels](ctp:api:type:StoreSetSupplyChannelsAction) update action. + */ export interface SetSupplyChannelsChange { readonly type: 'SetSupplyChannelsChange' /** - * Shape of the action for `setSupplyChannels` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference[] /** + * Value after the change. * */ readonly nextValue: Reference[] } +/** + * Change triggered by the [Set Target](ctp:api:type:ReviewSetTargetAction) update action. + */ export interface SetTargetChange { readonly type: 'SetTargetChange' /** - * Shape of the action for `setTarget` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered by the [Set TaxCategory](ctp:api:type:ProductSetTaxCategoryAction) update action. + */ export interface SetTaxCategoryChange { readonly type: 'SetTaxCategoryChange' /** - * Shape of the action for `setTaxCategory` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered by the [Set Text](ctp:api:type:ReviewSetTextAction) update action. + */ export interface SetTextChange { readonly type: 'SetTextChange' /** - * Shape of the action for `setText` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set TextLineItem CustomField](ctp:api:type:ShoppingListSetTextLineItemCustomFieldAction) update action. + */ export interface SetTextLineItemCustomFieldChange { readonly type: 'SetTextLineItemCustomFieldChange' /** - * Update action for `setTextLineItemCustomField` * */ readonly change: string /** + * Value before the change. * */ - readonly name: string + readonly previousValue: any /** + * Value after the change. * */ - readonly customTypeId: string + readonly nextValue: any /** + * Name of the [Custom Field](/../api/projects/custom-fields). * */ - readonly textLineItem: TextLineItemValue + readonly name: string /** + * `id` of the referenced [Type](ctp:api:type:Type). + * * */ - readonly nextValue: any + readonly customTypeId: string /** + * Holds information about the updated Text Line Item. * */ - readonly previousValue: any + readonly textLineItem: TextLineItemValue } +/** + * Change triggered by the [Set TextLineItem Custom Type](ctp:api:type:ShoppingListSetTextLineItemCustomTypeAction) update action. + */ export interface SetTextLineItemCustomTypeChange { readonly type: 'SetTextLineItemCustomTypeChange' /** - * Update action for `setTextLineItemCustomType` * */ readonly change: string /** + * Value before the change. * */ - readonly textLineItem: TextLineItemValue + readonly previousValue: CustomFields /** + * Value after the change. * */ readonly nextValue: CustomFields /** + * Holds information about the updated Text Line Item. * */ - readonly previousValue: CustomFields + readonly textLineItem: TextLineItemValue } +/** + * Change triggered by the [Set TextLineItem Description](ctp:api:type:ShoppingListSetTextLineItemDescriptionAction) update action. + */ export interface SetTextLineItemDescriptionChange { readonly type: 'SetTextLineItemDescriptionChange' /** @@ -4894,50 +6690,73 @@ export interface SetTextLineItemDescriptionChange { */ readonly change: string /** + * Value before the change. * */ - readonly textLineItem: TextLineItemValue + readonly previousValue: LocalizedString /** + * Value after the change. * */ - readonly previousValue: LocalizedString + readonly nextValue: LocalizedString /** + * Holds information about the updated Text Line Item. * */ - readonly nextValue: LocalizedString + readonly textLineItem: TextLineItemValue } +/** + * Change triggered by the following update actions: + * + * - [Set Title](ctp:api:type:CustomerSetTitleAction) on Customers. + * - [Set Title](ctp:api:type:ReviewSetTitleAction) on Reviews. + * + */ export interface SetTitleChange { readonly type: 'SetTitleChange' /** - * Shape of the action for `setTitle` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Transitions](ctp:api:type:StateSetTransitionsAction) update action. + */ export interface SetTransitionsChange { readonly type: 'SetTransitionsChange' /** - * Shape of the action for `setTransitions` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference[] /** + * Value after the change. * */ readonly nextValue: Reference[] } +/** + * Change triggered by the following update actions: + * + * - [Set Valid From and Until](ctp:api:type:CartDiscountSetValidFromAndUntilAction) on Cart Discounts. + * - [Set Valid From and Until](ctp:api:type:DiscountCodeSetValidFromAndUntilAction) on Discount Codes. + * - [Set Valid From and Until](ctp:api:type:ProductDiscountSetValidFromAndUntilAction) on Product Discounts. + * + */ export interface SetValidFromAndUntilChange { readonly type: 'SetValidFromAndUntilChange' /** @@ -4945,199 +6764,312 @@ export interface SetValidFromAndUntilChange { */ readonly change: string /** - * Shape of the value for `setValidFromAndUntil` action + * Value before the change. * */ readonly previousValue: ValidFromAndUntilValue /** - * Shape of the value for `setValidFromAndUntil` action + * Value after the change. * */ readonly nextValue: ValidFromAndUntilValue } +/** + * Change triggered by the following update actions: + * + * - [Set Valid From](ctp:api:type:CartDiscountSetValidFromAction) on Cart Discounts. + * - [Set Valid From](ctp:api:type:DiscountCodeSetValidFromAction) on Discount Codes. + * - [Set Valid From](ctp:api:type:ProductDiscountSetValidFromAction) on Product Discounts. + * + */ export interface SetValidFromChange { readonly type: 'SetValidFromChange' /** - * Shape of the action for `setValidFrom` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action. + */ export interface SetValidToChange { readonly type: 'SetValidToChange' /** - * Shape of the action for `setValidTo` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Set Valid Until](ctp:api:type:CartDiscountSetValidUntilAction) on Cart Discounts. + * - [Set Valid Until](ctp:api:type:DiscountCodeSetValidUntilAction) on Discount Codes. + * - [Set Valid Until](ctp:api:type:ProductDiscountSetValidUntilAction) on Product Discounts. + * + */ export interface SetValidUntilChange { readonly type: 'SetValidUntilChange' /** - * Shape of the action for `setValidUntil` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when a value of a property is updated. + */ export interface SetValueChange { readonly type: 'SetValueChange' /** - * Update action for `setValue` on custom objects * */ readonly change: string /** + * Value before the change. * */ - readonly nextValue: any + readonly previousValue: any /** + * Value after the change. * */ - readonly previousValue: any + readonly nextValue: any } +/** + * Change triggered automatically when an [InventoryEntry](ctp:api:type:InventoryEntry) associated with a Product changes. + */ export interface SetVariantAvailabilityChange { readonly type: 'SetVariantAvailabilityChange' /** - * Update action for `setVariantAvailability` * */ readonly change: string /** + * Value before the change. + * + */ + readonly previousValue: ProductVariantAvailability + /** + * Value after the change. + * + */ + readonly nextValue: ProductVariantAvailability + /** + * - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated. + * * */ readonly catalogData: string /** + * `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant). + * * */ readonly variant: string +} +/** + * Change triggered by the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action. + */ +export interface SetVariantSelectionChange { + readonly type: 'SetVariantSelectionChange' /** * */ - readonly previousValue: ProductVariantAvailability + readonly change: string /** + * Value before the change. * */ - readonly nextValue: ProductVariantAvailability + readonly previousValue: ProductVariantSelection + /** + * Value after the change. + * + */ + readonly nextValue: ProductVariantSelection + /** + * Reference to the updated [Product](ctp:api:type:Product). + * + */ + readonly product: Reference } +/** + * Change triggered by the [Set Vat ID](ctp:api:type:CustomerSetVatIdAction) update action. + */ export interface SetVatIdChange { readonly type: 'SetVatIdChange' /** - * Shape of the action for `setVatId` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: string /** + * Value after the change. * */ readonly nextValue: string } +/** + * Change triggered by the following update actions: + * + * - [Change the state of CustomLineItem according to allowed transitions](ctp:api:type:OrderTransitionCustomLineItemStateAction) on Orders. + * - [Change the state of CustomLineItem according to allowed transitions](ctp:api:type:StagedOrderTransitionCustomLineItemStateAction) on Staged Orders. + * + */ export interface TransitionCustomLineItemStateChange { readonly type: 'TransitionCustomLineItemStateChange' /** - * Update action for `transitionCustomLineItemState` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItemId: string + readonly previousValue: ItemState[] /** + * Value after the change. * */ - readonly stateId: string + readonly nextValue: ItemState[] /** + * `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem). + * * */ - readonly nextValue: ItemState[] + readonly lineItemId: string /** + * `id` of the [State](ctp:api:type:State) involved in the transition. + * * */ - readonly previousValue: ItemState[] + readonly stateId: string } +/** + * Change triggered by the following update actions: + * + * - [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Orders. + * - [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Staged Orders. + * + */ export interface TransitionLineItemStateChange { readonly type: 'TransitionLineItemStateChange' /** - * Update action for `transitionLineItemState` * */ readonly change: string /** + * Value before the change. * */ - readonly lineItemId: string + readonly previousValue: ItemState[] /** + * Value after the change. * */ - readonly stateId: string + readonly nextValue: ItemState[] /** + * `id` of the updated [LineItem](ctp:api:type:LineItem). + * * */ - readonly nextValue: ItemState[] + readonly lineItemId: string /** + * `id` of the [State](ctp:api:type:State) involved in the transition. + * * */ - readonly previousValue: ItemState[] + readonly stateId: string } +/** + * Change triggered by the following update actions: + * + * - [Transition State](ctp:api:type:OrderTransitionStateAction) on Orders. + * - [Transition State](ctp:api:type:StagedOrderTransitionStateAction) on Staged Orders. + * - [Transition State](ctp:api:type:PaymentTransitionStateAction) on Payments. + * - [Transition State](ctp:api:type:ProductTransitionStateAction) on Products. + * - [Transition State](ctp:api:type:QuoteTransitionStateAction) on Quotes. + * - [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) on Staged Quotes. + * - [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) on Quote Requests. + * - [Transition State](ctp:api:type:ReviewTransitionStateAction) on Reviews. + * - [Transition State](ctp:api:type:StateSetTransitionsAction) on States. + * + */ export interface TransitionStateChange { readonly type: 'TransitionStateChange' /** - * Shape of the action for `transitionState` * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: Reference /** + * Value after the change. * */ readonly nextValue: Reference } +/** + * Change triggered when the format of changes on an entity is not identified by Audit Log. + */ export interface UnknownChange { readonly type: 'UnknownChange' /** + * Identifier for the type of modification. + * * */ readonly change: string /** + * Value before the change. * */ readonly previousValue: any /** + * Value after the change. * */ readonly nextValue: any } +/** + * Change triggered by the [Unpublish](ctp:api:type:ProductUnpublishAction) update action. + */ export interface UnpublishChange { readonly type: 'UnpublishChange' /** @@ -5145,22 +7077,34 @@ export interface UnpublishChange { */ readonly change: string } +/** + * Change triggered by the following update actions: + * + * - [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) on Orders. + * - [Update SyncInfo](ctp:api:type:StagedOrderUpdateSyncInfoAction) on Staged Orders. + * + */ export interface UpdateSyncInfoChange { readonly type: 'UpdateSyncInfoChange' /** - * Update action for `updateSyncInfo` * */ readonly change: string /** + * Value after the change. * */ - readonly channelId: string + readonly nextValue: SyncInfo /** + * `id` of the updated [Channel](ctp:api:type:Channel). + * * */ - readonly nextValue: SyncInfo + readonly channelId: string } +/** + * Change triggered by a Customer email verification. + */ export interface VerifyEmailChange { readonly type: 'VerifyEmailChange' /** diff --git a/packages/history-sdk/src/generated/models/common.ts b/packages/history-sdk/src/generated/models/common.ts index 0f67a533e..2a6f6a293 100644 --- a/packages/history-sdk/src/generated/models/common.ts +++ b/packages/history-sdk/src/generated/models/common.ts @@ -162,6 +162,31 @@ export interface AssetSource { */ readonly contentType: string } +export interface Associate { + /** + * + */ + readonly associateRoleAssignments: AssociateRoleAssignment[] + /** + * + */ + readonly customer: Reference +} +export interface AssociateRoleAssignment { + /** + * + */ + readonly associateRole: KeyReference + /** + * Determines whether an [AssociateRoleAssignment](ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units. + * + */ + readonly inheritance: AssociateRoleInheritanceMode +} +/** + * Determines whether an [AssociateRoleAssignment](ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units. + */ +export type AssociateRoleInheritanceMode = 'Disabled' | 'Enabled' | string export type AttributeConstraintEnum = | 'CombinationUnique' | 'None' @@ -212,6 +237,21 @@ export interface AttributeType { readonly name: string } export type AuthenticationMode = 'ExternalAuth' | 'Password' | string +/** + * Determines whether a Business Unit can inherit Associates from a parent. + */ +export type BusinessUnitAssociateMode = + | 'Explicit' + | 'ExplicitAndFromParent' + | string +/** + * Indicates whether the Business Unit can be edited and used in [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), or [Quotes](ctp:api:type:Quote). + */ +export type BusinessUnitStatus = 'Active' | 'Inactive' | string +/** + * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit. + */ +export type BusinessUnitStoreMode = 'Explicit' | 'FromParent' | string export interface CategoryOrderHints { [key: string]: string } @@ -645,6 +685,17 @@ export interface ProductVariantChannelAvailability { export interface ProductVariantChannelAvailabilityMap { [key: string]: ProductVariantChannelAvailability } +export interface ProductVariantSelection { + /** + * + */ + readonly type: ProductVariantSelectionTypeEnum + /** + * + */ + readonly skus: string[] +} +export type ProductVariantSelectionTypeEnum = 'exclusion' | 'inclusion' | string export type QuoteRequestState = | 'Accepted' | 'Cancelled' @@ -655,6 +706,7 @@ export type QuoteRequestState = export type QuoteState = | 'Accepted' | 'Declined' + | 'DeclinedForRenegotiation' | 'Failed' | 'Pending' | 'Withdrawn' @@ -670,6 +722,8 @@ export interface Reference { readonly typeId: ReferenceTypeId } export type ReferenceTypeId = + | 'associate-role' + | 'business-unit' | 'cart' | 'cart-discount' | 'category' @@ -720,6 +774,20 @@ export interface Reservation { */ readonly checkoutStartedAt: string } +export interface ResourceIdentifier { + /** + * + */ + readonly id: string + /** + * + */ + readonly key: string + /** + * + */ + readonly typeId: ReferenceTypeId +} export interface ReturnInfo { /** * @@ -967,10 +1035,12 @@ export interface TaxedItemPrice { } export interface TaxedPrice { /** + * Total net price of the Order. * */ readonly totalNet: Money /** + * Total gross price of the Order. * */ readonly totalGross: Money diff --git a/packages/history-sdk/src/generated/models/label.ts b/packages/history-sdk/src/generated/models/label.ts index 22e6afb22..0c722f12b 100644 --- a/packages/history-sdk/src/generated/models/label.ts +++ b/packages/history-sdk/src/generated/models/label.ts @@ -10,6 +10,7 @@ import { LocalizedString, Money, Reference } from './common' * Provides descriptive information specific to the resource. */ export type Label = + | BusinessUnitLabel | CustomObjectLabel | CustomerLabel | LocalizedLabel @@ -21,13 +22,30 @@ export type Label = | ReviewLabel | StagedQuoteLabel | StringLabel +export interface BusinessUnitLabel { + readonly type: 'BusinessUnitLabel' + /** + * User-defined unique identifier of the [Business Unit](ctp:api:type:BusinessUnit). + * + */ + readonly key: string + /** + * Name of the Business Unit. + * + */ + readonly name: string +} export interface CustomObjectLabel { readonly type: 'CustomObjectLabel' /** + * User-defined unique identifier of the CustomObject within the defined `container`. + * * */ readonly key: string /** + * Namespace to group Custom Objects. + * * */ readonly container: string @@ -35,14 +53,20 @@ export interface CustomObjectLabel { export interface CustomerLabel { readonly type: 'CustomerLabel' /** + * Given name (first name) of the Customer. + * * */ readonly firstName: string /** + * Family name (last name) of the Customer. + * * */ readonly lastName: string /** + * User-defined unique identifier of the [Customer](ctp:api:type:Customer). + * * */ readonly customerNumber: string @@ -50,6 +74,8 @@ export interface CustomerLabel { export interface LocalizedLabel { readonly type: 'LocalizedLabel' /** + * Changed value. + * * */ readonly value: LocalizedString @@ -57,10 +83,14 @@ export interface LocalizedLabel { export interface OrderLabel { readonly type: 'OrderLabel' /** + * Email address of the Customer that the Order belongs to. + * * */ readonly customerEmail: string /** + * User-defined unique identifier of the Order that is unique across a Project. + * * */ readonly orderNumber: string @@ -68,10 +98,14 @@ export interface OrderLabel { export interface PaymentLabel { readonly type: 'PaymentLabel' /** + * User-defined unique identifier of the Payment. + * * */ readonly key: string /** + * Money value the Payment intends to receive from the Customer. + * * */ readonly amountPlanned: Money @@ -79,10 +113,14 @@ export interface PaymentLabel { export interface ProductLabel { readonly type: 'ProductLabel' /** + * User-defined identifier used in a deep-link URL for the Product. + * * */ readonly slug: LocalizedString /** + * Name of the Product. + * * */ readonly name: LocalizedString @@ -90,18 +128,26 @@ export interface ProductLabel { export interface QuoteLabel { readonly type: 'QuoteLabel' /** + * User-defined unique identifier of the Quote. + * * */ readonly key: string /** + * The [Buyer](/../api/quotes-overview#buyer) who requested the Quote. + * * */ readonly customer: Reference /** + * Staged Quote related to the Quote. + * * */ readonly stagedQuote: Reference /** + * Quote Request related to the Quote. + * * */ readonly quoteRequest: Reference @@ -109,10 +155,14 @@ export interface QuoteLabel { export interface QuoteRequestLabel { readonly type: 'QuoteRequestLabel' /** + * User-defined unique identifier of the Quote Request. + * * */ readonly key: string /** + * The [Buyer](/../api/quotes-overview#buyer) who raised the Quote Request. + * * */ readonly customer: Reference @@ -120,10 +170,14 @@ export interface QuoteRequestLabel { export interface ReviewLabel { readonly type: 'ReviewLabel' /** + * User-defined unique identifier of the Review. + * * */ readonly key: string /** + * Title of the Review. + * * */ readonly title: string @@ -131,14 +185,20 @@ export interface ReviewLabel { export interface StagedQuoteLabel { readonly type: 'StagedQuoteLabel' /** + * User-defined unique identifier of the Staged Quote. + * * */ readonly key: string /** + * The [Buyer](/../api/quotes-overview#buyer) who requested the Quote. + * * */ readonly customer: Reference /** + * Quote Request related to the Staged Quote. + * * */ readonly quoteRequest: Reference @@ -146,6 +206,8 @@ export interface StagedQuoteLabel { export interface StringLabel { readonly type: 'StringLabel' /** + * Changed value. + * * */ readonly value: string diff --git a/packages/history-sdk/test/generated/client/by-project-key-by-resource-type-request-builder.test.ts b/packages/history-sdk/test/generated/client/by-project-key-by-resource-type-request-builder.test.ts index 839e3e2ae..92b3f8e92 100644 --- a/packages/history-sdk/test/generated/client/by-project-key-by-resource-type-request-builder.test.ts +++ b/packages/history-sdk/test/generated/client/by-project-key-by-resource-type-request-builder.test.ts @@ -69,11 +69,11 @@ export function getRequestsWithMethodParameters(): RequestWithMethod[] { }, { method: 'get', - uri: '/test_projectKey/test_resourceType?resourceId=resourceId', + uri: '/test_projectKey/test_resourceType?resourceKey=resourceKey', request: apiRoot .withProjectKeyValue({ projectKey: 'test_projectKey' }) .withResourceTypeValue({ resourceType: 'test_resourceType' }) - .get({ queryArgs: { resourceId: 'resourceId' } }), + .get({ queryArgs: { resourceKey: 'resourceKey' } }), }, { method: 'get', diff --git a/packages/history-sdk/test/generated/client/by-project-key-request-builder.test.ts b/packages/history-sdk/test/generated/client/by-project-key-request-builder.test.ts index 2bf3b4232..9c7309d73 100644 --- a/packages/history-sdk/test/generated/client/by-project-key-request-builder.test.ts +++ b/packages/history-sdk/test/generated/client/by-project-key-request-builder.test.ts @@ -13,10 +13,10 @@ export function getRequestsWithMethodParameters(): RequestWithMethod[] { return [ { method: 'get', - uri: '/test_projectKey?resourceTypes=cart-discount', + uri: '/test_projectKey?resourceTypes=business-unit', request: apiRoot .withProjectKeyValue({ projectKey: 'test_projectKey' }) - .get({ queryArgs: { resourceTypes: 'cart-discount' } }), + .get({ queryArgs: { resourceTypes: 'business-unit' } }), }, { method: 'get', @@ -55,10 +55,10 @@ export function getRequestsWithMethodParameters(): RequestWithMethod[] { }, { method: 'get', - uri: '/test_projectKey?type=ResourceCreated', + uri: '/test_projectKey?type=type', request: apiRoot .withProjectKeyValue({ projectKey: 'test_projectKey' }) - .get({ queryArgs: { type: 'ResourceCreated' } }), + .get({ queryArgs: { type: 'type' } }), }, { method: 'get', @@ -74,6 +74,13 @@ export function getRequestsWithMethodParameters(): RequestWithMethod[] { .withProjectKeyValue({ projectKey: 'test_projectKey' }) .get({ queryArgs: { resourceId: 'resourceId' } }), }, + { + method: 'get', + uri: '/test_projectKey?resourceKey=resourceKey', + request: apiRoot + .withProjectKeyValue({ projectKey: 'test_projectKey' }) + .get({ queryArgs: { resourceKey: 'resourceKey' } }), + }, { method: 'get', uri: '/test_projectKey?source=source', diff --git a/packages/importapi-sdk/src/generated/models/types.ts b/packages/importapi-sdk/src/generated/models/types.ts index f3ebb5a1f..81cec95e0 100644 --- a/packages/importapi-sdk/src/generated/models/types.ts +++ b/packages/importapi-sdk/src/generated/models/types.ts @@ -163,6 +163,8 @@ export interface CustomFieldReferenceType { * Defines which resource type a [CustomFieldReferenceType](ctp:import:type:CustomFieldReferenceType) can reference. */ export type CustomFieldReferenceValue = + | 'associate-role' + | 'business-unit' | 'cart' | 'category' | 'channel' diff --git a/packages/platform-sdk/src/generated/models/business-unit.ts b/packages/platform-sdk/src/generated/models/business-unit.ts index a988c7ed3..aecc56b9a 100644 --- a/packages/platform-sdk/src/generated/models/business-unit.ts +++ b/packages/platform-sdk/src/generated/models/business-unit.ts @@ -952,7 +952,7 @@ export interface BusinessUnitChangeNameAction { export interface BusinessUnitChangeParentUnitAction { readonly action: 'changeParentUnit' /** - * New parent unit of the [Business Unit](ctp:api:type:BusinessUnit). + * New parent unit of the [Business Unit](ctp:api:type:BusinessUnit). The new parent unit must have the same top-level unit as the old parent unit. * * */ diff --git a/packages/platform-sdk/src/generated/models/cart-discount.ts b/packages/platform-sdk/src/generated/models/cart-discount.ts index 223bc9524..3f7d22451 100644 --- a/packages/platform-sdk/src/generated/models/cart-discount.ts +++ b/packages/platform-sdk/src/generated/models/cart-discount.ts @@ -411,7 +411,7 @@ export interface CartDiscountValueAbsoluteDraft { readonly money: Money[] } /** - * Sets the [DiscountedLineItemPrice](ctp:api:type:DiscountedLineItemPrice) of the [CartDiscountLineItemsTarget](ctp:api:type:CartDiscountLineItemsTarget) or [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget) to the value specified in the `money` field, if it is lower than the current Line Item price for the same currency. If the Line Item price is already discounted to a price equal to or lower than the respective price in the `money` field, this Discount is not applied. + * Sets the [DiscountedLineItemPrice](ctp:api:type:DiscountedLineItemPrice) of the [CartDiscountLineItemsTarget](ctp:api:type:CartDiscountLineItemsTarget) or [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget) to the value specified in the `money` field, if it is lower than the current Line Item price for the same currency. If the Line Item price is already discounted to a price equal to or lower than the respective price in the `money` field, this Discount is not applied. If the `quantity` of the Line Item eligible for the Discount is greater than `1`, the fixed price discount is only applied to the Line Item portion for which the `money` value is lesser than their current price. * */ export interface CartDiscountValueFixed { diff --git a/packages/platform-sdk/src/generated/models/cart.ts b/packages/platform-sdk/src/generated/models/cart.ts index c7dc02ae5..b9a683f87 100644 --- a/packages/platform-sdk/src/generated/models/cart.ts +++ b/packages/platform-sdk/src/generated/models/cart.ts @@ -761,6 +761,12 @@ export interface CustomLineItem { * */ readonly taxRate?: TaxRate + /** + * Tax Rate per Shipping Method for a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode). For a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode) it is automatically set after the [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction). + * For a Cart with `External` [TaxMode](ctp:api:type:TaxMode), the Tax Rate must be set with [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft). + * + */ + readonly perMethodTaxRate: MethodTaxRate[] /** * Discounted price of a single quantity of the Custom Line Item. * @@ -1205,11 +1211,17 @@ export interface ItemShippingTarget { */ export interface LineItem { /** - * Unique identifier of the Line Item. + * Unique identifier of the LineItem. * * */ readonly id: string + /** + * User-defined unique identifier of the LineItem. + * + * + */ + readonly key?: string /** * `id` of the [Product](ctp:api:type:Product) the Line Item is based on. * @@ -1373,6 +1385,12 @@ export interface LineItem { * */ export interface LineItemDraft { + /** + * User-defined unique identifier of the LineItem. + * + * + */ + readonly key?: string /** * `id` of a published [Product](ctp:api:type:Product). * @@ -2069,6 +2087,12 @@ export interface CartAddItemShippingAddressAction { */ export interface CartAddLineItemAction { readonly action: 'addLineItem' + /** + * User-defined unique identifier of the LineItem. + * + * + */ + readonly key?: string /** * `id` of the published [Product](ctp:api:type:Product). * @@ -2276,11 +2300,17 @@ export interface CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction { export interface CartApplyDeltaToLineItemShippingDetailsTargetsAction { readonly action: 'applyDeltaToLineItemShippingDetailsTargets' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Using positive or negative quantities increases or decreases the number of items shipped to an address. * @@ -2363,11 +2393,17 @@ export interface CartChangeCustomLineItemQuantityAction { export interface CartChangeLineItemQuantityAction { readonly action: 'changeLineItemQuantity' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * New value to set. * @@ -2502,14 +2538,20 @@ export interface CartRemoveItemShippingAddressAction { export interface CartRemoveLineItemAction { readonly action: 'removeLineItem' /** - * `id` of the Line Item to remove. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string /** - * New value to set. - * If absent or `0`, the Line Item is removed from the Cart. + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string + /** + * Amount to subtract from the LineItem's `quantity`. + * If absent, the LineItem is removed from the Cart. * * */ @@ -3005,11 +3047,17 @@ export interface CartSetKeyAction { export interface CartSetLineItemCustomFieldAction { readonly action: 'setLineItemCustomField' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * Name of the [Custom Field](/../api/projects/custom-fields). * @@ -3028,11 +3076,17 @@ export interface CartSetLineItemCustomFieldAction { export interface CartSetLineItemCustomTypeAction { readonly action: 'setLineItemCustomType' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * Defines the [Type](ctp:api:type:Type) that extends the Line Item with [Custom Fields](/../api/projects/custom-fields). * If absent, any existing Type and Custom Fields are removed from the Line Item. @@ -3054,11 +3108,17 @@ export interface CartSetLineItemCustomTypeAction { export interface CartSetLineItemDistributionChannelAction { readonly action: 'setLineItemDistributionChannel' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. * - If not present, the current [Reference](ctp:api:type:Reference) to a distribution channel is removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. @@ -3071,11 +3131,17 @@ export interface CartSetLineItemDistributionChannelAction { export interface CartSetLineItemInventoryModeAction { readonly action: 'setLineItemInventoryMode' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Inventory mode specific to the Line Item only, and valid for the entire `quantity` of the Line Item. * Set only if the inventory mode should be different from the `inventoryMode` specified on the [Cart](ctp:api:type:Cart). @@ -3091,11 +3157,17 @@ export interface CartSetLineItemInventoryModeAction { export interface CartSetLineItemPriceAction { readonly action: 'setLineItemPrice' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Value to set. * If `externalPrice` is not given and the `priceMode` is `ExternalPrice`, the external price is unset and the `priceMode` is set to `Platform`. @@ -3107,11 +3179,17 @@ export interface CartSetLineItemPriceAction { export interface CartSetLineItemShippingDetailsAction { readonly action: 'setLineItemShippingDetails' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Value to set. * If empty, the existing value is removed. @@ -3127,11 +3205,17 @@ export interface CartSetLineItemShippingDetailsAction { export interface CartSetLineItemSupplyChannelAction { readonly action: 'setLineItemSupplyChannel' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. * - If not present, the current [Reference](ctp:api:type:Reference) to a supply channel will be removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. @@ -3148,11 +3232,17 @@ export interface CartSetLineItemSupplyChannelAction { export interface CartSetLineItemTaxAmountAction { readonly action: 'setLineItemTaxAmount' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * Value to set. * If empty, any existing value is removed. @@ -3175,11 +3265,17 @@ export interface CartSetLineItemTaxAmountAction { export interface CartSetLineItemTaxRateAction { readonly action: 'setLineItemTaxRate' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * Value to set. * If empty, any existing value is removed. @@ -3202,11 +3298,17 @@ export interface CartSetLineItemTaxRateAction { export interface CartSetLineItemTotalPriceAction { readonly action: 'setLineItemTotalPrice' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * Value to set. * If `externalTotalPrice` is not given and the `priceMode` is `ExternalTotal`, the external price is unset and the `priceMode` is set to `Platform`. diff --git a/packages/platform-sdk/src/generated/models/common.ts b/packages/platform-sdk/src/generated/models/common.ts index c9b831c7a..63dbd0258 100644 --- a/packages/platform-sdk/src/generated/models/common.ts +++ b/packages/platform-sdk/src/generated/models/common.ts @@ -921,6 +921,7 @@ export interface PriceTier { * Minimum quantity this Price tier is valid for. * * The minimum quantity is always greater than or equal to 2. The base Price is interpreted as valid for a minimum quantity equal to 1. + * A [Price](ctp:api:type:Price) or [StandalonePrice](ctp:api:type:StandalonePrice) cannot contain more than one tier with the same `minimumQuantity`. * * */ @@ -943,6 +944,8 @@ export interface PriceTierDraft { * Minimum quantity this Price tier is valid for. * * The minimum quantity is always greater than or equal to 2. The base Price is interpreted as valid for a minimum quantity equal to 1. + * A [Price](ctp:api:type:Price) or [StandalonePrice](ctp:api:type:StandalonePrice) cannot contain more than one tier with the same `minimumQuantity`. + * In the case one of the constraint is not met an [InvalidField](ctp:api:type:InvalidFieldError) is returned. * * */ diff --git a/packages/platform-sdk/src/generated/models/error.ts b/packages/platform-sdk/src/generated/models/error.ts index 1963134b2..6333d414b 100644 --- a/packages/platform-sdk/src/generated/models/error.ts +++ b/packages/platform-sdk/src/generated/models/error.ts @@ -640,7 +640,7 @@ export interface DuplicateVariantValuesError { /** * Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated. * - * The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](/../api/projects/shippingMethods#get-shippingmethods-for-an-orderedit) request. + * The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](/../api/projects/shippingMethods#for-an-orderedit) request. * */ export interface EditPreviewFailedError { @@ -2395,7 +2395,7 @@ export interface GraphQLDuplicateVariantValuesError { /** * Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated. * - * The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](/../api/projects/shippingMethods#get-shippingmethods-for-an-orderedit) request. + * The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](/../api/projects/shippingMethods#for-an-orderedit) request. * */ export interface GraphQLEditPreviewFailedError { diff --git a/packages/platform-sdk/src/generated/models/me.ts b/packages/platform-sdk/src/generated/models/me.ts index 528abd6a5..033856f54 100644 --- a/packages/platform-sdk/src/generated/models/me.ts +++ b/packages/platform-sdk/src/generated/models/me.ts @@ -12,7 +12,6 @@ import { } from './business-unit' import { CartReference, - DirectDiscountDraft, ExternalLineItemTotalPrice, ExternalTaxRateDraft, InventoryMode, @@ -251,7 +250,6 @@ export type MyCartUpdateAction = | MyCartSetCustomTypeAction | MyCartSetCustomerEmailAction | MyCartSetDeleteDaysAfterLastModificationAction - | MyCartSetDirectDiscountsAction | MyCartSetLineItemCustomFieldAction | MyCartSetLineItemCustomTypeAction | MyCartSetLineItemDistributionChannelAction @@ -537,6 +535,12 @@ export interface MyDivisionDraft { * */ export interface MyLineItemDraft { + /** + * User-defined unique identifier of the LineItem. + * + * + */ + readonly key?: string /** * `id` of the [Product](ctp:api:type:Product). * @@ -1064,7 +1068,7 @@ export interface MyBusinessUnitChangeNameAction { export interface MyBusinessUnitChangeParentUnitAction { readonly action: 'changeParentUnit' /** - * New parent unit of the [Business Unit](ctp:api:type:BusinessUnit). + * New parent unit of the [Business Unit](ctp:api:type:BusinessUnit). The new parent unit must have the same top-level unit as the old parent unit. * * */ @@ -1317,6 +1321,12 @@ export interface MyCartAddItemShippingAddressAction { */ export interface MyCartAddLineItemAction { readonly action: 'addLineItem' + /** + * User-defined unique identifier of the LineItem. + * + * + */ + readonly key?: string /** * `id` of the [Product](ctp:api:type:Product). * @@ -1403,11 +1413,17 @@ export interface MyCartAddPaymentAction { export interface MyCartApplyDeltaToLineItemShippingDetailsTargetsAction { readonly action: 'applyDeltaToLineItemShippingDetailsTargets' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Using positive or negative quantities increases or decreases the number of items shipped to an address. * @@ -1426,17 +1442,25 @@ export interface MyCartApplyDeltaToLineItemShippingDetailsTargetsAction { * use this update action in combination with the [Set LineItemShippingDetails](ctp:api:type:CartSetCustomLineItemShippingDetailsAction) update action * in a single Cart update command. * - * The [LineItem](ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + * When the action applies to [LineItems](ctp:api:type:LineItem) with `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode), + * it will be changed to `ExternalPrice` and the existing `externalPrice` value, i.e. `LineItem.price`, will be retained. + * The LineItem total will be calculated by the system instead, so that the `externalTotalPrice` will be dropped. * */ export interface MyCartChangeLineItemQuantityAction { readonly action: 'changeLineItemQuantity' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * New value to set. * @@ -1446,15 +1470,13 @@ export interface MyCartChangeLineItemQuantityAction { */ readonly quantity: number /** - * Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when changing the quantity of a Line Item with the `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode). - * - * The LineItem price is updated as described in LineItem Price selection. + * Deprecated. Will be ignored. * * */ readonly externalPrice?: _Money /** - * Sets the [LineItem](ctp:api:type:LineItem) `price` and `totalPrice` to the given value when changing the quantity of a Line Item with the `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode). + * Deprecated. Will be ignored. * * */ @@ -1522,15 +1544,20 @@ export interface MyCartRemoveItemShippingAddressAction { export interface MyCartRemoveLineItemAction { readonly action: 'removeLineItem' /** - * `id` of the Line Item to remove. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string /** - * New value to set. + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * - * If `0`, the Line Item is removed from the Cart. + * + */ + readonly lineItemKey?: string + /** + * Amount to subtract from the LineItem's `quantity`. + * If absent, the LineItem is removed from the Cart. * * */ @@ -1663,30 +1690,20 @@ export interface MyCartSetDeleteDaysAfterLastModificationAction { */ readonly deleteDaysAfterLastModification?: number } -/** - * Adds a [DirectDiscount](ctp:api:type:DirectDiscount), but only if no [DiscountCode](ctp:api:type:DiscountCode) has been added to the Cart. - * Either a Discount Code or a Direct Discount can exist on a Cart at the same time. - * - */ -export interface MyCartSetDirectDiscountsAction { - readonly action: 'setDirectDiscounts' +export interface MyCartSetLineItemCustomFieldAction { + readonly action: 'setLineItemCustomField' /** - * - If set, all existing Direct Discounts are replaced. - * The discounts apply in the order they are added to the list. - * - If empty, all existing Direct Discounts are removed and all affected prices on the Cart or Order are recalculated. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly discounts: DirectDiscountDraft[] -} -export interface MyCartSetLineItemCustomFieldAction { - readonly action: 'setLineItemCustomField' + readonly lineItemId?: string /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * Name of the [Custom Field](/../api/projects/custom-fields). * @@ -1705,11 +1722,17 @@ export interface MyCartSetLineItemCustomFieldAction { export interface MyCartSetLineItemCustomTypeAction { readonly action: 'setLineItemCustomType' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Defines the [Type](ctp:api:type:Type) that extends the LineItem with [Custom Fields](/../api/projects/custom-fields). * If absent, any existing Type and Custom Fields are removed from the Line Item. @@ -1731,11 +1754,17 @@ export interface MyCartSetLineItemCustomTypeAction { export interface MyCartSetLineItemDistributionChannelAction { readonly action: 'setLineItemDistributionChannel' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. * - If not present, the current [Reference](ctp:api:type:Reference) to a distribution channel is removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. @@ -1748,11 +1777,17 @@ export interface MyCartSetLineItemDistributionChannelAction { export interface MyCartSetLineItemShippingDetailsAction { readonly action: 'setLineItemShippingDetails' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Value to set. * If empty, the existing value is removed. @@ -1768,11 +1803,17 @@ export interface MyCartSetLineItemShippingDetailsAction { export interface MyCartSetLineItemSupplyChannelAction { readonly action: 'setLineItemSupplyChannel' /** - * `id` of the [LineItem](ctp:api:type:LineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * - If present, a [Reference](ctp:api:type:Reference) to the Channel is set for the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. * - If not present, the current [Reference](ctp:api:type:Reference) to a supply channel will be removed from the [LineItem](ctp:api:type:LineItem) specified by `lineItemId`. @@ -2368,11 +2409,17 @@ export interface MyShoppingListAddTextLineItemAction { export interface MyShoppingListChangeLineItemQuantityAction { readonly action: 'changeLineItemQuantity' /** - * The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * New value to set. If `0`, the ShoppingListLineItem is removed from the ShoppingList. * diff --git a/packages/platform-sdk/src/generated/models/message.ts b/packages/platform-sdk/src/generated/models/message.ts index 68cd3e495..2c479bebd 100644 --- a/packages/platform-sdk/src/generated/models/message.ts +++ b/packages/platform-sdk/src/generated/models/message.ts @@ -36,6 +36,7 @@ import { LastModifiedBy, LocalizedString, Price, + PriceTier, Reference, _Money, } from './common' @@ -259,6 +260,12 @@ export type Message = | StandalonePriceExternalDiscountSetMessage | StandalonePriceKeySetMessage | StandalonePriceStagedChangesAppliedMessage + | StandalonePriceTierAddedMessage + | StandalonePriceTierRemovedMessage + | StandalonePriceTiersSetMessage + | StandalonePriceValidFromAndUntilSetMessage + | StandalonePriceValidFromSetMessage + | StandalonePriceValidUntilSetMessage | StandalonePriceValueChangedMessage | StoreCountriesChangedMessage | StoreCreatedMessage @@ -11332,7 +11339,7 @@ export interface StagedQuoteValidToSetMessage { readonly validTo: string } /** - * Generated after a successful [Change Active](ctp:api:types:StandalonePriceChangeActiveAction) update action. + * Generated after a successful [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. * */ export interface StandalonePriceActiveChangedMessage { @@ -11395,13 +11402,13 @@ export interface StandalonePriceActiveChangedMessage { */ readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers /** - * Value of the `active` field of the StandalonePrice after the [Change Active](ctp:api:types:StandalonePriceChangeActiveAction) update action. + * Value of the `active` field of the StandalonePrice after the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. * * */ readonly active: boolean /** - * Value of the `active` field of the StandalonePrice before the [Change Active](ctp:api:types:StandalonePriceChangeActiveAction) update action. + * Value of the `active` field of the StandalonePrice before the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. * * */ @@ -11540,6 +11547,12 @@ export interface StandalonePriceDeletedMessage { * */ readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers + /** + * SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the deleted Standalone Price was associated. + * + * + */ + readonly sku: string } /** * Generated after a [Product Discount](ctp:api:type:ProductDiscount) is successfully applied to a StandalonePrice. @@ -11758,7 +11771,7 @@ export interface StandalonePriceKeySetMessage { readonly oldKey?: string } /** - * Generated after a successful [Apply Staged Changes](ctp:api:types:StandalonePriceApplyStagedChangesAction) update action. + * Generated after a successful [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. * */ export interface StandalonePriceStagedChangesAppliedMessage { @@ -11821,12 +11834,468 @@ export interface StandalonePriceStagedChangesAppliedMessage { */ readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers /** - * Applied changes of the [StandalonePrice](/../api/projects/standalone-prices) after the [Apply Staged Changes](ctp:api:types:StandalonePriceApplyStagedChangesAction) update action. + * Applied changes of the [StandalonePrice](/../api/projects/standalone-prices) after the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. * * */ readonly stagedChanges: StagedStandalonePrice } +/** + * Generated after a successful [Add Price Tier](ctp:api:type:StandalonePriceAddPriceTierAction) update action + * + */ +export interface StandalonePriceTierAddedMessage { + readonly type: 'StandalonePriceTierAdded' + /** + * Unique identifier of the Message. Can be used to track which Messages have been processed. + * + */ + readonly id: string + /** + * Version of a resource. In case of Messages, this is always `1`. + * + */ + readonly version: number + /** + * Date and time (UTC) the Message was generated. + * + */ + readonly createdAt: string + /** + * Value of `createdAt`. + * + */ + readonly lastModifiedAt: string + /** + * Value of `createdBy`. + * + * + */ + readonly lastModifiedBy?: LastModifiedBy + /** + * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + * + * + */ + readonly createdBy?: CreatedBy + /** + * Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. + * `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource. + * + * + */ + readonly sequenceNumber: number + /** + * [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed. + * + * + */ + readonly resource: Reference + /** + * Version of the resource on which the change or action was performed. + * + * + */ + readonly resourceVersion: number + /** + * User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers. + * + * + */ + readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers + /** + * The [Price Tier](ctp:api:type:PriceTier) that has been added to the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly tier: PriceTier +} +/** + * Generated after a successful [Remove Price Tier](ctp:api:type:StandalonePriceRemovePriceTierAction) update action + * + */ +export interface StandalonePriceTierRemovedMessage { + readonly type: 'StandalonePriceTierRemoved' + /** + * Unique identifier of the Message. Can be used to track which Messages have been processed. + * + */ + readonly id: string + /** + * Version of a resource. In case of Messages, this is always `1`. + * + */ + readonly version: number + /** + * Date and time (UTC) the Message was generated. + * + */ + readonly createdAt: string + /** + * Value of `createdAt`. + * + */ + readonly lastModifiedAt: string + /** + * Value of `createdBy`. + * + * + */ + readonly lastModifiedBy?: LastModifiedBy + /** + * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + * + * + */ + readonly createdBy?: CreatedBy + /** + * Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. + * `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource. + * + * + */ + readonly sequenceNumber: number + /** + * [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed. + * + * + */ + readonly resource: Reference + /** + * Version of the resource on which the change or action was performed. + * + * + */ + readonly resourceVersion: number + /** + * User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers. + * + * + */ + readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers + /** + * The [Price Tier](ctp:api:type:PriceTier) that has been removed from the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly removedTier: PriceTier +} +/** + * Generated after a successful [Set Price Tier](ctp:api:type:StandalonePriceSetPriceTiersAction) update action + * + */ +export interface StandalonePriceTiersSetMessage { + readonly type: 'StandalonePriceTiersSet' + /** + * Unique identifier of the Message. Can be used to track which Messages have been processed. + * + */ + readonly id: string + /** + * Version of a resource. In case of Messages, this is always `1`. + * + */ + readonly version: number + /** + * Date and time (UTC) the Message was generated. + * + */ + readonly createdAt: string + /** + * Value of `createdAt`. + * + */ + readonly lastModifiedAt: string + /** + * Value of `createdBy`. + * + * + */ + readonly lastModifiedBy?: LastModifiedBy + /** + * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + * + * + */ + readonly createdBy?: CreatedBy + /** + * Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. + * `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource. + * + * + */ + readonly sequenceNumber: number + /** + * [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed. + * + * + */ + readonly resource: Reference + /** + * Version of the resource on which the change or action was performed. + * + * + */ + readonly resourceVersion: number + /** + * User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers. + * + * + */ + readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers + /** + * The updated content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly tiers: PriceTier[] + /** + * The previous content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly previousTiers: PriceTier[] +} +/** + * Generated after a successful [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + */ +export interface StandalonePriceValidFromAndUntilSetMessage { + readonly type: 'StandalonePriceValidFromAndUntilSet' + /** + * Unique identifier of the Message. Can be used to track which Messages have been processed. + * + */ + readonly id: string + /** + * Version of a resource. In case of Messages, this is always `1`. + * + */ + readonly version: number + /** + * Date and time (UTC) the Message was generated. + * + */ + readonly createdAt: string + /** + * Value of `createdAt`. + * + */ + readonly lastModifiedAt: string + /** + * Value of `createdBy`. + * + * + */ + readonly lastModifiedBy?: LastModifiedBy + /** + * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + * + * + */ + readonly createdBy?: CreatedBy + /** + * Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. + * `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource. + * + * + */ + readonly sequenceNumber: number + /** + * [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed. + * + * + */ + readonly resource: Reference + /** + * Version of the resource on which the change or action was performed. + * + * + */ + readonly resourceVersion: number + /** + * User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers. + * + * + */ + readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly validFrom?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly previousValidFrom?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly validUntil?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly previousValidUntil?: string +} +/** + * Generated after a successful [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. + * + */ +export interface StandalonePriceValidFromSetMessage { + readonly type: 'StandalonePriceValidFromSet' + /** + * Unique identifier of the Message. Can be used to track which Messages have been processed. + * + */ + readonly id: string + /** + * Version of a resource. In case of Messages, this is always `1`. + * + */ + readonly version: number + /** + * Date and time (UTC) the Message was generated. + * + */ + readonly createdAt: string + /** + * Value of `createdAt`. + * + */ + readonly lastModifiedAt: string + /** + * Value of `createdBy`. + * + * + */ + readonly lastModifiedBy?: LastModifiedBy + /** + * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + * + * + */ + readonly createdBy?: CreatedBy + /** + * Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. + * `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource. + * + * + */ + readonly sequenceNumber: number + /** + * [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed. + * + * + */ + readonly resource: Reference + /** + * Version of the resource on which the change or action was performed. + * + * + */ + readonly resourceVersion: number + /** + * User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers. + * + * + */ + readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. + * + * + */ + readonly validFrom?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. + * + * + */ + readonly previousValidFrom?: string +} +/** + * Generated after a successful [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. + * + */ +export interface StandalonePriceValidUntilSetMessage { + readonly type: 'StandalonePriceValidUntilSet' + /** + * Unique identifier of the Message. Can be used to track which Messages have been processed. + * + */ + readonly id: string + /** + * Version of a resource. In case of Messages, this is always `1`. + * + */ + readonly version: number + /** + * Date and time (UTC) the Message was generated. + * + */ + readonly createdAt: string + /** + * Value of `createdAt`. + * + */ + readonly lastModifiedAt: string + /** + * Value of `createdBy`. + * + * + */ + readonly lastModifiedBy?: LastModifiedBy + /** + * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + * + * + */ + readonly createdBy?: CreatedBy + /** + * Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. + * `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource. + * + * + */ + readonly sequenceNumber: number + /** + * [Reference](ctp:api:type:Reference) to the resource on which the change or action was performed. + * + * + */ + readonly resource: Reference + /** + * Version of the resource on which the change or action was performed. + * + * + */ + readonly resourceVersion: number + /** + * User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers. + * + * + */ + readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. + * + * + */ + readonly validUntil?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. + * + * + */ + readonly previousValidUntil?: string +} /** * Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. * @@ -12745,6 +13214,12 @@ export type MessagePayload = | StandalonePriceExternalDiscountSetMessagePayload | StandalonePriceKeySetMessagePayload | StandalonePriceStagedChangesAppliedMessagePayload + | StandalonePriceTierAddedMessagePayload + | StandalonePriceTierRemovedMessagePayload + | StandalonePriceTiersSetMessagePayload + | StandalonePriceValidFromAndUntilSetMessagePayload + | StandalonePriceValidFromSetMessagePayload + | StandalonePriceValidUntilSetMessagePayload | StandalonePriceValueChangedMessagePayload | StoreCountriesChangedMessagePayload | StoreCreatedMessagePayload @@ -15444,19 +15919,19 @@ export interface StagedQuoteValidToSetMessagePayload { readonly validTo: string } /** - * Generated after a successful [Change Active](ctp:api:types:StandalonePriceChangeActiveAction) update action. + * Generated after a successful [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. * */ export interface StandalonePriceActiveChangedMessagePayload { readonly type: 'StandalonePriceActiveChanged' /** - * Value of the `active` field of the StandalonePrice after the [Change Active](ctp:api:types:StandalonePriceChangeActiveAction) update action. + * Value of the `active` field of the StandalonePrice after the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. * * */ readonly active: boolean /** - * Value of the `active` field of the StandalonePrice before the [Change Active](ctp:api:types:StandalonePriceChangeActiveAction) update action. + * Value of the `active` field of the StandalonePrice before the [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action. * * */ @@ -15481,6 +15956,12 @@ export interface StandalonePriceCreatedMessagePayload { */ export interface StandalonePriceDeletedMessagePayload { readonly type: 'StandalonePriceDeleted' + /** + * SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the deleted Standalone Price was associated. + * + * + */ + readonly sku: string } /** * Generated after a [Product Discount](ctp:api:type:ProductDiscount) is successfully applied to a StandalonePrice. @@ -15528,18 +16009,132 @@ export interface StandalonePriceKeySetMessagePayload { readonly oldKey?: string } /** - * Generated after a successful [Apply Staged Changes](ctp:api:types:StandalonePriceApplyStagedChangesAction) update action. + * Generated after a successful [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. * */ export interface StandalonePriceStagedChangesAppliedMessagePayload { readonly type: 'StandalonePriceStagedChangesApplied' /** - * Applied changes of the [StandalonePrice](/../api/projects/standalone-prices) after the [Apply Staged Changes](ctp:api:types:StandalonePriceApplyStagedChangesAction) update action. + * Applied changes of the [StandalonePrice](/../api/projects/standalone-prices) after the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. * * */ readonly stagedChanges: StagedStandalonePrice } +/** + * Generated after a successful [Add Price Tier](ctp:api:type:StandalonePriceAddPriceTierAction) update action + * + */ +export interface StandalonePriceTierAddedMessagePayload { + readonly type: 'StandalonePriceTierAdded' + /** + * The [Price Tier](ctp:api:type:PriceTier) that has been added to the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly tier: PriceTier +} +/** + * Generated after a successful [Remove Price Tier](ctp:api:type:StandalonePriceRemovePriceTierAction) update action + * + */ +export interface StandalonePriceTierRemovedMessagePayload { + readonly type: 'StandalonePriceTierRemoved' + /** + * The [Price Tier](ctp:api:type:PriceTier) that has been removed from the array field `tiers` for the [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly removedTier: PriceTier +} +/** + * Generated after a successful [Set Price Tier](ctp:api:type:StandalonePriceSetPriceTiersAction) update action + * + */ +export interface StandalonePriceTiersSetMessagePayload { + readonly type: 'StandalonePriceTiersSet' + /** + * The updated content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly tiers: PriceTier[] + /** + * The previous content of the field `tiers` of the affected [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly previousTiers: PriceTier[] +} +/** + * Generated after a successful [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + */ +export interface StandalonePriceValidFromAndUntilSetMessagePayload { + readonly type: 'StandalonePriceValidFromAndUntilSet' + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly validFrom?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly previousValidFrom?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly validUntil?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action. + * + * + */ + readonly previousValidUntil?: string +} +/** + * Generated after a successful [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. + * + */ +export interface StandalonePriceValidFromSetMessagePayload { + readonly type: 'StandalonePriceValidFromSet' + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` after the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. + * + * + */ + readonly validFrom?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validFrom` before the [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action. + * + * + */ + readonly previousValidFrom?: string +} +/** + * Generated after a successful [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. + * + */ +export interface StandalonePriceValidUntilSetMessagePayload { + readonly type: 'StandalonePriceValidUntilSet' + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` after the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. + * + * + */ + readonly validUntil?: string + /** + * Value of [StandalonePrice](ctp:api:type:StandalonePrice) `validUntil` before the [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action. + * + * + */ + readonly previousValidUntil?: string +} /** * Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. * diff --git a/packages/platform-sdk/src/generated/models/order-edit.ts b/packages/platform-sdk/src/generated/models/order-edit.ts index 43b05741b..38f1c6cad 100644 --- a/packages/platform-sdk/src/generated/models/order-edit.ts +++ b/packages/platform-sdk/src/generated/models/order-edit.ts @@ -471,6 +471,12 @@ export interface StagedOrderAddItemShippingAddressAction { } export interface StagedOrderAddLineItemAction { readonly action: 'addLineItem' + /** + * User-defined unique identifier of the LineItem. + * + * + */ + readonly key?: string /** * The representation used when creating or updating a [customizable data type](/../api/projects/types#list-of-customizable-data-types) with Custom Fields. * @@ -544,6 +550,10 @@ export interface StagedOrderAddParcelToDeliveryAction { * */ readonly deliveryKey?: string + /** + * + */ + readonly parcelKey?: string /** * */ @@ -629,9 +639,17 @@ export interface StagedOrderChangeCustomLineItemQuantityAction { export interface StagedOrderChangeLineItemQuantityAction { readonly action: 'changeLineItemQuantity' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * */ @@ -756,9 +774,17 @@ export interface StagedOrderRemoveItemShippingAddressAction { export interface StagedOrderRemoveLineItemAction { readonly action: 'removeLineItem' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * */ @@ -783,9 +809,15 @@ export interface StagedOrderRemoveLineItemAction { export interface StagedOrderRemoveParcelFromDeliveryAction { readonly action: 'removeParcelFromDelivery' /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelKey?: string } export interface StagedOrderRemovePaymentAction { readonly action: 'removePayment' @@ -1199,9 +1231,17 @@ export interface StagedOrderSetItemShippingAddressCustomTypeAction { export interface StagedOrderSetLineItemCustomFieldAction { readonly action: 'setLineItemCustomField' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Name of the [Custom Field](/../api/projects/custom-fields). * @@ -1220,9 +1260,17 @@ export interface StagedOrderSetLineItemCustomFieldAction { export interface StagedOrderSetLineItemCustomTypeAction { readonly action: 'setLineItemCustomType' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Defines the [Type](ctp:api:type:Type) that extends the LineItem with [Custom Fields](/../api/projects/custom-fields). * If absent, any existing Type and Custom Fields are removed from the LineItem. @@ -1240,9 +1288,17 @@ export interface StagedOrderSetLineItemCustomTypeAction { export interface StagedOrderSetLineItemDistributionChannelAction { readonly action: 'setLineItemDistributionChannel' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel). * @@ -1253,9 +1309,17 @@ export interface StagedOrderSetLineItemDistributionChannelAction { export interface StagedOrderSetLineItemPriceAction { readonly action: 'setLineItemPrice' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Draft type that stores amounts only in cent precision for the specified currency. * @@ -1266,9 +1330,17 @@ export interface StagedOrderSetLineItemPriceAction { export interface StagedOrderSetLineItemShippingDetailsAction { readonly action: 'setLineItemShippingDetails' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items. * @@ -1279,9 +1351,17 @@ export interface StagedOrderSetLineItemShippingDetailsAction { export interface StagedOrderSetLineItemTaxAmountAction { readonly action: 'setLineItemTaxAmount' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemKey?: string /** * Cannot be used in [LineItemDraft](ctp:api:type:LineItemDraft) or [CustomLineItemDraft](ctp:api:type:CustomLineItemDraft). * @@ -1304,9 +1384,17 @@ export interface StagedOrderSetLineItemTaxAmountAction { export interface StagedOrderSetLineItemTaxRateAction { readonly action: 'setLineItemTaxRate' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation). * @@ -1324,9 +1412,17 @@ export interface StagedOrderSetLineItemTaxRateAction { export interface StagedOrderSetLineItemTotalPriceAction { readonly action: 'setLineItemTotalPrice' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * */ @@ -1362,9 +1458,15 @@ export interface StagedOrderSetOrderTotalTaxAction { export interface StagedOrderSetParcelCustomFieldAction { readonly action: 'setParcelCustomField' /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelKey?: string /** * Name of the [Custom Field](/../api/projects/custom-fields). * @@ -1383,9 +1485,15 @@ export interface StagedOrderSetParcelCustomFieldAction { export interface StagedOrderSetParcelCustomTypeAction { readonly action: 'setParcelCustomType' /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelKey?: string /** * Defines the [Type](ctp:api:type:Type) that extends the Parcel with [Custom Fields](/../api/projects/custom-fields). * If absent, any existing Type and Custom Fields are removed from the Parcel. @@ -1403,9 +1511,15 @@ export interface StagedOrderSetParcelCustomTypeAction { export interface StagedOrderSetParcelItemsAction { readonly action: 'setParcelItems' /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelKey?: string /** * */ @@ -1414,9 +1528,15 @@ export interface StagedOrderSetParcelItemsAction { export interface StagedOrderSetParcelMeasurementsAction { readonly action: 'setParcelMeasurements' /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelKey?: string /** * */ @@ -1425,9 +1545,15 @@ export interface StagedOrderSetParcelMeasurementsAction { export interface StagedOrderSetParcelTrackingDataAction { readonly action: 'setParcelTrackingData' /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelKey?: string /** * */ diff --git a/packages/platform-sdk/src/generated/models/order.ts b/packages/platform-sdk/src/generated/models/order.ts index ab37782fd..ce3545c0c 100644 --- a/packages/platform-sdk/src/generated/models/order.ts +++ b/packages/platform-sdk/src/generated/models/order.ts @@ -1325,6 +1325,11 @@ export interface Parcel { * */ readonly id: string + /** + * User-defined unique identifier of the Parcel. + * + */ + readonly key?: string /** * */ @@ -1349,6 +1354,11 @@ export interface Parcel { readonly custom?: CustomFields } export interface ParcelDraft { + /** + * User-defined unique identifier of the Parcel. + * + */ + readonly key?: string /** * */ @@ -1749,6 +1759,10 @@ export interface OrderAddParcelToDeliveryAction { * */ readonly deliveryKey?: string + /** + * + */ + readonly parcelKey?: string /** * */ @@ -1852,9 +1866,15 @@ export interface OrderRemoveItemShippingAddressAction { export interface OrderRemoveParcelFromDeliveryAction { readonly action: 'removeParcelFromDelivery' /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelKey?: string } export interface OrderRemovePaymentAction { readonly action: 'removePayment' @@ -2198,9 +2218,17 @@ export interface OrderSetItemShippingAddressCustomTypeAction { export interface OrderSetLineItemCustomFieldAction { readonly action: 'setLineItemCustomField' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Name of the [Custom Field](/../api/projects/custom-fields). * @@ -2219,9 +2247,17 @@ export interface OrderSetLineItemCustomFieldAction { export interface OrderSetLineItemCustomTypeAction { readonly action: 'setLineItemCustomType' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * Defines the [Type](ctp:api:type:Type) that extends the LineItem with [Custom Fields](/../api/projects/custom-fields). * If absent, any existing Type and Custom Fields are removed from the LineItem. @@ -2239,9 +2275,17 @@ export interface OrderSetLineItemCustomTypeAction { export interface OrderSetLineItemShippingDetailsAction { readonly action: 'setLineItemShippingDetails' /** + * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * * */ - readonly lineItemId: string + readonly lineItemId?: string + /** + * `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required. + * + * + */ + readonly lineItemKey?: string /** * For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items. * @@ -2266,9 +2310,15 @@ export interface OrderSetOrderNumberAction { export interface OrderSetParcelCustomFieldAction { readonly action: 'setParcelCustomField' /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelKey?: string /** * Name of the [Custom Field](/../api/projects/custom-fields). * @@ -2287,9 +2337,15 @@ export interface OrderSetParcelCustomFieldAction { export interface OrderSetParcelCustomTypeAction { readonly action: 'setParcelCustomType' /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelKey?: string /** * Defines the [Type](ctp:api:type:Type) that extends the Parcel with [Custom Fields](/../api/projects/custom-fields). * If absent, any existing Type and Custom Fields are removed from the Parcel. @@ -2307,9 +2363,15 @@ export interface OrderSetParcelCustomTypeAction { export interface OrderSetParcelItemsAction { readonly action: 'setParcelItems' /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelKey?: string /** * */ @@ -2318,9 +2380,15 @@ export interface OrderSetParcelItemsAction { export interface OrderSetParcelMeasurementsAction { readonly action: 'setParcelMeasurements' /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelKey?: string /** * */ @@ -2329,9 +2397,15 @@ export interface OrderSetParcelMeasurementsAction { export interface OrderSetParcelTrackingDataAction { readonly action: 'setParcelTrackingData' /** + * Either `parcelId` or `parcelKey` is required for this update action. + * + */ + readonly parcelId?: string + /** + * Either `parcelId` or `parcelKey` is required for this update action. * */ - readonly parcelId: string + readonly parcelKey?: string /** * */ diff --git a/packages/platform-sdk/src/generated/models/product-selection.ts b/packages/platform-sdk/src/generated/models/product-selection.ts index 0f12c195f..b882fde19 100644 --- a/packages/platform-sdk/src/generated/models/product-selection.ts +++ b/packages/platform-sdk/src/generated/models/product-selection.ts @@ -426,23 +426,8 @@ export interface ProductVariantExclusion { * */ export type ProductVariantSelection = - | ProductVariantSelectionExclusion | ProductVariantSelectionIncludeAllExcept | ProductVariantSelectionIncludeOnly - | ProductVariantSelectionInclusion -/** - * All Product Variants except the explicitly stated SKUs are part of the Product Selection. - * - */ -export interface ProductVariantSelectionExclusion { - readonly type: 'exclusion' - /** - * Non-empty array of SKUs representing Product Variants to be excluded from the Product Selection. - * - * - */ - readonly skus: string[] -} /** * All Product Variants except the explicitly stated SKUs are part of the Product Selection. * @@ -469,19 +454,6 @@ export interface ProductVariantSelectionIncludeOnly { */ readonly skus: string[] } -/** - * Only Product Variants with explicitly stated SKUs are part of the Product Selection. - * - */ -export interface ProductVariantSelectionInclusion { - readonly type: 'inclusion' - /** - * Non-empty array of SKUs representing Product Variants to be included into the Product Selection. - * - * - */ - readonly skus: string[] -} export type ProductVariantSelectionTypeEnum = | 'exclusion' | 'includeAllExcept' diff --git a/packages/platform-sdk/src/generated/models/product-type.ts b/packages/platform-sdk/src/generated/models/product-type.ts index 3d89220e0..28a0ec653 100644 --- a/packages/platform-sdk/src/generated/models/product-type.ts +++ b/packages/platform-sdk/src/generated/models/product-type.ts @@ -155,7 +155,7 @@ export interface AttributeLocalizedEnumValue { readonly label: LocalizedString } /** - * A plain enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:types:DuplicateEnumValuesError) error is returned. + * A plain enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned. * */ export interface AttributePlainEnumValue { diff --git a/packages/platform-sdk/src/generated/models/standalone-price.ts b/packages/platform-sdk/src/generated/models/standalone-price.ts index 8a74e2859..a2a067860 100644 --- a/packages/platform-sdk/src/generated/models/standalone-price.ts +++ b/packages/platform-sdk/src/generated/models/standalone-price.ts @@ -28,7 +28,7 @@ import { } from './type' /** - * Staged changes on a Standalone Price. To update the `value` property of a Staged Standalone Price, use the corresponding [update action](ctp:api:type:StandalonePriceChangeValueAction). To apply all staged changes to the Standalone Price, use the `applyStagedChanges` update action. + * Staged changes on a Standalone Price. To update the `value` property of a Staged Standalone Price, use the corresponding [update action](ctp:api:type:StandalonePriceChangeValueAction). To apply all staged changes to the Standalone Price, use the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. */ export interface StagedStandalonePrice { /** @@ -148,7 +148,7 @@ export interface StandalonePrice extends BaseResource { */ readonly custom?: CustomFields /** - * Staged changes of the StandalonePrice. Only present if the StandalonePrice has staged changes. + * Staged changes of the StandalonePrice. Only present if the StandalonePrice has some changes staged. * * */ @@ -233,8 +233,7 @@ export interface StandalonePriceDraft { */ readonly custom?: CustomFieldsDraft /** - * If set to `true`, the StandalonePrice is considered during [price selection](ctp:api:type:ProductPriceSelection). - * If set to `false`, the StandalonePrice is not considered during [price selection](ctp:api:type:ProductPriceSelection). + * Set to `false`, if the StandalonePrice should not be considered during [price selection](ctp:api:type:ProductPriceSelection). * * */ @@ -329,13 +328,36 @@ export interface StandalonePriceUpdate { readonly actions: StandalonePriceUpdateAction[] } export type StandalonePriceUpdateAction = + | StandalonePriceAddPriceTierAction | StandalonePriceApplyStagedChangesAction | StandalonePriceChangeActiveAction | StandalonePriceChangeValueAction + | StandalonePriceRemovePriceTierAction | StandalonePriceSetCustomFieldAction | StandalonePriceSetCustomTypeAction | StandalonePriceSetDiscountedPriceAction | StandalonePriceSetKeyAction + | StandalonePriceSetPriceTiersAction + | StandalonePriceSetValidFromAction + | StandalonePriceSetValidFromAndUntilAction + | StandalonePriceSetValidUntilAction +/** + * Adding a [PriceTier](ctp:api:type:PriceTier) to a [StandalonePrice](ctp:api:type:StandalonePrice) produces the [Standalone Price Tier Added](ctp:api:type:StandalonePriceTierAddedMessage) Message. + * + */ +export interface StandalonePriceAddPriceTierAction { + readonly action: 'addPriceTier' + /** + * The [PriceTier](ctp:api:type:PriceTier) to be added to the `tiers` field of the [StandalonePrice](ctp:api:type:StandalonePrice). + * The action returns an [InvalidField](ctp:api:type:InvalidFieldError) error in the following cases: + * + * * Trying to add a PriceTier with `minimumQuantity` < `2`. + * * Trying to add a PriceTier with `minimumQuantity` that already exists for the StandalonePrice. + * + * + */ + readonly tier: PriceTierDraft +} /** * Applies all staged changes to the StandalonePrice by overwriting all current values with the values in the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice). After successfully applied, the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice) will be removed from the StandalonePrice. An `applyStagedChanges` update action on a StandalonePrice that does not contain any staged changes will return a `400 Bad Request` error. Applying staged changes successfully will produce the [StandalonePriceStagedChangesApplied](ctp:api:type:StandalonePriceStagedChangesAppliedMessage) Message. * @@ -375,6 +397,19 @@ export interface StandalonePriceChangeValueAction { */ readonly staged?: boolean } +/** + * Removing a [PriceTier](ctp:api:type:PriceTier) from a [StandalonePrice](ctp:api:type:StandalonePrice) produces the [Standalone Price Tier Removed](ctp:api:type:StandalonePriceTierRemovedMessage) Message. + * + */ +export interface StandalonePriceRemovePriceTierAction { + readonly action: 'removePriceTier' + /** + * The `minimumQuantity` of the [PriceTier](ctp:api:type:PriceTier) to be removed from the `tiers` field of the [StandalonePrice](ctp:api:type:StandalonePrice). + * + * + */ + readonly tierMinimumQuantity: number +} export interface StandalonePriceSetCustomFieldAction { readonly action: 'setCustomField' /** @@ -434,3 +469,72 @@ export interface StandalonePriceSetKeyAction { */ readonly key?: string } +/** + * Sets all [PriceTiers](ctp:api:type:PriceTier) for a [StandalonePrice](ctp:api:type:StandalonePrice) in one action, produces the [Standalone Price Tiers Set](ctp:api:type:StandalonePriceTiersSetMessage) Message. + * + */ +export interface StandalonePriceSetPriceTiersAction { + readonly action: 'setPriceTier' + /** + * Value to set. If empty, any existing value will be removed. + * The `minimumQuantity` of the PriceTiers must be unique and greater than `1`, otherwise an [InvalidField](ctp:api:type:InvalidFieldError) error is returned. + * + * + */ + readonly tiers: PriceTierDraft[] +} +/** + * Updating the `validFrom` value generates the [StandalonePriceValidFromSet](ctp:api:type:StandalonePriceValidFromSetMessage) Message. + * + * As the validity dates are part of the price scope and are not allowed to overlap, this update might return the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period. + * + */ +export interface StandalonePriceSetValidFromAction { + readonly action: 'setValidFrom' + /** + * Value to set. + * If empty, any existing value is removed. + * + * + */ + readonly validFrom?: string +} +/** + * Updating the `validFrom` and `validUntil` values generates the [StandalonePriceValidFromAndUntilSet](ctp:api:type:StandalonePriceValidFromAndUntilSetMessage) Message. + * + * As the validity dates are part of the price scope and are not allowed to overlap, this update might return the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period. + * + */ +export interface StandalonePriceSetValidFromAndUntilAction { + readonly action: 'setValidFromAndUntil' + /** + * Value to set. + * If empty, any existing value is removed. + * + * + */ + readonly validFrom?: string + /** + * Value to set. + * If empty, any existing value is removed. + * + * + */ + readonly validUntil?: string +} +/** + * Updating the `validUntil` value generates the [StandalonePriceValidUntilSet](ctp:api:type:StandalonePriceValidUntilSetMessage) Message. + * + * As the validity dates are part of the price scope and are not allowed to overlap, this update might return the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period. + * + */ +export interface StandalonePriceSetValidUntilAction { + readonly action: 'setValidUntil' + /** + * Value to set. + * If empty, any existing value is removed. + * + * + */ + readonly validUntil?: string +} diff --git a/packages/platform-sdk/src/generated/models/subscription.ts b/packages/platform-sdk/src/generated/models/subscription.ts index e120c0239..1e12192f2 100644 --- a/packages/platform-sdk/src/generated/models/subscription.ts +++ b/packages/platform-sdk/src/generated/models/subscription.ts @@ -156,6 +156,7 @@ export type DeliveryPayload = export type Destination = | AzureEventGridDestination | AzureServiceBusDestination + | ConfluentCloudDestination | EventBridgeDestination | GoogleCloudPubSubDestination | SnsDestination @@ -194,6 +195,53 @@ export interface AzureServiceBusDestination { */ readonly connectionString: string } +/** + * This destination can be used to push events and messages to [Confluent Cloud](https://www.confluent.io/confluent-cloud/). + * To set up a Subscription of this type, first, create a topic in Confluent Cloud. + * Then, to allow Composable Commerce to push events and messages to your topic, generate [API keys](https://docs.confluent.io/cloud/current/access-management/authenticate/api-keys/api-keys.html) for your topic, and create the Subscription destination using the generated credentials. + * + * The Composable Commerce producer uses the following values: `SASL_SSL` for`security.protocol`, `PLAIN` for`sasl.mechanism`, and the default value (1048576) for `max.request.size`. + * + */ +export interface ConfluentCloudDestination { + readonly type: 'ConfluentCloud' + /** + * URL to the bootstrap server including the port number in the format `...confluent.cloud:9092`. + * + * + */ + readonly bootstrapServer: string + /** + * Partially hidden on retrieval for security reasons. + * + * + */ + readonly apiKey: string + /** + * Partially hidden on retrieval for security reasons. + * + * + */ + readonly apiSecret: string + /** + * The Kafka `acks` value. + * + * + */ + readonly acks: string + /** + * The name of the topic. + * + * + */ + readonly topic: string + /** + * The Kafka record key. + * + * + */ + readonly key?: string +} /** * [AWS EventBridge](https://aws.amazon.com/eventbridge/) can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules. * Once the Subscription is created, an equivalent "partner event source" is created in AWS EventBridge. This event source must be associated with an event bus for the Subscription setup to be complete. diff --git a/packages/platform-sdk/src/generated/models/type.ts b/packages/platform-sdk/src/generated/models/type.ts index 313477ab0..ef81adef5 100644 --- a/packages/platform-sdk/src/generated/models/type.ts +++ b/packages/platform-sdk/src/generated/models/type.ts @@ -52,6 +52,8 @@ export interface CustomFieldLocalizedEnumValue { * */ export type CustomFieldReferenceValue = + | 'associate-role' + | 'business-unit' | 'cart' | 'category' | 'channel' diff --git a/reference.txt b/reference.txt new file mode 100644 index 000000000..ff5aeb16c --- /dev/null +++ b/reference.txt @@ -0,0 +1 @@ +d235aad8ebdf97564d40955a133f0edd6b2edb9b diff --git a/references.txt b/references.txt index dd074be39..a331e87a4 100644 --- a/references.txt +++ b/references.txt @@ -34,3 +34,46 @@ d42bf370077b12aecb533c78384994e48a642d65 7efa7c0cdd87e8449e6b7f0afb8dd779ec88de67 9f076a1f276db15b30feb7e4fed9a3002605ba05 99d4e2e5654f5548348775ce6f815b08e628a721 +5a7a3cd887593a4b56cf7f57a3afbc2fcdc12dbc +c048fe59fe965666ef7ff21f7a465b64d610beb4 +6e2b941b09afd55731cd16d45390130c16a5c509 +8ae1bd244337d7520eb4bba082e51276edf42c9c +36db963240beb489b13f5324c1259bbf7799c13b +51b9f705b30085296c25a020c10844030c40b5ac +e8b2ad48fa08e8d1242ca3cea565fd958126a3d4 +8587243ec8f5ada1a4fcf367819395491f5e7bf5 +4e620fad9e13d6d8f972155084e139062b54afb2 +7e3db52a1cf6a201e167aca657dfd53a8d515c9b +d86f0159dce445b340be6198e51d62800a956d3a +788dc0c0d058f0344cd35e7703b47b0df7bdba0c +ce1e777383e86efb7134a1005ef921a6f8e31774 +57916f8435d127d6feb091510ea428968e8e21f0 +de932b97447ba7dab1c9bd23119a1c68801cb1ff +42f62096e9088ed1aa721c5d363ec3893b61d780 +b991026e48be178b4e3ea5df49d87351fa57b07f +257eb224079d2d11af9e73157b86df36747463a8 +ed046f5edcd1ff097292b6da0c3112e97275a465 +b738b44e08ae31498f4a2b3d9afb01ef3d9f6df7 +e6c0aa1fc0c3c72aad132d9eee91a93cfb698bce +e25e5abd279d56cdb3923bcf4e45254acd9a4239 +604ba8710c45a59cec386f4549de4d4b21e3e563 +1856edb8b76f2ba3ebb7359f5ce1359f4a3accc4 +9a2a55e24a04c46ae89d0fc6e06eb127d64d8579 +8b062e7d0050d1e875a50b3b17a9d3545ec0ff85 +f9794099ba4aa09d4447135b93bdb4dabdee175a +4e8d38c14aa1f346cd1f0d92210be5fb3f5ef6f4 +a5814ceb8631fc43a168a14518ae04fb1abad79c +a2b70e8534adc95d06e2ac575c87ddb836cadc8e +de69de2aeb9d0e463a5f4b6500ac1236b12632eb +4c0d8eabf43bd0ec727284ccdd4cf11bd8e88714 +cca2a403a6ab01eb9e0bd2487c0d8f4a97b521bc +73a88391a0ae105b155ba5750a79911c55a27032 +9c804f3d600a9ed9bae0535190194e1f0fb5edc3 +0e092f8c9ffb0cd0c32d96afac63dcf420cca9b7 +0398f41f9807106d2dd50a30127b60b5a17ff3c2 +0398f41f9807106d2dd50a30127b60b5a17ff3c2 +684bfa3dd80d662f980ddabc041607f8869a4f04 +56e457c07223bda90a6b7ac4776e6d59f2ca9554 +1ce375bcc89b580bc63fe029066812b511e42dfb +469db24ebd23ce69a05ad4208ed3a69f97a012f8 +b8643304f30b6ab91906dd29ad787d9b2064d738