@gradientedge/commercetools-utils 4.24.0 → 4.26.0

package/dist/typings/api/CommercetoolsApi.d.ts

@@ -72,6 +72,9 @@ export declare class CommercetoolsApi {
     getChannelById(options: CommonRequestOptions & {
         id: string;
     }): Promise<Channel>;
+    getChannelByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<Channel>;
     getCategory(options: CommonRequestOptions & {
         id?: string;
         key?: string;

package/dist/typings/models/cart.d.ts

@@ -28,9 +28,12 @@ export interface Cart extends BaseResource {
     readonly customLineItems: CustomLineItem[];
     readonly totalPrice: TypedMoney;
     readonly taxedPrice?: TaxedPrice;
+    readonly taxedShippingPrice?: TaxedPrice;
     readonly cartState: CartState;
     readonly shippingAddress?: Address;
     readonly billingAddress?: Address;
+    readonly shippingMode: ShippingMode;
+    readonly shipping: Shipping[];
     readonly inventoryMode?: InventoryMode;
     readonly taxMode: TaxMode;
     readonly taxRoundingMode: RoundingMode;
@@ -73,6 +76,9 @@ export interface CartDraft {
     readonly locale?: string;
     readonly deleteDaysAfterLastModification?: number;
     readonly origin?: CartOrigin;
+    readonly shippingMode?: ShippingMode;
+    readonly customShipping?: CustomShippingDraft[];
+    readonly shipping?: ShippingDraft[];
     readonly shippingRateInput?: ShippingRateInputDraft;
     readonly itemShippingAddresses?: BaseAddress[];
     readonly discountCodes?: string[];
@@ -100,7 +106,7 @@ export interface CartUpdate {
     readonly version: number;
     readonly actions: CartUpdateAction[];
 }
-export declare type CartUpdateAction = CartAddCustomLineItemAction | CartAddDiscountCodeAction | CartAddItemShippingAddressAction | CartAddLineItemAction | CartAddPaymentAction | CartAddShoppingListAction | CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction | CartApplyDeltaToLineItemShippingDetailsTargetsAction | CartChangeCustomLineItemMoneyAction | CartChangeCustomLineItemPriceModeAction | CartChangeCustomLineItemQuantityAction | CartChangeLineItemQuantityAction | CartChangeTaxCalculationModeAction | CartChangeTaxModeAction | CartChangeTaxRoundingModeAction | CartRecalculateAction | CartRemoveCustomLineItemAction | CartRemoveDiscountCodeAction | CartRemoveItemShippingAddressAction | CartRemoveLineItemAction | CartRemovePaymentAction | CartSetAnonymousIdAction | CartSetBillingAddressAction | CartSetBillingAddressCustomFieldAction | CartSetBillingAddressCustomTypeAction | CartSetCartTotalTaxAction | CartSetCountryAction | CartSetCustomFieldAction | CartSetCustomLineItemCustomFieldAction | CartSetCustomLineItemCustomTypeAction | CartSetCustomLineItemShippingDetailsAction | CartSetCustomLineItemTaxAmountAction | CartSetCustomLineItemTaxRateAction | CartSetCustomShippingMethodAction | CartSetCustomTypeAction | CartSetCustomerEmailAction | CartSetCustomerGroupAction | CartSetCustomerIdAction | CartSetDeleteDaysAfterLastModificationAction | CartSetDeliveryAddressCustomFieldAction | CartSetDeliveryAddressCustomTypeAction | CartSetDirectDiscountsAction | CartSetItemShippingAddressCustomFieldAction | CartSetItemShippingAddressCustomTypeAction | CartSetKeyAction | CartSetLineItemCustomFieldAction | CartSetLineItemCustomTypeAction | CartSetLineItemDistributionChannelAction | CartSetLineItemPriceAction | CartSetLineItemShippingDetailsAction | CartSetLineItemSupplyChannelAction | CartSetLineItemTaxAmountAction | CartSetLineItemTaxRateAction | CartSetLineItemTotalPriceAction | CartSetLocaleAction | CartSetShippingAddressAction | CartSetShippingAddressCustomFieldAction | CartSetShippingAddressCustomTypeAction | CartSetShippingMethodAction | CartSetShippingMethodTaxAmountAction | CartSetShippingMethodTaxRateAction | CartSetShippingRateInputAction | CartUpdateItemShippingAddressAction;
+export declare type CartUpdateAction = CartAddCustomLineItemAction | CartAddCustomShippingMethodAction | CartAddDiscountCodeAction | CartAddItemShippingAddressAction | CartAddLineItemAction | CartAddPaymentAction | CartAddShippingMethodAction | CartAddShoppingListAction | CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction | CartApplyDeltaToLineItemShippingDetailsTargetsAction | CartChangeCustomLineItemMoneyAction | CartChangeCustomLineItemPriceModeAction | CartChangeCustomLineItemQuantityAction | CartChangeLineItemQuantityAction | CartChangeTaxCalculationModeAction | CartChangeTaxModeAction | CartChangeTaxRoundingModeAction | CartRecalculateAction | CartRemoveCustomLineItemAction | CartRemoveDiscountCodeAction | CartRemoveItemShippingAddressAction | CartRemoveLineItemAction | CartRemovePaymentAction | CartRemoveShippingMethodAction | CartSetAnonymousIdAction | CartSetBillingAddressAction | CartSetBillingAddressCustomFieldAction | CartSetBillingAddressCustomTypeAction | CartSetCartTotalTaxAction | CartSetCountryAction | CartSetCustomFieldAction | CartSetCustomLineItemCustomFieldAction | CartSetCustomLineItemCustomTypeAction | CartSetCustomLineItemShippingDetailsAction | CartSetCustomLineItemTaxAmountAction | CartSetCustomLineItemTaxRateAction | CartSetCustomShippingMethodAction | CartSetCustomTypeAction | CartSetCustomerEmailAction | CartSetCustomerGroupAction | CartSetCustomerIdAction | CartSetDeleteDaysAfterLastModificationAction | CartSetDeliveryAddressCustomFieldAction | CartSetDeliveryAddressCustomTypeAction | CartSetDirectDiscountsAction | CartSetItemShippingAddressCustomFieldAction | CartSetItemShippingAddressCustomTypeAction | CartSetKeyAction | CartSetLineItemCustomFieldAction | CartSetLineItemCustomTypeAction | CartSetLineItemDistributionChannelAction | CartSetLineItemPriceAction | CartSetLineItemShippingDetailsAction | CartSetLineItemSupplyChannelAction | CartSetLineItemTaxAmountAction | CartSetLineItemTaxRateAction | CartSetLineItemTotalPriceAction | CartSetLocaleAction | CartSetShippingAddressAction | CartSetShippingAddressCustomFieldAction | CartSetShippingAddressCustomTypeAction | CartSetShippingCustomFieldAction | CartSetShippingCustomTypeAction | CartSetShippingMethodAction | CartSetShippingMethodTaxAmountAction | CartSetShippingMethodTaxRateAction | CartSetShippingRateInputAction | CartUpdateItemShippingAddressAction;
 export interface CustomLineItem {
     readonly id: string;
     readonly name: LocalizedString;
@@ -126,8 +132,20 @@ export interface CustomLineItemDraft {
     readonly externalTaxRate?: ExternalTaxRateDraft;
     readonly custom?: CustomFieldsDraft;
     readonly shippingDetails?: ItemShippingDetailsDraft;
+    readonly priceMode: CustomLineItemPriceMode;
 }
 export declare type CustomLineItemPriceMode = 'External' | 'Standard';
+export interface CustomShippingDraft {
+    readonly key: string;
+    readonly shippingMethodName: string;
+    readonly shippingAddress?: BaseAddress;
+    readonly shippingRate: ShippingRateDraft;
+    readonly shippingRateInput?: ShippingRateInputDraft;
+    readonly taxCategory?: TaxCategoryResourceIdentifier;
+    readonly externalTaxRate?: string;
+    readonly deliveries: Delivery[];
+    readonly custom?: string;
+}
 export interface DirectDiscount {
     readonly id: string;
     readonly value: CartDiscountValue;
@@ -181,6 +199,7 @@ export interface ItemShippingDetailsDraft {
 export interface ItemShippingTarget {
     readonly addressKey: string;
     readonly quantity: number;
+    readonly shippingMethodKey?: string;
 }
 export interface LineItem {
     readonly id: string;
@@ -192,11 +211,13 @@ export interface LineItem {
     readonly variant: ProductVariant;
     readonly price: Price;
     readonly taxedPrice?: TaxedItemPrice;
+    readonly taxedPricePortions: MethodTaxedPrice[];
     readonly totalPrice: TypedMoney;
     readonly quantity: number;
     readonly addedAt?: string;
     readonly state: ItemState[];
     readonly taxRate?: TaxRate;
+    readonly perMethodTaxRate: MethodTaxRate[];
     readonly supplyChannel?: ChannelReference;
     readonly distributionChannel?: ChannelReference;
     readonly discountedPricePerQuantity: DiscountedLineItemPriceForQuantity[];
@@ -224,11 +245,35 @@ export interface LineItemDraft {
 }
 export declare type LineItemMode = 'GiftLineItem' | 'Standard';
 export declare type LineItemPriceMode = 'ExternalPrice' | 'ExternalTotal' | 'Platform';
+export interface MethodTaxRate {
+    readonly shippingMethodKey: string;
+    readonly taxRate?: TaxRate;
+}
+export interface MethodTaxedPrice {
+    readonly shippingMethodKey: string;
+    readonly taxedPrice?: TaxedItemPrice;
+}
 export interface ReplicaCartDraft {
     readonly reference: CartReference | OrderReference;
     readonly key?: string;
 }
 export declare type RoundingMode = 'HalfDown' | 'HalfEven' | 'HalfUp';
+export interface Shipping {
+    readonly shippingKey: string;
+    readonly shippingInfo: ShippingInfo;
+    readonly shippingAddress: Address;
+    readonly shippingRateInput?: ShippingRateInput;
+    readonly shippingCustomFields?: CustomFields;
+}
+export interface ShippingDraft {
+    readonly key: string;
+    readonly shippingMethod?: ShippingMethodReference;
+    readonly shippingAddress?: BaseAddress;
+    readonly shippingRateInput?: ShippingRateInputDraft;
+    readonly externalTaxRate?: string;
+    readonly deliveries: Delivery[];
+    readonly custom?: string;
+}
 export interface ShippingInfo {
     readonly shippingMethodName: string;
     readonly price: TypedMoney;
@@ -242,6 +287,7 @@ export interface ShippingInfo {
     readonly shippingMethodState: ShippingMethodState;
 }
 export declare type ShippingMethodState = 'DoesNotMatchCart' | 'MatchesCart';
+export declare type ShippingMode = 'Multiple' | 'Single';
 export declare type ShippingRateInput = ClassificationShippingRateInput | ScoreShippingRateInput;
 export interface ClassificationShippingRateInput {
     readonly type: 'Classification';
@@ -298,6 +344,19 @@ export interface CartAddCustomLineItemAction {
     readonly taxCategory?: TaxCategoryResourceIdentifier;
     readonly custom?: CustomFieldsDraft;
     readonly externalTaxRate?: ExternalTaxRateDraft;
+    readonly priceMode?: CustomLineItemPriceMode;
+}
+export interface CartAddCustomShippingMethodAction {
+    readonly action: 'addCustomShippingMethod';
+    readonly shippingKey: string;
+    readonly shippingMethodName: string;
+    readonly shippingAddress?: BaseAddress;
+    readonly shippingRate: ShippingRateDraft;
+    readonly shippingRateInput?: ShippingRateInputDraft;
+    readonly taxCategory?: TaxCategoryResourceIdentifier;
+    readonly externalTaxRate?: string;
+    readonly deliveries: Delivery[];
+    readonly custom?: string;
 }
 export interface CartAddDiscountCodeAction {
     readonly action: 'addDiscountCode';
@@ -325,6 +384,16 @@ export interface CartAddPaymentAction {
     readonly action: 'addPayment';
     readonly payment: PaymentResourceIdentifier;
 }
+export interface CartAddShippingMethodAction {
+    readonly action: 'addShippingMethod';
+    readonly shippingKey: string;
+    readonly shippingMethod?: ShippingMethodReference;
+    readonly shippingAddress?: BaseAddress;
+    readonly shippingRateInput?: ShippingRateInputDraft;
+    readonly externalTaxRate?: string;
+    readonly deliveries: Delivery[];
+    readonly custom?: string;
+}
 export interface CartAddShoppingListAction {
     readonly action: 'addShoppingList';
     readonly shoppingList: ShoppingListResourceIdentifier;
@@ -403,6 +472,10 @@ export interface CartRemovePaymentAction {
     readonly action: 'removePayment';
     readonly payment: PaymentResourceIdentifier;
 }
+export interface CartRemoveShippingMethodAction {
+    readonly action: 'removeShippingMethod';
+    readonly shippingKey: string;
+}
 export interface CartSetAnonymousIdAction {
     readonly action: 'setAnonymousId';
     readonly anonymousId?: string;
@@ -587,6 +660,18 @@ export interface CartSetShippingAddressCustomTypeAction {
     readonly type?: TypeResourceIdentifier;
     readonly fields?: FieldContainer;
 }
+export interface CartSetShippingCustomFieldAction {
+    readonly action: 'setShippingCustomField';
+    readonly shippingKey?: string;
+    readonly name: string;
+    readonly value?: any;
+}
+export interface CartSetShippingCustomTypeAction {
+    readonly action: 'setShippingCustomType';
+    readonly shippingKey?: string;
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
 export interface CartSetShippingMethodAction {
     readonly action: 'setShippingMethod';
     readonly shippingMethod?: ShippingMethodResourceIdentifier;
@@ -618,5 +703,6 @@ export interface CustomLineItemImportDraft {
     readonly taxCategory?: TaxCategoryResourceIdentifier;
     readonly custom?: CustomFieldsDraft;
     readonly shippingDetails?: ItemShippingDetailsDraft;
+    readonly priceMode: CustomLineItemPriceMode;
 }
 export declare type ProductPublishScope = 'All' | 'Prices';

package/dist/typings/models/common.d.ts

@@ -203,7 +203,7 @@ export interface QueryPrice {
     readonly tiers?: PriceTierDraft[];
 }
 export declare type Reference = CartDiscountReference | CartReference | CategoryReference | ChannelReference | CustomObjectReference | CustomerGroupReference | CustomerReference | DiscountCodeReference | InventoryEntryReference | OrderEditReference | OrderReference | PaymentReference | ProductDiscountReference | ProductReference | ProductSelectionReference | ProductTypeReference | QuoteReference | QuoteRequestReference | ReviewReference | ShippingMethodReference | ShoppingListReference | StagedQuoteReference | StandalonePriceReference | StateReference | StoreReference | TaxCategoryReference | TypeReference | ZoneReference;
-export declare type ReferenceTypeId = 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-price' | 'product-selection' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone';
+export declare type ReferenceTypeId = 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-price' | 'product-selection' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'standalone-price' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone';
 export declare type ResourceIdentifier = CartDiscountResourceIdentifier | CartResourceIdentifier | CategoryResourceIdentifier | ChannelResourceIdentifier | CustomerGroupResourceIdentifier | CustomerResourceIdentifier | DiscountCodeResourceIdentifier | InventoryEntryResourceIdentifier | OrderEditResourceIdentifier | OrderResourceIdentifier | PaymentResourceIdentifier | ProductDiscountResourceIdentifier | ProductResourceIdentifier | ProductSelectionResourceIdentifier | ProductTypeResourceIdentifier | QuoteRequestResourceIdentifier | QuoteResourceIdentifier | ReviewResourceIdentifier | ShippingMethodResourceIdentifier | ShoppingListResourceIdentifier | StagedQuoteResourceIdentifier | StandalonePriceResourceIdentifier | StateResourceIdentifier | StoreResourceIdentifier | TaxCategoryResourceIdentifier | TypeResourceIdentifier | ZoneResourceIdentifier;
 export interface ScopedPrice {
     readonly id: string;

package/dist/typings/models/me.d.ts

@@ -1,4 +1,4 @@
-import { CartReference, CartResourceIdentifier, DiscountCodeInfo, ExternalLineItemTotalPrice, ExternalTaxRateDraft, InventoryMode, ItemShippingDetailsDraft, ItemShippingTarget, TaxMode } from './cart';
+import { CartReference, CartResourceIdentifier, ExternalLineItemTotalPrice, ExternalTaxRateDraft, InventoryMode, ItemShippingDetailsDraft, ItemShippingTarget, TaxMode } from './cart';
 import { ChannelResourceIdentifier } from './channel';
 import { BaseAddress, LocalizedString, Money, TypedMoney } from './common';
 import { CustomerReference } from './customer';
@@ -24,7 +24,7 @@ export interface MyCartDraft {
     readonly deleteDaysAfterLastModification?: number;
     readonly itemShippingAddresses?: BaseAddress[];
     readonly store?: StoreKeyReference;
-    readonly discountCodes?: DiscountCodeInfo[];
+    readonly discountCodes?: string[];
 }
 export interface MyCartUpdate {
     readonly version: number;