@gradientedge/commercetools-utils 4.11.3 → 4.13.0

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

@@ -0,0 +1,115 @@
+import { ChannelReference, ChannelResourceIdentifier } from './channel';
+import { BaseResource, CreatedBy, LastModifiedBy } from './common';
+import { CustomerReference, CustomerResourceIdentifier } from './customer';
+import { ProductReference, ProductResourceIdentifier } from './product';
+import { StateReference, StateResourceIdentifier } from './state';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
+export interface Review extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly key?: string;
+    readonly uniquenessValue?: string;
+    readonly locale?: string;
+    readonly authorName?: string;
+    readonly title?: string;
+    readonly text?: string;
+    readonly target?: ProductReference | ChannelReference;
+    readonly includedInStatistics: boolean;
+    readonly rating?: number;
+    readonly state?: StateReference;
+    readonly customer?: CustomerReference;
+    readonly custom?: CustomFields;
+}
+export interface ReviewDraft {
+    readonly key?: string;
+    readonly uniquenessValue?: string;
+    readonly locale?: string;
+    readonly authorName?: string;
+    readonly title?: string;
+    readonly text?: string;
+    readonly target?: ProductResourceIdentifier | ChannelResourceIdentifier;
+    readonly state?: StateResourceIdentifier;
+    readonly rating?: number;
+    readonly customer?: CustomerResourceIdentifier;
+    readonly custom?: CustomFieldsDraft;
+}
+export interface ReviewPagedQueryResponse {
+    readonly limit: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly offset: number;
+    readonly results: Review[];
+}
+export interface ReviewRatingStatistics {
+    readonly averageRating: number;
+    readonly highestRating: number;
+    readonly lowestRating: number;
+    readonly count: number;
+    readonly ratingsDistribution: any;
+}
+export interface ReviewReference {
+    readonly typeId: 'review';
+    readonly id: string;
+    readonly obj?: Review;
+}
+export interface ReviewResourceIdentifier {
+    readonly typeId: 'review';
+    readonly id?: string;
+    readonly key?: string;
+}
+export interface ReviewUpdate {
+    readonly version: number;
+    readonly actions: ReviewUpdateAction[];
+}
+export declare type ReviewUpdateAction = ReviewSetAuthorNameAction | ReviewSetCustomFieldAction | ReviewSetCustomTypeAction | ReviewSetCustomerAction | ReviewSetKeyAction | ReviewSetLocaleAction | ReviewSetRatingAction | ReviewSetTargetAction | ReviewSetTextAction | ReviewSetTitleAction | ReviewTransitionStateAction;
+export interface ReviewSetAuthorNameAction {
+    readonly action: 'setAuthorName';
+    readonly authorName?: string;
+}
+export interface ReviewSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    readonly name: string;
+    readonly value?: any;
+}
+export interface ReviewSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface ReviewSetCustomerAction {
+    readonly action: 'setCustomer';
+    readonly customer?: CustomerResourceIdentifier;
+}
+export interface ReviewSetKeyAction {
+    readonly action: 'setKey';
+    readonly key?: string;
+}
+export interface ReviewSetLocaleAction {
+    readonly action: 'setLocale';
+    readonly locale?: string;
+}
+export interface ReviewSetRatingAction {
+    readonly action: 'setRating';
+    readonly rating?: number;
+}
+export interface ReviewSetTargetAction {
+    readonly action: 'setTarget';
+    readonly target: ProductResourceIdentifier | ChannelResourceIdentifier;
+}
+export interface ReviewSetTextAction {
+    readonly action: 'setText';
+    readonly text?: string;
+}
+export interface ReviewSetTitleAction {
+    readonly action: 'setTitle';
+    readonly title?: string;
+}
+export interface ReviewTransitionStateAction {
+    readonly action: 'transitionState';
+    readonly state: StateResourceIdentifier;
+    readonly force?: boolean;
+}

package/dist/typings/models/scalar-types.d.ts

@@ -0,0 +1,4 @@
+export declare type Expansion = string;
+export declare type QueryPredicate = string;
+export declare type Sort = string;
+export declare type OrderSearchSorting = string;

package/dist/typings/models/shipping-method.d.ts

