@wix/auto_sdk_stores_info-sections-v-3 1.0.26 → 1.0.27

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { InfoSection, CreateInfoSectionValidationErrors, GetInfoSectionOptions, GetOrCreateInfoSectionOptions, GetOrCreateInfoSectionResponse, GetOrCreateInfoSectionValidationErrors, BulkGetOrCreateInfoSectionsOptions, BulkGetOrCreateInfoSectionsResponse, BulkGetOrCreateInfoSectionsValidationErrors, UpdateInfoSection, UpdateInfoSectionOptions, QueryInfoSectionsOptions, InfoSectionsQueryBuilder, BulkCreateInfoSectionsOptions, BulkCreateInfoSectionsResponse, BulkCreateInfoSectionsValidationErrors, MaskedInfoSection, BulkUpdateInfoSectionsOptions, BulkUpdateInfoSectionsResponse, BulkDeleteInfoSectionsResponse, InfoSectionCreatedEnvelope, InfoSectionDeletedEnvelope, InfoSectionUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, Alignment, AnchorData, App, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, ApplicationError, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BookingData, Border, BorderColors, BulkActionMetadata, BulkCreateInfoSectionsRequest, BulkDeleteInfoSectionsRequest, BulkGetOrCreateInfoSectionsRequest, BulkInfoSectionItemResult, BulkInfoSectionResult, BulkUpdateInfoSectionsRequest, BulletedListData, ButtonData, CaptionData, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, CreateInfoSectionRequest, CreateInfoSectionResponse, Crop, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, Decoration, DecorationDataOneOf, DecorationType, DeleteInfoSectionRequest, DeleteInfoSectionResponse, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, File, FileData, FileSource, FileSourceDataOneOf, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetInfoSectionRequest, GetInfoSectionResponse, GetOrCreateInfoSectionRequest, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InfoSectionForGetOrCreate, InfoSectionsQueryResult, InitialExpandedItems, InvalidateCache, InvalidateCacheGetByOneOf, Item, ItemDataOneOf, ItemMetadata, ItemStyle, Layout, LayoutCellData, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListValue, MapData, MapSettings, MapType, Media, MentionData, MessageEnvelope, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, PDFSettings, Page, ParagraphData, Permissions, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, Position, QueryInfoSectionsRequest, QueryInfoSectionsResponse, Rel, RequestedFields, RestoreInfo, RichContent, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Styles, StylesBorder, TableCellData, TableData, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, URI, UpdateInfoSectionRequest, UpdateInfoSectionResponse, VerticalAlignment, Video, VideoData, ViewMode, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType } from './index.typings.js';
 
