@gradientedge/commercetools-utils 5.3.0 → 5.4.0

package/dist/typings/models/associate-role.d.ts

@@ -0,0 +1,79 @@
+import { BaseResource, CreatedBy, LastModifiedBy } from './common';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
+export interface AssociateRole extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly key: string;
+    readonly buyerAssignable: boolean;
+    readonly name?: string;
+    readonly permissions: Permission[];
+    readonly custom?: CustomFields;
+}
+export interface AssociateRoleDraft {
+    readonly key: string;
+    readonly name?: string;
+    readonly buyerAssignable?: boolean;
+    readonly permissions?: Permission[];
+    readonly custom?: CustomFieldsDraft;
+}
+export interface AssociateRoleKeyReference {
+    readonly typeId: 'associate-role';
+    readonly key: string;
+}
+export interface AssociateRolePagedQueryResponse {
+    readonly limit: number;
+    readonly offset: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly results: AssociateRole[];
+}
+export interface AssociateRoleReference {
+    readonly typeId: 'associate-role';
+    readonly id: string;
+    readonly obj?: AssociateRole;
+}
+export interface AssociateRoleResourceIdentifier {
+    readonly typeId: 'associate-role';
+    readonly id?: string;
+    readonly key?: string;
+}
+export interface AssociateRoleUpdate {
+    readonly version: number;
+    readonly actions: AssociateRoleUpdateAction[];
+}
+export type AssociateRoleUpdateAction = AssociateRoleAddPermissionAction | AssociateRoleChangeBuyerAssignableAction | AssociateRoleRemovePermissionAction | AssociateRoleSetCustomFieldAction | AssociateRoleSetCustomTypeAction | AssociateRoleSetNameAction | AssociateRoleSetPermissionsAction;
+export type Permission = 'AcceptMyQuotes' | 'AcceptOthersQuotes' | 'AddChildUnits' | 'CreateMyCarts' | 'CreateMyOrdersFromMyCarts' | 'CreateMyOrdersFromMyQuotes' | 'CreateMyQuoteRequestsFromMyCarts' | 'CreateOrdersFromOthersCarts' | 'CreateOrdersFromOthersQuotes' | 'CreateOthersCarts' | 'CreateQuoteRequestsFromOthersCarts' | 'DeclineMyQuotes' | 'DeclineOthersQuotes' | 'DeleteMyCarts' | 'DeleteOthersCarts' | 'RenegotiateMyQuotes' | 'RenegotiateOthersQuotes' | 'UpdateAssociates' | 'UpdateBusinessUnitDetails' | 'UpdateMyCarts' | 'UpdateMyOrders' | 'UpdateMyQuoteRequests' | 'UpdateOthersCarts' | 'UpdateOthersOrders' | 'UpdateOthersQuoteRequests' | 'UpdateParentUnit' | 'ViewMyCarts' | 'ViewMyOrders' | 'ViewMyQuoteRequests' | 'ViewMyQuotes' | 'ViewOthersCarts' | 'ViewOthersOrders' | 'ViewOthersQuoteRequests' | 'ViewOthersQuotes' | string;
+export interface AssociateRoleAddPermissionAction {
+    readonly action: 'addPermission';
+    readonly permission: Permission;
+}
+export interface AssociateRoleChangeBuyerAssignableAction {
+    readonly action: 'changeBuyerAssignable';
+    readonly buyerAssignable: boolean;
+}
+export interface AssociateRoleRemovePermissionAction {
+    readonly action: 'removePermission';
+    readonly permission: Permission;
+}
+export interface AssociateRoleSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    readonly name: string;
+    readonly value?: any;
+}
+export interface AssociateRoleSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface AssociateRoleSetNameAction {
+    readonly action: 'setName';
+    readonly name?: string;
+}
+export interface AssociateRoleSetPermissionsAction {
+    readonly action: 'setPermissions';
+    readonly permissions?: Permission[];
+}

package/dist/typings/models/attribute-group.d.ts

