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

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

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

package/build/internal/cjs/index.typings.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,