@wix/auto_sdk_online-programs_sections 1.0.19 → 1.0.21
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 +10 -22
- package/build/cjs/index.js +0 -107
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +19 -50
- package/build/cjs/index.typings.js +0 -99
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +5 -8
- package/build/cjs/meta.js +0 -75
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +10 -22
- package/build/es/index.mjs +0 -106
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +19 -50
- package/build/es/index.typings.mjs +0 -98
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +5 -8
- package/build/es/meta.mjs +0 -74
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +10 -22
- package/build/internal/cjs/index.typings.d.ts +29 -48
- package/build/internal/cjs/meta.d.ts +10 -7
- package/build/internal/es/index.d.mts +10 -22
- package/build/internal/es/index.typings.d.mts +29 -48
- package/build/internal/es/meta.d.mts +10 -7
- package/package.json +2 -2
|
@@ -4,7 +4,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
|
|
|
4
4
|
/**
|
|
5
5
|
* A section groups related steps within an online program.
|
|
6
6
|
*
|
|
7
|
-
* Sections
|
|
7
|
+
* Sections are published when created, and can be reordered and optionally released after a delay from the start of the parent program.
|
|
8
8
|
*/
|
|
9
9
|
interface Section {
|
|
10
10
|
/**
|
|
@@ -37,7 +37,11 @@ interface Section {
|
|
|
37
37
|
programId?: string;
|
|
38
38
|
/** Section title and deprecated backward-compatibility content fields. */
|
|
39
39
|
description?: Description;
|
|
40
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* @internal
|
|
42
|
+
* @deprecated
|
|
43
|
+
* @targetRemovalDate 2026-09-22
|
|
44
|
+
*/
|
|
41
45
|
state?: StateWithLiterals;
|
|
42
46
|
/**
|
|
43
47
|
* Legacy total number of steps in the section.
|
|
@@ -180,9 +184,9 @@ interface VideoResolution {
|
|
|
180
184
|
assetKey?: string | null;
|
|
181
185
|
}
|
|
182
186
|
declare enum State {
|
|
183
|
-
/**
|
|
187
|
+
/** Retained for backward compatibility. Doesn't affect whether the section is served. */
|
|
184
188
|
DRAFT = "DRAFT",
|
|
185
|
-
/**
|
|
189
|
+
/** Default state for new sections. */
|
|
186
190
|
PUBLISHED = "PUBLISHED"
|
|
187
191
|
}
|
|
188
192
|
/** @enumType */
|
|
@@ -984,7 +988,7 @@ interface AccountInfo {
|
|
|
984
988
|
* @returns Created section.
|
|
985
989
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
|
|
986
990
|
*/
|
|
987
|
-
declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
991
|
+
declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
988
992
|
interface CreateSectionOptions {
|
|
989
993
|
/**
|
|
990
994
|
* Predefined sets of fields to return.
|
|
@@ -1027,7 +1031,7 @@ interface BulkCreateSectionsOptions {
|
|
|
1027
1031
|
* @returns Retrieved section.
|
|
1028
1032
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
|
|
1029
1033
|
*/
|
|
1030
|
-
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
1034
|
+
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
1031
1035
|
interface GetSectionOptions {
|
|
1032
1036
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1033
1037
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1042,7 +1046,7 @@ interface GetSectionOptions {
|
|
|
1042
1046
|
*
|
|
1043
1047
|
* Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when updating the section. This ensures you're working with the latest section and prevents unintended overwrites.
|
|
1044
1048
|
*
|
|
1045
|
-
* Use this method to update section content and settings. To reorder a section, call [Move Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/move-section).
|
|
1049
|
+
* Use this method to update section content and settings. To reorder a section, call [Move Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/move-section).
|
|
1046
1050
|
* @param _id - Section ID.
|
|
1047
1051
|
* @public
|
|
1048
1052
|
* @documentationMaturity preview
|
|
@@ -1053,7 +1057,7 @@ interface GetSectionOptions {
|
|
|
1053
1057
|
* @returns Updated section.
|
|
1054
1058
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.UpdateSection
|
|
1055
1059
|
*/
|
|
1056
|
-
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
1060
|
+
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
1057
1061
|
interface UpdateSectionOptions {
|
|
1058
1062
|
section?: {
|
|
1059
1063
|
/**
|
|
@@ -1086,7 +1090,11 @@ interface UpdateSectionOptions {
|
|
|
1086
1090
|
programId?: string;
|
|
1087
1091
|
/** Section title and deprecated backward-compatibility content fields. */
|
|
1088
1092
|
description?: Description;
|
|
1089
|
-
/**
|
|
1093
|
+
/**
|
|
1094
|
+
* @internal
|
|
1095
|
+
* @deprecated
|
|
1096
|
+
* @targetRemovalDate 2026-09-22
|
|
1097
|
+
*/
|
|
1090
1098
|
state?: StateWithLiterals;
|
|
1091
1099
|
/**
|
|
1092
1100
|
* Legacy total number of steps in the section.
|
|
@@ -1138,8 +1146,8 @@ declare function deleteSection(sectionId: string): Promise<void>;
|
|
|
1138
1146
|
* - `paging.limit` is `1000`.
|
|
1139
1147
|
* - `paging.offset` is `0`.
|
|
1140
1148
|
*
|
|
1141
|
-
* Supported filter fields are `programId`, `id`, `delayInDays`,
|
|
1142
|
-
* Supported sorting fields are `id`, `delayInDays`, `trialSection`, `
|
|
1149
|
+
* Supported filter fields are `programId`, `id`, `delayInDays`, and `trialSection`.
|
|
1150
|
+
* Supported sorting fields are `id`, `delayInDays`, `trialSection`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
|
|
1143
1151
|
* `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
|
|
1144
1152
|
*
|
|
1145
1153
|
* To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
|
|
@@ -1184,12 +1192,12 @@ interface SectionsQueryBuilder {
|
|
|
1184
1192
|
* @param value - Value to compare against.
|
|
1185
1193
|
* @documentationMaturity preview
|
|
1186
1194
|
*/
|
|
1187
|
-
eq: (propertyName: '_id' | 'programId' | '
|
|
1195
|
+
eq: (propertyName: '_id' | 'programId' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1188
1196
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1189
1197
|
* @param value - Value to compare against.
|
|
1190
1198
|
* @documentationMaturity preview
|
|
1191
1199
|
*/
|
|
1192
|
-
ne: (propertyName: '_id' | '
|
|
1200
|
+
ne: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1193
1201
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1194
1202
|
* @param value - Value to compare against.
|
|
1195
1203
|
* @documentationMaturity preview
|
|
@@ -1216,9 +1224,9 @@ interface SectionsQueryBuilder {
|
|
|
1216
1224
|
*/
|
|
1217
1225
|
startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
|
|
1218
1226
|
/** @documentationMaturity preview */
|
|
1219
|
-
in: (propertyName: '_id' | '
|
|
1227
|
+
in: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1220
1228
|
/** @documentationMaturity preview */
|
|
1221
|
-
exists: (propertyName: '_id' | '
|
|
1229
|
+
exists: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
|
|
1222
1230
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1223
1231
|
* @documentationMaturity preview
|
|
1224
1232
|
*/
|
|
@@ -1243,7 +1251,7 @@ interface SectionsQueryBuilder {
|
|
|
1243
1251
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
|
|
1244
1252
|
* @requiredField query
|
|
1245
1253
|
*/
|
|
1246
|
-
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.
|
|
1254
|
+
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1247
1255
|
interface SectionQuerySpec extends QuerySpec {
|
|
1248
1256
|
paging: 'cursor';
|
|
1249
1257
|
wql: [
|
|
@@ -1253,7 +1261,7 @@ interface SectionQuerySpec extends QuerySpec {
|
|
|
1253
1261
|
sort: 'NONE';
|
|
1254
1262
|
},
|
|
1255
1263
|
{
|
|
1256
|
-
fields: ['_id', 'delayInDays', '
|
|
1264
|
+
fields: ['_id', 'delayInDays', 'trialSection'];
|
|
1257
1265
|
operators: '*';
|
|
1258
1266
|
sort: 'BOTH';
|
|
1259
1267
|
},
|
|
@@ -1346,7 +1354,7 @@ declare const utils: {
|
|
|
1346
1354
|
* @applicableIdentity APP
|
|
1347
1355
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.ListSections
|
|
1348
1356
|
*/
|
|
1349
|
-
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.
|
|
1357
|
+
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1350
1358
|
interface ListSectionsOptions {
|
|
1351
1359
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1352
1360
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1368,7 +1376,7 @@ interface ListSectionsOptions {
|
|
|
1368
1376
|
* @applicableIdentity APP
|
|
1369
1377
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CloneSection
|
|
1370
1378
|
*/
|
|
1371
|
-
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.
|
|
1379
|
+
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1372
1380
|
interface CloneSectionOptions {
|
|
1373
1381
|
/**
|
|
1374
1382
|
* Predefined sets of fields to return.
|
|
@@ -1388,7 +1396,7 @@ interface CloneSectionOptions {
|
|
|
1388
1396
|
* @applicableIdentity APP
|
|
1389
1397
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.MoveSection
|
|
1390
1398
|
*/
|
|
1391
|
-
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.
|
|
1399
|
+
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1392
1400
|
interface MoveSectionOptions {
|
|
1393
1401
|
/**
|
|
1394
1402
|
* ID of the section to move.
|
|
@@ -1408,32 +1416,5 @@ interface MoveSectionOptions {
|
|
|
1408
1416
|
*/
|
|
1409
1417
|
fields?: RequestedFieldsWithLiterals[];
|
|
1410
1418
|
}
|
|
1411
|
-
/**
|
|
1412
|
-
* Publishes a section.
|
|
1413
|
-
*
|
|
1414
|
-
* Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when publishing the section. This ensures you're working with the latest section and prevents unintended overwrites.
|
|
1415
|
-
*
|
|
1416
|
-
* Publishing sets the section's `state` to `PUBLISHED`.
|
|
1417
|
-
* @public
|
|
1418
|
-
* @documentationMaturity preview
|
|
1419
|
-
* @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
|
|
1420
|
-
* @applicableIdentity APP
|
|
1421
|
-
* @fqn wix.onlineprograms.sections.v3.SectionsService.PublishSection
|
|
1422
|
-
*/
|
|
1423
|
-
declare function publishSection(options?: PublishSectionOptions): Promise<NonNullablePaths<PublishSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1424
|
-
interface PublishSectionOptions {
|
|
1425
|
-
/**
|
|
1426
|
-
* ID of the section to publish.
|
|
1427
|
-
* @format GUID
|
|
1428
|
-
*/
|
|
1429
|
-
sectionId?: string;
|
|
1430
|
-
/** Current revision of the section. */
|
|
1431
|
-
revision?: string;
|
|
1432
|
-
/**
|
|
1433
|
-
* Predefined sets of fields to return.
|
|
1434
|
-
* @maxSize 1
|
|
1435
|
-
*/
|
|
1436
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
1437
|
-
}
|
|
1438
1419
|
|
|
1439
|
-
export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type
|
|
1420
|
+
export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type PublishSectionRequest, type PublishSectionResponse, type QuerySectionsOptions, type QuerySectionsRequest, type QuerySectionsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RestoreSectionFromTrashRequest, type RestoreSectionFromTrashResponse, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type Section, type SectionCloned, type SectionDeleted, type SectionMoved, type SectionPublished, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateSectionOptions, type UpdateSectionRequest, type UpdateSectionResponse, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, typedQuerySections, updateSection, utils };
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { CreateSectionRequest as CreateSectionRequest$1, CreateSectionResponse as CreateSectionResponse$1, BulkCreateSectionsRequest as BulkCreateSectionsRequest$1, BulkCreateSectionsResponse as BulkCreateSectionsResponse$1, GetSectionRequest as GetSectionRequest$1, GetSectionResponse as GetSectionResponse$1, UpdateSectionRequest as UpdateSectionRequest$1, UpdateSectionResponse as UpdateSectionResponse$1, DeleteSectionRequest as DeleteSectionRequest$1, DeleteSectionResponse as DeleteSectionResponse$1, QuerySectionsRequest as QuerySectionsRequest$1, QuerySectionsResponse as QuerySectionsResponse$1, ListSectionsRequest as ListSectionsRequest$1, ListSectionsResponse as ListSectionsResponse$1, CloneSectionRequest as CloneSectionRequest$1, CloneSectionResponse as CloneSectionResponse$1, MoveSectionRequest as MoveSectionRequest$1, MoveSectionResponse as MoveSectionResponse$1
|
|
1
|
+
import { CreateSectionRequest as CreateSectionRequest$1, CreateSectionResponse as CreateSectionResponse$1, BulkCreateSectionsRequest as BulkCreateSectionsRequest$1, BulkCreateSectionsResponse as BulkCreateSectionsResponse$1, GetSectionRequest as GetSectionRequest$1, GetSectionResponse as GetSectionResponse$1, UpdateSectionRequest as UpdateSectionRequest$1, UpdateSectionResponse as UpdateSectionResponse$1, DeleteSectionRequest as DeleteSectionRequest$1, DeleteSectionResponse as DeleteSectionResponse$1, QuerySectionsRequest as QuerySectionsRequest$1, QuerySectionsResponse as QuerySectionsResponse$1, ListSectionsRequest as ListSectionsRequest$1, ListSectionsResponse as ListSectionsResponse$1, CloneSectionRequest as CloneSectionRequest$1, CloneSectionResponse as CloneSectionResponse$1, MoveSectionRequest as MoveSectionRequest$1, MoveSectionResponse as MoveSectionResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* A section groups related steps within an online program.
|
|
6
6
|
*
|
|
7
|
-
* Sections
|
|
7
|
+
* Sections are published when created, and can be reordered and optionally released after a delay from the start of the parent program.
|
|
8
8
|
*/
|
|
9
9
|
interface Section {
|
|
10
10
|
/**
|
|
@@ -37,7 +37,11 @@ interface Section {
|
|
|
37
37
|
programId?: string;
|
|
38
38
|
/** Section title and deprecated backward-compatibility content fields. */
|
|
39
39
|
description?: Description;
|
|
40
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* @internal
|
|
42
|
+
* @deprecated
|
|
43
|
+
* @targetRemovalDate 2026-09-22
|
|
44
|
+
*/
|
|
41
45
|
state?: StateWithLiterals;
|
|
42
46
|
/**
|
|
43
47
|
* Legacy total number of steps in the section.
|
|
@@ -290,9 +294,9 @@ interface VideoResolution {
|
|
|
290
294
|
assetKey?: string | null;
|
|
291
295
|
}
|
|
292
296
|
declare enum State {
|
|
293
|
-
/**
|
|
297
|
+
/** Retained for backward compatibility. Doesn't affect whether the section is served. */
|
|
294
298
|
DRAFT = "DRAFT",
|
|
295
|
-
/**
|
|
299
|
+
/** Default state for new sections. */
|
|
296
300
|
PUBLISHED = "PUBLISHED"
|
|
297
301
|
}
|
|
298
302
|
/** @enumType */
|
|
@@ -1151,6 +1155,5 @@ declare function cloneSection(): __PublicMethodMetaInfo<'POST', {
|
|
|
1151
1155
|
sectionId: string;
|
|
1152
1156
|
}, CloneSectionRequest$1, CloneSectionRequest, CloneSectionResponse$1, CloneSectionResponse>;
|
|
1153
1157
|
declare function moveSection(): __PublicMethodMetaInfo<'PATCH', {}, MoveSectionRequest$1, MoveSectionRequest, MoveSectionResponse$1, MoveSectionResponse>;
|
|
1154
|
-
declare function publishSection(): __PublicMethodMetaInfo<'PATCH', {}, PublishSectionRequest$1, PublishSectionRequest, PublishSectionResponse$1, PublishSectionResponse>;
|
|
1155
1158
|
|
|
1156
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCloneSectionRequest as BulkCloneSectionRequestOriginal, type BulkCloneSectionResponse as BulkCloneSectionResponseOriginal, type BulkCreateSectionMigrationRequest as BulkCreateSectionMigrationRequestOriginal, type BulkCreateSectionMigrationResponse as BulkCreateSectionMigrationResponseOriginal, type BulkCreateSectionRequest as BulkCreateSectionRequestOriginal, type BulkCreateSectionResponse as BulkCreateSectionResponseOriginal, type BulkCreateSectionsRequest as BulkCreateSectionsRequestOriginal, type BulkCreateSectionsResponse as BulkCreateSectionsResponseOriginal, type BulkSectionResult as BulkSectionResultOriginal, type CloneSectionRequest as CloneSectionRequestOriginal, type CloneSectionResponse as CloneSectionResponseOriginal, type CreateSectionRequest as CreateSectionRequestOriginal, type CreateSectionResponse as CreateSectionResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteAllProgramSectionsRequest as DeleteAllProgramSectionsRequestOriginal, type DeleteAllProgramSectionsResponse as DeleteAllProgramSectionsResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteSectionRequest as DeleteSectionRequestOriginal, type DeleteSectionResponse as DeleteSectionResponseOriginal, DescriptionFieldSet as DescriptionFieldSetOriginal, type DescriptionFieldSetWithLiterals as DescriptionFieldSetWithLiteralsOriginal, type DescriptionMediaOneOf as DescriptionMediaOneOfOriginal, type Description as DescriptionOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FocalPoint as FocalPointOriginal, type GetSectionRequest as GetSectionRequestOriginal, type GetSectionResponse as GetSectionResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IndexDocument as IndexDocumentOriginal, type ItemMetadata as ItemMetadataOriginal, type ListSectionsRequest as ListSectionsRequestOriginal, type ListSectionsResponse as ListSectionsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MoveSectionRequest as MoveSectionRequestOriginal, type MoveSectionResponse as MoveSectionResponseOriginal, type PublishSectionRequest as PublishSectionRequestOriginal, type PublishSectionResponse as PublishSectionResponseOriginal, type QuerySectionsRequest as QuerySectionsRequestOriginal, type QuerySectionsResponse as QuerySectionsResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreSectionFromTrashRequest as RestoreSectionFromTrashRequestOriginal, type RestoreSectionFromTrashResponse as RestoreSectionFromTrashResponseOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal, type SearchIndexingNotificationStateWithLiterals as SearchIndexingNotificationStateWithLiteralsOriginal, type SectionCloned as SectionClonedOriginal, type SectionDeleted as SectionDeletedOriginal, type SectionMoved as SectionMovedOriginal, type Section as SectionOriginal, type SectionPublished as SectionPublishedOriginal, type SectionUpdated as SectionUpdatedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateSectionRequest as UpdateSectionRequestOriginal, type UpdateSectionResponse as UpdateSectionResponseOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection,
|
|
1159
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCloneSectionRequest as BulkCloneSectionRequestOriginal, type BulkCloneSectionResponse as BulkCloneSectionResponseOriginal, type BulkCreateSectionMigrationRequest as BulkCreateSectionMigrationRequestOriginal, type BulkCreateSectionMigrationResponse as BulkCreateSectionMigrationResponseOriginal, type BulkCreateSectionRequest as BulkCreateSectionRequestOriginal, type BulkCreateSectionResponse as BulkCreateSectionResponseOriginal, type BulkCreateSectionsRequest as BulkCreateSectionsRequestOriginal, type BulkCreateSectionsResponse as BulkCreateSectionsResponseOriginal, type BulkSectionResult as BulkSectionResultOriginal, type CloneSectionRequest as CloneSectionRequestOriginal, type CloneSectionResponse as CloneSectionResponseOriginal, type CreateSectionRequest as CreateSectionRequestOriginal, type CreateSectionResponse as CreateSectionResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteAllProgramSectionsRequest as DeleteAllProgramSectionsRequestOriginal, type DeleteAllProgramSectionsResponse as DeleteAllProgramSectionsResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteSectionRequest as DeleteSectionRequestOriginal, type DeleteSectionResponse as DeleteSectionResponseOriginal, DescriptionFieldSet as DescriptionFieldSetOriginal, type DescriptionFieldSetWithLiterals as DescriptionFieldSetWithLiteralsOriginal, type DescriptionMediaOneOf as DescriptionMediaOneOfOriginal, type Description as DescriptionOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FocalPoint as FocalPointOriginal, type GetSectionRequest as GetSectionRequestOriginal, type GetSectionResponse as GetSectionResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IndexDocument as IndexDocumentOriginal, type ItemMetadata as ItemMetadataOriginal, type ListSectionsRequest as ListSectionsRequestOriginal, type ListSectionsResponse as ListSectionsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MoveSectionRequest as MoveSectionRequestOriginal, type MoveSectionResponse as MoveSectionResponseOriginal, type PublishSectionRequest as PublishSectionRequestOriginal, type PublishSectionResponse as PublishSectionResponseOriginal, type QuerySectionsRequest as QuerySectionsRequestOriginal, type QuerySectionsResponse as QuerySectionsResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreSectionFromTrashRequest as RestoreSectionFromTrashRequestOriginal, type RestoreSectionFromTrashResponse as RestoreSectionFromTrashResponseOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal, type SearchIndexingNotificationStateWithLiterals as SearchIndexingNotificationStateWithLiteralsOriginal, type SectionCloned as SectionClonedOriginal, type SectionDeleted as SectionDeletedOriginal, type SectionMoved as SectionMovedOriginal, type Section as SectionOriginal, type SectionPublished as SectionPublishedOriginal, type SectionUpdated as SectionUpdatedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateSectionRequest as UpdateSectionRequestOriginal, type UpdateSectionResponse as UpdateSectionResponseOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, updateSection };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { Section, CreateSectionOptions, BulkCreateSectionsOptions, BulkCreateSectionsResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse,
|
|
3
|
-
export { AccountInfo, ActionEvent, AddressLocation, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionMigrationRequest, BulkCreateSectionMigrationResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DescriptionMediaOneOf, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, ExtendedFields, FocalPoint, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, PublishSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionPublished, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, VideoResolution, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.mjs';
|
|
2
|
+
import { Section, CreateSectionOptions, BulkCreateSectionsOptions, BulkCreateSectionsResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.mjs';
|
|
3
|
+
export { AccountInfo, ActionEvent, AddressLocation, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionMigrationRequest, BulkCreateSectionMigrationResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DescriptionMediaOneOf, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, ExtendedFields, FocalPoint, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, PublishSectionRequest, PublishSectionResponse, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionPublished, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, VideoResolution, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
|
|
6
6
|
interface CreateSectionSignature {
|
|
@@ -13,7 +13,7 @@ interface CreateSectionSignature {
|
|
|
13
13
|
* @param - Section to create. Must include `section.program_id`.
|
|
14
14
|
* @returns Created section.
|
|
15
15
|
*/
|
|
16
|
-
(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
16
|
+
(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
17
17
|
}
|
|
18
18
|
declare function bulkCreateSections$1(httpClient: HttpClient): BulkCreateSectionsSignature;
|
|
19
19
|
interface BulkCreateSectionsSignature {
|
|
@@ -36,7 +36,7 @@ interface GetSectionSignature {
|
|
|
36
36
|
* @param - ID of the Section to retrieve.
|
|
37
37
|
* @returns Retrieved section.
|
|
38
38
|
*/
|
|
39
|
-
(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
39
|
+
(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
40
40
|
}
|
|
41
41
|
declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
|
|
42
42
|
interface UpdateSectionSignature {
|
|
@@ -45,11 +45,11 @@ interface UpdateSectionSignature {
|
|
|
45
45
|
*
|
|
46
46
|
* Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when updating the section. This ensures you're working with the latest section and prevents unintended overwrites.
|
|
47
47
|
*
|
|
48
|
-
* Use this method to update section content and settings. To reorder a section, call [Move Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/move-section).
|
|
48
|
+
* Use this method to update section content and settings. To reorder a section, call [Move Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/move-section).
|
|
49
49
|
* @param - Section ID.
|
|
50
50
|
* @returns Updated section.
|
|
51
51
|
*/
|
|
52
|
-
(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
52
|
+
(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
53
53
|
}
|
|
54
54
|
declare function deleteSection$1(httpClient: HttpClient): DeleteSectionSignature;
|
|
55
55
|
interface DeleteSectionSignature {
|
|
@@ -71,7 +71,7 @@ interface ListSectionsSignature {
|
|
|
71
71
|
* To filter or sort sections, call [Query Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/query-sections).
|
|
72
72
|
* @param - Program ID to list sections for.
|
|
73
73
|
*/
|
|
74
|
-
(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.
|
|
74
|
+
(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
75
75
|
}
|
|
76
76
|
declare function cloneSection$1(httpClient: HttpClient): CloneSectionSignature;
|
|
77
77
|
interface CloneSectionSignature {
|
|
@@ -81,7 +81,7 @@ interface CloneSectionSignature {
|
|
|
81
81
|
* The cloned section is added to the same program after the current last section. Translation content is copied to the cloned section.
|
|
82
82
|
* @param - ID of the section to clone.
|
|
83
83
|
*/
|
|
84
|
-
(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.
|
|
84
|
+
(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
85
85
|
}
|
|
86
86
|
declare function moveSection$1(httpClient: HttpClient): MoveSectionSignature;
|
|
87
87
|
interface MoveSectionSignature {
|
|
@@ -92,18 +92,7 @@ interface MoveSectionSignature {
|
|
|
92
92
|
*
|
|
93
93
|
* If `afterSectionId` isn't specified, the section is moved to the beginning of the program. The stored ordering value is recalculated automatically.
|
|
94
94
|
*/
|
|
95
|
-
(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.
|
|
96
|
-
}
|
|
97
|
-
declare function publishSection$1(httpClient: HttpClient): PublishSectionSignature;
|
|
98
|
-
interface PublishSectionSignature {
|
|
99
|
-
/**
|
|
100
|
-
* Publishes a section.
|
|
101
|
-
*
|
|
102
|
-
* Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when publishing the section. This ensures you're working with the latest section and prevents unintended overwrites.
|
|
103
|
-
*
|
|
104
|
-
* Publishing sets the section's `state` to `PUBLISHED`.
|
|
105
|
-
*/
|
|
106
|
-
(options?: PublishSectionOptions): Promise<NonNullablePaths<PublishSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
95
|
+
(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
107
96
|
}
|
|
108
97
|
|
|
109
98
|
declare function customQuerySections(httpClient: HttpClient): {
|
|
@@ -118,7 +107,6 @@ declare const deleteSection: MaybeContext<BuildRESTFunction<typeof deleteSection
|
|
|
118
107
|
declare const listSections: MaybeContext<BuildRESTFunction<typeof listSections$1> & typeof listSections$1>;
|
|
119
108
|
declare const cloneSection: MaybeContext<BuildRESTFunction<typeof cloneSection$1> & typeof cloneSection$1>;
|
|
120
109
|
declare const moveSection: MaybeContext<BuildRESTFunction<typeof moveSection$1> & typeof moveSection$1>;
|
|
121
|
-
declare const publishSection: MaybeContext<BuildRESTFunction<typeof publishSection$1> & typeof publishSection$1>;
|
|
122
110
|
declare const querySections: MaybeContext<BuildRESTFunction<typeof customQuerySections> & typeof customQuerySections>;
|
|
123
111
|
|
|
124
|
-
export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse,
|
|
112
|
+
export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, QuerySectionsOptions, Section, SectionQuery, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, updateSection };
|
|
@@ -4,7 +4,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
|
|
|
4
4
|
/**
|
|
5
5
|
* A section groups related steps within an online program.
|
|
6
6
|
*
|
|
7
|
-
* Sections
|
|
7
|
+
* Sections are published when created, and can be reordered and optionally released after a delay from the start of the parent program.
|
|
8
8
|
*/
|
|
9
9
|
interface Section {
|
|
10
10
|
/**
|
|
@@ -37,7 +37,11 @@ interface Section {
|
|
|
37
37
|
programId?: string;
|
|
38
38
|
/** Section title and deprecated backward-compatibility content fields. */
|
|
39
39
|
description?: Description;
|
|
40
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* @internal
|
|
42
|
+
* @deprecated
|
|
43
|
+
* @targetRemovalDate 2026-09-22
|
|
44
|
+
*/
|
|
41
45
|
state?: StateWithLiterals;
|
|
42
46
|
/**
|
|
43
47
|
* Legacy total number of steps in the section.
|
|
@@ -180,9 +184,9 @@ interface VideoResolution {
|
|
|
180
184
|
assetKey?: string | null;
|
|
181
185
|
}
|
|
182
186
|
declare enum State {
|
|
183
|
-
/**
|
|
187
|
+
/** Retained for backward compatibility. Doesn't affect whether the section is served. */
|
|
184
188
|
DRAFT = "DRAFT",
|
|
185
|
-
/**
|
|
189
|
+
/** Default state for new sections. */
|
|
186
190
|
PUBLISHED = "PUBLISHED"
|
|
187
191
|
}
|
|
188
192
|
/** @enumType */
|
|
@@ -984,7 +988,7 @@ interface AccountInfo {
|
|
|
984
988
|
* @returns Created section.
|
|
985
989
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
|
|
986
990
|
*/
|
|
987
|
-
declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
991
|
+
declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
988
992
|
interface CreateSectionOptions {
|
|
989
993
|
/**
|
|
990
994
|
* Predefined sets of fields to return.
|
|
@@ -1027,7 +1031,7 @@ interface BulkCreateSectionsOptions {
|
|
|
1027
1031
|
* @returns Retrieved section.
|
|
1028
1032
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
|
|
1029
1033
|
*/
|
|
1030
|
-
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
1034
|
+
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
1031
1035
|
interface GetSectionOptions {
|
|
1032
1036
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1033
1037
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1042,7 +1046,7 @@ interface GetSectionOptions {
|
|
|
1042
1046
|
*
|
|
1043
1047
|
* Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when updating the section. This ensures you're working with the latest section and prevents unintended overwrites.
|
|
1044
1048
|
*
|
|
1045
|
-
* Use this method to update section content and settings. To reorder a section, call [Move Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/move-section).
|
|
1049
|
+
* Use this method to update section content and settings. To reorder a section, call [Move Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/move-section).
|
|
1046
1050
|
* @param _id - Section ID.
|
|
1047
1051
|
* @public
|
|
1048
1052
|
* @documentationMaturity preview
|
|
@@ -1053,7 +1057,7 @@ interface GetSectionOptions {
|
|
|
1053
1057
|
* @returns Updated section.
|
|
1054
1058
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.UpdateSection
|
|
1055
1059
|
*/
|
|
1056
|
-
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `
|
|
1060
|
+
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
1057
1061
|
interface UpdateSectionOptions {
|
|
1058
1062
|
section?: {
|
|
1059
1063
|
/**
|
|
@@ -1086,7 +1090,11 @@ interface UpdateSectionOptions {
|
|
|
1086
1090
|
programId?: string;
|
|
1087
1091
|
/** Section title and deprecated backward-compatibility content fields. */
|
|
1088
1092
|
description?: Description;
|
|
1089
|
-
/**
|
|
1093
|
+
/**
|
|
1094
|
+
* @internal
|
|
1095
|
+
* @deprecated
|
|
1096
|
+
* @targetRemovalDate 2026-09-22
|
|
1097
|
+
*/
|
|
1090
1098
|
state?: StateWithLiterals;
|
|
1091
1099
|
/**
|
|
1092
1100
|
* Legacy total number of steps in the section.
|
|
@@ -1138,8 +1146,8 @@ declare function deleteSection(sectionId: string): Promise<void>;
|
|
|
1138
1146
|
* - `paging.limit` is `1000`.
|
|
1139
1147
|
* - `paging.offset` is `0`.
|
|
1140
1148
|
*
|
|
1141
|
-
* Supported filter fields are `programId`, `id`, `delayInDays`,
|
|
1142
|
-
* Supported sorting fields are `id`, `delayInDays`, `trialSection`, `
|
|
1149
|
+
* Supported filter fields are `programId`, `id`, `delayInDays`, and `trialSection`.
|
|
1150
|
+
* Supported sorting fields are `id`, `delayInDays`, `trialSection`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
|
|
1143
1151
|
* `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
|
|
1144
1152
|
*
|
|
1145
1153
|
* To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
|
|
@@ -1184,12 +1192,12 @@ interface SectionsQueryBuilder {
|
|
|
1184
1192
|
* @param value - Value to compare against.
|
|
1185
1193
|
* @documentationMaturity preview
|
|
1186
1194
|
*/
|
|
1187
|
-
eq: (propertyName: '_id' | 'programId' | '
|
|
1195
|
+
eq: (propertyName: '_id' | 'programId' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1188
1196
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1189
1197
|
* @param value - Value to compare against.
|
|
1190
1198
|
* @documentationMaturity preview
|
|
1191
1199
|
*/
|
|
1192
|
-
ne: (propertyName: '_id' | '
|
|
1200
|
+
ne: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1193
1201
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1194
1202
|
* @param value - Value to compare against.
|
|
1195
1203
|
* @documentationMaturity preview
|
|
@@ -1216,9 +1224,9 @@ interface SectionsQueryBuilder {
|
|
|
1216
1224
|
*/
|
|
1217
1225
|
startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
|
|
1218
1226
|
/** @documentationMaturity preview */
|
|
1219
|
-
in: (propertyName: '_id' | '
|
|
1227
|
+
in: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1220
1228
|
/** @documentationMaturity preview */
|
|
1221
|
-
exists: (propertyName: '_id' | '
|
|
1229
|
+
exists: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
|
|
1222
1230
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1223
1231
|
* @documentationMaturity preview
|
|
1224
1232
|
*/
|
|
@@ -1243,7 +1251,7 @@ interface SectionsQueryBuilder {
|
|
|
1243
1251
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
|
|
1244
1252
|
* @requiredField query
|
|
1245
1253
|
*/
|
|
1246
|
-
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.
|
|
1254
|
+
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1247
1255
|
interface SectionQuerySpec extends QuerySpec {
|
|
1248
1256
|
paging: 'cursor';
|
|
1249
1257
|
wql: [
|
|
@@ -1253,7 +1261,7 @@ interface SectionQuerySpec extends QuerySpec {
|
|
|
1253
1261
|
sort: 'NONE';
|
|
1254
1262
|
},
|
|
1255
1263
|
{
|
|
1256
|
-
fields: ['_id', 'delayInDays', '
|
|
1264
|
+
fields: ['_id', 'delayInDays', 'trialSection'];
|
|
1257
1265
|
operators: '*';
|
|
1258
1266
|
sort: 'BOTH';
|
|
1259
1267
|
},
|
|
@@ -1346,7 +1354,7 @@ declare const utils: {
|
|
|
1346
1354
|
* @applicableIdentity APP
|
|
1347
1355
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.ListSections
|
|
1348
1356
|
*/
|
|
1349
|
-
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.
|
|
1357
|
+
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1350
1358
|
interface ListSectionsOptions {
|
|
1351
1359
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1352
1360
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1368,7 +1376,7 @@ interface ListSectionsOptions {
|
|
|
1368
1376
|
* @applicableIdentity APP
|
|
1369
1377
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CloneSection
|
|
1370
1378
|
*/
|
|
1371
|
-
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.
|
|
1379
|
+
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1372
1380
|
interface CloneSectionOptions {
|
|
1373
1381
|
/**
|
|
1374
1382
|
* Predefined sets of fields to return.
|
|
@@ -1388,7 +1396,7 @@ interface CloneSectionOptions {
|
|
|
1388
1396
|
* @applicableIdentity APP
|
|
1389
1397
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.MoveSection
|
|
1390
1398
|
*/
|
|
1391
|
-
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.
|
|
1399
|
+
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1392
1400
|
interface MoveSectionOptions {
|
|
1393
1401
|
/**
|
|
1394
1402
|
* ID of the section to move.
|
|
@@ -1408,32 +1416,5 @@ interface MoveSectionOptions {
|
|
|
1408
1416
|
*/
|
|
1409
1417
|
fields?: RequestedFieldsWithLiterals[];
|
|
1410
1418
|
}
|
|
1411
|
-
/**
|
|
1412
|
-
* Publishes a section.
|
|
1413
|
-
*
|
|
1414
|
-
* Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when publishing the section. This ensures you're working with the latest section and prevents unintended overwrites.
|
|
1415
|
-
*
|
|
1416
|
-
* Publishing sets the section's `state` to `PUBLISHED`.
|
|
1417
|
-
* @public
|
|
1418
|
-
* @documentationMaturity preview
|
|
1419
|
-
* @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
|
|
1420
|
-
* @applicableIdentity APP
|
|
1421
|
-
* @fqn wix.onlineprograms.sections.v3.SectionsService.PublishSection
|
|
1422
|
-
*/
|
|
1423
|
-
declare function publishSection(options?: PublishSectionOptions): Promise<NonNullablePaths<PublishSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1424
|
-
interface PublishSectionOptions {
|
|
1425
|
-
/**
|
|
1426
|
-
* ID of the section to publish.
|
|
1427
|
-
* @format GUID
|
|
1428
|
-
*/
|
|
1429
|
-
sectionId?: string;
|
|
1430
|
-
/** Current revision of the section. */
|
|
1431
|
-
revision?: string;
|
|
1432
|
-
/**
|
|
1433
|
-
* Predefined sets of fields to return.
|
|
1434
|
-
* @maxSize 1
|
|
1435
|
-
*/
|
|
1436
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
1437
|
-
}
|
|
1438
1419
|
|
|
1439
|
-
export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type
|
|
1420
|
+
export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type PublishSectionRequest, type PublishSectionResponse, type QuerySectionsOptions, type QuerySectionsRequest, type QuerySectionsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RestoreSectionFromTrashRequest, type RestoreSectionFromTrashResponse, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type Section, type SectionCloned, type SectionDeleted, type SectionMoved, type SectionPublished, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateSectionOptions, type UpdateSectionRequest, type UpdateSectionResponse, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, typedQuerySections, updateSection, utils };
|