@wix/auto_sdk_online-programs_sections 1.0.34 → 1.0.36

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.
@@ -1,5 +1,5 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { Section, CreateSectionOptions, BulkCreateSectionsOptions, BulkCreateSectionsResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionUpdatedEnvelope, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.js';
2
+ import { Section, BulkCreateSectionsResponse, UpdateSectionOptions, ListSectionsResponse, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionUpdatedEnvelope, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.js';
3
3
  export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, EventMetadata, ExtendedFields, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
4
4
 
5
5
  declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
@@ -15,7 +15,7 @@ interface CreateSectionSignature {
15
15
  * @param - Section to create. Must include `section.programId`.
16
16
  * @returns Created section.
17
17
  */
18
- (section: NonNullablePaths<Section, `programId`, 0>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
18
+ (section: NonNullablePaths<Section, `programId`, 0>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
19
19
  }
20
20
  declare function bulkCreateSections$1(httpClient: HttpClient): BulkCreateSectionsSignature;
21
21
  interface BulkCreateSectionsSignature {
@@ -29,7 +29,7 @@ interface BulkCreateSectionsSignature {
29
29
  * To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
30
30
  * @param - List of sections to create. Each section must include `programId`, and all sections must belong to the same program.
31
31
  */
32
- (sections: NonNullablePaths<Section, `programId`, 0>[], options?: BulkCreateSectionsOptions): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
32
+ (sections: NonNullablePaths<Section, `programId`, 0>[]): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
33
33
  }
34
34
  declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
35
35
  interface GetSectionSignature {
@@ -38,7 +38,7 @@ interface GetSectionSignature {
38
38
  * @param - ID of the Section to retrieve.
39
39
  * @returns Retrieved section.
40
40
  */
41
- (sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
41
+ (sectionId: string): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
42
42
  }
43
43
  declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
44
44
  interface UpdateSectionSignature {
@@ -75,7 +75,7 @@ interface ListSectionsSignature {
75
75
  * To filter sections, apply custom sorting or paging, or query across programs, call [Query Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/query-sections).
76
76
  * @param - Program ID to list sections for.
77
77
  */
78
- (programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
78
+ (programId: string): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
79
79
  }
80
80
  declare function cloneSection$1(httpClient: HttpClient): CloneSectionSignature;
81
81
  interface CloneSectionSignature {
@@ -91,7 +91,7 @@ interface CloneSectionSignature {
91
91
  * A program can contain up to 1,000 sections. This call fails if cloning the section would exceed that limit.
92
92
  * @param - ID of the section to clone.
93
93
  */
94
- (sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
94
+ (sectionId: string): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
95
95
  }
96
96
  declare function moveSection$1(httpClient: HttpClient): MoveSectionSignature;
97
97
  interface MoveSectionSignature {
@@ -140,4 +140,4 @@ declare const onSectionDeleted: BuildEventDefinition<typeof onSectionDeleted$1>
140
140
  */
141
141
  declare const onSectionUpdated: BuildEventDefinition<typeof onSectionUpdated$1> & typeof onSectionUpdated$1;
142
142
 
143
- export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, QuerySectionsOptions, Section, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionQuery, SectionUpdatedEnvelope, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };
143
+ export { BulkCreateSectionsResponse, CloneSectionResponse, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, QuerySectionsOptions, Section, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionQuery, SectionUpdatedEnvelope, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };
@@ -228,6 +228,7 @@ interface CreateSectionRequest {
228
228
  section: Section;
229
229
  /**
230
230
  * Deprecated: `total_steps` is always returned. This field is ignored.
231
+ * @internal
231
232
  * @maxSize 1
232
233
  * @deprecated
233
234
  * @targetRemovalDate 2026-12-31
@@ -235,11 +236,14 @@ interface CreateSectionRequest {
235
236
  fields?: RequestedFieldsWithLiterals[];
236
237
  }
237
238
  declare enum RequestedFields {
238
- /** return total number of steps in this section. */
239
+ /**
240
+ * return total number of steps in this section.
241
+ * @internal
242
+ */
239
243
  TOTAL_STEPS = "TOTAL_STEPS"
240
244
  }
241
245
  /** @enumType */
242
- type RequestedFieldsWithLiterals = RequestedFields | 'TOTAL_STEPS';
246
+ type RequestedFieldsWithLiterals = RequestedFields;
243
247
  interface CreateSectionResponse {
244
248
  /** Created section. */
245
249
  section?: Section;
@@ -253,6 +257,7 @@ interface BulkCreateSectionsRequest {
253
257
  sections: Section[];
254
258
  /**
255
259
  * Deprecated: This field is ignored.
260
+ * @internal
256
261
  * @maxSize 1
257
262
  * @deprecated
258
263
  * @targetRemovalDate 2026-12-31
@@ -319,6 +324,7 @@ interface BulkCreateSectionRequest {
319
324
  sections?: Section[];
320
325
  /**
321
326
  * Deprecated: This field is ignored.
327
+ * @internal
322
328
  * @maxSize 1
323
329
  * @deprecated
324
330
  * @targetRemovalDate 2026-12-31
@@ -339,12 +345,14 @@ interface GetSectionRequest {
339
345
  sectionId: string;
340
346
  /**
341
347
  * Deprecated: Current section responses always include the section title. This field is ignored.
348
+ * @internal
342
349
  * @deprecated
343
350
  * @targetRemovalDate 2026-12-31
344
351
  */
345
352
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
346
353
  /**
347
354
  * Deprecated: `total_steps` is always returned. This field is ignored.
355
+ * @internal
348
356
  * @maxSize 1
349
357
  * @deprecated
350
358
  * @targetRemovalDate 2026-12-31
@@ -352,13 +360,19 @@ interface GetSectionRequest {
352
360
  fields?: RequestedFieldsWithLiterals[];
353
361
  }
354
362
  declare enum DescriptionFieldSet {
355
- /** Retained for backward compatibility. Current section responses return the section title. */
363
+ /**
364
+ * Retained for backward compatibility. Current section responses return the section title.
365
+ * @internal
366
+ */
356
367
  STANDARD = "STANDARD",
357
- /** Retained for backward compatibility. Current section responses return the section title. */
368
+ /**
369
+ * Retained for backward compatibility. Current section responses return the section title.
370
+ * @internal
371
+ */
358
372
  EXTENDED = "EXTENDED"
359
373
  }
360
374
  /** @enumType */
361
- type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'STANDARD' | 'EXTENDED';
375
+ type DescriptionFieldSetWithLiterals = DescriptionFieldSet;
362
376
  interface GetSectionResponse {
363
377
  /** Retrieved section. */
364
378
  section?: Section;
@@ -373,6 +387,7 @@ interface UpdateSectionRequest {
373
387
  fieldMask?: string[];
374
388
  /**
375
389
  * Deprecated: `total_steps` is always returned. This field is ignored.
390
+ * @internal
376
391
  * @maxSize 1
377
392
  * @deprecated
378
393
  * @targetRemovalDate 2026-12-31
@@ -412,12 +427,14 @@ interface QuerySectionsRequest {
412
427
  query?: CursorQuery;
413
428
  /**
414
429
  * Deprecated: Current section responses always include the section title. This field is ignored.
430
+ * @internal
415
431
  * @deprecated
416
432
  * @targetRemovalDate 2026-12-31
417
433
  */
418
434
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
419
435
  /**
420
436
  * Deprecated: `total_steps` is always returned. This field is ignored.
437
+ * @internal
421
438
  * @maxSize 1
422
439
  * @deprecated
423
440
  * @targetRemovalDate 2026-12-31
@@ -555,12 +572,14 @@ interface ListSectionsRequest {
555
572
  programId: string;
556
573
  /**
557
574
  * Deprecated: Current section responses always include the section title. This field is ignored.
575
+ * @internal
558
576
  * @deprecated
559
577
  * @targetRemovalDate 2026-12-31
560
578
  */
561
579
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
562
580
  /**
563
581
  * Deprecated: `total_steps` is always returned. This field is ignored.
582
+ * @internal
564
583
  * @maxSize 1
565
584
  * @deprecated
566
585
  * @targetRemovalDate 2026-12-31
@@ -582,6 +601,7 @@ interface CloneSectionRequest {
582
601
  sectionId: string;
583
602
  /**
584
603
  * Deprecated: `total_steps` is always returned. This field is ignored.
604
+ * @internal
585
605
  * @maxSize 1
586
606
  * @deprecated
587
607
  * @targetRemovalDate 2026-12-31
@@ -607,6 +627,7 @@ interface MoveSectionRequest {
607
627
  revision?: string;
608
628
  /**
609
629
  * Deprecated: `total_steps` is always returned. This field is ignored.
630
+ * @internal
610
631
  * @maxSize 1
611
632
  * @deprecated
612
633
  * @targetRemovalDate 2026-12-31
@@ -651,6 +672,7 @@ interface RestoreSectionFromTrashRequest {
651
672
  sectionId?: string;
652
673
  /**
653
674
  * Deprecated: `total_steps` is always returned. This field is ignored.
675
+ * @internal
654
676
  * @maxSize 1
655
677
  * @deprecated
656
678
  * @targetRemovalDate 2026-12-31
@@ -974,16 +996,7 @@ declare function onSectionUpdated(handler: (event: SectionUpdatedEnvelope) => vo
974
996
  * @returns Created section.
975
997
  * @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
976
998
  */
977
- declare function createSection(section: NonNullablePaths<Section, `programId`, 0>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
978
- interface CreateSectionOptions {
979
- /**
980
- * Deprecated: `total_steps` is always returned. This field is ignored.
981
- * @maxSize 1
982
- * @deprecated
983
- * @targetRemovalDate 2026-12-31
984
- */
985
- fields?: RequestedFieldsWithLiterals[];
986
- }
999
+ declare function createSection(section: NonNullablePaths<Section, `programId`, 0>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
987
1000
  /**
988
1001
  * Creates up to 100 sections in a single API call.
989
1002
  *
@@ -1001,16 +1014,7 @@ interface CreateSectionOptions {
1001
1014
  * @applicableIdentity APP
1002
1015
  * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
1003
1016
  */
1004
- declare function bulkCreateSections(sections: NonNullablePaths<Section, `programId`, 0>[], options?: BulkCreateSectionsOptions): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
1005
- interface BulkCreateSectionsOptions {
1006
- /**
1007
- * Deprecated: This field is ignored.
1008
- * @maxSize 1
1009
- * @deprecated
1010
- * @targetRemovalDate 2026-12-31
1011
- */
1012
- fields?: RequestedFieldsWithLiterals[];
1013
- }
1017
+ declare function bulkCreateSections(sections: NonNullablePaths<Section, `programId`, 0>[]): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
1014
1018
  /**
1015
1019
  * Retrieves a section.
1016
1020
  * @param sectionId - ID of the Section to retrieve.
@@ -1022,22 +1026,7 @@ interface BulkCreateSectionsOptions {
1022
1026
  * @returns Retrieved section.
1023
1027
  * @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
1024
1028
  */
1025
- declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
1026
- interface GetSectionOptions {
1027
- /**
1028
- * Deprecated: Current section responses always include the section title. This field is ignored.
1029
- * @deprecated
1030
- * @targetRemovalDate 2026-12-31
1031
- */
1032
- descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1033
- /**
1034
- * Deprecated: `total_steps` is always returned. This field is ignored.
1035
- * @maxSize 1
1036
- * @deprecated
1037
- * @targetRemovalDate 2026-12-31
1038
- */
1039
- fields?: RequestedFieldsWithLiterals[];
1040
- }
1029
+ declare function getSection(sectionId: string): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
1041
1030
  /**
1042
1031
  * Updates a section.
1043
1032
  *
@@ -1111,13 +1100,6 @@ interface UpdateSectionOptions {
1111
1100
  /** Custom field data for the section. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. */
1112
1101
  extendedFields?: ExtendedFields;
1113
1102
  };
1114
- /**
1115
- * Deprecated: `total_steps` is always returned. This field is ignored.
1116
- * @maxSize 1
1117
- * @deprecated
1118
- * @targetRemovalDate 2026-12-31
1119
- */
1120
- fields?: RequestedFieldsWithLiterals[];
1121
1103
  }
1122
1104
  /**
1123
1105
  * Permanently deletes a section from the public API.
@@ -1159,17 +1141,19 @@ declare function querySections(options?: QuerySectionsOptions): SectionsQueryBui
1159
1141
  interface QuerySectionsOptions {
1160
1142
  /**
1161
1143
  * Deprecated: Current section responses always include the section title. This field is ignored.
1144
+ * @internal
1162
1145
  * @deprecated
1163
1146
  * @targetRemovalDate 2026-12-31
1164
1147
  */
1165
- descriptionFieldSet?: DescriptionFieldSetWithLiterals | undefined;
1148
+ descriptionFieldSet?: DescriptionFieldSet | undefined;
1166
1149
  /**
1167
1150
  * Deprecated: `total_steps` is always returned. This field is ignored.
1151
+ * @internal
1168
1152
  * @maxSize 1
1169
1153
  * @deprecated
1170
1154
  * @targetRemovalDate 2026-12-31
1171
1155
  */
1172
- fields?: RequestedFieldsWithLiterals[] | undefined;
1156
+ fields?: RequestedFields[] | undefined;
1173
1157
  }
1174
1158
  interface QueryCursorResult {
1175
1159
  cursors: Cursors;
@@ -1353,22 +1337,7 @@ declare const utils: {
1353
1337
  * @applicableIdentity APP
1354
1338
  * @fqn wix.onlineprograms.sections.v3.SectionsService.ListSections
1355
1339
  */
1356
- declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
1357
- interface ListSectionsOptions {
1358
- /**
1359
- * Deprecated: Current section responses always include the section title. This field is ignored.
1360
- * @deprecated
1361
- * @targetRemovalDate 2026-12-31
1362
- */
1363
- descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1364
- /**
1365
- * Deprecated: `total_steps` is always returned. This field is ignored.
1366
- * @maxSize 1
1367
- * @deprecated
1368
- * @targetRemovalDate 2026-12-31
1369
- */
1370
- fields?: RequestedFieldsWithLiterals[];
1371
- }
1340
+ declare function listSections(programId: string): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
1372
1341
  /**
1373
1342
  * Clones a section.
1374
1343
  *
@@ -1387,16 +1356,7 @@ interface ListSectionsOptions {
1387
1356
  * @applicableIdentity APP
1388
1357
  * @fqn wix.onlineprograms.sections.v3.SectionsService.CloneSection
1389
1358
  */
1390
- declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
1391
- interface CloneSectionOptions {
1392
- /**
1393
- * Deprecated: `total_steps` is always returned. This field is ignored.
1394
- * @maxSize 1
1395
- * @deprecated
1396
- * @targetRemovalDate 2026-12-31
1397
- */
1398
- fields?: RequestedFieldsWithLiterals[];
1399
- }
1359
+ declare function cloneSection(sectionId: string): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
1400
1360
  /**
1401
1361
  * Moves a section within its program.
1402
1362
  *
@@ -1420,13 +1380,6 @@ interface MoveSectionOptions {
1420
1380
  afterSectionId?: string | null;
1421
1381
  /** Current revision of the section. When provided, it must match the current revision to protect against conflicting updates. */
1422
1382
  revision?: string;
1423
- /**
1424
- * Deprecated: `total_steps` is always returned. This field is ignored.
1425
- * @maxSize 1
1426
- * @deprecated
1427
- * @targetRemovalDate 2026-12-31
1428
- */
1429
- fields?: RequestedFieldsWithLiterals[];
1430
1383
  }
1431
1384
 
1432
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, 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 DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EventMetadata, type ExtendedFields, 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 QuerySectionsOptions, type QuerySectionsRequest, type QuerySectionsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RestoreSectionFromTrashRequest, type RestoreSectionFromTrashResponse, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type Section, type SectionCloned, type SectionClonedEnvelope, type SectionCreatedEnvelope, type SectionDeleted, type SectionDeletedEnvelope, type SectionMoved, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionUpdatedEnvelope, 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, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, typedQuerySections, updateSection, utils };
1385
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, 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 DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EventMetadata, type ExtendedFields, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, 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 SectionClonedEnvelope, type SectionCreatedEnvelope, type SectionDeleted, type SectionDeletedEnvelope, type SectionMoved, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionUpdatedEnvelope, 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, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, typedQuerySections, updateSection, utils };
@@ -228,6 +228,7 @@ interface CreateSectionRequest {
228
228
  section: Section;
229
229
  /**
230
230
  * Deprecated: `total_steps` is always returned. This field is ignored.
231
+ * @internal
231
232
  * @maxSize 1
232
233
  * @deprecated
233
234
  * @targetRemovalDate 2026-12-31
@@ -235,11 +236,14 @@ interface CreateSectionRequest {
235
236
  fields?: RequestedFieldsWithLiterals[];
236
237
  }
237
238
  declare enum RequestedFields {
238
- /** return total number of steps in this section. */
239
+ /**
240
+ * return total number of steps in this section.
241
+ * @internal
242
+ */
239
243
  TOTAL_STEPS = "TOTAL_STEPS"
240
244
  }
241
245
  /** @enumType */
242
- type RequestedFieldsWithLiterals = RequestedFields | 'TOTAL_STEPS';
246
+ type RequestedFieldsWithLiterals = RequestedFields;
243
247
  interface CreateSectionResponse {
244
248
  /** Created section. */
245
249
  section?: Section;
@@ -253,6 +257,7 @@ interface BulkCreateSectionsRequest {
253
257
  sections: Section[];
254
258
  /**
255
259
  * Deprecated: This field is ignored.
260
+ * @internal
256
261
  * @maxSize 1
257
262
  * @deprecated
258
263
  * @targetRemovalDate 2026-12-31
@@ -319,6 +324,7 @@ interface BulkCreateSectionRequest {
319
324
  sections?: Section[];
320
325
  /**
321
326
  * Deprecated: This field is ignored.
327
+ * @internal
322
328
  * @maxSize 1
323
329
  * @deprecated
324
330
  * @targetRemovalDate 2026-12-31
@@ -339,12 +345,14 @@ interface GetSectionRequest {
339
345
  sectionId: string;
340
346
  /**
341
347
  * Deprecated: Current section responses always include the section title. This field is ignored.
348
+ * @internal
342
349
  * @deprecated
343
350
  * @targetRemovalDate 2026-12-31
344
351
  */
345
352
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
346
353
  /**
347
354
  * Deprecated: `total_steps` is always returned. This field is ignored.
355
+ * @internal
348
356
  * @maxSize 1
349
357
  * @deprecated
350
358
  * @targetRemovalDate 2026-12-31
@@ -352,13 +360,19 @@ interface GetSectionRequest {
352
360
  fields?: RequestedFieldsWithLiterals[];
353
361
  }
354
362
  declare enum DescriptionFieldSet {
355
- /** Retained for backward compatibility. Current section responses return the section title. */
363
+ /**
364
+ * Retained for backward compatibility. Current section responses return the section title.
365
+ * @internal
366
+ */
356
367
  STANDARD = "STANDARD",
357
- /** Retained for backward compatibility. Current section responses return the section title. */
368
+ /**
369
+ * Retained for backward compatibility. Current section responses return the section title.
370
+ * @internal
371
+ */
358
372
  EXTENDED = "EXTENDED"
359
373
  }
360
374
  /** @enumType */
361
- type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'STANDARD' | 'EXTENDED';
375
+ type DescriptionFieldSetWithLiterals = DescriptionFieldSet;
362
376
  interface GetSectionResponse {
363
377
  /** Retrieved section. */
364
378
  section?: Section;
@@ -373,6 +387,7 @@ interface UpdateSectionRequest {
373
387
  fieldMask?: string[];
374
388
  /**
375
389
  * Deprecated: `total_steps` is always returned. This field is ignored.
390
+ * @internal
376
391
  * @maxSize 1
377
392
  * @deprecated
378
393
  * @targetRemovalDate 2026-12-31
@@ -412,12 +427,14 @@ interface QuerySectionsRequest {
412
427
  query?: CursorQuery;
413
428
  /**
414
429
  * Deprecated: Current section responses always include the section title. This field is ignored.
430
+ * @internal
415
431
  * @deprecated
416
432
  * @targetRemovalDate 2026-12-31
417
433
  */
418
434
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
419
435
  /**
420
436
  * Deprecated: `total_steps` is always returned. This field is ignored.
437
+ * @internal
421
438
  * @maxSize 1
422
439
  * @deprecated
423
440
  * @targetRemovalDate 2026-12-31
@@ -555,12 +572,14 @@ interface ListSectionsRequest {
555
572
  programId: string;
556
573
  /**
557
574
  * Deprecated: Current section responses always include the section title. This field is ignored.
575
+ * @internal
558
576
  * @deprecated
559
577
  * @targetRemovalDate 2026-12-31
560
578
  */
561
579
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
562
580
  /**
563
581
  * Deprecated: `total_steps` is always returned. This field is ignored.
582
+ * @internal
564
583
  * @maxSize 1
565
584
  * @deprecated
566
585
  * @targetRemovalDate 2026-12-31
@@ -582,6 +601,7 @@ interface CloneSectionRequest {
582
601
  sectionId: string;
583
602
  /**
584
603
  * Deprecated: `total_steps` is always returned. This field is ignored.
604
+ * @internal
585
605
  * @maxSize 1
586
606
  * @deprecated
587
607
  * @targetRemovalDate 2026-12-31
@@ -607,6 +627,7 @@ interface MoveSectionRequest {
607
627
  revision?: string;
608
628
  /**
609
629
  * Deprecated: `total_steps` is always returned. This field is ignored.
630
+ * @internal
610
631
  * @maxSize 1
611
632
  * @deprecated
612
633
  * @targetRemovalDate 2026-12-31
@@ -651,6 +672,7 @@ interface RestoreSectionFromTrashRequest {
651
672
  sectionId?: string;
652
673
  /**
653
674
  * Deprecated: `total_steps` is always returned. This field is ignored.
675
+ * @internal
654
676
  * @maxSize 1
655
677
  * @deprecated
656
678
  * @targetRemovalDate 2026-12-31
@@ -1,5 +1,5 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { Section, CreateSectionOptions, BulkCreateSectionsOptions, BulkCreateSectionsResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionUpdatedEnvelope, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.mjs';
2
+ import { Section, BulkCreateSectionsResponse, UpdateSectionOptions, ListSectionsResponse, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionUpdatedEnvelope, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.mjs';
3
3
  export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, EventMetadata, ExtendedFields, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.mjs';
4
4
 
5
5
  declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
@@ -15,7 +15,7 @@ interface CreateSectionSignature {
15
15
  * @param - Section to create. Must include `section.programId`.
16
16
  * @returns Created section.
17
17
  */
18
- (section: NonNullablePaths<Section, `programId`, 0>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
18
+ (section: NonNullablePaths<Section, `programId`, 0>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
19
19
  }
20
20
  declare function bulkCreateSections$1(httpClient: HttpClient): BulkCreateSectionsSignature;
21
21
  interface BulkCreateSectionsSignature {
@@ -29,7 +29,7 @@ interface BulkCreateSectionsSignature {
29
29
  * To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
30
30
  * @param - List of sections to create. Each section must include `programId`, and all sections must belong to the same program.
31
31
  */
32
- (sections: NonNullablePaths<Section, `programId`, 0>[], options?: BulkCreateSectionsOptions): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
32
+ (sections: NonNullablePaths<Section, `programId`, 0>[]): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
33
33
  }
34
34
  declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
35
35
  interface GetSectionSignature {
@@ -38,7 +38,7 @@ interface GetSectionSignature {
38
38
  * @param - ID of the Section to retrieve.
39
39
  * @returns Retrieved section.
40
40
  */
41
- (sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
41
+ (sectionId: string): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
42
42
  }
43
43
  declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
44
44
  interface UpdateSectionSignature {
@@ -75,7 +75,7 @@ interface ListSectionsSignature {
75
75
  * To filter sections, apply custom sorting or paging, or query across programs, call [Query Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/query-sections).
76
76
  * @param - Program ID to list sections for.
77
77
  */
78
- (programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
78
+ (programId: string): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
79
79
  }
80
80
  declare function cloneSection$1(httpClient: HttpClient): CloneSectionSignature;
81
81
  interface CloneSectionSignature {
@@ -91,7 +91,7 @@ interface CloneSectionSignature {
91
91
  * A program can contain up to 1,000 sections. This call fails if cloning the section would exceed that limit.
92
92
  * @param - ID of the section to clone.
93
93
  */
94
- (sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
94
+ (sectionId: string): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
95
95
  }
96
96
  declare function moveSection$1(httpClient: HttpClient): MoveSectionSignature;
97
97
  interface MoveSectionSignature {
@@ -140,4 +140,4 @@ declare const onSectionDeleted: BuildEventDefinition<typeof onSectionDeleted$1>
140
140
  */
141
141
  declare const onSectionUpdated: BuildEventDefinition<typeof onSectionUpdated$1> & typeof onSectionUpdated$1;
142
142
 
143
- export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, QuerySectionsOptions, Section, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionQuery, SectionUpdatedEnvelope, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };
143
+ export { BulkCreateSectionsResponse, CloneSectionResponse, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, QuerySectionsOptions, Section, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionQuery, SectionUpdatedEnvelope, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };