@wix/auto_sdk_online-programs_sections 1.0.13 → 1.0.15
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 +61 -31
- package/build/cjs/index.js +47 -26
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +220 -120
- package/build/cjs/index.typings.js +41 -21
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +117 -72
- package/build/cjs/meta.js +35 -18
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +14 -5
- package/build/cjs/schemas.js +335 -212
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +61 -31
- package/build/es/index.mjs +46 -25
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +220 -120
- package/build/es/index.typings.mjs +40 -20
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +117 -72
- package/build/es/meta.mjs +34 -17
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +14 -5
- package/build/es/schemas.mjs +333 -210
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +61 -31
- package/build/internal/cjs/index.js +47 -26
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +220 -120
- package/build/internal/cjs/index.typings.js +41 -21
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +117 -72
- package/build/internal/cjs/meta.js +35 -18
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +14 -5
- package/build/internal/cjs/schemas.js +335 -212
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +61 -31
- package/build/internal/es/index.mjs +46 -25
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +220 -120
- package/build/internal/es/index.typings.mjs +40 -20
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +117 -72
- package/build/internal/es/meta.mjs +34 -17
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +14 -5
- package/build/internal/es/schemas.mjs +333 -210
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,58 +1,64 @@
|
|
|
1
1
|
import * as _wix_sdk_types from '@wix/sdk-types';
|
|
2
2
|
import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
|
|
3
3
|
|
|
4
|
+
/**
|
|
5
|
+
* A section groups related steps within an online program.
|
|
6
|
+
*
|
|
7
|
+
* Sections can be drafted, published, reordered, and optionally released after a delay from the start of the parent program.
|
|
8
|
+
*/
|
|
4
9
|
interface Section {
|
|
5
10
|
/**
|
|
6
|
-
*
|
|
11
|
+
* Section ID.
|
|
7
12
|
* @format GUID
|
|
8
13
|
* @readonly
|
|
9
14
|
*/
|
|
10
15
|
_id?: string | null;
|
|
11
16
|
/**
|
|
12
|
-
*
|
|
17
|
+
* Revision number, which increments by 1 each time the section is updated. To prevent conflicting changes, the current `revision` must be passed when updating or publishing the section.
|
|
13
18
|
* @readonly
|
|
14
19
|
*/
|
|
15
20
|
revision?: string | null;
|
|
16
21
|
/**
|
|
17
|
-
*
|
|
22
|
+
* Date and time the section was created.
|
|
18
23
|
* @readonly
|
|
19
24
|
*/
|
|
20
25
|
_createdDate?: Date | null;
|
|
21
26
|
/**
|
|
22
|
-
*
|
|
27
|
+
* Date and time the section was last updated.
|
|
23
28
|
* @readonly
|
|
24
29
|
*/
|
|
25
30
|
_updatedDate?: Date | null;
|
|
26
31
|
/**
|
|
27
|
-
* Program
|
|
32
|
+
* Program ID of the parent program. Provide it when creating a section. After creation, this value can't be changed.
|
|
28
33
|
* @format GUID
|
|
29
34
|
* @readonly
|
|
35
|
+
* @immutable
|
|
30
36
|
*/
|
|
31
37
|
programId?: string;
|
|
32
|
-
/** title
|
|
38
|
+
/** Section title and deprecated backward-compatibility content fields. */
|
|
33
39
|
description?: Description;
|
|
34
|
-
/**
|
|
40
|
+
/** Publication state of the section. */
|
|
35
41
|
state?: StateWithLiterals;
|
|
36
42
|
/**
|
|
37
|
-
* number of
|
|
43
|
+
* Legacy total number of steps in the section.
|
|
38
44
|
* @readonly
|
|
39
45
|
*/
|
|
40
46
|
oldTotalSteps?: number;
|
|
41
47
|
/**
|
|
42
|
-
* number of
|
|
48
|
+
* Total number of steps in the section.
|
|
43
49
|
* @readonly
|
|
44
50
|
*/
|
|
45
51
|
totalSteps?: number | null;
|
|
46
|
-
/**
|
|
52
|
+
/** Whether participants can access the section as trial content before purchasing the parent program. */
|
|
47
53
|
trialSection?: boolean;
|
|
48
|
-
/**
|
|
54
|
+
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
49
55
|
ordering?: number;
|
|
50
56
|
/**
|
|
51
|
-
*
|
|
57
|
+
* Number of days after the parent program starts before the section becomes available. Use `0` to make the section available immediately.
|
|
52
58
|
* @max 5000
|
|
53
59
|
*/
|
|
54
60
|
delayInDays?: number;
|
|
55
|
-
/**
|
|
61
|
+
/** Custom field data for the section. */
|
|
56
62
|
extendedFields?: ExtendedFields;
|
|
57
63
|
}
|
|
58
64
|
interface Description extends DescriptionMediaOneOf {
|
|
@@ -68,7 +74,11 @@ interface Description extends DescriptionMediaOneOf {
|
|
|
68
74
|
video?: string;
|
|
69
75
|
/** @maxLength 500 */
|
|
70
76
|
title?: string;
|
|
71
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* @maxLength 10000000
|
|
79
|
+
* @deprecated
|
|
80
|
+
* @targetRemovalDate 2026-06-25
|
|
81
|
+
*/
|
|
72
82
|
details?: string | null;
|
|
73
83
|
}
|
|
74
84
|
/** @oneof */
|
|
@@ -234,40 +244,43 @@ interface UpdateExistingOperation {
|
|
|
234
244
|
/** documents to update */
|
|
235
245
|
documents?: IndexDocument[];
|
|
236
246
|
}
|
|
247
|
+
/** Payload for the Section Updated event. */
|
|
237
248
|
interface SectionUpdated {
|
|
238
|
-
/** Section before update. */
|
|
249
|
+
/** Section before the update. */
|
|
239
250
|
previous?: Section;
|
|
240
|
-
/** Section after update. */
|
|
251
|
+
/** Section after the update. */
|
|
241
252
|
current?: Section;
|
|
242
253
|
}
|
|
254
|
+
/** Payload for the Section Deleted event. */
|
|
243
255
|
interface SectionDeleted {
|
|
244
|
-
/**
|
|
256
|
+
/** Section that was deleted. */
|
|
245
257
|
section?: Section;
|
|
246
258
|
}
|
|
259
|
+
/** Payload for the Section Cloned event. */
|
|
247
260
|
interface SectionCloned {
|
|
248
|
-
/**
|
|
261
|
+
/** Source section used for cloning. */
|
|
249
262
|
prototype?: Section;
|
|
250
|
-
/**
|
|
263
|
+
/** Cloned section. */
|
|
251
264
|
cloned?: Section;
|
|
252
265
|
}
|
|
253
266
|
interface SectionMoved {
|
|
254
267
|
/**
|
|
255
|
-
*
|
|
268
|
+
* ID of the moved section.
|
|
256
269
|
* @format GUID
|
|
257
270
|
*/
|
|
258
271
|
sectionId?: string;
|
|
259
|
-
/** section
|
|
272
|
+
/** New ordering rank assigned to the moved section. */
|
|
260
273
|
newSectionPositionRank?: number;
|
|
261
274
|
}
|
|
262
275
|
interface SectionPublished {
|
|
263
276
|
/**
|
|
264
|
-
*
|
|
277
|
+
* ID of the published section.
|
|
265
278
|
* @format GUID
|
|
266
279
|
*/
|
|
267
280
|
sectionId?: string;
|
|
268
281
|
}
|
|
269
282
|
interface CreateSectionRequest {
|
|
270
|
-
/** Section to
|
|
283
|
+
/** Section to create. Must include `section.program_id`. */
|
|
271
284
|
section: Section;
|
|
272
285
|
/**
|
|
273
286
|
* Predefined sets of fields to return.
|
|
@@ -282,12 +295,12 @@ declare enum RequestedFields {
|
|
|
282
295
|
/** @enumType */
|
|
283
296
|
type RequestedFieldsWithLiterals = RequestedFields | 'TOTAL_STEPS';
|
|
284
297
|
interface CreateSectionResponse {
|
|
285
|
-
/**
|
|
298
|
+
/** Created section. */
|
|
286
299
|
section?: Section;
|
|
287
300
|
}
|
|
288
|
-
interface
|
|
301
|
+
interface BulkCreateSectionsRequest {
|
|
289
302
|
/**
|
|
290
|
-
* List of sections
|
|
303
|
+
* List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
|
|
291
304
|
* @minSize 1
|
|
292
305
|
* @maxSize 100
|
|
293
306
|
*/
|
|
@@ -298,18 +311,18 @@ interface BulkCreateSectionRequest {
|
|
|
298
311
|
*/
|
|
299
312
|
fields?: RequestedFieldsWithLiterals[];
|
|
300
313
|
}
|
|
301
|
-
interface
|
|
302
|
-
/** bulk
|
|
314
|
+
interface BulkCreateSectionsResponse {
|
|
315
|
+
/** Results for the bulk create operation. */
|
|
303
316
|
results?: BulkSectionResult[];
|
|
304
|
-
/** bulk
|
|
317
|
+
/** Summary of the bulk create operation. */
|
|
305
318
|
bulkActionMetadata?: BulkActionMetadata;
|
|
306
319
|
}
|
|
307
320
|
interface BulkSectionResult {
|
|
308
|
-
/**
|
|
321
|
+
/** Metadata for the bulk operation result. */
|
|
309
322
|
itemMetadata?: ItemMetadata;
|
|
310
|
-
/**
|
|
323
|
+
/** Created section. */
|
|
311
324
|
item?: Section;
|
|
312
|
-
/**
|
|
325
|
+
/** Action associated with the bulk result. */
|
|
313
326
|
action?: BulkActionTypeWithLiterals;
|
|
314
327
|
}
|
|
315
328
|
interface ItemMetadata {
|
|
@@ -346,18 +359,37 @@ interface BulkActionMetadata {
|
|
|
346
359
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
347
360
|
undetailedFailures?: number;
|
|
348
361
|
}
|
|
349
|
-
interface
|
|
362
|
+
interface BulkCreateSectionRequest {
|
|
350
363
|
/**
|
|
351
|
-
* List of sections
|
|
364
|
+
* List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
|
|
352
365
|
* @minSize 1
|
|
353
366
|
* @maxSize 100
|
|
354
367
|
*/
|
|
355
368
|
sections: Section[];
|
|
369
|
+
/**
|
|
370
|
+
* Predefined sets of fields to return.
|
|
371
|
+
* @maxSize 1
|
|
372
|
+
*/
|
|
373
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
374
|
+
}
|
|
375
|
+
interface BulkCreateSectionResponse {
|
|
376
|
+
/** Results for the bulk create operation. */
|
|
377
|
+
results?: BulkSectionResult[];
|
|
378
|
+
/** Summary of the bulk create operation. */
|
|
379
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
380
|
+
}
|
|
381
|
+
interface BulkCreateSectionMigrationRequest {
|
|
382
|
+
/**
|
|
383
|
+
* List of sections to create.
|
|
384
|
+
* @minSize 1
|
|
385
|
+
* @maxSize 100
|
|
386
|
+
*/
|
|
387
|
+
sections?: Section[];
|
|
356
388
|
}
|
|
357
389
|
interface BulkCreateSectionMigrationResponse {
|
|
358
|
-
/** bulk
|
|
390
|
+
/** Results for the bulk create operation. */
|
|
359
391
|
results?: BulkSectionResult[];
|
|
360
|
-
/** bulk
|
|
392
|
+
/** Summary of the bulk create operation. */
|
|
361
393
|
bulkActionMetadata?: BulkActionMetadata;
|
|
362
394
|
}
|
|
363
395
|
interface GetSectionRequest {
|
|
@@ -366,7 +398,7 @@ interface GetSectionRequest {
|
|
|
366
398
|
* @format GUID
|
|
367
399
|
*/
|
|
368
400
|
sectionId: string;
|
|
369
|
-
/**
|
|
401
|
+
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
370
402
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
371
403
|
/**
|
|
372
404
|
* Predefined sets of fields to return.
|
|
@@ -375,17 +407,19 @@ interface GetSectionRequest {
|
|
|
375
407
|
fields?: RequestedFieldsWithLiterals[];
|
|
376
408
|
}
|
|
377
409
|
declare enum DescriptionFieldSet {
|
|
410
|
+
/** Retained for backward compatibility. Current section responses return the section title. */
|
|
378
411
|
STANDARD = "STANDARD",
|
|
412
|
+
/** Retained for backward compatibility. Current section responses return the section title. */
|
|
379
413
|
EXTENDED = "EXTENDED"
|
|
380
414
|
}
|
|
381
415
|
/** @enumType */
|
|
382
416
|
type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'STANDARD' | 'EXTENDED';
|
|
383
417
|
interface GetSectionResponse {
|
|
384
|
-
/**
|
|
418
|
+
/** Retrieved section. */
|
|
385
419
|
section?: Section;
|
|
386
420
|
}
|
|
387
421
|
interface UpdateSectionRequest {
|
|
388
|
-
/** Section to
|
|
422
|
+
/** Section to update. Include `section.id`, `section.revision`, and the fields to update. */
|
|
389
423
|
section?: Section;
|
|
390
424
|
/**
|
|
391
425
|
* Predefined sets of fields to return.
|
|
@@ -394,12 +428,12 @@ interface UpdateSectionRequest {
|
|
|
394
428
|
fields?: RequestedFieldsWithLiterals[];
|
|
395
429
|
}
|
|
396
430
|
interface UpdateSectionResponse {
|
|
397
|
-
/** Updated
|
|
431
|
+
/** Updated section. */
|
|
398
432
|
section?: Section;
|
|
399
433
|
}
|
|
400
434
|
interface DeleteSectionRequest {
|
|
401
435
|
/**
|
|
402
|
-
*
|
|
436
|
+
* ID of the section to delete.
|
|
403
437
|
* @format GUID
|
|
404
438
|
*/
|
|
405
439
|
sectionId: string;
|
|
@@ -408,26 +442,26 @@ interface DeleteSectionResponse {
|
|
|
408
442
|
}
|
|
409
443
|
interface DeleteAllProgramSectionsRequest {
|
|
410
444
|
/**
|
|
411
|
-
* Program
|
|
445
|
+
* Program ID to delete sections from.
|
|
412
446
|
* @format GUID
|
|
413
447
|
*/
|
|
414
448
|
programId?: string;
|
|
415
449
|
}
|
|
416
450
|
interface DeleteAllProgramSectionsResponse {
|
|
417
|
-
/** Total
|
|
451
|
+
/** Total number of sections in the program. */
|
|
418
452
|
sectionsTotal?: number;
|
|
419
|
-
/**
|
|
453
|
+
/** Number of sections that were deleted successfully. */
|
|
420
454
|
successfulCount?: number;
|
|
421
|
-
/**
|
|
455
|
+
/** Number of sections that couldn't be deleted. */
|
|
422
456
|
failedCount?: number;
|
|
423
457
|
}
|
|
424
458
|
interface QuerySectionsRequest {
|
|
425
459
|
/** WQL expression. */
|
|
426
460
|
query?: CursorQuery;
|
|
427
|
-
/**
|
|
461
|
+
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
428
462
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
429
463
|
/**
|
|
430
|
-
* Program
|
|
464
|
+
* Deprecated. Program ID used to scope the query. Use `query.filter` instead.
|
|
431
465
|
* @deprecated
|
|
432
466
|
* @replacedBy wix.common.CursorQuery
|
|
433
467
|
* @targetRemovalDate 2026-06-30
|
|
@@ -477,6 +511,11 @@ interface Sorting {
|
|
|
477
511
|
fieldName?: string;
|
|
478
512
|
/** Sort order. */
|
|
479
513
|
order?: SortOrderWithLiterals;
|
|
514
|
+
/**
|
|
515
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
516
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
517
|
+
*/
|
|
518
|
+
origin?: AddressLocation;
|
|
480
519
|
}
|
|
481
520
|
declare enum SortOrder {
|
|
482
521
|
ASC = "ASC",
|
|
@@ -484,6 +523,12 @@ declare enum SortOrder {
|
|
|
484
523
|
}
|
|
485
524
|
/** @enumType */
|
|
486
525
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
526
|
+
interface AddressLocation {
|
|
527
|
+
/** Address latitude. */
|
|
528
|
+
latitude?: number | null;
|
|
529
|
+
/** Address longitude. */
|
|
530
|
+
longitude?: number | null;
|
|
531
|
+
}
|
|
487
532
|
interface CursorPaging {
|
|
488
533
|
/**
|
|
489
534
|
* Maximum number of items to return in the results.
|
|
@@ -500,9 +545,9 @@ interface CursorPaging {
|
|
|
500
545
|
cursor?: string | null;
|
|
501
546
|
}
|
|
502
547
|
interface QuerySectionsResponse {
|
|
503
|
-
/**
|
|
548
|
+
/** Matching sections. */
|
|
504
549
|
sections?: Section[];
|
|
505
|
-
/** Paging metadata */
|
|
550
|
+
/** Paging metadata. */
|
|
506
551
|
pagingMetadata?: CursorPagingMetadata;
|
|
507
552
|
}
|
|
508
553
|
interface CursorPagingMetadata {
|
|
@@ -532,11 +577,11 @@ interface Cursors {
|
|
|
532
577
|
}
|
|
533
578
|
interface ListSectionsRequest {
|
|
534
579
|
/**
|
|
535
|
-
* Program
|
|
580
|
+
* Program ID to list sections for.
|
|
536
581
|
* @format GUID
|
|
537
582
|
*/
|
|
538
583
|
programId: string;
|
|
539
|
-
/**
|
|
584
|
+
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
540
585
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
541
586
|
/**
|
|
542
587
|
* Predefined sets of fields to return.
|
|
@@ -546,14 +591,14 @@ interface ListSectionsRequest {
|
|
|
546
591
|
}
|
|
547
592
|
interface ListSectionsResponse {
|
|
548
593
|
/**
|
|
549
|
-
*
|
|
594
|
+
* Sections in the requested program.
|
|
550
595
|
* @maxSize 1000
|
|
551
596
|
*/
|
|
552
597
|
sections?: Section[];
|
|
553
598
|
}
|
|
554
599
|
interface CloneSectionRequest {
|
|
555
600
|
/**
|
|
556
|
-
*
|
|
601
|
+
* ID of the section to clone.
|
|
557
602
|
* @format GUID
|
|
558
603
|
*/
|
|
559
604
|
sectionId: string;
|
|
@@ -564,21 +609,21 @@ interface CloneSectionRequest {
|
|
|
564
609
|
fields?: RequestedFieldsWithLiterals[];
|
|
565
610
|
}
|
|
566
611
|
interface CloneSectionResponse {
|
|
567
|
-
/**
|
|
612
|
+
/** Cloned section. */
|
|
568
613
|
section?: Section;
|
|
569
614
|
}
|
|
570
615
|
interface MoveSectionRequest {
|
|
571
616
|
/**
|
|
572
|
-
*
|
|
617
|
+
* ID of the section to move.
|
|
573
618
|
* @format GUID
|
|
574
619
|
*/
|
|
575
620
|
sectionId?: string;
|
|
576
621
|
/**
|
|
577
|
-
*
|
|
622
|
+
* ID of the section that the moved section should be placed after. Leave empty to move the section to the beginning of the program.
|
|
578
623
|
* @format GUID
|
|
579
624
|
*/
|
|
580
625
|
afterSectionId?: string | null;
|
|
581
|
-
/**
|
|
626
|
+
/** Current revision of the section. */
|
|
582
627
|
revision?: string;
|
|
583
628
|
/**
|
|
584
629
|
* Predefined sets of fields to return.
|
|
@@ -587,16 +632,16 @@ interface MoveSectionRequest {
|
|
|
587
632
|
fields?: RequestedFieldsWithLiterals[];
|
|
588
633
|
}
|
|
589
634
|
interface MoveSectionResponse {
|
|
590
|
-
/**
|
|
635
|
+
/** Moved section. */
|
|
591
636
|
section?: Section;
|
|
592
637
|
}
|
|
593
638
|
interface PublishSectionRequest {
|
|
594
639
|
/**
|
|
595
|
-
*
|
|
640
|
+
* ID of the section to publish.
|
|
596
641
|
* @format GUID
|
|
597
642
|
*/
|
|
598
643
|
sectionId?: string;
|
|
599
|
-
/**
|
|
644
|
+
/** Current revision of the section. */
|
|
600
645
|
revision?: string;
|
|
601
646
|
/**
|
|
602
647
|
* Predefined sets of fields to return.
|
|
@@ -605,38 +650,38 @@ interface PublishSectionRequest {
|
|
|
605
650
|
fields?: RequestedFieldsWithLiterals[];
|
|
606
651
|
}
|
|
607
652
|
interface PublishSectionResponse {
|
|
608
|
-
/** Published section */
|
|
653
|
+
/** Published section. */
|
|
609
654
|
section?: Section;
|
|
610
655
|
}
|
|
611
656
|
interface BulkCloneSectionRequest {
|
|
612
657
|
/**
|
|
613
|
-
*
|
|
658
|
+
* ID of the program that was cloned.
|
|
614
659
|
* @format GUID
|
|
615
660
|
*/
|
|
616
661
|
prototypeProgramId?: string;
|
|
617
662
|
/**
|
|
618
|
-
*
|
|
663
|
+
* ID of the program created by the clone operation.
|
|
619
664
|
* @format GUID
|
|
620
665
|
*/
|
|
621
666
|
clonedProgramId?: string;
|
|
622
667
|
}
|
|
623
668
|
interface BulkCloneSectionResponse {
|
|
624
669
|
/**
|
|
625
|
-
*
|
|
670
|
+
* ID of the program that was cloned.
|
|
626
671
|
* @format GUID
|
|
627
672
|
*/
|
|
628
673
|
prototypeProgramId?: string;
|
|
629
674
|
/**
|
|
630
|
-
*
|
|
675
|
+
* ID of the program created by the clone operation.
|
|
631
676
|
* @format GUID
|
|
632
677
|
*/
|
|
633
678
|
clonedProgramId?: string;
|
|
634
|
-
/**
|
|
679
|
+
/** Mapping from original section IDs to cloned section IDs. */
|
|
635
680
|
prototypeIdToClonedId?: Record<string, string>;
|
|
636
681
|
}
|
|
637
682
|
interface RestoreSectionFromTrashRequest {
|
|
638
683
|
/**
|
|
639
|
-
* section
|
|
684
|
+
* ID of the section to restore.
|
|
640
685
|
* @format GUID
|
|
641
686
|
*/
|
|
642
687
|
sectionId?: string;
|
|
@@ -647,7 +692,7 @@ interface RestoreSectionFromTrashRequest {
|
|
|
647
692
|
fields?: RequestedFieldsWithLiterals[];
|
|
648
693
|
}
|
|
649
694
|
interface RestoreSectionFromTrashResponse {
|
|
650
|
-
/**
|
|
695
|
+
/** Restored section. */
|
|
651
696
|
section?: Section;
|
|
652
697
|
}
|
|
653
698
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -679,7 +724,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
679
724
|
/** If present, indicates the action that triggered the event. */
|
|
680
725
|
originatedFrom?: string | null;
|
|
681
726
|
/**
|
|
682
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01
|
|
727
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
683
728
|
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
684
729
|
*/
|
|
685
730
|
entityEventSequence?: string | null;
|
|
@@ -829,14 +874,18 @@ interface AccountInfo {
|
|
|
829
874
|
siteId?: string | null;
|
|
830
875
|
}
|
|
831
876
|
/**
|
|
832
|
-
* Creates a
|
|
833
|
-
*
|
|
877
|
+
* Creates a section.
|
|
878
|
+
*
|
|
879
|
+
* The section is added to the program identified by `section.program_id`. Provide that program ID in the request. Set `section.description.title` for the section title. `section.description.details`, `section.description.image`, and `section.description.video` are deprecated backward-compatibility fields. The stored ordering value is assigned automatically.
|
|
880
|
+
*
|
|
881
|
+
* To create multiple sections in a single API call, call [Bulk Create Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/bulk-create-sections).
|
|
882
|
+
* @param section - Section to create. Must include `section.program_id`.
|
|
834
883
|
* @public
|
|
835
884
|
* @documentationMaturity preview
|
|
836
885
|
* @requiredField section
|
|
837
886
|
* @permissionId ONLINE_PROGRAMS.SECTION_CREATE
|
|
838
887
|
* @applicableIdentity APP
|
|
839
|
-
* @returns
|
|
888
|
+
* @returns Created section.
|
|
840
889
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
|
|
841
890
|
*/
|
|
842
891
|
declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
@@ -848,17 +897,21 @@ interface CreateSectionOptions {
|
|
|
848
897
|
fields?: RequestedFieldsWithLiterals[];
|
|
849
898
|
}
|
|
850
899
|
/**
|
|
851
|
-
*
|
|
852
|
-
*
|
|
900
|
+
* Creates up to 100 sections in a single API call.
|
|
901
|
+
*
|
|
902
|
+
* All sections in the request must include `program_id` and belong to the same program. Set `description.title` for each section title. `description.details`, `description.image`, and `description.video` are deprecated backward-compatibility fields. The stored ordering values are assigned automatically.
|
|
903
|
+
*
|
|
904
|
+
* To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
|
|
905
|
+
* @param sections - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
|
|
853
906
|
* @public
|
|
854
907
|
* @documentationMaturity preview
|
|
855
908
|
* @requiredField sections
|
|
856
909
|
* @permissionId ONLINE_PROGRAMS.SECTION_CREATE
|
|
857
910
|
* @applicableIdentity APP
|
|
858
|
-
* @fqn wix.onlineprograms.sections.v3.SectionsService.
|
|
911
|
+
* @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
|
|
859
912
|
*/
|
|
860
|
-
declare function
|
|
861
|
-
interface
|
|
913
|
+
declare function bulkCreateSections(sections: Section[], 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}.item.programId` | `results.${number}.item.description.title` | `results.${number}.item.state` | `results.${number}.item.oldTotalSteps` | `results.${number}.item.trialSection` | `results.${number}.item.ordering` | `results.${number}.item.delayInDays` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
914
|
+
interface BulkCreateSectionsOptions {
|
|
862
915
|
/**
|
|
863
916
|
* Predefined sets of fields to return.
|
|
864
917
|
* @maxSize 1
|
|
@@ -866,30 +919,44 @@ interface BulkCreateSectionOptions {
|
|
|
866
919
|
fields?: RequestedFieldsWithLiterals[];
|
|
867
920
|
}
|
|
868
921
|
/**
|
|
869
|
-
*
|
|
870
|
-
*
|
|
922
|
+
* Deprecated. Use [Bulk Create Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/bulk-create-sections).
|
|
923
|
+
*
|
|
924
|
+
* To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
|
|
925
|
+
* @param sections - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
|
|
871
926
|
* @public
|
|
872
927
|
* @documentationMaturity preview
|
|
873
928
|
* @requiredField sections
|
|
874
929
|
* @permissionId ONLINE_PROGRAMS.SECTION_CREATE
|
|
875
930
|
* @applicableIdentity APP
|
|
876
|
-
* @fqn wix.onlineprograms.sections.v3.SectionsService.
|
|
931
|
+
* @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSection
|
|
932
|
+
* @deprecated
|
|
933
|
+
* @replacedBy wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
|
|
934
|
+
* @targetRemovalDate 2026-07-24
|
|
877
935
|
*/
|
|
878
|
-
declare function
|
|
936
|
+
declare function bulkCreateSection(sections: Section[], options?: BulkCreateSectionOptions): Promise<NonNullablePaths<BulkCreateSectionResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.programId` | `results.${number}.item.description.title` | `results.${number}.item.state` | `results.${number}.item.oldTotalSteps` | `results.${number}.item.trialSection` | `results.${number}.item.ordering` | `results.${number}.item.delayInDays` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
937
|
+
interface BulkCreateSectionOptions {
|
|
938
|
+
/**
|
|
939
|
+
* Predefined sets of fields to return.
|
|
940
|
+
* @maxSize 1
|
|
941
|
+
*/
|
|
942
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
943
|
+
}
|
|
879
944
|
/**
|
|
880
|
-
* Retrieves a
|
|
945
|
+
* Retrieves a section.
|
|
946
|
+
*
|
|
947
|
+
* `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
|
|
881
948
|
* @param sectionId - ID of the Section to retrieve.
|
|
882
949
|
* @public
|
|
883
950
|
* @documentationMaturity preview
|
|
884
951
|
* @requiredField sectionId
|
|
885
952
|
* @permissionId ONLINE_PROGRAMS.SECTION_READ
|
|
886
953
|
* @applicableIdentity APP
|
|
887
|
-
* @returns
|
|
954
|
+
* @returns Retrieved section.
|
|
888
955
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
|
|
889
956
|
*/
|
|
890
957
|
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
891
958
|
interface GetSectionOptions {
|
|
892
|
-
/**
|
|
959
|
+
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
893
960
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
894
961
|
/**
|
|
895
962
|
* Predefined sets of fields to return.
|
|
@@ -898,71 +965,76 @@ interface GetSectionOptions {
|
|
|
898
965
|
fields?: RequestedFieldsWithLiterals[];
|
|
899
966
|
}
|
|
900
967
|
/**
|
|
901
|
-
* Updates a
|
|
902
|
-
*
|
|
968
|
+
* Updates a section.
|
|
969
|
+
*
|
|
970
|
+
* 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.
|
|
971
|
+
*
|
|
972
|
+
* 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). To publish a section, call [Publish Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/publish-section).
|
|
973
|
+
* @param _id - Section ID.
|
|
903
974
|
* @public
|
|
904
975
|
* @documentationMaturity preview
|
|
905
976
|
* @requiredField _id
|
|
906
977
|
* @requiredField options.section.revision
|
|
907
978
|
* @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
|
|
908
979
|
* @applicableIdentity APP
|
|
909
|
-
* @returns Updated
|
|
980
|
+
* @returns Updated section.
|
|
910
981
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.UpdateSection
|
|
911
982
|
*/
|
|
912
983
|
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
|
|
913
984
|
interface UpdateSectionOptions {
|
|
914
985
|
section?: {
|
|
915
986
|
/**
|
|
916
|
-
*
|
|
987
|
+
* Section ID.
|
|
917
988
|
* @format GUID
|
|
918
989
|
* @readonly
|
|
919
990
|
*/
|
|
920
991
|
_id?: string | null;
|
|
921
992
|
/**
|
|
922
|
-
*
|
|
993
|
+
* Revision number, which increments by 1 each time the section is updated. To prevent conflicting changes, the current `revision` must be passed when updating or publishing the section.
|
|
923
994
|
* @readonly
|
|
924
995
|
*/
|
|
925
996
|
revision?: string | null;
|
|
926
997
|
/**
|
|
927
|
-
*
|
|
998
|
+
* Date and time the section was created.
|
|
928
999
|
* @readonly
|
|
929
1000
|
*/
|
|
930
1001
|
_createdDate?: Date | null;
|
|
931
1002
|
/**
|
|
932
|
-
*
|
|
1003
|
+
* Date and time the section was last updated.
|
|
933
1004
|
* @readonly
|
|
934
1005
|
*/
|
|
935
1006
|
_updatedDate?: Date | null;
|
|
936
1007
|
/**
|
|
937
|
-
* Program
|
|
1008
|
+
* Program ID of the parent program. Provide it when creating a section. After creation, this value can't be changed.
|
|
938
1009
|
* @format GUID
|
|
939
1010
|
* @readonly
|
|
1011
|
+
* @immutable
|
|
940
1012
|
*/
|
|
941
1013
|
programId?: string;
|
|
942
|
-
/** title
|
|
1014
|
+
/** Section title and deprecated backward-compatibility content fields. */
|
|
943
1015
|
description?: Description;
|
|
944
|
-
/**
|
|
1016
|
+
/** Publication state of the section. */
|
|
945
1017
|
state?: StateWithLiterals;
|
|
946
1018
|
/**
|
|
947
|
-
* number of
|
|
1019
|
+
* Legacy total number of steps in the section.
|
|
948
1020
|
* @readonly
|
|
949
1021
|
*/
|
|
950
1022
|
oldTotalSteps?: number;
|
|
951
1023
|
/**
|
|
952
|
-
* number of
|
|
1024
|
+
* Total number of steps in the section.
|
|
953
1025
|
* @readonly
|
|
954
1026
|
*/
|
|
955
1027
|
totalSteps?: number | null;
|
|
956
|
-
/**
|
|
1028
|
+
/** Whether participants can access the section as trial content before purchasing the parent program. */
|
|
957
1029
|
trialSection?: boolean;
|
|
958
|
-
/**
|
|
1030
|
+
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
959
1031
|
ordering?: number;
|
|
960
1032
|
/**
|
|
961
|
-
*
|
|
1033
|
+
* Number of days after the parent program starts before the section becomes available. Use `0` to make the section available immediately.
|
|
962
1034
|
* @max 5000
|
|
963
1035
|
*/
|
|
964
1036
|
delayInDays?: number;
|
|
965
|
-
/**
|
|
1037
|
+
/** Custom field data for the section. */
|
|
966
1038
|
extendedFields?: ExtendedFields;
|
|
967
1039
|
};
|
|
968
1040
|
/**
|
|
@@ -972,9 +1044,10 @@ interface UpdateSectionOptions {
|
|
|
972
1044
|
fields?: RequestedFieldsWithLiterals[];
|
|
973
1045
|
}
|
|
974
1046
|
/**
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
*
|
|
1047
|
+
* Permanently deletes a section from the public API.
|
|
1048
|
+
*
|
|
1049
|
+
* Deleted sections aren't returned by standard retrieval and list methods. The public API doesn't expose trash-bin or restore operations.
|
|
1050
|
+
* @param sectionId - ID of the section to delete.
|
|
978
1051
|
* @public
|
|
979
1052
|
* @documentationMaturity preview
|
|
980
1053
|
* @requiredField sectionId
|
|
@@ -984,9 +1057,19 @@ interface UpdateSectionOptions {
|
|
|
984
1057
|
*/
|
|
985
1058
|
declare function deleteSection(sectionId: string): Promise<void>;
|
|
986
1059
|
/**
|
|
987
|
-
* Retrieves a list of
|
|
1060
|
+
* Retrieves a list of up to 1,000 sections, given the provided paging, filtering, and sorting.
|
|
988
1061
|
*
|
|
989
|
-
*
|
|
1062
|
+
* Query Sections runs with these defaults, which you can override:
|
|
1063
|
+
*
|
|
1064
|
+
* - `createdDate` is sorted in `DESC` order.
|
|
1065
|
+
* - `paging.limit` is `1000`.
|
|
1066
|
+
* - `paging.offset` is `0`.
|
|
1067
|
+
*
|
|
1068
|
+
* Supported filter fields are `programId`, `id`, `delayInDays`, `trialSection`, and `state`.
|
|
1069
|
+
* Supported sorting fields are `id`, `delayInDays`, `trialSection`, `state`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
|
|
1070
|
+
* `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
|
|
1071
|
+
*
|
|
1072
|
+
* 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).
|
|
990
1073
|
* @public
|
|
991
1074
|
* @documentationMaturity preview
|
|
992
1075
|
* @permissionId ONLINE_PROGRAMS.SECTION_READ
|
|
@@ -995,10 +1078,10 @@ declare function deleteSection(sectionId: string): Promise<void>;
|
|
|
995
1078
|
*/
|
|
996
1079
|
declare function querySections(options?: QuerySectionsOptions): SectionsQueryBuilder;
|
|
997
1080
|
interface QuerySectionsOptions {
|
|
998
|
-
/**
|
|
1081
|
+
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
999
1082
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals | undefined;
|
|
1000
1083
|
/**
|
|
1001
|
-
* Program
|
|
1084
|
+
* Deprecated. Program ID used to scope the query. Use `query.filter` instead.
|
|
1002
1085
|
* @deprecated
|
|
1003
1086
|
* @replacedBy wix.common.CursorQuery
|
|
1004
1087
|
* @targetRemovalDate 2026-06-30
|
|
@@ -1157,6 +1240,11 @@ type SectionQuery = {
|
|
|
1157
1240
|
Sort order.
|
|
1158
1241
|
*/
|
|
1159
1242
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
1243
|
+
/**
|
|
1244
|
+
Origin point for geo-distance sorting on a GEO field
|
|
1245
|
+
results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1246
|
+
*/
|
|
1247
|
+
origin?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['origin'];
|
|
1160
1248
|
}[];
|
|
1161
1249
|
};
|
|
1162
1250
|
declare const utils: {
|
|
@@ -1167,8 +1255,12 @@ declare const utils: {
|
|
|
1167
1255
|
};
|
|
1168
1256
|
};
|
|
1169
1257
|
/**
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1258
|
+
* Retrieves the sections in a program.
|
|
1259
|
+
*
|
|
1260
|
+
* Results are sorted by `ordering` in ascending order. `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
|
|
1261
|
+
*
|
|
1262
|
+
* To filter or sort sections, call [Query Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/query-sections).
|
|
1263
|
+
* @param programId - Program ID to list sections for.
|
|
1172
1264
|
* @public
|
|
1173
1265
|
* @documentationMaturity preview
|
|
1174
1266
|
* @requiredField programId
|
|
@@ -1178,7 +1270,7 @@ declare const utils: {
|
|
|
1178
1270
|
*/
|
|
1179
1271
|
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.state` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1180
1272
|
interface ListSectionsOptions {
|
|
1181
|
-
/**
|
|
1273
|
+
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1182
1274
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1183
1275
|
/**
|
|
1184
1276
|
* Predefined sets of fields to return.
|
|
@@ -1187,8 +1279,10 @@ interface ListSectionsOptions {
|
|
|
1187
1279
|
fields?: RequestedFieldsWithLiterals[];
|
|
1188
1280
|
}
|
|
1189
1281
|
/**
|
|
1190
|
-
* Clones section
|
|
1191
|
-
*
|
|
1282
|
+
* Clones a section.
|
|
1283
|
+
*
|
|
1284
|
+
* The cloned section is added to the same program after the current last section. Translation content is copied to the cloned section.
|
|
1285
|
+
* @param sectionId - ID of the section to clone.
|
|
1192
1286
|
* @public
|
|
1193
1287
|
* @documentationMaturity preview
|
|
1194
1288
|
* @requiredField sectionId
|
|
@@ -1205,7 +1299,9 @@ interface CloneSectionOptions {
|
|
|
1205
1299
|
fields?: RequestedFieldsWithLiterals[];
|
|
1206
1300
|
}
|
|
1207
1301
|
/**
|
|
1208
|
-
*
|
|
1302
|
+
* Moves a section within its program.
|
|
1303
|
+
*
|
|
1304
|
+
* If `afterSectionId` isn't specified, the section is moved to the beginning of the program. The stored ordering value is recalculated automatically.
|
|
1209
1305
|
* @public
|
|
1210
1306
|
* @documentationMaturity preview
|
|
1211
1307
|
* @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
|
|
@@ -1215,16 +1311,16 @@ interface CloneSectionOptions {
|
|
|
1215
1311
|
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1216
1312
|
interface MoveSectionOptions {
|
|
1217
1313
|
/**
|
|
1218
|
-
*
|
|
1314
|
+
* ID of the section to move.
|
|
1219
1315
|
* @format GUID
|
|
1220
1316
|
*/
|
|
1221
1317
|
sectionId?: string;
|
|
1222
1318
|
/**
|
|
1223
|
-
*
|
|
1319
|
+
* ID of the section that the moved section should be placed after. Leave empty to move the section to the beginning of the program.
|
|
1224
1320
|
* @format GUID
|
|
1225
1321
|
*/
|
|
1226
1322
|
afterSectionId?: string | null;
|
|
1227
|
-
/**
|
|
1323
|
+
/** Current revision of the section. */
|
|
1228
1324
|
revision?: string;
|
|
1229
1325
|
/**
|
|
1230
1326
|
* Predefined sets of fields to return.
|
|
@@ -1233,7 +1329,11 @@ interface MoveSectionOptions {
|
|
|
1233
1329
|
fields?: RequestedFieldsWithLiterals[];
|
|
1234
1330
|
}
|
|
1235
1331
|
/**
|
|
1236
|
-
* Publishes section
|
|
1332
|
+
* Publishes a section.
|
|
1333
|
+
*
|
|
1334
|
+
* 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.
|
|
1335
|
+
*
|
|
1336
|
+
* Publishing sets the section's `state` to `PUBLISHED`.
|
|
1237
1337
|
* @public
|
|
1238
1338
|
* @documentationMaturity preview
|
|
1239
1339
|
* @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
|
|
@@ -1243,11 +1343,11 @@ interface MoveSectionOptions {
|
|
|
1243
1343
|
declare function publishSection(options?: PublishSectionOptions): Promise<NonNullablePaths<PublishSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1244
1344
|
interface PublishSectionOptions {
|
|
1245
1345
|
/**
|
|
1246
|
-
*
|
|
1346
|
+
* ID of the section to publish.
|
|
1247
1347
|
* @format GUID
|
|
1248
1348
|
*/
|
|
1249
1349
|
sectionId?: string;
|
|
1250
|
-
/**
|
|
1350
|
+
/** Current revision of the section. */
|
|
1251
1351
|
revision?: string;
|
|
1252
1352
|
/**
|
|
1253
1353
|
* Predefined sets of fields to return.
|
|
@@ -1256,4 +1356,4 @@ interface PublishSectionOptions {
|
|
|
1256
1356
|
fields?: RequestedFieldsWithLiterals[];
|
|
1257
1357
|
}
|
|
1258
1358
|
|
|
1259
|
-
export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionOptions, type BulkCreateSectionRequest, type BulkCreateSectionResponse, 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 PublishSectionOptions, 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, bulkCreateSection,
|
|
1359
|
+
export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionOptions, 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 PublishSectionOptions, 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, bulkCreateSection, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, typedQuerySections, updateSection, utils };
|