@wix/auto_sdk_online-programs_sections 1.0.21 → 1.0.23

package/build/cjs/index.typings.d.ts

@@ -47,8 +47,6 @@ interface Section {
      * @readonly
      */
     totalSteps?: number | null;
-    /** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
-    trialSection?: boolean;
     /** Position rank used to order sections within a program. To reorder sections, call Move Section. */
     ordering?: number;
     /**
@@ -853,12 +851,13 @@ interface AccountInfo {
  * @public
  * @documentationMaturity preview
  * @requiredField section
+ * @requiredField section.programId
  * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
  * @applicableIdentity APP
  * @returns Created section.
  * @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
  */
-declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+declare function createSection(section: NonNullablePaths<Section, `programId`, 2>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
 interface CreateSectionOptions {
     /**
      * Predefined sets of fields to return.
@@ -876,11 +875,12 @@ interface CreateSectionOptions {
  * @public
  * @documentationMaturity preview
  * @requiredField sections
+ * @requiredField sections.programId
  * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
  */
-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>>;
+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>>;
 interface BulkCreateSectionsOptions {
     /**
      * Predefined sets of fields to return.
@@ -901,7 +901,7 @@ interface BulkCreateSectionsOptions {
  * @returns Retrieved section.
  * @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
  */
-declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
 interface GetSectionOptions {
     /** Compatibility option for existing integrations. Current section responses return the section title. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
@@ -927,7 +927,7 @@ interface GetSectionOptions {
  * @returns Updated section.
  * @fqn wix.onlineprograms.sections.v3.SectionsService.UpdateSection
  */
-declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 3>>;
 interface UpdateSectionOptions {
     section?: {
         /**
@@ -970,8 +970,6 @@ interface UpdateSectionOptions {
          * @readonly
          */
         totalSteps?: number | null;
-        /** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
-        trialSection?: boolean;
         /** Position rank used to order sections within a program. To reorder sections, call Move Section. */
         ordering?: number;
         /**
@@ -1010,8 +1008,8 @@ declare function deleteSection(sectionId: string): Promise<void>;
  * - `paging.limit` is `1000`.
  * - `paging.offset` is `0`.
  *
- * Supported filter fields are `programId`, `id`, `delayInDays`, and `trialSection`.
- * Supported sorting fields are `id`, `delayInDays`, `trialSection`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
+ * Supported filter fields are `programId`, `id`, and `delayInDays`.
+ * Supported sorting fields are `id`, `delayInDays`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
  * `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
  *
  * 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).
@@ -1056,12 +1054,12 @@ interface SectionsQueryBuilder {
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    eq: (propertyName: '_id' | 'programId' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
+    eq: (propertyName: '_id' | 'programId' | 'delayInDays', value: any) => SectionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    ne: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
+    ne: (propertyName: '_id' | 'delayInDays', value: any) => SectionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -1088,17 +1086,17 @@ interface SectionsQueryBuilder {
      */
     startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
     /** @documentationMaturity preview */
-    in: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
+    in: (propertyName: '_id' | 'delayInDays', value: any) => SectionsQueryBuilder;
     /** @documentationMaturity preview */
-    exists: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
+    exists: (propertyName: '_id' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
      * @documentationMaturity preview
      */
-    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'trialSection' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
      * @documentationMaturity preview
      */
-    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'trialSection' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
     /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
      * @documentationMaturity preview
      */
@@ -1115,7 +1113,7 @@ interface SectionsQueryBuilder {
  * @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
  * @requiredField query
  */
-declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
+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>>;
 interface SectionQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
@@ -1125,7 +1123,7 @@ interface SectionQuerySpec extends QuerySpec {
             sort: 'NONE';
         },
         {
-            fields: ['_id', 'delayInDays', 'trialSection'];
+            fields: ['_id', 'delayInDays'];
             operators: '*';
             sort: 'BOTH';
         },
@@ -1204,7 +1202,7 @@ declare const utils: {
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.ListSections
  */
-declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
+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>>;
 interface ListSectionsOptions {
     /** Compatibility option for existing integrations. Current section responses return the section title. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
@@ -1226,7 +1224,7 @@ interface ListSectionsOptions {
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.CloneSection
  */
-declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
 interface CloneSectionOptions {
     /**
      * Predefined sets of fields to return.
@@ -1246,7 +1244,7 @@ interface CloneSectionOptions {
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.MoveSection
  */
-declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.ordering` | `section.delayInDays`, 4>>;
 interface MoveSectionOptions {
     /**
      * ID of the section to move.