@gradientedge/commercetools-utils 4.11.2 → 4.12.1

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

@@ -0,0 +1,412 @@
+import { ChannelReference, ChannelResourceIdentifier, ChannelRoleEnum } from './channel';
+import { LocalizedString, Price, PriceDraft, Reference, ReferenceTypeId } from './common';
+import { CustomerGroupReference } from './customer-group';
+import { OrderEditPreviewFailure } from './order-edit';
+import { Attribute } from './product';
+export interface ErrorByExtension {
+    readonly id: string;
+    readonly key?: string;
+}
+export declare type ErrorObject = AccessDeniedError | AnonymousIdAlreadyInUseError | AttributeDefinitionAlreadyExistsError | AttributeDefinitionTypeConflictError | AttributeNameDoesNotExistError | BadGatewayError | ConcurrentModificationError | DiscountCodeNonApplicableError | DuplicateAttributeValueError | DuplicateAttributeValuesError | DuplicateEnumValuesError | DuplicateFieldError | DuplicateFieldWithConflictingResourceError | DuplicatePriceScopeError | DuplicateVariantValuesError | EditPreviewFailedError | EnumKeyAlreadyExistsError | EnumKeyDoesNotExistError | EnumValueIsUsedError | EnumValuesMustMatchError | ExtensionBadResponseError | ExtensionNoResponseError | ExtensionUpdateActionsFailedError | ExternalOAuthFailedError | FeatureRemovedError | GeneralError | InsufficientScopeError | InternalConstraintViolatedError | InvalidCredentialsError | InvalidCurrentPasswordError | InvalidFieldError | InvalidInputError | InvalidItemShippingDetailsError | InvalidJsonInputError | InvalidOperationError | InvalidSubjectError | InvalidTokenError | LanguageUsedInStoresError | MatchingPriceNotFoundError | MaxResourceLimitExceededError | MissingRoleOnChannelError | MissingTaxRateForCountryError | NoMatchingProductDiscountFoundError | NotEnabledError | ObjectNotFoundError | OutOfStockError | OverCapacityError | PendingOperationError | PriceChangedError | ProjectNotConfiguredForLanguagesError | QueryComplexityLimitExceededError | QueryTimedOutError | ReferenceExistsError | ReferencedResourceNotFoundError | RequiredFieldError | ResourceNotFoundError | ResourceSizeLimitExceededError | SearchDeactivatedError | SearchExecutionFailureError | SearchFacetPathNotFoundError | SearchIndexingInProgressError | SemanticErrorError | ShippingMethodDoesNotMatchCartError | SyntaxErrorError | WeakPasswordError;
+export interface AccessDeniedError {
+    readonly code: 'access_denied';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface AnonymousIdAlreadyInUseError {
+    readonly code: 'AnonymousIdAlreadyInUse';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface AttributeDefinitionAlreadyExistsError {
+    readonly code: 'AttributeDefinitionAlreadyExists';
+    [key: string]: any;
+    readonly message: string;
+    readonly conflictingProductTypeId: string;
+    readonly conflictingProductTypeName: string;
+    readonly conflictingAttributeName: string;
+}
+export interface AttributeDefinitionTypeConflictError {
+    readonly code: 'AttributeDefinitionTypeConflict';
+    [key: string]: any;
+    readonly message: string;
+    readonly conflictingProductTypeId: string;
+    readonly conflictingProductTypeName: string;
+    readonly conflictingAttributeName: string;
+}
+export interface AttributeNameDoesNotExistError {
+    readonly code: 'AttributeNameDoesNotExist';
+    [key: string]: any;
+    readonly message: string;
+    readonly invalidAttributeName: string;
+}
+export interface BadGatewayError {
+    readonly code: 'BadGateway';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface ConcurrentModificationError {
+    readonly code: 'ConcurrentModification';
+    [key: string]: any;
+    readonly message: string;
+    readonly currentVersion?: number;
+}
+export interface DiscountCodeNonApplicableError {
+    readonly code: 'DiscountCodeNonApplicable';
+    [key: string]: any;
+    readonly message: string;
+    readonly discountCode?: string;
+    readonly reason?: string;
+    readonly dicountCodeId?: string;
+    readonly validFrom?: string;
+    readonly validUntil?: string;
+    readonly validityCheckTime?: string;
+}
+export interface DuplicateAttributeValueError {
+    readonly code: 'DuplicateAttributeValue';
+    [key: string]: any;
+    readonly message: string;
+    readonly attribute: Attribute;
+}
+export interface DuplicateAttributeValuesError {
+    readonly code: 'DuplicateAttributeValues';
+    [key: string]: any;
+    readonly message: string;
+    readonly attributes: Attribute[];
+}
+export interface DuplicateEnumValuesError {
+    readonly code: 'DuplicateEnumValues';
+    [key: string]: any;
+    readonly message: string;
+    readonly duplicates: string[];
+}
+export interface DuplicateFieldError {
+    readonly code: 'DuplicateField';
+    [key: string]: any;
+    readonly message: string;
+    readonly field?: string;
+    readonly duplicateValue?: any;
+    readonly conflictingResource?: Reference;
+}
+export interface DuplicateFieldWithConflictingResourceError {
+    readonly code: 'DuplicateFieldWithConflictingResource';
+    [key: string]: any;
+    readonly message: string;
+    readonly field: string;
+    readonly duplicateValue: any;
+    readonly conflictingResource: Reference;
+}
+export interface DuplicatePriceScopeError {
+    readonly code: 'DuplicatePriceScope';
+    [key: string]: any;
+    readonly message: string;
+    readonly conflictingPrices: Price[];
+}
+export interface DuplicateVariantValuesError {
+    readonly code: 'DuplicateVariantValues';
+    [key: string]: any;
+    readonly message: string;
+    readonly variantValues: VariantValues;
+}
+export interface EditPreviewFailedError {
+    readonly code: 'EditPreviewFailed';
+    [key: string]: any;
+    readonly message: string;
+    readonly result: OrderEditPreviewFailure;
+}
+export interface EnumKeyAlreadyExistsError {
+    readonly code: 'EnumKeyAlreadyExists';
+    [key: string]: any;
+    readonly message: string;
+    readonly conflictingEnumKey: string;
+    readonly conflictingAttributeName: string;
+}
+export interface EnumKeyDoesNotExistError {
+    readonly code: 'EnumKeyDoesNotExist';
+    [key: string]: any;
+    readonly message: string;
+    readonly conflictingEnumKey: string;
+    readonly conflictingAttributeName: string;
+}
+export interface EnumValueIsUsedError {
+    readonly code: 'EnumValueIsUsed';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface EnumValuesMustMatchError {
+    readonly code: 'EnumValuesMustMatch';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface ErrorResponse {
+    readonly statusCode: number;
+    readonly message: string;
+    readonly error?: string;
+    readonly error_description?: string;
+    readonly errors?: ErrorObject[];
+}
+export interface ExtensionBadResponseError {
+    readonly code: 'ExtensionBadResponse';
+    [key: string]: any;
+    readonly message: string;
+    readonly localizedMessage?: LocalizedString;
+    readonly extensionExtraInfo?: any;
+    readonly errorByExtension: ErrorByExtension;
+}
+export interface ExtensionNoResponseError {
+    readonly code: 'ExtensionNoResponse';
+    [key: string]: any;
+    readonly message: string;
+    readonly extensionId: string;
+    readonly extensionKey?: string;
+}
+export interface ExtensionUpdateActionsFailedError {
+    readonly code: 'ExtensionUpdateActionsFailed';
+    [key: string]: any;
+    readonly message: string;
+    readonly localizedMessage?: LocalizedString;
+    readonly extensionExtraInfo?: any;
+    readonly errorByExtension: ErrorByExtension;
+}
+export interface ExternalOAuthFailedError {
+    readonly code: 'ExternalOAuthFailed';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface FeatureRemovedError {
+    readonly code: 'FeatureRemoved';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface GeneralError {
+    readonly code: 'General';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InsufficientScopeError {
+    readonly code: 'insufficient_scope';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InternalConstraintViolatedError {
+    readonly code: 'InternalConstraintViolated';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InvalidCredentialsError {
+    readonly code: 'InvalidCredentials';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InvalidCurrentPasswordError {
+    readonly code: 'InvalidCurrentPassword';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InvalidFieldError {
+    readonly code: 'InvalidField';
+    [key: string]: any;
+    readonly message: string;
+    readonly field: string;
+    readonly invalidValue: any;
+    readonly allowedValues?: any[];
+}
+export interface InvalidInputError {
+    readonly code: 'InvalidInput';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InvalidItemShippingDetailsError {
+    readonly code: 'InvalidItemShippingDetails';
+    [key: string]: any;
+    readonly message: string;
+    readonly subject: string;
+    readonly itemId: string;
+}
+export interface InvalidJsonInputError {
+    readonly code: 'InvalidJsonInput';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InvalidOperationError {
+    readonly code: 'InvalidOperation';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InvalidSubjectError {
+    readonly code: 'InvalidSubject';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface InvalidTokenError {
+    readonly code: 'invalid_token';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface LanguageUsedInStoresError {
+    readonly code: 'LanguageUsedInStores';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface MatchingPriceNotFoundError {
+    readonly code: 'MatchingPriceNotFound';
+    [key: string]: any;
+    readonly message: string;
+    readonly productId: string;
+    readonly variantId: number;
+    readonly currency?: string;
+    readonly country?: string;
+    readonly customerGroup?: CustomerGroupReference;
+    readonly channel?: ChannelReference;
+}
+export interface MaxResourceLimitExceededError {
+    readonly code: 'MaxResourceLimitExceeded';
+    [key: string]: any;
+    readonly message: string;
+    readonly exceededResource: ReferenceTypeId;
+}
+export interface MissingRoleOnChannelError {
+    readonly code: 'MissingRoleOnChannel';
+    [key: string]: any;
+    readonly message: string;
+    readonly channel?: ChannelResourceIdentifier;
+    readonly missingRole: ChannelRoleEnum;
+}
+export interface MissingTaxRateForCountryError {
+    readonly code: 'MissingTaxRateForCountry';
+    [key: string]: any;
+    readonly message: string;
+    readonly taxCategoryId: string;
+    readonly country?: string;
+    readonly state?: string;
+}
+export interface NoMatchingProductDiscountFoundError {
+    readonly code: 'NoMatchingProductDiscountFound';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface NotEnabledError {
+    readonly code: 'NotEnabled';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface ObjectNotFoundError {
+    readonly code: 'ObjectNotFound';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface OutOfStockError {
+    readonly code: 'OutOfStock';
+    [key: string]: any;
+    readonly message: string;
+    readonly lineItems: string[];
+    readonly skus: string[];
+}
+export interface OverCapacityError {
+    readonly code: 'OverCapacity';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface PendingOperationError {
+    readonly code: 'PendingOperation';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface PriceChangedError {
+    readonly code: 'PriceChanged';
+    [key: string]: any;
+    readonly message: string;
+    readonly lineItems: string[];
+    readonly shipping: boolean;
+}
+export interface ProjectNotConfiguredForLanguagesError {
+    readonly code: 'ProjectNotConfiguredForLanguages';
+    [key: string]: any;
+    readonly message: string;
+    readonly languages?: string[];
+}
+export interface QueryComplexityLimitExceededError {
+    readonly code: 'QueryComplexityLimitExceeded';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface QueryTimedOutError {
+    readonly code: 'QueryTimedOut';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface ReferenceExistsError {
+    readonly code: 'ReferenceExists';
+    [key: string]: any;
+    readonly message: string;
+    readonly referencedBy?: ReferenceTypeId;
+}
+export interface ReferencedResourceNotFoundError {
+    readonly code: 'ReferencedResourceNotFound';
+    [key: string]: any;
+    readonly message: string;
+    readonly typeId: ReferenceTypeId;
+    readonly id?: string;
+    readonly key?: string;
+}
+export interface RequiredFieldError {
+    readonly code: 'RequiredField';
+    [key: string]: any;
+    readonly message: string;
+    readonly field: string;
+}
+export interface ResourceNotFoundError {
+    readonly code: 'ResourceNotFound';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface ResourceSizeLimitExceededError {
+    readonly code: 'ResourceSizeLimitExceeded';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface SearchDeactivatedError {
+    readonly code: 'SearchDeactivated';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface SearchExecutionFailureError {
+    readonly code: 'SearchExecutionFailure';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface SearchFacetPathNotFoundError {
+    readonly code: 'SearchFacetPathNotFound';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface SearchIndexingInProgressError {
+    readonly code: 'SearchIndexingInProgress';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface SemanticErrorError {
+    readonly code: 'SemanticError';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface ShippingMethodDoesNotMatchCartError {
+    readonly code: 'ShippingMethodDoesNotMatchCart';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface SyntaxErrorError {
+    readonly code: 'SyntaxError';
+    [key: string]: any;
+    readonly message: string;
+}
+export interface VariantValues {
+    readonly sku?: string;
+    readonly prices: PriceDraft[];
+    readonly attributes: Attribute[];
+}
+export interface WeakPasswordError {
+    readonly code: 'WeakPassword';
+    [key: string]: any;
+    readonly message: string;
+}

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

@@ -0,0 +1,78 @@
+import { BaseResource, CreatedBy, LastModifiedBy, Reference } from './common';
+export interface Extension extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly key?: string;
+    readonly destination: ExtensionDestination;
+    readonly triggers: ExtensionTrigger[];
+    readonly timeoutInMs?: number;
+}
+export declare type ExtensionAction = 'Create' | 'Update';
+export declare type ExtensionDestination = AWSLambdaDestination | HttpDestination;
+export interface AWSLambdaDestination {
+    readonly type: 'AWSLambda';
+    readonly arn: string;
+    readonly accessKey: string;
+    readonly accessSecret: string;
+}
+export interface ExtensionDraft {
+    readonly key?: string;
+    readonly destination: ExtensionDestination;
+    readonly triggers: ExtensionTrigger[];
+    readonly timeoutInMs?: number;
+}
+export interface ExtensionInput {
+    readonly action: ExtensionAction;
+    readonly resource: Reference;
+}
+export interface ExtensionPagedQueryResponse {
+    readonly limit: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly offset: number;
+    readonly results: Extension[];
+}
+export declare type ExtensionResourceTypeId = 'cart' | 'customer' | 'order' | 'payment';
+export interface ExtensionTrigger {
+    readonly resourceTypeId: ExtensionResourceTypeId;
+    readonly actions: ExtensionAction[];
+}
+export interface ExtensionUpdate {
+    readonly version: number;
+    readonly actions: ExtensionUpdateAction[];
+}
+export declare type ExtensionUpdateAction = ExtensionChangeDestinationAction | ExtensionChangeTriggersAction | ExtensionSetKeyAction | ExtensionSetTimeoutInMsAction;
+export interface HttpDestination {
+    readonly type: 'HTTP';
+    readonly url: string;
+    readonly authentication?: HttpDestinationAuthentication;
+}
+export declare type HttpDestinationAuthentication = AuthorizationHeaderAuthentication | AzureFunctionsAuthentication;
+export interface AuthorizationHeaderAuthentication {
+    readonly type: 'AuthorizationHeader';
+    readonly headerValue: string;
+}
+export interface AzureFunctionsAuthentication {
+    readonly type: 'AzureFunctions';
+    readonly key: string;
+}
+export interface ExtensionChangeDestinationAction {
+    readonly action: 'changeDestination';
+    readonly destination: ExtensionDestination;
+}
+export interface ExtensionChangeTriggersAction {
+    readonly action: 'changeTriggers';
+    readonly triggers: ExtensionTrigger[];
+}
+export interface ExtensionSetKeyAction {
+    readonly action: 'setKey';
+    readonly key?: string;
+}
+export interface ExtensionSetTimeoutInMsAction {
+    readonly action: 'setTimeoutInMs';
+    readonly timeoutInMs?: number;
+}

package/dist/typings/models/graph-ql.d.ts

@@ -0,0 +1,21 @@
+export interface GraphQLError {
+    readonly message: string;
+    readonly locations: GraphQLErrorLocation[];
+    readonly path: any[];
+}
+export interface GraphQLErrorLocation {
+    readonly line: number;
+    readonly column: number;
+}
+export interface GraphQLRequest {
+    readonly query: string;
+    readonly operationName?: string;
+    readonly variables?: GraphQLVariablesMap;
+}
+export interface GraphQLResponse {
+    readonly data?: any;
+    readonly errors?: GraphQLError[];
+}
+export interface GraphQLVariablesMap {
+    [key: string]: any;
+}

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

@@ -0,0 +1,33 @@
+export * from './cart';
+export * from './cart-discount';
+export * from './category';
+export * from './channel';
+export * from './common';
+export * from './custom-object';
+export * from './customer';
+export * from './customer-group';
+export * from './discount-code';
+export * from './error';
+export * from './extension';
+export * from './graph-ql';
+export * from './inventory';
+export * from './me';
+export * from './message';
+export * from './order';
+export * from './order-edit';
+export * from './payment';
+export * from './product';
+export * from './product-discount';
+export * from './product-selection';
+export * from './product-type';
+export * from './project';
+export * from './review';
+export * from './scalar-types';
+export * from './shipping-method';
+export * from './shopping-list';
+export * from './state';
+export * from './store';
+export * from './subscription';
+export * from './tax-category';
+export * from './type';
+export * from './zone';

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

@@ -0,0 +1,82 @@
+import { ChannelReference, ChannelResourceIdentifier } from './channel';
+import { BaseResource, CreatedBy, LastModifiedBy } from './common';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
+export interface InventoryEntry extends BaseResource {
+    readonly id: string;
+    readonly version: number;
+    readonly createdAt: string;
+    readonly lastModifiedAt: string;
+    readonly lastModifiedBy?: LastModifiedBy;
+    readonly createdBy?: CreatedBy;
+    readonly sku: string;
+    readonly supplyChannel?: ChannelReference;
+    readonly quantityOnStock: number;
+    readonly availableQuantity: number;
+    readonly restockableInDays?: number;
+    readonly expectedDelivery?: string;
+    readonly custom?: CustomFields;
+}
+export interface InventoryEntryDraft {
+    readonly sku: string;
+    readonly supplyChannel?: ChannelResourceIdentifier;
+    readonly quantityOnStock: number;
+    readonly restockableInDays?: number;
+    readonly expectedDelivery?: string;
+    readonly custom?: CustomFieldsDraft;
+}
+export interface InventoryEntryReference {
+    readonly typeId: 'inventory-entry';
+    readonly id: string;
+    readonly obj?: InventoryEntry;
+}
+export interface InventoryEntryResourceIdentifier {
+    readonly typeId: 'inventory-entry';
+    readonly id?: string;
+    readonly key?: string;
+}
+export interface InventoryEntryUpdate {
+    readonly version: number;
+    readonly actions: InventoryEntryUpdateAction[];
+}
+export declare type InventoryEntryUpdateAction = InventoryEntryAddQuantityAction | InventoryEntryChangeQuantityAction | InventoryEntryRemoveQuantityAction | InventoryEntrySetCustomFieldAction | InventoryEntrySetCustomTypeAction | InventoryEntrySetExpectedDeliveryAction | InventoryEntrySetRestockableInDaysAction | InventoryEntrySetSupplyChannelAction;
+export interface InventoryPagedQueryResponse {
+    readonly limit: number;
+    readonly count: number;
+    readonly total?: number;
+    readonly offset: number;
+    readonly results: InventoryEntry[];
+}
+export interface InventoryEntryAddQuantityAction {
+    readonly action: 'addQuantity';
+    readonly quantity: number;
+}
+export interface InventoryEntryChangeQuantityAction {
+    readonly action: 'changeQuantity';
+    readonly quantity: number;
+}
+export interface InventoryEntryRemoveQuantityAction {
+    readonly action: 'removeQuantity';
+    readonly quantity: number;
+}
+export interface InventoryEntrySetCustomFieldAction {
+    readonly action: 'setCustomField';
+    readonly name: string;
+    readonly value?: any;
+}
+export interface InventoryEntrySetCustomTypeAction {
+    readonly action: 'setCustomType';
+    readonly type?: TypeResourceIdentifier;
+    readonly fields?: FieldContainer;
+}
+export interface InventoryEntrySetExpectedDeliveryAction {
+    readonly action: 'setExpectedDelivery';
+    readonly expectedDelivery?: string;
+}
+export interface InventoryEntrySetRestockableInDaysAction {
+    readonly action: 'setRestockableInDays';
+    readonly restockableInDays?: number;
+}
+export interface InventoryEntrySetSupplyChannelAction {
+    readonly action: 'setSupplyChannel';
+    readonly supplyChannel?: ChannelResourceIdentifier;
+}