+type InfoSectionNonNullablePaths = `uniqueName` | `title`;
 declare function createInfoSection$1(httpClient: HttpClient): CreateInfoSectionSignature;
 interface CreateInfoSectionSignature {
     /**
@@ -13,8 +14,8 @@ interface CreateInfoSectionSignature {
      * @param - Info section to create.
      * @returns Created info section.
      */
-    (infoSection: InfoSection): Promise<InfoSection & {
-        __validationErrorsType?: CreateInfoSectionValidationErrors | undefined;
+    (infoSection: NonNullablePaths<InfoSection, `title` | `uniqueName`>): Promise<NonNullablePaths<InfoSection, InfoSectionNonNullablePaths> & {
+        __validationErrorsType?: CreateInfoSectionValidationErrors;
     }>;
 }
 declare function getInfoSection$1(httpClient: HttpClient): GetInfoSectionSignature;
@@ -24,7 +25,7 @@ interface GetInfoSectionSignature {
      * @param - Info section ID.
      * @returns Info section.
      */
-    (infoSectionId: string, options?: GetInfoSectionOptions | undefined): Promise<InfoSection>;
+    (infoSectionId: string, options?: GetInfoSectionOptions): Promise<NonNullablePaths<InfoSection, InfoSectionNonNullablePaths>>;
 }
 declare function getOrCreateInfoSection$1(httpClient: HttpClient): GetOrCreateInfoSectionSignature;
 interface GetOrCreateInfoSectionSignature {
@@ -33,8 +34,10 @@ interface GetOrCreateInfoSectionSignature {
      *
      * > **Note:** If an info section with the passed `uniqueName` doesn't exist, the `uniqueName` and `title` fields are required to create a new info section.
      */
-    (options?: GetOrCreateInfoSectionOptions | undefined): Promise<GetOrCreateInfoSectionResponse & {
-        __validationErrorsType?: GetOrCreateInfoSectionValidationErrors | undefined;
+    (options?: GetOrCreateInfoSectionOptions): Promise<NonNullablePaths<GetOrCreateInfoSectionResponse, {
+        [P in InfoSectionNonNullablePaths]: `infoSection.${P}`;
+    }[InfoSectionNonNullablePaths]> & {
+        __validationErrorsType?: GetOrCreateInfoSectionValidationErrors;
     }>;
 }
 declare function bulkGetOrCreateInfoSections$1(httpClient: HttpClient): BulkGetOrCreateInfoSectionsSignature;
@@ -44,8 +47,10 @@ interface BulkGetOrCreateInfoSectionsSignature {
      *
      * > **Note:** If an info section with the passed `uniqueName` doesn't exist, the `uniqueName` and `title` fields are required to create a new info section.
      */
-    (options?: BulkGetOrCreateInfoSectionsOptions | undefined): Promise<BulkGetOrCreateInfoSectionsResponse & {
-        __validationErrorsType?: BulkGetOrCreateInfoSectionsValidationErrors | undefined;
+    (options?: BulkGetOrCreateInfoSectionsOptions): Promise<NonNullablePaths<BulkGetOrCreateInfoSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in InfoSectionNonNullablePaths]: `results.${number}.item.${P}`;
+    }[InfoSectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+        __validationErrorsType?: BulkGetOrCreateInfoSectionsValidationErrors;
     }>;
 }
 declare function updateInfoSection$1(httpClient: HttpClient): UpdateInfoSectionSignature;
@@ -60,7 +65,7 @@ interface UpdateInfoSectionSignature {
      * @param - Info section ID.
      * @returns Updated info section.
      */
-    (_id: string, infoSection: UpdateInfoSection, options?: UpdateInfoSectionOptions | undefined): Promise<InfoSection>;
+    (_id: string, infoSection: NonNullablePaths<UpdateInfoSection, `revision`>, options?: UpdateInfoSectionOptions): Promise<NonNullablePaths<InfoSection, InfoSectionNonNullablePaths>>;
 }
 declare function deleteInfoSection$1(httpClient: HttpClient): DeleteInfoSectionSignature;
 interface DeleteInfoSectionSignature {
@@ -91,7 +96,7 @@ interface QueryInfoSectionsSignature {
      * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
      * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
      */
-    (options?: QueryInfoSectionsOptions | undefined): InfoSectionsQueryBuilder;
+    (options?: QueryInfoSectionsOptions): InfoSectionsQueryBuilder;
 }
 declare function bulkCreateInfoSections$1(httpClient: HttpClient): BulkCreateInfoSectionsSignature;
 interface BulkCreateInfoSectionsSignature {
@@ -99,8 +104,10 @@ interface BulkCreateInfoSectionsSignature {
      * Creates multiple info sections.
      * @param - Info sections to create.
      */
-    (infoSections: InfoSection[], options?: BulkCreateInfoSectionsOptions | undefined): Promise<BulkCreateInfoSectionsResponse & {
-        __validationErrorsType?: BulkCreateInfoSectionsValidationErrors | undefined;
+    (infoSections: NonNullablePaths<InfoSection, `title` | `uniqueName`>[], options?: BulkCreateInfoSectionsOptions): Promise<NonNullablePaths<BulkCreateInfoSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in InfoSectionNonNullablePaths]: `results.${number}.item.${P}`;
+    }[InfoSectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+        __validationErrorsType?: BulkCreateInfoSectionsValidationErrors;
     }>;
 }
 declare function bulkUpdateInfoSections$1(httpClient: HttpClient): BulkUpdateInfoSectionsSignature;
@@ -113,7 +120,9 @@ interface BulkUpdateInfoSectionsSignature {
      * This ensures you're working with the latest info section and prevents unintended overwrites.
      * @param - List of info sections to update.
      */
-    (infoSections: MaskedInfoSection[], options?: BulkUpdateInfoSectionsOptions | undefined): Promise<BulkUpdateInfoSectionsResponse>;
+    (infoSections: NonNullablePaths<MaskedInfoSection, `infoSection._id` | `infoSection.revision`>[], options?: BulkUpdateInfoSectionsOptions): Promise<NonNullablePaths<BulkUpdateInfoSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in InfoSectionNonNullablePaths]: `results.${number}.item.${P}`;
+    }[InfoSectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function bulkDeleteInfoSections$1(httpClient: HttpClient): BulkDeleteInfoSectionsSignature;
 interface BulkDeleteInfoSectionsSignature {
@@ -121,7 +130,7 @@ interface BulkDeleteInfoSectionsSignature {
      * Deletes multiple info sections.
      * @param - IDs of info sections to delete.
      */
-    (infoSectionIds: string[]): Promise<BulkDeleteInfoSectionsResponse>;
+    (infoSectionIds: string[]): Promise<NonNullablePaths<BulkDeleteInfoSectionsResponse, `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`>>;
 }
 declare const onInfoSectionCreated$1: EventDefinition<InfoSectionCreatedEnvelope, "wix.stores.catalog.v3.info_section_created">;
 declare const onInfoSectionDeleted$1: EventDefinition<InfoSectionDeletedEnvelope, "wix.stores.catalog.v3.info_section_deleted">;