@wix/auto_sdk_stores_info-sections-v-3 1.0.25 → 1.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/{stores-catalog-v3-info-section-info-sections-v-3.universal-DvKL8Gfo.d.ts → index.typings.d.ts} +268 -1
- package/build/cjs/index.typings.js +1716 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +2 -2
- package/build/es/{stores-catalog-v3-info-section-info-sections-v-3.universal-DvKL8Gfo.d.mts → index.typings.d.mts} +268 -1
- package/build/es/index.typings.mjs +1650 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/{stores-catalog-v3-info-section-info-sections-v-3.universal-DvKL8Gfo.d.ts → index.typings.d.ts} +268 -1
- package/build/internal/cjs/index.typings.js +1716 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -1
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/{stores-catalog-v3-info-section-info-sections-v-3.universal-DvKL8Gfo.d.mts → index.typings.d.mts} +268 -1
- package/build/internal/es/index.typings.mjs +1650 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export {
|
|
2
|
+
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';
|
|
3
|
+
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';
|
|
4
4
|
|
|
5
5
|
declare function createInfoSection$1(httpClient: HttpClient): CreateInfoSectionSignature;
|
|
6
6
|
interface CreateInfoSectionSignature {
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* An info section is a visible property of a product
|
|
3
5
|
* Add info sections to a product to provide all the explanations your customers need.
|
|
@@ -1463,6 +1465,8 @@ declare enum NullValue {
|
|
|
1463
1465
|
/** Null value. */
|
|
1464
1466
|
NULL_VALUE = "NULL_VALUE"
|
|
1465
1467
|
}
|
|
1468
|
+
/** @enumType */
|
|
1469
|
+
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1466
1470
|
/**
|
|
1467
1471
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1468
1472
|
*
|
|
@@ -2233,13 +2237,143 @@ interface InfoSectionCreatedEnvelope {
|
|
|
2233
2237
|
entity: InfoSection;
|
|
2234
2238
|
metadata: EventMetadata;
|
|
2235
2239
|
}
|
|
2240
|
+
/**
|
|
2241
|
+
* Triggered when an info section is created.
|
|
2242
|
+
* @permissionScope Manage Stores - all permissions
|
|
2243
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2244
|
+
* @permissionScope Manage Stores
|
|
2245
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2246
|
+
* @permissionScope Read info sections in v3 catalog
|
|
2247
|
+
* @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
|
|
2248
|
+
* @permissionScope Read v3 catalog
|
|
2249
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
2250
|
+
* @permissionScope Manage Products
|
|
2251
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
2252
|
+
* @permissionScope Read Stores - all read permissions
|
|
2253
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
2254
|
+
* @permissionScope Read Products
|
|
2255
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
2256
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2257
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2258
|
+
* @permissionScope Product write in v3 catalog
|
|
2259
|
+
* @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
|
|
2260
|
+
* @permissionScope Manage v3 catalog
|
|
2261
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
2262
|
+
* @permissionScope Manage Orders
|
|
2263
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
2264
|
+
* @permissionId WIX_STORES.INFO_SECTION_READ
|
|
2265
|
+
* @webhook
|
|
2266
|
+
* @eventType wix.stores.catalog.v3.info_section_created
|
|
2267
|
+
* @serviceIdentifier com.wix.stores.catalog.info.section.v3.InfoSectionsService
|
|
2268
|
+
* @slug created
|
|
2269
|
+
* @documentationMaturity preview
|
|
2270
|
+
*/
|
|
2271
|
+
declare function onInfoSectionCreated(handler: (event: InfoSectionCreatedEnvelope) => void | Promise<void>): void;
|
|
2236
2272
|
interface InfoSectionDeletedEnvelope {
|
|
2237
2273
|
metadata: EventMetadata;
|
|
2238
2274
|
}
|
|
2275
|
+
/**
|
|
2276
|
+
* Triggered when an info section is deleted.
|
|
2277
|
+
* @permissionScope Manage Stores - all permissions
|
|
2278
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2279
|
+
* @permissionScope Manage Stores
|
|
2280
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2281
|
+
* @permissionScope Read info sections in v3 catalog
|
|
2282
|
+
* @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
|
|
2283
|
+
* @permissionScope Read v3 catalog
|
|
2284
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
2285
|
+
* @permissionScope Manage Products
|
|
2286
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
2287
|
+
* @permissionScope Read Stores - all read permissions
|
|
2288
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
2289
|
+
* @permissionScope Read Products
|
|
2290
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
2291
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2292
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2293
|
+
* @permissionScope Product write in v3 catalog
|
|
2294
|
+
* @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
|
|
2295
|
+
* @permissionScope Manage v3 catalog
|
|
2296
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
2297
|
+
* @permissionScope Manage Orders
|
|
2298
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
2299
|
+
* @permissionId WIX_STORES.INFO_SECTION_READ
|
|
2300
|
+
* @webhook
|
|
2301
|
+
* @eventType wix.stores.catalog.v3.info_section_deleted
|
|
2302
|
+
* @serviceIdentifier com.wix.stores.catalog.info.section.v3.InfoSectionsService
|
|
2303
|
+
* @slug deleted
|
|
2304
|
+
* @documentationMaturity preview
|
|
2305
|
+
*/
|
|
2306
|
+
declare function onInfoSectionDeleted(handler: (event: InfoSectionDeletedEnvelope) => void | Promise<void>): void;
|
|
2239
2307
|
interface InfoSectionUpdatedEnvelope {
|
|
2240
2308
|
entity: InfoSection;
|
|
2241
2309
|
metadata: EventMetadata;
|
|
2242
2310
|
}
|
|
2311
|
+
/**
|
|
2312
|
+
* Triggered when an info section is updated.
|
|
2313
|
+
* @permissionScope Manage Stores - all permissions
|
|
2314
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2315
|
+
* @permissionScope Manage Stores
|
|
2316
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2317
|
+
* @permissionScope Read info sections in v3 catalog
|
|
2318
|
+
* @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
|
|
2319
|
+
* @permissionScope Read v3 catalog
|
|
2320
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
2321
|
+
* @permissionScope Manage Products
|
|
2322
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
2323
|
+
* @permissionScope Read Stores - all read permissions
|
|
2324
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
2325
|
+
* @permissionScope Read Products
|
|
2326
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
2327
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2328
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2329
|
+
* @permissionScope Product write in v3 catalog
|
|
2330
|
+
* @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
|
|
2331
|
+
* @permissionScope Manage v3 catalog
|
|
2332
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
2333
|
+
* @permissionScope Manage Orders
|
|
2334
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
2335
|
+
* @permissionId WIX_STORES.INFO_SECTION_READ
|
|
2336
|
+
* @webhook
|
|
2337
|
+
* @eventType wix.stores.catalog.v3.info_section_updated
|
|
2338
|
+
* @serviceIdentifier com.wix.stores.catalog.info.section.v3.InfoSectionsService
|
|
2339
|
+
* @slug updated
|
|
2340
|
+
* @documentationMaturity preview
|
|
2341
|
+
*/
|
|
2342
|
+
declare function onInfoSectionUpdated(handler: (event: InfoSectionUpdatedEnvelope) => void | Promise<void>): void;
|
|
2343
|
+
type InfoSectionNonNullablePaths = `uniqueName` | `title`;
|
|
2344
|
+
/**
|
|
2345
|
+
* Creates an info section.
|
|
2346
|
+
*
|
|
2347
|
+
* To assign the info section to a product, include the `infoSection.id` or `infoSection.uniqueName`
|
|
2348
|
+
* when [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or
|
|
2349
|
+
* [updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.
|
|
2350
|
+
* @param infoSection - Info section to create.
|
|
2351
|
+
* @public
|
|
2352
|
+
* @documentationMaturity preview
|
|
2353
|
+
* @requiredField infoSection
|
|
2354
|
+
* @requiredField infoSection.title
|
|
2355
|
+
* @requiredField infoSection.uniqueName
|
|
2356
|
+
* @permissionId WIX_STORES.INFO_SECTION_CREATE
|
|
2357
|
+
* @applicableIdentity APP
|
|
2358
|
+
* @returns Created info section.
|
|
2359
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.CreateInfoSection
|
|
2360
|
+
*/
|
|
2361
|
+
declare function createInfoSection(infoSection: NonNullablePaths<InfoSection, `title` | `uniqueName`>): Promise<NonNullablePaths<InfoSection, InfoSectionNonNullablePaths> & {
|
|
2362
|
+
__validationErrorsType?: CreateInfoSectionValidationErrors;
|
|
2363
|
+
}>;
|
|
2364
|
+
/**
|
|
2365
|
+
* Retrieves an info section.
|
|
2366
|
+
* @param infoSectionId - Info section ID.
|
|
2367
|
+
* @public
|
|
2368
|
+
* @documentationMaturity preview
|
|
2369
|
+
* @requiredField infoSectionId
|
|
2370
|
+
* @permissionId WIX_STORES.INFO_SECTION_READ
|
|
2371
|
+
* @applicableIdentity APP
|
|
2372
|
+
* @applicableIdentity VISITOR
|
|
2373
|
+
* @returns Info section.
|
|
2374
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.GetInfoSection
|
|
2375
|
+
*/
|
|
2376
|
+
declare function getInfoSection(infoSectionId: string, options?: GetInfoSectionOptions): Promise<NonNullablePaths<InfoSection, InfoSectionNonNullablePaths>>;
|
|
2243
2377
|
interface GetInfoSectionOptions {
|
|
2244
2378
|
/**
|
|
2245
2379
|
* Fields to include in the response.
|
|
@@ -2249,6 +2383,21 @@ interface GetInfoSectionOptions {
|
|
|
2249
2383
|
*/
|
|
2250
2384
|
fields?: RequestedFieldsWithLiterals[];
|
|
2251
2385
|
}
|
|
2386
|
+
/**
|
|
2387
|
+
* Retrieves an info section by ID or `uniqueName`, or creates an info section if one with the passed `uniqueName` doesn't exist.
|
|
2388
|
+
*
|
|
2389
|
+
* > **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.
|
|
2390
|
+
* @public
|
|
2391
|
+
* @documentationMaturity preview
|
|
2392
|
+
* @permissionId WIX_STORES.INFO_SECTION_GET_OR_CREATE
|
|
2393
|
+
* @applicableIdentity APP
|
|
2394
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.GetOrCreateInfoSection
|
|
2395
|
+
*/
|
|
2396
|
+
declare function getOrCreateInfoSection(options?: GetOrCreateInfoSectionOptions): Promise<NonNullablePaths<GetOrCreateInfoSectionResponse, {
|
|
2397
|
+
[P in InfoSectionNonNullablePaths]: `infoSection.${P}`;
|
|
2398
|
+
}[InfoSectionNonNullablePaths]> & {
|
|
2399
|
+
__validationErrorsType?: GetOrCreateInfoSectionValidationErrors;
|
|
2400
|
+
}>;
|
|
2252
2401
|
interface GetOrCreateInfoSectionOptions {
|
|
2253
2402
|
/** Info section to retrieve or create. */
|
|
2254
2403
|
infoSection?: InfoSectionForGetOrCreate;
|
|
@@ -2260,6 +2409,21 @@ interface GetOrCreateInfoSectionOptions {
|
|
|
2260
2409
|
*/
|
|
2261
2410
|
fields?: RequestedFieldsWithLiterals[];
|
|
2262
2411
|
}
|
|
2412
|
+
/**
|
|
2413
|
+
* Retrieves multiple info sections by ID or `uniqueName`, or creates multiple info sections if those with the passed `uniqueName` don't exist.
|
|
2414
|
+
*
|
|
2415
|
+
* > **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.
|
|
2416
|
+
* @public
|
|
2417
|
+
* @documentationMaturity preview
|
|
2418
|
+
* @permissionId WIX_STORES.INFO_SECTION_GET_OR_CREATE
|
|
2419
|
+
* @applicableIdentity APP
|
|
2420
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkGetOrCreateInfoSections
|
|
2421
|
+
*/
|
|
2422
|
+
declare function bulkGetOrCreateInfoSections(options?: BulkGetOrCreateInfoSectionsOptions): Promise<NonNullablePaths<BulkGetOrCreateInfoSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
2423
|
+
[P in InfoSectionNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2424
|
+
}[InfoSectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
|
|
2425
|
+
__validationErrorsType?: BulkGetOrCreateInfoSectionsValidationErrors;
|
|
2426
|
+
}>;
|
|
2263
2427
|
interface BulkGetOrCreateInfoSectionsOptions {
|
|
2264
2428
|
/**
|
|
2265
2429
|
* Info sections to retrieve or create.
|
|
@@ -2275,6 +2439,25 @@ interface BulkGetOrCreateInfoSectionsOptions {
|
|
|
2275
2439
|
*/
|
|
2276
2440
|
fields?: RequestedFieldsWithLiterals[];
|
|
2277
2441
|
}
|
|
2442
|
+
/**
|
|
2443
|
+
* Updates an info section.
|
|
2444
|
+
*
|
|
2445
|
+
*
|
|
2446
|
+
* Each time the info section is updated, `revision` increments by 1.
|
|
2447
|
+
* The current `revision` must be passed when updating the info section.
|
|
2448
|
+
* This ensures you're working with the latest info section and prevents unintended overwrites.
|
|
2449
|
+
* @param _id - Info section ID.
|
|
2450
|
+
* @public
|
|
2451
|
+
* @documentationMaturity preview
|
|
2452
|
+
* @requiredField _id
|
|
2453
|
+
* @requiredField infoSection
|
|
2454
|
+
* @requiredField infoSection.revision
|
|
2455
|
+
* @permissionId WIX_STORES.INFO_SECTION_UPDATE
|
|
2456
|
+
* @applicableIdentity APP
|
|
2457
|
+
* @returns Updated info section.
|
|
2458
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.UpdateInfoSection
|
|
2459
|
+
*/
|
|
2460
|
+
declare function updateInfoSection(_id: string, infoSection: NonNullablePaths<UpdateInfoSection, `revision`>, options?: UpdateInfoSectionOptions): Promise<NonNullablePaths<InfoSection, InfoSectionNonNullablePaths>>;
|
|
2278
2461
|
interface UpdateInfoSection {
|
|
2279
2462
|
/**
|
|
2280
2463
|
* Info section ID.
|
|
@@ -2344,6 +2527,43 @@ interface UpdateInfoSectionOptions {
|
|
|
2344
2527
|
*/
|
|
2345
2528
|
fields?: RequestedFieldsWithLiterals[];
|
|
2346
2529
|
}
|
|
2530
|
+
/**
|
|
2531
|
+
* Deletes an info section.
|
|
2532
|
+
*
|
|
2533
|
+
* > **Note:** Deleting an info section will also remove it from all products it is assigned to.
|
|
2534
|
+
* @param infoSectionId - Info section ID
|
|
2535
|
+
* @public
|
|
2536
|
+
* @documentationMaturity preview
|
|
2537
|
+
* @requiredField infoSectionId
|
|
2538
|
+
* @permissionId WIX_STORES.INFO_SECTION_DELETE
|
|
2539
|
+
* @applicableIdentity APP
|
|
2540
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.DeleteInfoSection
|
|
2541
|
+
*/
|
|
2542
|
+
declare function deleteInfoSection(infoSectionId: string): Promise<void>;
|
|
2543
|
+
/**
|
|
2544
|
+
* Retrieves a list of up to 100 info sections, given the provided filtering, sorting, and cursor paging.
|
|
2545
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
2546
|
+
*
|
|
2547
|
+
*
|
|
2548
|
+
* Query Info Sections runs with these defaults, which you can override:
|
|
2549
|
+
*
|
|
2550
|
+
* - `createdDate` is sorted in `DESC` order
|
|
2551
|
+
* - `cursorPaging.limit` is `100`
|
|
2552
|
+
*
|
|
2553
|
+
* For field support for filters and sorting,
|
|
2554
|
+
* see [Info Sections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/info-sections-v3/supported-filters-and-sorting).
|
|
2555
|
+
*
|
|
2556
|
+
* To learn about working with _Query_ endpoints, see
|
|
2557
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
2558
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
2559
|
+
* @public
|
|
2560
|
+
* @documentationMaturity preview
|
|
2561
|
+
* @permissionId WIX_STORES.INFO_SECTION_READ
|
|
2562
|
+
* @applicableIdentity APP
|
|
2563
|
+
* @applicableIdentity VISITOR
|
|
2564
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.QueryInfoSections
|
|
2565
|
+
*/
|
|
2566
|
+
declare function queryInfoSections(options?: QueryInfoSectionsOptions): InfoSectionsQueryBuilder;
|
|
2347
2567
|
interface QueryInfoSectionsOptions {
|
|
2348
2568
|
/**
|
|
2349
2569
|
* Fields to include in the response.
|
|
@@ -2430,6 +2650,23 @@ interface InfoSectionsQueryBuilder {
|
|
|
2430
2650
|
/** @documentationMaturity preview */
|
|
2431
2651
|
find: () => Promise<InfoSectionsQueryResult>;
|
|
2432
2652
|
}
|
|
2653
|
+
/**
|
|
2654
|
+
* Creates multiple info sections.
|
|
2655
|
+
* @param infoSections - Info sections to create.
|
|
2656
|
+
* @public
|
|
2657
|
+
* @documentationMaturity preview
|
|
2658
|
+
* @requiredField infoSections
|
|
2659
|
+
* @requiredField infoSections.title
|
|
2660
|
+
* @requiredField infoSections.uniqueName
|
|
2661
|
+
* @permissionId WIX_STORES.INFO_SECTION_CREATE
|
|
2662
|
+
* @applicableIdentity APP
|
|
2663
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkCreateInfoSections
|
|
2664
|
+
*/
|
|
2665
|
+
declare function bulkCreateInfoSections(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` | {
|
|
2666
|
+
[P in InfoSectionNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2667
|
+
}[InfoSectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
|
|
2668
|
+
__validationErrorsType?: BulkCreateInfoSectionsValidationErrors;
|
|
2669
|
+
}>;
|
|
2433
2670
|
interface BulkCreateInfoSectionsOptions {
|
|
2434
2671
|
/**
|
|
2435
2672
|
* Whether to return the full created info section entities in the response.
|
|
@@ -2438,6 +2675,25 @@ interface BulkCreateInfoSectionsOptions {
|
|
|
2438
2675
|
*/
|
|
2439
2676
|
returnEntity?: boolean;
|
|
2440
2677
|
}
|
|
2678
|
+
/**
|
|
2679
|
+
* Updates multiple info sections.
|
|
2680
|
+
*
|
|
2681
|
+
* Each time an info section is updated, `revision` increments by 1.
|
|
2682
|
+
* The current `revision` must be passed when updating an info section.
|
|
2683
|
+
* This ensures you're working with the latest info section and prevents unintended overwrites.
|
|
2684
|
+
* @param infoSections - List of info sections to update.
|
|
2685
|
+
* @public
|
|
2686
|
+
* @documentationMaturity preview
|
|
2687
|
+
* @requiredField infoSections
|
|
2688
|
+
* @requiredField infoSections.infoSection._id
|
|
2689
|
+
* @requiredField infoSections.infoSection.revision
|
|
2690
|
+
* @permissionId WIX_STORES.INFO_SECTION_UPDATE
|
|
2691
|
+
* @applicableIdentity APP
|
|
2692
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkUpdateInfoSections
|
|
2693
|
+
*/
|
|
2694
|
+
declare function bulkUpdateInfoSections(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` | {
|
|
2695
|
+
[P in InfoSectionNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2696
|
+
}[InfoSectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2441
2697
|
interface BulkUpdateInfoSectionsOptions {
|
|
2442
2698
|
/**
|
|
2443
2699
|
* Whether to return the full updated info sections entities in the response.
|
|
@@ -2453,5 +2709,16 @@ interface BulkUpdateInfoSectionsOptions {
|
|
|
2453
2709
|
*/
|
|
2454
2710
|
fields?: RequestedFieldsWithLiterals[];
|
|
2455
2711
|
}
|
|
2712
|
+
/**
|
|
2713
|
+
* Deletes multiple info sections.
|
|
2714
|
+
* @param infoSectionIds - IDs of info sections to delete.
|
|
2715
|
+
* @public
|
|
2716
|
+
* @documentationMaturity preview
|
|
2717
|
+
* @requiredField infoSectionIds
|
|
2718
|
+
* @permissionId WIX_STORES.INFO_SECTION_DELETE
|
|
2719
|
+
* @applicableIdentity APP
|
|
2720
|
+
* @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkDeleteInfoSections
|
|
2721
|
+
*/
|
|
2722
|
+
declare function bulkDeleteInfoSections(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`>>;
|
|
2456
2723
|
|
|
2457
|
-
export {
|
|
2724
|
+
export { type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type App, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type ApplicationError, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkActionMetadata, type BulkCreateInfoSectionsOptions, type BulkCreateInfoSectionsRequest, type BulkCreateInfoSectionsResponse, type BulkCreateInfoSectionsValidationErrors, type BulkDeleteInfoSectionsRequest, type BulkDeleteInfoSectionsResponse, type BulkGetOrCreateInfoSectionsOptions, type BulkGetOrCreateInfoSectionsRequest, type BulkGetOrCreateInfoSectionsResponse, type BulkGetOrCreateInfoSectionsValidationErrors, type BulkInfoSectionItemResult, type BulkInfoSectionResult, type BulkUpdateInfoSectionsOptions, type BulkUpdateInfoSectionsRequest, type BulkUpdateInfoSectionsResponse, type BulletedListData, type ButtonData, type CaptionData, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CreateInfoSectionRequest, type CreateInfoSectionResponse, type CreateInfoSectionValidationErrors, Crop, type CropWithLiterals, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteInfoSectionRequest, type DeleteInfoSectionResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, type File, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GetInfoSectionOptions, type GetInfoSectionRequest, type GetInfoSectionResponse, type GetOrCreateInfoSectionOptions, type GetOrCreateInfoSectionRequest, type GetOrCreateInfoSectionResponse, type GetOrCreateInfoSectionValidationErrors, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type InfoSection, type InfoSectionCreatedEnvelope, type InfoSectionDeletedEnvelope, type InfoSectionForGetOrCreate, type InfoSectionUpdatedEnvelope, type InfoSectionsQueryBuilder, type InfoSectionsQueryResult, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InvalidateCache, type InvalidateCacheGetByOneOf, type Item, type ItemDataOneOf, type ItemMetadata, type ItemStyle, type Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type MaskedInfoSection, type Media, type MentionData, type MessageEnvelope, type Metadata, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type Page, type ParagraphData, type Permissions, 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, Position, type PositionWithLiterals, type QueryInfoSectionsOptions, type QueryInfoSectionsRequest, type QueryInfoSectionsResponse, type Rel, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RichContent, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type Styles, type StylesBorder, type TableCellData, type TableData, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type URI, type UpdateInfoSection, type UpdateInfoSectionOptions, type UpdateInfoSectionRequest, type UpdateInfoSectionResponse, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkCreateInfoSections, bulkDeleteInfoSections, bulkGetOrCreateInfoSections, bulkUpdateInfoSections, createInfoSection, deleteInfoSection, getInfoSection, getOrCreateInfoSection, onInfoSectionCreated, onInfoSectionDeleted, onInfoSectionUpdated, queryInfoSections, updateInfoSection };
|