@wix/auto_sdk_online-programs_sections 1.0.21 → 1.0.23
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 +7 -7
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +19 -21
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +0 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +7 -7
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +19 -21
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +0 -2
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +7 -7
- package/build/internal/cjs/index.typings.d.ts +19 -21
- package/build/internal/cjs/meta.d.ts +0 -2
- package/build/internal/es/index.d.mts +7 -7
- package/build/internal/es/index.typings.d.mts +19 -21
- package/build/internal/es/meta.d.mts +0 -2
- package/package.json +2 -2
|
@@ -53,8 +53,6 @@ interface Section {
|
|
|
53
53
|
* @readonly
|
|
54
54
|
*/
|
|
55
55
|
totalSteps?: number | null;
|
|
56
|
-
/** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
|
|
57
|
-
trialSection?: boolean;
|
|
58
56
|
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
59
57
|
ordering?: number;
|
|
60
58
|
/**
|
|
@@ -983,12 +981,13 @@ interface AccountInfo {
|
|
|
983
981
|
* @public
|
|
984
982
|
* @documentationMaturity preview
|
|
985
983
|
* @requiredField section
|
|
984
|
+
* @requiredField section.programId
|
|
986
985
|
* @permissionId ONLINE_PROGRAMS.SECTION_CREATE
|
|
987
986
|
* @applicableIdentity APP
|
|
988
987
|
* @returns Created section.
|
|
989
988
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
|
|
990
989
|
*/
|
|
991
|
-
declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `
|
|
990
|
+
declare function createSection(section: NonNullablePaths<Section, `programId`, 2>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
992
991
|
interface CreateSectionOptions {
|
|
993
992
|
/**
|
|
994
993
|
* Predefined sets of fields to return.
|
|
@@ -1006,11 +1005,12 @@ interface CreateSectionOptions {
|
|
|
1006
1005
|
* @public
|
|
1007
1006
|
* @documentationMaturity preview
|
|
1008
1007
|
* @requiredField sections
|
|
1008
|
+
* @requiredField sections.programId
|
|
1009
1009
|
* @permissionId ONLINE_PROGRAMS.SECTION_CREATE
|
|
1010
1010
|
* @applicableIdentity APP
|
|
1011
1011
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
|
|
1012
1012
|
*/
|
|
1013
|
-
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}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
1013
|
+
declare function bulkCreateSections(sections: NonNullablePaths<Section, `programId`, 2>[], 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`, 6>>;
|
|
1014
1014
|
interface BulkCreateSectionsOptions {
|
|
1015
1015
|
/**
|
|
1016
1016
|
* Predefined sets of fields to return.
|
|
@@ -1031,7 +1031,7 @@ interface BulkCreateSectionsOptions {
|
|
|
1031
1031
|
* @returns Retrieved section.
|
|
1032
1032
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
|
|
1033
1033
|
*/
|
|
1034
|
-
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `
|
|
1034
|
+
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
1035
1035
|
interface GetSectionOptions {
|
|
1036
1036
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1037
1037
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1057,7 +1057,7 @@ interface GetSectionOptions {
|
|
|
1057
1057
|
* @returns Updated section.
|
|
1058
1058
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.UpdateSection
|
|
1059
1059
|
*/
|
|
1060
|
-
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `
|
|
1060
|
+
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
1061
1061
|
interface UpdateSectionOptions {
|
|
1062
1062
|
section?: {
|
|
1063
1063
|
/**
|
|
@@ -1106,8 +1106,6 @@ interface UpdateSectionOptions {
|
|
|
1106
1106
|
* @readonly
|
|
1107
1107
|
*/
|
|
1108
1108
|
totalSteps?: number | null;
|
|
1109
|
-
/** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
|
|
1110
|
-
trialSection?: boolean;
|
|
1111
1109
|
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
1112
1110
|
ordering?: number;
|
|
1113
1111
|
/**
|
|
@@ -1146,8 +1144,8 @@ declare function deleteSection(sectionId: string): Promise<void>;
|
|
|
1146
1144
|
* - `paging.limit` is `1000`.
|
|
1147
1145
|
* - `paging.offset` is `0`.
|
|
1148
1146
|
*
|
|
1149
|
-
* Supported filter fields are `programId`, `id`,
|
|
1150
|
-
* Supported sorting fields are `id`, `delayInDays`, `
|
|
1147
|
+
* Supported filter fields are `programId`, `id`, and `delayInDays`.
|
|
1148
|
+
* Supported sorting fields are `id`, `delayInDays`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
|
|
1151
1149
|
* `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
|
|
1152
1150
|
*
|
|
1153
1151
|
* 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).
|
|
@@ -1192,12 +1190,12 @@ interface SectionsQueryBuilder {
|
|
|
1192
1190
|
* @param value - Value to compare against.
|
|
1193
1191
|
* @documentationMaturity preview
|
|
1194
1192
|
*/
|
|
1195
|
-
eq: (propertyName: '_id' | 'programId' | '
|
|
1193
|
+
eq: (propertyName: '_id' | 'programId' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1196
1194
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1197
1195
|
* @param value - Value to compare against.
|
|
1198
1196
|
* @documentationMaturity preview
|
|
1199
1197
|
*/
|
|
1200
|
-
ne: (propertyName: '_id' | '
|
|
1198
|
+
ne: (propertyName: '_id' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1201
1199
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1202
1200
|
* @param value - Value to compare against.
|
|
1203
1201
|
* @documentationMaturity preview
|
|
@@ -1224,17 +1222,17 @@ interface SectionsQueryBuilder {
|
|
|
1224
1222
|
*/
|
|
1225
1223
|
startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
|
|
1226
1224
|
/** @documentationMaturity preview */
|
|
1227
|
-
in: (propertyName: '_id' | '
|
|
1225
|
+
in: (propertyName: '_id' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1228
1226
|
/** @documentationMaturity preview */
|
|
1229
|
-
exists: (propertyName: '_id' | '
|
|
1227
|
+
exists: (propertyName: '_id' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
|
|
1230
1228
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1231
1229
|
* @documentationMaturity preview
|
|
1232
1230
|
*/
|
|
1233
|
-
ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | '
|
|
1231
|
+
ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
|
|
1234
1232
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1235
1233
|
* @documentationMaturity preview
|
|
1236
1234
|
*/
|
|
1237
|
-
descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | '
|
|
1235
|
+
descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
|
|
1238
1236
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1239
1237
|
* @documentationMaturity preview
|
|
1240
1238
|
*/
|
|
@@ -1251,7 +1249,7 @@ interface SectionsQueryBuilder {
|
|
|
1251
1249
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
|
|
1252
1250
|
* @requiredField query
|
|
1253
1251
|
*/
|
|
1254
|
-
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.
|
|
1252
|
+
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1255
1253
|
interface SectionQuerySpec extends QuerySpec {
|
|
1256
1254
|
paging: 'cursor';
|
|
1257
1255
|
wql: [
|
|
@@ -1261,7 +1259,7 @@ interface SectionQuerySpec extends QuerySpec {
|
|
|
1261
1259
|
sort: 'NONE';
|
|
1262
1260
|
},
|
|
1263
1261
|
{
|
|
1264
|
-
fields: ['_id', 'delayInDays'
|
|
1262
|
+
fields: ['_id', 'delayInDays'];
|
|
1265
1263
|
operators: '*';
|
|
1266
1264
|
sort: 'BOTH';
|
|
1267
1265
|
},
|
|
@@ -1354,7 +1352,7 @@ declare const utils: {
|
|
|
1354
1352
|
* @applicableIdentity APP
|
|
1355
1353
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.ListSections
|
|
1356
1354
|
*/
|
|
1357
|
-
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.
|
|
1355
|
+
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1358
1356
|
interface ListSectionsOptions {
|
|
1359
1357
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1360
1358
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1376,7 +1374,7 @@ interface ListSectionsOptions {
|
|
|
1376
1374
|
* @applicableIdentity APP
|
|
1377
1375
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CloneSection
|
|
1378
1376
|
*/
|
|
1379
|
-
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.
|
|
1377
|
+
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1380
1378
|
interface CloneSectionOptions {
|
|
1381
1379
|
/**
|
|
1382
1380
|
* Predefined sets of fields to return.
|
|
@@ -1396,7 +1394,7 @@ interface CloneSectionOptions {
|
|
|
1396
1394
|
* @applicableIdentity APP
|
|
1397
1395
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.MoveSection
|
|
1398
1396
|
*/
|
|
1399
|
-
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.
|
|
1397
|
+
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1400
1398
|
interface MoveSectionOptions {
|
|
1401
1399
|
/**
|
|
1402
1400
|
* ID of the section to move.
|
|
@@ -53,8 +53,6 @@ interface Section {
|
|
|
53
53
|
* @readonly
|
|
54
54
|
*/
|
|
55
55
|
totalSteps?: number | null;
|
|
56
|
-
/** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
|
|
57
|
-
trialSection?: boolean;
|
|
58
56
|
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
59
57
|
ordering?: number;
|
|
60
58
|
/**
|
|
@@ -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` | `oldTotalSteps` | `
|
|
16
|
+
(section: NonNullablePaths<Section, `programId`, 2>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
17
17
|
}
|
|
18
18
|
declare function bulkCreateSections$1(httpClient: HttpClient): BulkCreateSectionsSignature;
|
|
19
19
|
interface BulkCreateSectionsSignature {
|
|
@@ -25,7 +25,7 @@ interface BulkCreateSectionsSignature {
|
|
|
25
25
|
* To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
|
|
26
26
|
* @param - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
|
|
27
27
|
*/
|
|
28
|
-
(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}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
28
|
+
(sections: NonNullablePaths<Section, `programId`, 2>[], 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`, 6>>;
|
|
29
29
|
}
|
|
30
30
|
declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
|
|
31
31
|
interface GetSectionSignature {
|
|
@@ -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` | `oldTotalSteps` | `
|
|
39
|
+
(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
40
40
|
}
|
|
41
41
|
declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
|
|
42
42
|
interface UpdateSectionSignature {
|
|
@@ -49,7 +49,7 @@ interface UpdateSectionSignature {
|
|
|
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` | `oldTotalSteps` | `
|
|
52
|
+
(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `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}.oldTotalSteps` | `sections.${number}.
|
|
74
|
+
(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `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.oldTotalSteps` | `section.
|
|
84
|
+
(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
85
85
|
}
|
|
86
86
|
declare function moveSection$1(httpClient: HttpClient): MoveSectionSignature;
|
|
87
87
|
interface MoveSectionSignature {
|
|
@@ -92,7 +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.oldTotalSteps` | `section.
|
|
95
|
+
(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
96
96
|
}
|
|
97
97
|
|
|
98
98
|
declare function customQuerySections(httpClient: HttpClient): {
|
|
@@ -53,8 +53,6 @@ interface Section {
|
|
|
53
53
|
* @readonly
|
|
54
54
|
*/
|
|
55
55
|
totalSteps?: number | null;
|
|
56
|
-
/** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
|
|
57
|
-
trialSection?: boolean;
|
|
58
56
|
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
59
57
|
ordering?: number;
|
|
60
58
|
/**
|
|
@@ -983,12 +981,13 @@ interface AccountInfo {
|
|
|
983
981
|
* @public
|
|
984
982
|
* @documentationMaturity preview
|
|
985
983
|
* @requiredField section
|
|
984
|
+
* @requiredField section.programId
|
|
986
985
|
* @permissionId ONLINE_PROGRAMS.SECTION_CREATE
|
|
987
986
|
* @applicableIdentity APP
|
|
988
987
|
* @returns Created section.
|
|
989
988
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
|
|
990
989
|
*/
|
|
991
|
-
declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `
|
|
990
|
+
declare function createSection(section: NonNullablePaths<Section, `programId`, 2>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
992
991
|
interface CreateSectionOptions {
|
|
993
992
|
/**
|
|
994
993
|
* Predefined sets of fields to return.
|
|
@@ -1006,11 +1005,12 @@ interface CreateSectionOptions {
|
|
|
1006
1005
|
* @public
|
|
1007
1006
|
* @documentationMaturity preview
|
|
1008
1007
|
* @requiredField sections
|
|
1008
|
+
* @requiredField sections.programId
|
|
1009
1009
|
* @permissionId ONLINE_PROGRAMS.SECTION_CREATE
|
|
1010
1010
|
* @applicableIdentity APP
|
|
1011
1011
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
|
|
1012
1012
|
*/
|
|
1013
|
-
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}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
1013
|
+
declare function bulkCreateSections(sections: NonNullablePaths<Section, `programId`, 2>[], 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`, 6>>;
|
|
1014
1014
|
interface BulkCreateSectionsOptions {
|
|
1015
1015
|
/**
|
|
1016
1016
|
* Predefined sets of fields to return.
|
|
@@ -1031,7 +1031,7 @@ interface BulkCreateSectionsOptions {
|
|
|
1031
1031
|
* @returns Retrieved section.
|
|
1032
1032
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
|
|
1033
1033
|
*/
|
|
1034
|
-
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `
|
|
1034
|
+
declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
1035
1035
|
interface GetSectionOptions {
|
|
1036
1036
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1037
1037
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1057,7 +1057,7 @@ interface GetSectionOptions {
|
|
|
1057
1057
|
* @returns Updated section.
|
|
1058
1058
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.UpdateSection
|
|
1059
1059
|
*/
|
|
1060
|
-
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `
|
|
1060
|
+
declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
|
|
1061
1061
|
interface UpdateSectionOptions {
|
|
1062
1062
|
section?: {
|
|
1063
1063
|
/**
|
|
@@ -1106,8 +1106,6 @@ interface UpdateSectionOptions {
|
|
|
1106
1106
|
* @readonly
|
|
1107
1107
|
*/
|
|
1108
1108
|
totalSteps?: number | null;
|
|
1109
|
-
/** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
|
|
1110
|
-
trialSection?: boolean;
|
|
1111
1109
|
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
1112
1110
|
ordering?: number;
|
|
1113
1111
|
/**
|
|
@@ -1146,8 +1144,8 @@ declare function deleteSection(sectionId: string): Promise<void>;
|
|
|
1146
1144
|
* - `paging.limit` is `1000`.
|
|
1147
1145
|
* - `paging.offset` is `0`.
|
|
1148
1146
|
*
|
|
1149
|
-
* Supported filter fields are `programId`, `id`,
|
|
1150
|
-
* Supported sorting fields are `id`, `delayInDays`, `
|
|
1147
|
+
* Supported filter fields are `programId`, `id`, and `delayInDays`.
|
|
1148
|
+
* Supported sorting fields are `id`, `delayInDays`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
|
|
1151
1149
|
* `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
|
|
1152
1150
|
*
|
|
1153
1151
|
* 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).
|
|
@@ -1192,12 +1190,12 @@ interface SectionsQueryBuilder {
|
|
|
1192
1190
|
* @param value - Value to compare against.
|
|
1193
1191
|
* @documentationMaturity preview
|
|
1194
1192
|
*/
|
|
1195
|
-
eq: (propertyName: '_id' | 'programId' | '
|
|
1193
|
+
eq: (propertyName: '_id' | 'programId' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1196
1194
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1197
1195
|
* @param value - Value to compare against.
|
|
1198
1196
|
* @documentationMaturity preview
|
|
1199
1197
|
*/
|
|
1200
|
-
ne: (propertyName: '_id' | '
|
|
1198
|
+
ne: (propertyName: '_id' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1201
1199
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1202
1200
|
* @param value - Value to compare against.
|
|
1203
1201
|
* @documentationMaturity preview
|
|
@@ -1224,17 +1222,17 @@ interface SectionsQueryBuilder {
|
|
|
1224
1222
|
*/
|
|
1225
1223
|
startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
|
|
1226
1224
|
/** @documentationMaturity preview */
|
|
1227
|
-
in: (propertyName: '_id' | '
|
|
1225
|
+
in: (propertyName: '_id' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1228
1226
|
/** @documentationMaturity preview */
|
|
1229
|
-
exists: (propertyName: '_id' | '
|
|
1227
|
+
exists: (propertyName: '_id' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
|
|
1230
1228
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1231
1229
|
* @documentationMaturity preview
|
|
1232
1230
|
*/
|
|
1233
|
-
ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | '
|
|
1231
|
+
ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
|
|
1234
1232
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1235
1233
|
* @documentationMaturity preview
|
|
1236
1234
|
*/
|
|
1237
|
-
descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | '
|
|
1235
|
+
descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
|
|
1238
1236
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1239
1237
|
* @documentationMaturity preview
|
|
1240
1238
|
*/
|
|
@@ -1251,7 +1249,7 @@ interface SectionsQueryBuilder {
|
|
|
1251
1249
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
|
|
1252
1250
|
* @requiredField query
|
|
1253
1251
|
*/
|
|
1254
|
-
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.
|
|
1252
|
+
declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1255
1253
|
interface SectionQuerySpec extends QuerySpec {
|
|
1256
1254
|
paging: 'cursor';
|
|
1257
1255
|
wql: [
|
|
@@ -1261,7 +1259,7 @@ interface SectionQuerySpec extends QuerySpec {
|
|
|
1261
1259
|
sort: 'NONE';
|
|
1262
1260
|
},
|
|
1263
1261
|
{
|
|
1264
|
-
fields: ['_id', 'delayInDays'
|
|
1262
|
+
fields: ['_id', 'delayInDays'];
|
|
1265
1263
|
operators: '*';
|
|
1266
1264
|
sort: 'BOTH';
|
|
1267
1265
|
},
|
|
@@ -1354,7 +1352,7 @@ declare const utils: {
|
|
|
1354
1352
|
* @applicableIdentity APP
|
|
1355
1353
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.ListSections
|
|
1356
1354
|
*/
|
|
1357
|
-
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.
|
|
1355
|
+
declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
|
|
1358
1356
|
interface ListSectionsOptions {
|
|
1359
1357
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1360
1358
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
@@ -1376,7 +1374,7 @@ interface ListSectionsOptions {
|
|
|
1376
1374
|
* @applicableIdentity APP
|
|
1377
1375
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.CloneSection
|
|
1378
1376
|
*/
|
|
1379
|
-
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.
|
|
1377
|
+
declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1380
1378
|
interface CloneSectionOptions {
|
|
1381
1379
|
/**
|
|
1382
1380
|
* Predefined sets of fields to return.
|
|
@@ -1396,7 +1394,7 @@ interface CloneSectionOptions {
|
|
|
1396
1394
|
* @applicableIdentity APP
|
|
1397
1395
|
* @fqn wix.onlineprograms.sections.v3.SectionsService.MoveSection
|
|
1398
1396
|
*/
|
|
1399
|
-
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.
|
|
1397
|
+
declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
|
|
1400
1398
|
interface MoveSectionOptions {
|
|
1401
1399
|
/**
|
|
1402
1400
|
* ID of the section to move.
|
|
@@ -53,8 +53,6 @@ interface Section {
|
|
|
53
53
|
* @readonly
|
|
54
54
|
*/
|
|
55
55
|
totalSteps?: number | null;
|
|
56
|
-
/** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
|
|
57
|
-
trialSection?: boolean;
|
|
58
56
|
/** Position rank used to order sections within a program. To reorder sections, call Move Section. */
|
|
59
57
|
ordering?: number;
|
|
60
58
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_online-programs_sections",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.23",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/",
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"fqdn": "wix.online_programs.v3.section"
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
|
-
"falconPackageHash": "
|
|
53
|
+
"falconPackageHash": "b0e798a73b537494629af548557882ca45b98bbae57f74b5e8a2bdd9"
|
|
54
54
|
}
|