@wix/auto_sdk_stores_catalog-imports-v-3 1.0.0 → 1.0.1

package/build/es/meta.d.mts

@@ -3020,6 +3020,47 @@ interface ProductCategoryIdsInfo {
     categoryIds?: string[];
 }
 interface AddProductsToImportResponse {
+    /**
+     * Action results.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: AddProductResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface AddProductResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+}
+interface ItemMetadata {
+    /**
+     * The product `handle` as passed in the `AddProductsToImport` request.
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
 }
 interface SubmitCatalogImportRequest {
     /**

package/build/internal/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { CatalogImport, ProductItem, SubmitCatalogImportResponse, SubmitCatalogImportApplicationErrors } from './index.typings.js';
-export { ActionEvent, AddProductsToImportRequest, AddProductsToImportResponse, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BackgroundTypeWithLiterals, BlockquoteData, BookingData, Border, BorderColors, Brand, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, CatalogImportAlreadySubmittedErrorData, CellStyle, ChoiceType, ChoiceTypeWithLiterals, ChoicesSettings, CodeBlockData, CollapsibleListData, ColorData, Colors, ConnectedModifier, ConnectedModifierChoice, ConnectedModifierChoiceValueOneOf, ConnectedModifierModifierSettingsOneOf, ConnectedOption, ConnectedOptionChoice, ConnectedOptionChoiceValueOneOf, ConnectedOptionOptionSettingsOneOf, CreateCatalogImportRequest, CreateCatalogImportResponse, Crop, CropWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DiscountType, DiscountTypeWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, ExtendedFields, FileData, FileSource, FileSourceDataOneOf, FileType, FileTypeWithLiterals, FixedMonetaryAmount, FontSizeData, FontType, FontTypeWithLiterals, FreeTextSettings, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImageStyles, InfoSection, InitialExpandedItems, InitialExpandedItemsWithLiterals, InventoryItemComposite, InventoryItemCompositeTrackingMethodOneOf, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListValue, MapData, MapSettings, MapType, MapTypeWithLiterals, MeasurementUnit, MeasurementUnitWithLiterals, Media, MediaItemsInfo, MediaType, MediaTypeWithLiterals, MentionData, MessageEnvelope, Metadata, ModifierChoicesSettings, ModifierRenderType, ModifierRenderTypeWithLiterals, MultipleColors, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionChoiceIds, OptionChoiceNames, OptionChoiceReferences, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, PDFSettings, ParagraphData, Permissions, PhysicalProperties, Placement, PlacementWithLiterals, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, PreorderInfo, PriceInfo, PricePerUnit, PricePerUnitRange, PricePerUnitRangePricePerUnit, PricePerUnitSettings, PricingData, ProductCategoryIdsInfo, ProductMedia, ProductMediaMediaOneOf, ProductMediaSetByOneOf, ProductOptionRenderType, ProductOptionRenderTypeWithLiterals, ProductType, ProductTypeWithLiterals, ProductWithInventory, ProductWithInventoryTypedPropertiesOneOf, Rel, Resizing, ResizingWithLiterals, RestoreInfo, RevenueDetails, Ribbon, RibbonStyles, RichContent, SecuredMedia, SeoSchema, Settings, Source, SourceWithLiterals, Spoiler, SpoilerData, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, SubmitCatalogImportRequest, Subscription, SubscriptionCyclesOneOf, SubscriptionDetails, SubscriptionDiscount, SubscriptionDiscountDiscountOneOf, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnail, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, Type, TypeWithLiterals, V1Media, VariantDigitalProperties, VariantPhysicalProperties, VariantWithInventory, VariantWithInventoryTypedPropertiesOneOf, VariantsInfo, VerticalAlignment, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightMeasurementUnitInfo, WeightRange, WeightUnit, WeightUnitWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
+import { CatalogImport, ProductItem, AddProductsToImportResponse, SubmitCatalogImportResponse, SubmitCatalogImportApplicationErrors } from './index.typings.js';
+export { ActionEvent, AddProductResult, AddProductsToImportRequest, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, ApplicationError, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BackgroundTypeWithLiterals, BlockquoteData, BookingData, Border, BorderColors, Brand, BulkActionMetadata, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, CatalogImportAlreadySubmittedErrorData, CellStyle, ChoiceType, ChoiceTypeWithLiterals, ChoicesSettings, CodeBlockData, CollapsibleListData, ColorData, Colors, ConnectedModifier, ConnectedModifierChoice, ConnectedModifierChoiceValueOneOf, ConnectedModifierModifierSettingsOneOf, ConnectedOption, ConnectedOptionChoice, ConnectedOptionChoiceValueOneOf, ConnectedOptionOptionSettingsOneOf, CreateCatalogImportRequest, CreateCatalogImportResponse, Crop, CropWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DiscountType, DiscountTypeWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, ExtendedFields, FileData, FileSource, FileSourceDataOneOf, FileType, FileTypeWithLiterals, FixedMonetaryAmount, FontSizeData, FontType, FontTypeWithLiterals, FreeTextSettings, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImageStyles, InfoSection, InitialExpandedItems, InitialExpandedItemsWithLiterals, InventoryItemComposite, InventoryItemCompositeTrackingMethodOneOf, Item, ItemDataOneOf, ItemMetadata, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListValue, MapData, MapSettings, MapType, MapTypeWithLiterals, MeasurementUnit, MeasurementUnitWithLiterals, Media, MediaItemsInfo, MediaType, MediaTypeWithLiterals, MentionData, MessageEnvelope, Metadata, ModifierChoicesSettings, ModifierRenderType, ModifierRenderTypeWithLiterals, MultipleColors, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionChoiceIds, OptionChoiceNames, OptionChoiceReferences, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, PDFSettings, ParagraphData, Permissions, PhysicalProperties, Placement, PlacementWithLiterals, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, PreorderInfo, PriceInfo, PricePerUnit, PricePerUnitRange, PricePerUnitRangePricePerUnit, PricePerUnitSettings, PricingData, ProductCategoryIdsInfo, ProductMedia, ProductMediaMediaOneOf, ProductMediaSetByOneOf, ProductOptionRenderType, ProductOptionRenderTypeWithLiterals, ProductType, ProductTypeWithLiterals, ProductWithInventory, ProductWithInventoryTypedPropertiesOneOf, Rel, Resizing, ResizingWithLiterals, RestoreInfo, RevenueDetails, Ribbon, RibbonStyles, RichContent, SecuredMedia, SeoSchema, Settings, Source, SourceWithLiterals, Spoiler, SpoilerData, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, SubmitCatalogImportRequest, Subscription, SubscriptionCyclesOneOf, SubscriptionDetails, SubscriptionDiscount, SubscriptionDiscountDiscountOneOf, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnail, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, Type, TypeWithLiterals, V1Media, VariantDigitalProperties, VariantPhysicalProperties, VariantWithInventory, VariantWithInventoryTypedPropertiesOneOf, VariantsInfo, VerticalAlignment, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightMeasurementUnitInfo, WeightRange, WeightUnit, WeightUnitWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
 
 /** @internal */
 declare function createCatalogImport$1(httpClient: HttpClient): CreateCatalogImportSignature;
@@ -30,7 +30,7 @@ interface AddProductsToImportSignature {
      * @param - Catalog Import ID.
      * @param - List of product items to add to the import session.
      */
-    (catalogImportId: string, products: NonNullablePaths<ProductItem, `product.handle`, 3>[]): Promise<void>;
+    (catalogImportId: string, products: NonNullablePaths<ProductItem, `product.handle`, 3>[]): Promise<NonNullablePaths<AddProductsToImportResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 }
 /** @internal */
 declare function submitCatalogImport$1(httpClient: HttpClient): SubmitCatalogImportSignature;
@@ -52,4 +52,4 @@ declare const addProductsToImport: MaybeContext<BuildRESTFunction<typeof addProd
 /** @internal */
 declare const submitCatalogImport: MaybeContext<BuildRESTFunction<typeof submitCatalogImport$1> & typeof submitCatalogImport$1>;
 
-export { CatalogImport, ProductItem, SubmitCatalogImportApplicationErrors, SubmitCatalogImportResponse, addProductsToImport, createCatalogImport, submitCatalogImport };
+export { AddProductsToImportResponse, CatalogImport, ProductItem, SubmitCatalogImportApplicationErrors, SubmitCatalogImportResponse, addProductsToImport, createCatalogImport, submitCatalogImport };

package/build/internal/cjs/index.js

@@ -787,6 +787,7 @@ async function addProductsToImport2(catalogImportId, products) {
   try {
     const result = await httpClient.request(reqOpts);
     sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
       err,