@gradientedge/commercetools-utils 5.3.1 → 5.5.0

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

@@ -1,36 +1,61 @@
-import { CartReference, CartResourceIdentifier, ExternalLineItemTotalPrice, ExternalTaxRateDraft, InventoryMode, ItemShippingDetailsDraft, ItemShippingTarget, TaxMode } from './cart';
+import { AssociateDraft, AssociateRoleAssignmentDraft, BusinessUnitResourceIdentifier, BusinessUnitUpdateAction } from './business-unit';
+import { CartReference, ExternalLineItemTotalPrice, ExternalTaxRateDraft, InventoryMode, ItemShippingDetailsDraft, ItemShippingTarget, TaxMode } from './cart';
 import { ChannelResourceIdentifier } from './channel';
-import { BaseAddress, LocalizedString, Money, TypedMoney } from './common';
-import { CustomerReference } from './customer';
+import { BaseAddress, CentPrecisionMoney, LocalizedString, _BaseAddress, _Money } from './common';
+import { CustomerReference, CustomerResourceIdentifier } from './customer';
 import { DiscountCodeReference } from './discount-code';
 import { OrderReference } from './order';
 import { PaymentMethodInfo, PaymentResourceIdentifier, Transaction, TransactionDraft, TransactionType } from './payment';
 import { ShippingMethodResourceIdentifier } from './shipping-method';
 import { ShoppingListLineItemDraft, TextLineItemDraft } from './shopping-list';
-import { StoreKeyReference, StoreResourceIdentifier } from './store';
+import { StoreResourceIdentifier } from './store';
 import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
+export interface MyBusinessUnitAssociateDraft {
+    readonly version: number;
+    readonly customer: MyCustomerDraft;
+    readonly associateRoleAssignments: AssociateRoleAssignmentDraft[];
+}
+export type MyBusinessUnitDraft = MyCompanyDraft | MyDivisionDraft;
+export interface MyBusinessUnitUpdate {
+    readonly version: number;
+    readonly actions: BusinessUnitUpdateAction[];
+}
+export type MyBusinessUnitUpdateAction = MyBusinessUnitAddAddressAction | MyBusinessUnitAddBillingAddressIdAction | MyBusinessUnitAddShippingAddressIdAction | MyBusinessUnitChangeAddressAction | MyBusinessUnitChangeAssociateAction | MyBusinessUnitChangeNameAction | MyBusinessUnitChangeParentUnitAction | MyBusinessUnitRemoveAddressAction | MyBusinessUnitRemoveAssociateAction | MyBusinessUnitRemoveBillingAddressIdAction | MyBusinessUnitRemoveShippingAddressIdAction | MyBusinessUnitSetAddressCustomFieldAction | MyBusinessUnitSetAddressCustomTypeAction | MyBusinessUnitSetContactEmailAction | MyBusinessUnitSetCustomFieldAction | MyBusinessUnitSetCustomTypeAction | MyBusinessUnitSetDefaultBillingAddressAction | MyBusinessUnitSetDefaultShippingAddressAction;
 export interface MyCartDraft {
     readonly currency: string;
     readonly customerEmail?: string;
-    readonly country?: string;
-    readonly inventoryMode?: InventoryMode;
+    readonly businessUnit?: BusinessUnitResourceIdentifier;
+    readonly store?: StoreResourceIdentifier;
     readonly lineItems?: MyLineItemDraft[];
-    readonly shippingAddress?: BaseAddress;
-    readonly billingAddress?: BaseAddress;
-    readonly shippingMethod?: ShippingMethodResourceIdentifier;
-    readonly custom?: CustomFieldsDraft;
-    readonly locale?: string;
     readonly taxMode?: TaxMode;
-    readonly deleteDaysAfterLastModification?: number;
+    readonly inventoryMode?: InventoryMode;
+    readonly billingAddress?: _BaseAddress;
+    readonly shippingAddress?: _BaseAddress;
+    readonly shippingMethod?: ShippingMethodResourceIdentifier;
     readonly itemShippingAddresses?: BaseAddress[];
-    readonly store?: StoreKeyReference;
     readonly discountCodes?: string[];
+    readonly country?: string;
+    readonly locale?: string;
+    readonly deleteDaysAfterLastModification?: number;
+    readonly custom?: CustomFieldsDraft;
 }
 export interface MyCartUpdate {
     readonly version: number;
     readonly actions: MyCartUpdateAction[];
 }