@@ -0,0 +1,160 @@
+import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString, Money, TypedMoney } from './common';
+import { TaxCategoryReference, TaxCategoryResourceIdentifier } from './tax-category';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
+import { ZoneReference, ZoneResourceIdentifier } from './zone';
+export interface PriceFunction {
+    readonly currencyCode: string;
+    readonly function: string;
+}
+export interface ShippingMethod extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly key?: string;
+    readonly name: string;
+    readonly localizedName?: LocalizedString;
+    readonly description?: string;
+    readonly localizedDescription?: LocalizedString;
+    readonly taxCategory: TaxCategoryReference;
+    readonly zoneRates: ZoneRate[];
+    readonly isDefault: boolean;
+    readonly predicate?: string;
+    readonly custom?: CustomFields;
+}
+export interface ShippingMethodDraft {
+    readonly key?: string;
+    readonly name: string;
+    readonly localizedName?: LocalizedString;
+    readonly description?: string;
+    readonly localizedDescription?: LocalizedString;
+    readonly taxCategory: TaxCategoryResourceIdentifier;
+    readonly zoneRates: ZoneRateDraft[];
+    readonly isDefault: boolean;
+    readonly predicate?: string;
+    readonly custom?: CustomFieldsDraft;
+}
+export interface ShippingMethodPagedQueryResponse {
+    readonly limit?: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly offset?: number;
+    readonly results: ShippingMethod[];
+}
+export interface ShippingMethodReference {
+    readonly typeId: 'shipping-method';
+    readonly id: string;
+    readonly obj?: ShippingMethod;
+}
+export interface ShippingMethodResourceIdentifier {
+    readonly typeId: 'shipping-method';
+    readonly id?: string;
+    readonly key?: string;
+}
+export interface ShippingMethodUpdate {
+    readonly version: number;
+    readonly actions: ShippingMethodUpdateAction[];
+}
+export declare type ShippingMethodUpdateAction = ShippingMethodAddShippingRateAction | ShippingMethodAddZoneAction | ShippingMethodChangeIsDefaultAction | ShippingMethodChangeNameAction | ShippingMethodChangeTaxCategoryAction | ShippingMethodRemoveShippingRateAction | ShippingMethodRemoveZoneAction | ShippingMethodSetCustomFieldAction | ShippingMethodSetCustomTypeAction | ShippingMethodSetDescriptionAction | ShippingMethodSetKeyAction | ShippingMethodSetLocalizedDescriptionAction | ShippingMethodSetLocalizedNameAction | ShippingMethodSetPredicateAction;
+export interface ShippingRate {
+    readonly price: TypedMoney;
+    readonly freeAbove?: TypedMoney;
+    readonly isMatching?: boolean;
+    readonly tiers: ShippingRatePriceTier[];
+}
+export interface ShippingRateDraft {
+    readonly price: Money;
+    readonly freeAbove?: Money;
+    readonly tiers?: ShippingRatePriceTier[];
+}
+export declare type ShippingRatePriceTier = CartClassificationTier | CartScoreTier | CartValueTier;
+export interface CartClassificationTier {
+    readonly type: 'CartClassification';
+    readonly value: string;
+    readonly price: Money;
+    readonly isMatching?: boolean;
+}
+export interface CartScoreTier {
+    readonly type: 'CartScore';
+    readonly score: number;
+    readonly price?: Money;
+    readonly priceFunction?: PriceFunction;
+    readonly isMatching?: boolean;
+}
+export interface CartValueTier {
+    readonly type: 'CartValue';
+    readonly minimumCentAmount: number;
+    readonly price: Money;
+    readonly isMatching?: boolean;
+}
+export declare type ShippingRateTierType = 'CartClassification' | 'CartScore' | 'CartValue';
+export interface ZoneRate {
+    readonly zone: ZoneReference;
+    readonly shippingRates: ShippingRate[];
+}
+export interface ZoneRateDraft {
+    readonly zone: ZoneResourceIdentifier;
+    readonly shippingRates: ShippingRateDraft[];
+}
+export interface ShippingMethodAddShippingRateAction {
+    readonly action: 'addShippingRate';
+    readonly zone: ZoneResourceIdentifier;
+    readonly shippingRate: ShippingRateDraft;
+}
+export interface ShippingMethodAddZoneAction {
+    readonly action: 'addZone';
+    readonly zone: ZoneResourceIdentifier;
+}
+export interface ShippingMethodChangeIsDefaultAction {
+    readonly action: 'changeIsDefault';
+    readonly isDefault: boolean;
+}
+export interface ShippingMethodChangeNameAction {
+    readonly action: 'changeName';
+    readonly name: string;
+}
+export interface ShippingMethodChangeTaxCategoryAction {
+    readonly action: 'changeTaxCategory';
+    readonly taxCategory: TaxCategoryResourceIdentifier;
+}
+export interface ShippingMethodRemoveShippingRateAction {
+    readonly action: 'removeShippingRate';
+    readonly zone: ZoneResourceIdentifier;
+    readonly shippingRate: ShippingRateDraft;
+}
+export interface ShippingMethodRemoveZoneAction {
+    readonly action: 'removeZone';
+    readonly zone: ZoneResourceIdentifier;
+}
+export interface ShippingMethodSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    readonly name: string;
+    readonly value?: any;
+}
+export interface ShippingMethodSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface ShippingMethodSetDescriptionAction {
+    readonly action: 'setDescription';
+    readonly description?: string;
+}
+export interface ShippingMethodSetKeyAction {
+    readonly action: 'setKey';
+    readonly key?: string;
+}
+export interface ShippingMethodSetLocalizedDescriptionAction {
+    readonly action: 'setLocalizedDescription';
+    readonly localizedDescription?: LocalizedString;
+}
+export interface ShippingMethodSetLocalizedNameAction {
+    readonly action: 'setLocalizedName';
+    readonly localizedName?: LocalizedString;
+}
+export interface ShippingMethodSetPredicateAction {
+    readonly action: 'setPredicate';
+    readonly predicate?: string;
+}

