@gradientedge/commercetools-utils 5.3.0 → 5.4.0

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

@@ -1,31 +1,37 @@
-import { CartReference, CartResourceIdentifier } from './cart';
-import { CartDiscountReference, CartDiscountResourceIdentifier } from './cart-discount';
-import { CategoryReference, CategoryResourceIdentifier } from './category';
-import { ChannelReference, ChannelResourceIdentifier } from './channel';
-import { CustomObjectReference } from './custom-object';
-import { CustomerReference, CustomerResourceIdentifier } from './customer';
-import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group';
-import { DiscountCodeReference, DiscountCodeResourceIdentifier } from './discount-code';
-import { InventoryEntryReference, InventoryEntryResourceIdentifier } from './inventory';
-import { OrderReference, OrderResourceIdentifier } from './order';
-import { OrderEditReference, OrderEditResourceIdentifier } from './order-edit';
-import { PaymentReference, PaymentResourceIdentifier } from './payment';
-import { ProductReference, ProductResourceIdentifier } from './product';
-import { ProductDiscountReference, ProductDiscountResourceIdentifier } from './product-discount';
-import { ProductSelectionReference, ProductSelectionResourceIdentifier } from './product-selection';
-import { ProductTypeReference, ProductTypeResourceIdentifier } from './product-type';
-import { QuoteReference, QuoteResourceIdentifier } from './quote';
-import { QuoteRequestReference, QuoteRequestResourceIdentifier } from './quote-request';
-import { ReviewReference, ReviewResourceIdentifier } from './review';
-import { ShippingMethodReference, ShippingMethodResourceIdentifier } from './shipping-method';
-import { ShoppingListReference, ShoppingListResourceIdentifier } from './shopping-list';
-import { StagedQuoteReference, StagedQuoteResourceIdentifier } from './staged-quote';
-import { StandalonePriceReference, StandalonePriceResourceIdentifier } from './standalone-price';
-import { StateReference, StateResourceIdentifier } from './state';
-import { StoreKeyReference, StoreReference, StoreResourceIdentifier } from './store';
-import { TaxCategoryReference, TaxCategoryResourceIdentifier } from './tax-category';
-import { CustomFields, CustomFieldsDraft, TypeReference, TypeResourceIdentifier } from './type';
-import { ZoneReference, ZoneResourceIdentifier } from './zone';
+import { AssociateRole, AssociateRoleKeyReference, AssociateRoleReference, AssociateRoleResourceIdentifier } from './associate-role';
+import { AttributeGroup, AttributeGroupReference, AttributeGroupResourceIdentifier } from './attribute-group';
+import { BusinessUnit, BusinessUnitKeyReference, BusinessUnitReference, BusinessUnitResourceIdentifier } from './business-unit';
+import { Cart, CartReference, CartResourceIdentifier, DirectDiscountReference } from './cart';
+import { CartDiscount, CartDiscountReference, CartDiscountResourceIdentifier } from './cart-discount';
+import { Category, CategoryReference, CategoryResourceIdentifier } from './category';
+import { Channel, ChannelReference, ChannelResourceIdentifier } from './channel';
+import { CustomObject, CustomObjectReference } from './custom-object';
+import { Customer, CustomerReference, CustomerResourceIdentifier } from './customer';
+import { CustomerGroup, CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group';
+import { DiscountCode, DiscountCodeReference, DiscountCodeResourceIdentifier } from './discount-code';
+import { Extension } from './extension';
+import { InventoryEntry, InventoryEntryReference, InventoryEntryResourceIdentifier } from './inventory';
+import { Message } from './message';
+import { Order, OrderReference, OrderResourceIdentifier } from './order';
+import { OrderEdit, OrderEditReference, OrderEditResourceIdentifier } from './order-edit';
+import { Payment, PaymentReference, PaymentResourceIdentifier } from './payment';
+import { Product, ProductProjection, ProductReference, ProductResourceIdentifier } from './product';
+import { ProductDiscount, ProductDiscountReference, ProductDiscountResourceIdentifier } from './product-discount';
+import { ProductSelection, ProductSelectionReference, ProductSelectionResourceIdentifier } from './product-selection';
+import { ProductType, ProductTypeReference, ProductTypeResourceIdentifier } from './product-type';
+import { Quote, QuoteReference, QuoteResourceIdentifier } from './quote';
+import { QuoteRequest, QuoteRequestReference, QuoteRequestResourceIdentifier } from './quote-request';
+import { Review, ReviewReference, ReviewResourceIdentifier } from './review';
+import { ShippingMethod, ShippingMethodReference, ShippingMethodResourceIdentifier } from './shipping-method';
+import { ShoppingList, ShoppingListReference, ShoppingListResourceIdentifier } from './shopping-list';
+import { StagedQuote, StagedQuoteReference, StagedQuoteResourceIdentifier } from './staged-quote';
+import { StandalonePrice, StandalonePriceReference, StandalonePriceResourceIdentifier } from './standalone-price';
+import { State, StateReference, StateResourceIdentifier } from './state';
+import { Store, StoreKeyReference, StoreReference, StoreResourceIdentifier } from './store';
+import { Subscription } from './subscription';
+import { TaxCategory, TaxCategoryReference, TaxCategoryResourceIdentifier } from './tax-category';
+import { CustomFields, CustomFieldsDraft, Type, TypeReference, TypeResourceIdentifier } from './type';
+import { Zone, ZoneReference, ZoneResourceIdentifier } from './zone';
 export interface PagedQueryResponse {
     readonly limit: number;
     readonly offset: number;
@@ -95,14 +101,12 @@ export interface BaseAddress {
     readonly additionalAddressInfo?: string;
     readonly externalId?: string;
 }
+export type _BaseAddress = BaseAddress | Address | AddressDraft;
 export interface Address extends BaseAddress {
-    readonly id?: string;
     readonly custom?: CustomFields;
 }
 export interface AddressDraft extends BaseAddress {
     readonly custom?: CustomFieldsDraft;
-    readonly id?: string;
-    readonly key?: string;
 }
 export interface BaseResource {
     readonly id: string;
@@ -110,12 +114,14 @@ export interface BaseResource {
     readonly createdAt: string;
     readonly lastModifiedAt: string;
 }
+export type _BaseResource = BaseResource | AssociateRole | AttributeGroup | BusinessUnit | Cart | CartDiscount | Category | Channel | CustomObject | Customer | CustomerGroup | DiscountCode | Extension | InventoryEntry | Message | Order | OrderEdit | Payment | Product | ProductDiscount | ProductProjection | ProductSelection | ProductType | Quote | QuoteRequest | Review | ShippingMethod | ShoppingList | StagedQuote | StandalonePrice | State | Store | Subscription | TaxCategory | Type | Zone;
 export interface ClientLogging {
     readonly clientId?: string;
     readonly externalUserId?: string;
     readonly customer?: CustomerReference;
     readonly anonymousId?: string;
 }
+export type _ClientLogging = ClientLogging | CreatedBy | LastModifiedBy;
 export interface CreatedBy extends ClientLogging {
     readonly clientId?: string;
     readonly externalUserId?: string;
@@ -127,7 +133,7 @@ export interface DiscountedPrice {
     readonly discount: ProductDiscountReference;
 }
 export interface DiscountedPriceDraft {
-    readonly value: Money;
+    readonly value: _Money;
     readonly discount: ProductDiscountReference;
 }
 export type GeoJson = GeoJsonPoint;
@@ -144,7 +150,7 @@ export interface ImageDimensions {
     readonly w: number;
     readonly h: number;
 }
-export type KeyReference = StoreKeyReference;
+export type KeyReference = AssociateRoleKeyReference | BusinessUnitKeyReference | StoreKeyReference;
 export interface LastModifiedBy extends ClientLogging {
     readonly clientId?: string;
     readonly externalUserId?: string;
@@ -158,9 +164,11 @@ export interface Money {
     readonly centAmount: number;
     readonly currencyCode: string;
 }
-export type MoneyType = 'centPrecision' | 'highPrecision';
+export type _Money = Money | TypedMoney | TypedMoneyDraft;
+export type MoneyType = 'centPrecision' | 'highPrecision' | string;
 export interface Price {
     readonly id: string;
+    readonly key?: string;
     readonly value: TypedMoney;
     readonly country?: string;
     readonly customerGroup?: CustomerGroupReference;
@@ -172,7 +180,8 @@ export interface Price {
     readonly custom?: CustomFields;
 }
 export interface PriceDraft {
-    readonly value: Money;
+    readonly key?: string;
+    readonly value: _Money;
     readonly country?: string;
     readonly customerGroup?: CustomerGroupResourceIdentifier;
     readonly channel?: ChannelResourceIdentifier;
@@ -188,11 +197,11 @@ export interface PriceTier {
 }
 export interface PriceTierDraft {
     readonly minimumQuantity: number;
-    readonly value: Money;
+    readonly value: _Money;
 }
 export interface QueryPrice {
     readonly id?: string;
-    readonly value: Money;
+    readonly value: _Money;
     readonly country?: string;
     readonly customerGroup?: CustomerGroupReference;
     readonly channel?: ChannelReference;
@@ -202,9 +211,9 @@ export interface QueryPrice {
     readonly custom?: CustomFields;
     readonly tiers?: PriceTierDraft[];
 }
-export 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 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 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 type Reference = AssociateRoleReference | AttributeGroupReference | BusinessUnitReference | CartDiscountReference | CartReference | CategoryReference | ChannelReference | CustomObjectReference | CustomerGroupReference | CustomerReference | DirectDiscountReference | DiscountCodeReference | InventoryEntryReference | OrderEditReference | OrderReference | PaymentReference | ProductDiscountReference | ProductReference | ProductSelectionReference | ProductTypeReference | QuoteReference | QuoteRequestReference | ReviewReference | ShippingMethodReference | ShoppingListReference | StagedQuoteReference | StandalonePriceReference | StateReference | StoreReference | TaxCategoryReference | TypeReference | ZoneReference;
+export type ReferenceTypeId = 'associate-role' | 'attribute-group' | 'business-unit' | 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'direct-discount' | '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' | string;
+export type ResourceIdentifier = AssociateRoleResourceIdentifier | AttributeGroupResourceIdentifier | BusinessUnitResourceIdentifier | 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;
     readonly value: TypedMoney;

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

@@ -1,18 +1,20 @@
 import { Cart, CartResourceIdentifier } from './cart';
-import { Address, BaseAddress, BaseResource, CreatedBy, LastModifiedBy } from './common';
+import { Address, BaseAddress, BaseResource, CreatedBy, LastModifiedBy, _BaseAddress } from './common';
 import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group';
 import { StoreKeyReference, StoreResourceIdentifier } from './store';
 import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
-export type AnonymousCartSignInMode = 'MergeWithExistingCustomerCart' | 'UseAsNewActiveCustomerCart';
-export type AuthenticationMode = 'ExternalAuth' | 'Password';
+export type AnonymousCartSignInMode = 'MergeWithExistingCustomerCart' | 'UseAsNewActiveCustomerCart' | string;
+export type AuthenticationMode = 'ExternalAuth' | 'Password' | string;
 export interface Customer extends BaseResource {
     readonly id: string;
     readonly version: number;
+    readonly key?: string;
+    readonly customerNumber?: string;
+    readonly externalId?: string;
     readonly createdAt: string;
     readonly lastModifiedAt: string;
     readonly lastModifiedBy?: LastModifiedBy;
     readonly createdBy?: CreatedBy;
-    readonly customerNumber?: string;
     readonly email: string;
     readonly password?: string;
     readonly firstName?: string;
@@ -28,14 +30,12 @@ export interface Customer extends BaseResource {
     readonly defaultBillingAddressId?: string;
     readonly billingAddressIds?: string[];
     readonly isEmailVerified: boolean;
-    readonly externalId?: string;
     readonly customerGroup?: CustomerGroupReference;
     readonly custom?: CustomFields;
     readonly locale?: string;
     readonly salutation?: string;
-    readonly key?: string;
     readonly stores?: StoreKeyReference[];
-    readonly authenticationMode?: AuthenticationMode;
+    readonly authenticationMode: AuthenticationMode;
 }
 export interface CustomerChangePassword {
     readonly id: string;
@@ -53,7 +53,9 @@ export interface CustomerCreatePasswordResetToken {
     readonly ttlMinutes?: number;
 }
 export interface CustomerDraft {
+    readonly key?: string;
     readonly customerNumber?: string;
+    readonly externalId?: string;
     readonly email: string;
     readonly password?: string;
     readonly firstName?: string;
@@ -72,12 +74,10 @@ export interface CustomerDraft {
     readonly defaultBillingAddress?: number;
     readonly billingAddresses?: number[];
     readonly isEmailVerified?: boolean;
-    readonly externalId?: string;
     readonly customerGroup?: CustomerGroupResourceIdentifier;
     readonly custom?: CustomFieldsDraft;
     readonly locale?: string;
     readonly salutation?: string;
-    readonly key?: string;
     readonly stores?: StoreResourceIdentifier[];
     readonly authenticationMode?: AuthenticationMode;
 }
@@ -87,9 +87,9 @@ export interface CustomerEmailVerify {
 }
 export interface CustomerPagedQueryResponse {
     readonly limit: number;
+    readonly offset: number;
     readonly count: number;
     readonly total?: number;
-    readonly offset: number;
     readonly results: Customer[];
 }
 export interface CustomerReference {
@@ -138,6 +138,9 @@ export interface MyCustomerChangePassword {
     readonly currentPassword: string;
     readonly newPassword: string;
 }
+export interface MyCustomerEmailVerify {
+    readonly tokenValue: string;
+}
 export interface MyCustomerResetPassword {
     readonly tokenValue: string;
     readonly newPassword: string;
@@ -150,7 +153,7 @@ export interface MyCustomerSignin {
 }
 export interface CustomerAddAddressAction {
     readonly action: 'addAddress';
-    readonly address: BaseAddress;
+    readonly address: _BaseAddress;
 }
 export interface CustomerAddBillingAddressIdAction {
     readonly action: 'addBillingAddressId';
@@ -170,7 +173,7 @@ export interface CustomerChangeAddressAction {
     readonly action: 'changeAddress';
     readonly addressId?: string;
     readonly addressKey?: string;
-    readonly address: BaseAddress;
+    readonly address: _BaseAddress;
 }
 export interface CustomerChangeEmailAction {
     readonly action: 'changeEmail';
@@ -203,9 +206,9 @@ export interface CustomerSetAddressCustomFieldAction {
 }
 export interface CustomerSetAddressCustomTypeAction {
     readonly action: 'setAddressCustomType';
+    readonly addressId: string;
     readonly type?: TypeResourceIdentifier;
     readonly fields?: FieldContainer;
-    readonly addressId: string;
 }
 export interface CustomerSetAuthenticationModeAction {
     readonly action: 'setAuthenticationMode';