@wix/auto_sdk_online-programs_sections 1.0.28 → 1.0.30

package/build/internal/es/index.typings.d.mts

@@ -4,7 +4,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 /**
  * A section groups related steps within an online program.
  *
- * Sections are published when created, and can be reordered and optionally released after a delay from the start of the parent program.
+ * Sections have no separate draft or publish lifecycle. They can be reordered and made available after a delay counted from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced programs.
  */
 interface Section {
     /**
@@ -55,7 +55,7 @@ interface Section {
      * @max 5000
      */
     delayInDays?: number;
-    /** Custom field data for the section. */
+    /** Custom field data for the section. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. */
     extendedFields?: ExtendedFields;
 }
 interface Description {
@@ -582,7 +582,7 @@ interface MoveSectionRequest {
      * ID of the section to move.
      * @format GUID
      */
-    sectionId?: string;
+    sectionId: string;
     /**
      * ID of the section that the moved section should be placed after. Leave empty to move the section to the beginning of the program.
      * @format GUID
@@ -825,6 +825,8 @@ interface AccountInfo {
  *
  * 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. The stored ordering value is assigned automatically.
  *
+ * A program can contain up to 1,000 sections. This call fails if creating the section would exceed that limit.
+ *
  * 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).
  * @param section - Section to create. Must include `section.program_id`.
  * @public
@@ -849,6 +851,8 @@ interface CreateSectionOptions {
  *
  * All sections in the request must include `program_id` and belong to the same program. Set `description.title` for each section title. The stored ordering values are assigned automatically.
  *
+ * A program can contain up to 1,000 sections. This call fails if creating the requested sections would exceed that limit.
+ *
  * To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
  * @param sections - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
  * @public
@@ -957,7 +961,7 @@ interface UpdateSectionOptions {
          * @max 5000
          */
         delayInDays?: number;
-        /** Custom field data for the section. */
+        /** Custom field data for the section. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. */
         extendedFields?: ExtendedFields;
     };
     /**
@@ -990,6 +994,7 @@ declare function deleteSection(sectionId: string): Promise<void>;
  *
  * 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`.
+ * Section extended fields aren't supported for filtering or sorting. Queries that reference them are rejected.
  * `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).
@@ -1202,7 +1207,11 @@ interface ListSectionsOptions {
 /**
  * Clones a section.
  *
- * The cloned section is added to the same program after the current last section. Translation content is copied to the cloned section.
+ * The cloned section is added to the same program after the current last section. Translation content and extended field data are copied to the cloned section.
+ *
+ * Steps are cloned asynchronously after this call returns. The `section.total_steps` value in the response may not reflect the eventual number of cloned steps. Until cloning finishes, Get, List, and Query calls may return a lower actual step count.
+ *
+ * A program can contain up to 1,000 sections. This call fails if cloning the section would exceed that limit.
  * @param sectionId - ID of the section to clone.
  * @public
  * @documentationMaturity preview
@@ -1225,19 +1234,16 @@ interface CloneSectionOptions {
  * Each time the section is updated, its `revision` increments by 1. When provided, `revision` must match the current section revision to protect against conflicting updates.
  *
  * If `afterSectionId` isn't specified, the section is moved to the beginning of the program. The stored ordering value is recalculated automatically.
+ * @param sectionId - ID of the section to move.
  * @public
  * @documentationMaturity preview
+ * @requiredField sectionId
  * @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.MoveSection
  */
-declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
+declare function moveSection(sectionId: string, options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
 interface MoveSectionOptions {
-    /**
-     * ID of the section to move.
-     * @format GUID
-     */
-    sectionId?: string;
     /**
      * ID of the section that the moved section should be placed after. Leave empty to move the section to the beginning of the program.
      * @format GUID

package/build/internal/es/meta.d.mts

@@ -4,7 +4,7 @@ import '@wix/sdk-types';
 /**
  * A section groups related steps within an online program.
  *
- * Sections are published when created, and can be reordered and optionally released after a delay from the start of the parent program.
+ * Sections have no separate draft or publish lifecycle. They can be reordered and made available after a delay counted from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced programs.
  */
 interface Section {
     /**
@@ -55,7 +55,7 @@ interface Section {
      * @max 5000
      */
     delayInDays?: number;
-    /** Custom field data for the section. */
+    /** Custom field data for the section. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. */
     extendedFields?: ExtendedFields;
 }
 interface Description {
@@ -582,7 +582,7 @@ interface MoveSectionRequest {
      * ID of the section to move.
      * @format GUID
      */
-    sectionId?: string;
+    sectionId: string;
     /**
      * ID of the section that the moved section should be placed after. Leave empty to move the section to the beginning of the program.
      * @format GUID

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_online-programs_sections",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.online_programs.v3.section"
     }
   },
-  "falconPackageHash": "41e3a691968e11d01b53805582650de7e9b84a2334e73b5fbc53a9df"
+  "falconPackageHash": "68d5d33c3ff258fed4a79a43bbdecfc678eb9f748db990a4b4b0842f"
 }