package/dist/typings/models/shopping-list.d.ts

@@ -0,0 +1,217 @@
+import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString } from './common';
+import { CustomerReference, CustomerResourceIdentifier } from './customer';
+import { ProductVariant } from './product';
+import { ProductTypeReference } from './product-type';
+import { StoreKeyReference, StoreResourceIdentifier } from './store';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
+export interface ShoppingList extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly custom?: CustomFields;
+    readonly customer?: CustomerReference;
+    readonly deleteDaysAfterLastModification?: number;
+    readonly description?: LocalizedString;
+    readonly key?: string;
+    readonly lineItems?: ShoppingListLineItem[];
+    readonly name: LocalizedString;
+    readonly slug?: LocalizedString;
+    readonly textLineItems?: TextLineItem[];
+    readonly anonymousId?: string;
+    readonly store?: StoreKeyReference;
+}
+export interface ShoppingListDraft {
+    readonly custom?: CustomFieldsDraft;
+    readonly customer?: CustomerResourceIdentifier;
+    readonly deleteDaysAfterLastModification?: number;
+    readonly description?: LocalizedString;
+    readonly key?: string;
+    readonly lineItems?: ShoppingListLineItemDraft[];
+    readonly name: LocalizedString;
+    readonly slug?: LocalizedString;
+    readonly textLineItems?: TextLineItemDraft[];
+    readonly anonymousId?: string;
+    readonly store?: StoreResourceIdentifier;
+}
+export interface ShoppingListLineItem {
+    readonly addedAt: string;
+    readonly custom?: CustomFields;
+    readonly deactivatedAt?: string;
+    readonly id: string;
+    readonly name: LocalizedString;
+    readonly productId: string;
+    readonly productSlug?: LocalizedString;
+    readonly productType: ProductTypeReference;
+    readonly quantity: number;
+    readonly variant?: ProductVariant;
+    readonly variantId?: number;
+}
+export interface ShoppingListLineItemDraft {
+    readonly addedAt?: string;
+    readonly custom?: CustomFieldsDraft;
+    readonly sku?: string;
+    readonly productId?: string;
+    readonly quantity?: number;
+    readonly variantId?: number;
+}
+export interface ShoppingListPagedQueryResponse {
+    readonly limit: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly offset: number;
+    readonly results: ShoppingList[];
+}
+export interface ShoppingListReference {
+    readonly typeId: 'shopping-list';
+    readonly id: string;
+    readonly obj?: ShoppingList;
+}
+export interface ShoppingListResourceIdentifier {
+    readonly typeId: 'shopping-list';
+    readonly id?: string;
+    readonly key?: string;
+}
+export interface ShoppingListUpdate {
+    readonly version: number;
+    readonly actions: ShoppingListUpdateAction[];
+}
+export declare type ShoppingListUpdateAction = ShoppingListAddLineItemAction | ShoppingListAddTextLineItemAction | ShoppingListChangeLineItemQuantityAction | ShoppingListChangeLineItemsOrderAction | ShoppingListChangeNameAction | ShoppingListChangeTextLineItemNameAction | ShoppingListChangeTextLineItemQuantityAction | ShoppingListChangeTextLineItemsOrderAction | ShoppingListRemoveLineItemAction | ShoppingListRemoveTextLineItemAction | ShoppingListSetAnonymousIdAction | ShoppingListSetCustomFieldAction | ShoppingListSetCustomTypeAction | ShoppingListSetCustomerAction | ShoppingListSetDeleteDaysAfterLastModificationAction | ShoppingListSetDescriptionAction | ShoppingListSetKeyAction | ShoppingListSetLineItemCustomFieldAction | ShoppingListSetLineItemCustomTypeAction | ShoppingListSetSlugAction | ShoppingListSetStoreAction | ShoppingListSetTextLineItemCustomFieldAction | ShoppingListSetTextLineItemCustomTypeAction | ShoppingListSetTextLineItemDescriptionAction;
+export interface TextLineItem {
+    readonly addedAt: string;
+    readonly custom?: CustomFields;
+    readonly description?: LocalizedString;
+    readonly id: string;
+    readonly name: LocalizedString;
+    readonly quantity: number;
+}
+export interface TextLineItemDraft {
+    readonly addedAt?: string;
+    readonly custom?: CustomFieldsDraft;
+    readonly description?: LocalizedString;
+    readonly name: LocalizedString;
+    readonly quantity?: number;
+}
+export interface ShoppingListAddLineItemAction {
+    readonly action: 'addLineItem';
+    readonly sku?: string;
+    readonly productId?: string;
+    readonly variantId?: number;
+    readonly quantity?: number;
+    readonly addedAt?: string;
+    readonly custom?: CustomFieldsDraft;
+}
+export interface ShoppingListAddTextLineItemAction {
+    readonly action: 'addTextLineItem';
+    readonly name: LocalizedString;
+    readonly description?: LocalizedString;
+    readonly quantity?: number;
+    readonly addedAt?: string;
+    readonly custom?: CustomFieldsDraft;
+}
+export interface ShoppingListChangeLineItemQuantityAction {
+    readonly action: 'changeLineItemQuantity';
+    readonly lineItemId: string;
+    readonly quantity: number;
+}
+export interface ShoppingListChangeLineItemsOrderAction {
+    readonly action: 'changeLineItemsOrder';
+    readonly lineItemOrder: string[];
+}
+export interface ShoppingListChangeNameAction {
+    readonly action: 'changeName';
+    readonly name: LocalizedString;
+}
+export interface ShoppingListChangeTextLineItemNameAction {
+    readonly action: 'changeTextLineItemName';
+    readonly textLineItemId: string;
+    readonly name: LocalizedString;
+}
+export interface ShoppingListChangeTextLineItemQuantityAction {
+    readonly action: 'changeTextLineItemQuantity';
+    readonly textLineItemId: string;
+    readonly quantity: number;
+}
+export interface ShoppingListChangeTextLineItemsOrderAction {
+    readonly action: 'changeTextLineItemsOrder';
+    readonly textLineItemOrder: string[];
+}
+export interface ShoppingListRemoveLineItemAction {
+    readonly action: 'removeLineItem';
+    readonly lineItemId: string;
+    readonly quantity?: number;
+}
+export interface ShoppingListRemoveTextLineItemAction {
+    readonly action: 'removeTextLineItem';
+    readonly textLineItemId: string;
+    readonly quantity?: number;
+}
+export interface ShoppingListSetAnonymousIdAction {
+    readonly action: 'setAnonymousId';
+    readonly anonymousId?: string;
+}
+export interface ShoppingListSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    readonly name: string;
+    readonly value?: any;
+}
+export interface ShoppingListSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface ShoppingListSetCustomerAction {
+    readonly action: 'setCustomer';
+    readonly customer?: CustomerResourceIdentifier;
+}
+export interface ShoppingListSetDeleteDaysAfterLastModificationAction {
+    readonly action: 'setDeleteDaysAfterLastModification';
+    readonly deleteDaysAfterLastModification?: number;
+}
+export interface ShoppingListSetDescriptionAction {
+    readonly action: 'setDescription';
+    readonly description?: LocalizedString;
+}
+export interface ShoppingListSetKeyAction {
+    readonly action: 'setKey';
+    readonly key?: string;
+}
+export interface ShoppingListSetLineItemCustomFieldAction {
+    readonly action: 'setLineItemCustomField';
+    readonly lineItemId: string;
+    readonly name: string;
+    readonly value?: any;
+}
+export interface ShoppingListSetLineItemCustomTypeAction {
+    readonly action: 'setLineItemCustomType';
+    readonly lineItemId: string;
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface ShoppingListSetSlugAction {
+    readonly action: 'setSlug';
+    readonly slug?: LocalizedString;
+}
+export interface ShoppingListSetStoreAction {
+    readonly action: 'setStore';
+    readonly store?: StoreResourceIdentifier;
+}
+export interface ShoppingListSetTextLineItemCustomFieldAction {
+    readonly action: 'setTextLineItemCustomField';
+    readonly textLineItemId: string;
+    readonly name: string;
+    readonly value?: any;
+}
+export interface ShoppingListSetTextLineItemCustomTypeAction {
+    readonly action: 'setTextLineItemCustomType';
+    readonly textLineItemId: string;
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface ShoppingListSetTextLineItemDescriptionAction {
+    readonly action: 'setTextLineItemDescription';
+    readonly textLineItemId: string;
+    readonly description?: LocalizedString;
+}

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

@@ -0,0 +1,86 @@
+import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString } from './common';
+export interface State extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly key: string;
+    readonly type: StateTypeEnum;
+    readonly name?: LocalizedString;
+    readonly description?: LocalizedString;
+    readonly initial: boolean;
+    readonly builtIn: boolean;
+    readonly roles?: StateRoleEnum[];
+    readonly transitions?: StateReference[];
+}
+export interface StateDraft {
+    readonly key: string;
+    readonly type: StateTypeEnum;
+    readonly name?: LocalizedString;
+    readonly description?: LocalizedString;
+    readonly initial?: boolean;
+    readonly roles?: StateRoleEnum[];
+    readonly transitions?: StateResourceIdentifier[];
+}
+export interface StatePagedQueryResponse {
+    readonly limit: number;
+    readonly offset: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly results: State[];
+}
+export interface StateReference {
+    readonly typeId: 'state';
+    readonly id: string;
+    readonly obj?: State;
+}
+export interface StateResourceIdentifier {
+    readonly typeId: 'state';
+    readonly id?: string;
+    readonly key?: string;
+}
+export declare type StateRoleEnum = 'Return' | 'ReviewIncludedInStatistics';
+export declare type StateTypeEnum = 'LineItemState' | 'OrderState' | 'PaymentState' | 'ProductState' | 'ReviewState';
+export interface StateUpdate {
+    readonly version: number;
+    readonly actions: StateUpdateAction[];
+}
+export declare type StateUpdateAction = StateAddRolesAction | StateChangeInitialAction | StateChangeKeyAction | StateChangeTypeAction | StateRemoveRolesAction | StateSetDescriptionAction | StateSetNameAction | StateSetRolesAction | StateSetTransitionsAction;
+export interface StateAddRolesAction {
+    readonly action: 'addRoles';
+    readonly roles: StateRoleEnum[];
+}
+export interface StateChangeInitialAction {
+    readonly action: 'changeInitial';
+    readonly initial: boolean;
+}
+export interface StateChangeKeyAction {
+    readonly action: 'changeKey';
+    readonly key: string;
+}
+export interface StateChangeTypeAction {
+    readonly action: 'changeType';
+    readonly type: StateTypeEnum;
+}
+export interface StateRemoveRolesAction {
+    readonly action: 'removeRoles';
+    readonly roles: StateRoleEnum[];
+}
+export interface StateSetDescriptionAction {
+    readonly action: 'setDescription';
+    readonly description: LocalizedString;
+}
+export interface StateSetNameAction {
+    readonly action: 'setName';
+    readonly name: LocalizedString;
+}
+export interface StateSetRolesAction {
+    readonly action: 'setRoles';
+    readonly roles: StateRoleEnum[];
+}
+export interface StateSetTransitionsAction {
+    readonly action: 'setTransitions';
+    readonly transitions?: StateResourceIdentifier[];
+}