@@ -0,0 +1,68 @@
+import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString } from './common';
+export interface AttributeGroup extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly name: LocalizedString;
+    readonly description?: LocalizedString;
+    readonly attributes: AttributeReference[];
+    readonly key?: string;
+}
+export interface AttributeGroupDraft {
+    readonly name: LocalizedString;
+    readonly description?: LocalizedString;
+    readonly attributes: AttributeReference[];
+    readonly key?: string;
+}
+export interface AttributeGroupPagedQueryResponse {
+    readonly limit: number;
+    readonly offset: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly results: AttributeGroup[];
+}
+export interface AttributeGroupReference {
+    readonly typeId: 'attribute-group';
+    readonly id: string;
+    readonly obj?: AttributeGroup;
+}
+export interface AttributeGroupResourceIdentifier {
+    readonly typeId: 'attribute-group';
+    readonly id?: string;
+    readonly key?: string;
+}
+export interface AttributeGroupUpdate {
+    readonly version: number;
+    readonly actions: AttributeGroupUpdateAction[];
+}
+export type AttributeGroupUpdateAction = AttributeGroupAddAttributeAction | AttributeGroupChangeNameAction | AttributeGroupRemoveAttributeAction | AttributeGroupSetAttributesAction | AttributeGroupSetDescriptionAction | AttributeGroupSetKeyAction;
+export interface AttributeReference {
+    readonly key: string;
+}
+export interface AttributeGroupAddAttributeAction {
+    readonly action: 'addAttribute';
+    readonly attribute: AttributeReference;
+}
+export interface AttributeGroupChangeNameAction {
+    readonly action: 'changeName';
+    readonly name: LocalizedString;
+}
+export interface AttributeGroupRemoveAttributeAction {
+    readonly action: 'removeAttribute';
+    readonly attribute: AttributeReference;
+}
+export interface AttributeGroupSetAttributesAction {
+    readonly action: 'setAttributes';
+    readonly attributes: AttributeReference[];
+}
+export interface AttributeGroupSetDescriptionAction {
+    readonly action: 'setDescription';
+    readonly description?: LocalizedString;
+}
+export interface AttributeGroupSetKeyAction {
+    readonly action: 'setKey';
+    readonly key?: string;
+}

package/dist/typings/models/business-unit.d.ts