-export type MyCartUpdateAction = MyCartAddDiscountCodeAction | MyCartAddItemShippingAddressAction | MyCartAddLineItemAction | MyCartAddPaymentAction | MyCartApplyDeltaToLineItemShippingDetailsTargetsAction | MyCartChangeLineItemQuantityAction | MyCartChangeTaxModeAction | MyCartRecalculateAction | MyCartRemoveDiscountCodeAction | MyCartRemoveItemShippingAddressAction | MyCartRemoveLineItemAction | MyCartRemovePaymentAction | MyCartSetBillingAddressAction | MyCartSetCountryAction | MyCartSetCustomFieldAction | MyCartSetCustomTypeAction | MyCartSetCustomerEmailAction | MyCartSetDeleteDaysAfterLastModificationAction | MyCartSetLineItemCustomFieldAction | MyCartSetLineItemCustomTypeAction | MyCartSetLineItemDistributionChannelAction | MyCartSetLineItemShippingDetailsAction | MyCartSetLineItemSupplyChannelAction | MyCartSetLocaleAction | MyCartSetShippingAddressAction | MyCartSetShippingMethodAction | MyCartUpdateItemShippingAddressAction;
+export type MyCartUpdateAction = MyCartAddDiscountCodeAction | MyCartAddItemShippingAddressAction | MyCartAddLineItemAction | MyCartAddPaymentAction | MyCartApplyDeltaToLineItemShippingDetailsTargetsAction | MyCartChangeLineItemQuantityAction | MyCartChangeTaxModeAction | MyCartRecalculateAction | MyCartRemoveDiscountCodeAction | MyCartRemoveItemShippingAddressAction | MyCartRemoveLineItemAction | MyCartRemovePaymentAction | MyCartSetBillingAddressAction | MyCartSetBusinessUnitAction | MyCartSetCountryAction | MyCartSetCustomFieldAction | MyCartSetCustomTypeAction | MyCartSetCustomerEmailAction | MyCartSetDeleteDaysAfterLastModificationAction | MyCartSetLineItemCustomFieldAction | MyCartSetLineItemCustomTypeAction | MyCartSetLineItemDistributionChannelAction | MyCartSetLineItemShippingDetailsAction | MyCartSetLineItemSupplyChannelAction | MyCartSetLocaleAction | MyCartSetShippingAddressAction | MyCartSetShippingMethodAction | MyCartUpdateItemShippingAddressAction;
+export interface MyCompanyDraft {
+    readonly unitType: 'Company';
+    readonly key: string;
+    readonly name: string;
+    readonly contactEmail?: string;
+    readonly custom?: CustomFields;
+    readonly addresses?: BaseAddress[];
+    readonly shippingAddresses?: number[];
+    readonly defaultShippingAddress?: number;
+    readonly billingAddresses?: number[];
+    readonly defaultBillingAddress?: number;
+}
 export interface MyCustomerDraft {
     readonly email: string;
     readonly password: string;
@@ -38,6 +63,7 @@ export interface MyCustomerDraft {
     readonly lastName?: string;
     readonly middleName?: string;
     readonly title?: string;
+    readonly salutation?: string;
     readonly dateOfBirth?: string;
     readonly companyName?: string;
     readonly vatId?: string;
@@ -53,33 +79,51 @@ export interface MyCustomerUpdate {
     readonly actions: MyCustomerUpdateAction[];
 }
 export type MyCustomerUpdateAction = MyCustomerAddAddressAction | MyCustomerAddBillingAddressIdAction | MyCustomerAddShippingAddressIdAction | MyCustomerChangeAddressAction | MyCustomerChangeEmailAction | MyCustomerRemoveAddressAction | MyCustomerRemoveBillingAddressIdAction | MyCustomerRemoveShippingAddressIdAction | MyCustomerSetCompanyNameAction | MyCustomerSetCustomFieldAction | MyCustomerSetCustomTypeAction | MyCustomerSetDateOfBirthAction | MyCustomerSetDefaultBillingAddressAction | MyCustomerSetDefaultShippingAddressAction | MyCustomerSetFirstNameAction | MyCustomerSetLastNameAction | MyCustomerSetLocaleAction | MyCustomerSetMiddleNameAction | MyCustomerSetSalutationAction | MyCustomerSetTitleAction | MyCustomerSetVatIdAction;
+export interface MyDivisionDraft {
+    readonly unitType: 'Division';
+    readonly key: string;
+    readonly name: string;
+    readonly contactEmail?: string;
+    readonly custom?: CustomFields;
+    readonly addresses?: BaseAddress[];
+    readonly shippingAddresses?: number[];
+    readonly defaultShippingAddress?: number;
+    readonly billingAddresses?: number[];
+    readonly defaultBillingAddress?: number;
+    readonly parentUnit: BusinessUnitResourceIdentifier;
+}
 export interface MyLineItemDraft {
     readonly productId?: string;
     readonly variantId?: number;
-    readonly quantity: number;
+    readonly sku?: string;
+    readonly quantity?: number;
     readonly addedAt?: string;
     readonly supplyChannel?: ChannelResourceIdentifier;
     readonly distributionChannel?: ChannelResourceIdentifier;
-    readonly custom?: CustomFieldsDraft;
     readonly shippingDetails?: ItemShippingDetailsDraft;
-    readonly sku?: string;
+    readonly custom?: CustomFieldsDraft;
 }
 export interface MyOrderFromCartDraft {
     readonly id: string;
     readonly version: number;
 }
+export interface MyOrderFromQuoteDraft {
+    readonly id: string;
+    readonly version: number;
+    readonly quoteStateToAccepted?: boolean;
+}
 export interface MyPayment {
     readonly id: string;
     readonly version: number;
     readonly customer?: CustomerReference;
     readonly anonymousId?: string;
-    readonly amountPlanned: TypedMoney;
+    readonly amountPlanned: CentPrecisionMoney;
     readonly paymentMethodInfo: PaymentMethodInfo;
     readonly transactions: Transaction[];
     readonly custom?: CustomFields;
 }
 export interface MyPaymentDraft {
-    readonly amountPlanned: Money;
+    readonly amountPlanned: _Money;
     readonly paymentMethodInfo?: PaymentMethodInfo;
     readonly custom?: CustomFieldsDraft;
     readonly transaction?: MyTransactionDraft;
@@ -97,8 +141,8 @@ export interface MyPaymentUpdate {
 }
 export type MyPaymentUpdateAction = MyPaymentAddTransactionAction | MyPaymentChangeAmountPlannedAction | MyPaymentSetCustomFieldAction | MyPaymentSetMethodInfoInterfaceAction | MyPaymentSetMethodInfoMethodAction | MyPaymentSetMethodInfoNameAction | MyPaymentSetTransactionCustomFieldAction;
 export interface MyQuoteRequestDraft {
-    readonly cart: CartResourceIdentifier;
-    readonly version: number;
+    readonly cartId: string;
+    readonly cartVersion: number;
     readonly comment: string;
 }
 export interface MyQuoteRequestUpdate {
@@ -106,6 +150,12 @@ export interface MyQuoteRequestUpdate {
     readonly actions: MyQuoteRequestUpdateAction[];
 }
 export type MyQuoteRequestUpdateAction = MyQuoteRequestCancelAction;
+export type MyQuoteState = 'Accepted' | 'Declined' | string;
+export interface MyQuoteUpdate {
+    readonly version: number;
+    readonly actions: MyQuoteUpdateAction[];
+}
+export type MyQuoteUpdateAction = MyQuoteChangeMyQuoteStateAction;
 export interface MyShoppingListDraft {
     readonly name: LocalizedString;
     readonly description?: LocalizedString;
@@ -123,35 +173,119 @@ export type MyShoppingListUpdateAction = MyShoppingListAddLineItemAction | MySho
 export interface MyTransactionDraft {
     readonly timestamp?: string;
     readonly type: TransactionType;
-    readonly amount: Money;
+    readonly amount: _Money;
     readonly interactionId?: string;
     readonly custom?: CustomFieldsDraft;
 }
 export interface ReplicaMyCartDraft {
     readonly reference: CartReference | OrderReference;
 }
+export interface MyBusinessUnitAddAddressAction {
+    readonly action: 'addAddress';
+    readonly address: _BaseAddress;
+}
+export interface MyBusinessUnitAddBillingAddressIdAction {
+    readonly action: 'addBillingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface MyBusinessUnitAddShippingAddressIdAction {
+    readonly action: 'addShippingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface MyBusinessUnitChangeAddressAction {
+    readonly action: 'changeAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+    readonly address: _BaseAddress;
+}
+export interface MyBusinessUnitChangeAssociateAction {
+    readonly action: 'changeAssociate';
+    readonly associate: AssociateDraft;
+}
+export interface MyBusinessUnitChangeNameAction {
+    readonly action: 'changeName';
+    readonly name: string;
+}
+export interface MyBusinessUnitChangeParentUnitAction {
+    readonly action: 'changeParentUnit';
+    readonly parentUnit: BusinessUnitResourceIdentifier;
+}
+export interface MyBusinessUnitRemoveAddressAction {
+    readonly action: 'removeAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface MyBusinessUnitRemoveAssociateAction {
+    readonly action: 'removeAssociate';
+    readonly customer: CustomerResourceIdentifier;
+}
+export interface MyBusinessUnitRemoveBillingAddressIdAction {
+    readonly action: 'removeBillingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface MyBusinessUnitRemoveShippingAddressIdAction {
+    readonly action: 'removeShippingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface MyBusinessUnitSetAddressCustomFieldAction {
+    readonly action: 'setAddressCustomField';
+    readonly addressId: string;
+    readonly name: string;
+    readonly value?: any;
+}
+export interface MyBusinessUnitSetAddressCustomTypeAction {
+    readonly action: 'setAddressCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+    readonly addressId: string;
+}
+export interface MyBusinessUnitSetContactEmailAction {
+    readonly action: 'setContactEmail';
+    readonly contactEmail?: string;
+}
+export interface MyBusinessUnitSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    readonly name: string;
+    readonly value?: any;
+}
+export interface MyBusinessUnitSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface MyBusinessUnitSetDefaultBillingAddressAction {
+    readonly action: 'setDefaultBillingAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface MyBusinessUnitSetDefaultShippingAddressAction {
+    readonly action: 'setDefaultShippingAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
 export interface MyCartAddDiscountCodeAction {
     readonly action: 'addDiscountCode';
     readonly code: string;
 }
 export interface MyCartAddItemShippingAddressAction {
     readonly action: 'addItemShippingAddress';
-    readonly address: BaseAddress;
+    readonly address: _BaseAddress;
 }
 export interface MyCartAddLineItemAction {
     readonly action: 'addLineItem';
-    readonly custom?: CustomFieldsDraft;
-    readonly distributionChannel?: ChannelResourceIdentifier;
-    readonly externalTaxRate?: ExternalTaxRateDraft;
     readonly productId?: string;
     readonly variantId?: number;
     readonly sku?: string;
     readonly quantity?: number;
+    readonly addedAt?: string;
+    readonly distributionChannel?: ChannelResourceIdentifier;
     readonly supplyChannel?: ChannelResourceIdentifier;
-    readonly externalPrice?: Money;
-    readonly externalTotalPrice?: ExternalLineItemTotalPrice;
     readonly shippingDetails?: ItemShippingDetailsDraft;
-    readonly addedAt?: string;
+    readonly custom?: CustomFieldsDraft;
 }
 export interface MyCartAddPaymentAction {
     readonly action: 'addPayment';
@@ -166,7 +300,7 @@ export interface MyCartChangeLineItemQuantityAction {
     readonly action: 'changeLineItemQuantity';
     readonly lineItemId: string;
     readonly quantity: number;
-    readonly externalPrice?: Money;
+    readonly externalPrice?: _Money;
     readonly externalTotalPrice?: ExternalLineItemTotalPrice;
 }
 export interface MyCartChangeTaxModeAction {
@@ -189,7 +323,7 @@ export interface MyCartRemoveLineItemAction {
     readonly action: 'removeLineItem';
     readonly lineItemId: string;
     readonly quantity?: number;
-    readonly externalPrice?: Money;
+    readonly externalPrice?: _Money;
     readonly externalTotalPrice?: ExternalLineItemTotalPrice;
     readonly shippingDetailsToRemove?: ItemShippingDetailsDraft;
 }
@@ -199,7 +333,11 @@ export interface MyCartRemovePaymentAction {
 }
 export interface MyCartSetBillingAddressAction {
     readonly action: 'setBillingAddress';
-    readonly address?: BaseAddress;
+    readonly address?: _BaseAddress;
+}
+export interface MyCartSetBusinessUnitAction {
+    readonly action: 'setBusinessUnit';
+    readonly businessUnit: BusinessUnitResourceIdentifier;
 }
 export interface MyCartSetCountryAction {
     readonly action: 'setCountry';
@@ -256,7 +394,7 @@ export interface MyCartSetLocaleAction {
 }
 export interface MyCartSetShippingAddressAction {
     readonly action: 'setShippingAddress';
-    readonly address?: BaseAddress;
+    readonly address?: _BaseAddress;
 }
 export interface MyCartSetShippingMethodAction {
     readonly action: 'setShippingMethod';
@@ -265,11 +403,11 @@ export interface MyCartSetShippingMethodAction {
 }
 export interface MyCartUpdateItemShippingAddressAction {
     readonly action: 'updateItemShippingAddress';
-    readonly address: BaseAddress;
+    readonly address: _BaseAddress;
 }
 export interface MyCustomerAddAddressAction {
     readonly action: 'addAddress';
-    readonly address: BaseAddress;
+    readonly address: _BaseAddress;
 }
 export interface MyCustomerAddBillingAddressIdAction {
     readonly action: 'addBillingAddressId';
@@ -285,7 +423,7 @@ export interface MyCustomerChangeAddressAction {
     readonly action: 'changeAddress';
     readonly addressId?: string;
     readonly addressKey?: string;
-    readonly address: BaseAddress;
+    readonly address: _BaseAddress;
 }
 export interface MyCustomerChangeEmailAction {
     readonly action: 'changeEmail';
@@ -368,7 +506,7 @@ export interface MyPaymentAddTransactionAction {
 }
 export interface MyPaymentChangeAmountPlannedAction {
     readonly action: 'changeAmountPlanned';
-    readonly amount: Money;
+    readonly amount: _Money;
 }
 export interface MyPaymentSetCustomFieldAction {
     readonly action: 'setCustomField';
@@ -392,6 +530,10 @@ export interface MyPaymentSetTransactionCustomFieldAction {
     readonly name: string;
     readonly value?: any;
 }
+export interface MyQuoteChangeMyQuoteStateAction {
+    readonly action: 'changeMyQuoteState';
+    readonly quoteState: MyQuoteState;
+}
 export interface MyQuoteRequestCancelAction {
     readonly action: 'cancelQuoteRequest';
 }