@@ -0,0 +1,272 @@
+import { AssociateRoleKeyReference, AssociateRoleResourceIdentifier } from './associate-role';
+import { Address, BaseAddress, CreatedBy, LastModifiedBy, _BaseAddress } from './common';
+import { CustomerReference, CustomerResourceIdentifier } from './customer';
+import { StoreKeyReference, StoreResourceIdentifier } from './store';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
+export interface Associate {
+    readonly associateRoleAssignments: AssociateRoleAssignment[];
+    readonly roles: AssociateRoleDeprecated[];
+    readonly customer: CustomerReference;
+}
+export interface AssociateDraft {
+    readonly associateRoleAssignments?: AssociateRoleAssignmentDraft[];
+    readonly roles?: AssociateRoleDeprecated[];
+    readonly customer: CustomerResourceIdentifier;
+}
+export interface AssociateRoleAssignment {
+    readonly associateRole: AssociateRoleKeyReference;
+    readonly inheritance: AssociateRoleInheritanceMode;
+}
+export interface AssociateRoleAssignmentDraft {
+    readonly associateRole: AssociateRoleResourceIdentifier;
+    readonly inheritance?: AssociateRoleInheritanceMode;
+}
+export type AssociateRoleDeprecated = 'Admin' | 'Buyer' | string;
+export type AssociateRoleInheritanceMode = 'Disabled' | 'Enabled' | string;
+export type BusinessUnit = Company | Division;
+export type BusinessUnitAssociateMode = 'Explicit' | 'ExplicitAndFromParent' | string;
+export type BusinessUnitDraft = CompanyDraft | DivisionDraft;
+export interface BusinessUnitKeyReference {
+    readonly typeId: 'business-unit';
+    readonly key: string;
+}
+export interface BusinessUnitPagedQueryResponse {
+    readonly limit: number;
+    readonly offset: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly results: BusinessUnit[];
+}
+export interface BusinessUnitReference {
+    readonly typeId: 'business-unit';
+    readonly id: string;
+    readonly obj?: BusinessUnit;
+}
+export interface BusinessUnitResourceIdentifier {
+    readonly typeId: 'business-unit';
+    readonly id?: string;
+    readonly key?: string;
+}
+export type BusinessUnitStatus = 'Active' | 'Inactive' | string;
+export type BusinessUnitStoreMode = 'Explicit' | 'FromParent' | string;
+export type BusinessUnitType = 'Company' | 'Division' | string;
+export interface BusinessUnitUpdate {
+    readonly version: number;
+    readonly actions: BusinessUnitUpdateAction[];
+}
+export type BusinessUnitUpdateAction = BusinessUnitAddAddressAction | BusinessUnitAddAssociateAction | BusinessUnitAddBillingAddressIdAction | BusinessUnitAddShippingAddressIdAction | BusinessUnitAddStoreAction | BusinessUnitChangeAddressAction | BusinessUnitChangeAssociateAction | BusinessUnitChangeAssociateModeAction | BusinessUnitChangeNameAction | BusinessUnitChangeParentUnitAction | BusinessUnitChangeStatusAction | BusinessUnitRemoveAddressAction | BusinessUnitRemoveAssociateAction | BusinessUnitRemoveBillingAddressIdAction | BusinessUnitRemoveShippingAddressIdAction | BusinessUnitRemoveStoreAction | BusinessUnitSetAddressCustomFieldAction | BusinessUnitSetAddressCustomTypeAction | BusinessUnitSetAssociatesAction | BusinessUnitSetContactEmailAction | BusinessUnitSetCustomFieldAction | BusinessUnitSetCustomTypeAction | BusinessUnitSetDefaultBillingAddressAction | BusinessUnitSetDefaultShippingAddressAction | BusinessUnitSetStoreModeAction | BusinessUnitSetStoresAction;
+export interface Company {
+    readonly unitType: 'Company';
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly key: string;
+    readonly status: BusinessUnitStatus;
+    readonly stores?: StoreKeyReference[];
+    readonly storeMode: BusinessUnitStoreMode;
+    readonly name: string;
+    readonly contactEmail?: string;
+    readonly custom?: CustomFields;
+    readonly addresses: Address[];
+    readonly shippingAddressIds?: string[];
+    readonly defaultShippingAddressId?: string;
+    readonly billingAddressIds?: string[];
+    readonly defaultBillingAddressId?: string;
+    readonly associateMode: BusinessUnitAssociateMode;
+    readonly associates: Associate[];
+    readonly inheritedAssociates?: InheritedAssociate[];
+    readonly parentUnit?: BusinessUnitKeyReference;
+    readonly topLevelUnit: BusinessUnitKeyReference;
+}
+export interface CompanyDraft {
+    readonly unitType: 'Company';
+    readonly key: string;
+    readonly status?: BusinessUnitStatus;
+    readonly stores?: StoreResourceIdentifier[];
+    readonly storeMode?: BusinessUnitStoreMode;
+    readonly name: string;
+    readonly contactEmail?: string;
+    readonly associateMode?: BusinessUnitAssociateMode;
+    readonly associates?: AssociateDraft[];
+    readonly addresses?: BaseAddress[];
+    readonly shippingAddresses?: number[];
+    readonly defaultShippingAddress?: number;
+    readonly billingAddresses?: number[];
+    readonly defaultBillingAddress?: number;
+    readonly custom?: CustomFieldsDraft;
+}
+export interface Division {
+    readonly unitType: 'Division';
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly key: string;
+    readonly status: BusinessUnitStatus;
+    readonly stores?: StoreKeyReference[];
+    readonly storeMode: BusinessUnitStoreMode;
+    readonly name: string;
+    readonly contactEmail?: string;
+    readonly custom?: CustomFields;
+    readonly addresses: Address[];
+    readonly shippingAddressIds?: string[];
+    readonly defaultShippingAddressId?: string;
+    readonly billingAddressIds?: string[];
+    readonly defaultBillingAddressId?: string;
+    readonly associateMode: BusinessUnitAssociateMode;
+    readonly associates: Associate[];
+    readonly inheritedAssociates?: InheritedAssociate[];
+    readonly parentUnit: BusinessUnitKeyReference;
+    readonly topLevelUnit: BusinessUnitKeyReference;
+}
+export interface DivisionDraft {
+    readonly unitType: 'Division';
+    readonly key: string;
+    readonly status?: BusinessUnitStatus;
+    readonly stores?: StoreResourceIdentifier[];
+    readonly storeMode?: BusinessUnitStoreMode;
+    readonly name: string;
+    readonly contactEmail?: string;
+    readonly associateMode?: BusinessUnitAssociateMode;
+    readonly associates?: AssociateDraft[];
+    readonly addresses?: BaseAddress[];
+    readonly shippingAddresses?: number[];
+    readonly defaultShippingAddress?: number;
+    readonly billingAddresses?: number[];
+    readonly defaultBillingAddress?: number;
+    readonly custom?: CustomFieldsDraft;
+    readonly parentUnit: BusinessUnitResourceIdentifier;
+}
+export interface InheritedAssociate {
+    readonly associateRoleAssignments: InheritedAssociateRoleAssignment[];
+    readonly customer: CustomerReference;
+}
+export interface InheritedAssociateRoleAssignment {
+    readonly associateRole: AssociateRoleKeyReference;
+    readonly source: BusinessUnitKeyReference;
+}
+export interface BusinessUnitAddAddressAction {
+    readonly action: 'addAddress';
+    readonly address: _BaseAddress;
+}
+export interface BusinessUnitAddAssociateAction {
+    readonly action: 'addAssociate';
+    readonly associate: AssociateDraft;
+}
+export interface BusinessUnitAddBillingAddressIdAction {
+    readonly action: 'addBillingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface BusinessUnitAddShippingAddressIdAction {
+    readonly action: 'addShippingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface BusinessUnitAddStoreAction {
+    readonly action: 'addStore';
+    readonly store: StoreResourceIdentifier;
+}
+export interface BusinessUnitChangeAddressAction {
+    readonly action: 'changeAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+    readonly address: _BaseAddress;
+}
+export interface BusinessUnitChangeAssociateAction {
+    readonly action: 'changeAssociate';
+    readonly associate: AssociateDraft;
+}
+export interface BusinessUnitChangeAssociateModeAction {
+    readonly action: 'changeAssociateMode';
+    readonly associateMode: BusinessUnitAssociateMode;
+}
+export interface BusinessUnitChangeNameAction {
+    readonly action: 'changeName';
+    readonly name: string;
+}
+export interface BusinessUnitChangeParentUnitAction {
+    readonly action: 'changeParentUnit';
+    readonly parentUnit: BusinessUnitResourceIdentifier;
+}
+export interface BusinessUnitChangeStatusAction {
+    readonly action: 'changeStatus';
+    readonly status: string;
+}
+export interface BusinessUnitRemoveAddressAction {
+    readonly action: 'removeAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface BusinessUnitRemoveAssociateAction {
+    readonly action: 'removeAssociate';
+    readonly customer: CustomerResourceIdentifier;
+}
+export interface BusinessUnitRemoveBillingAddressIdAction {
+    readonly action: 'removeBillingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface BusinessUnitRemoveShippingAddressIdAction {
+    readonly action: 'removeShippingAddressId';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface BusinessUnitRemoveStoreAction {
+    readonly action: 'removeStore';
+    readonly store: StoreResourceIdentifier;
+}
+export interface BusinessUnitSetAddressCustomFieldAction {
+    readonly action: 'setAddressCustomField';
+    readonly addressId: string;
+    readonly name: string;
+    readonly value?: any;
+}
+export interface BusinessUnitSetAddressCustomTypeAction {
+    readonly action: 'setAddressCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+    readonly addressId: string;
+}
+export interface BusinessUnitSetAssociatesAction {
+    readonly action: 'setAssociates';
+    readonly associates: AssociateDraft[];
+}
+export interface BusinessUnitSetContactEmailAction {
+    readonly action: 'setContactEmail';
+    readonly contactEmail?: string;
+}
+export interface BusinessUnitSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    readonly name: string;
+    readonly value?: any;
+}
+export interface BusinessUnitSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface BusinessUnitSetDefaultBillingAddressAction {
+    readonly action: 'setDefaultBillingAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface BusinessUnitSetDefaultShippingAddressAction {
+    readonly action: 'setDefaultShippingAddress';
+    readonly addressId?: string;
+    readonly addressKey?: string;
+}
+export interface BusinessUnitSetStoreModeAction {
+    readonly action: 'setStoreMode';
+    readonly storeMode: BusinessUnitStoreMode;
+    readonly stores?: StoreResourceIdentifier[];
+}
+export interface BusinessUnitSetStoresAction {
+    readonly action: 'setStores';
+    readonly stores?: StoreResourceIdentifier[];
+}

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

@@ -129,8 +129,8 @@ export interface MultiBuyLineItemsTarget {
     readonly maxOccurrence?: number;
     readonly selectionMode: SelectionMode;
 }
-export type SelectionMode = 'Cheapest' | 'MostExpensive';
-export type StackingMode = 'Stacking' | 'StopAfterThisDiscount';
+export type SelectionMode = 'Cheapest' | 'MostExpensive' | string;
+export type StackingMode = 'Stacking' | 'StopAfterThisDiscount' | string;
 export interface CartDiscountChangeCartPredicateAction {
     readonly action: 'changeCartPredicate';
     readonly cartPredicate: string;