@wix/auto_sdk_online-programs_sections 1.0.30 → 1.0.31

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

@@ -218,8 +218,10 @@ interface CreateSectionRequest {
     /** Section to create. Must include `section.program_id`. */
     section: Section;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -241,8 +243,10 @@ interface BulkCreateSectionsRequest {
      */
     sections: Section[];
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -300,8 +304,10 @@ interface BulkCreateSectionRequest {
      */
     sections?: Section[];
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -331,11 +337,17 @@ interface GetSectionRequest {
      * @format GUID
      */
     sectionId: string;
-    /** Compatibility option for existing integrations. Current section responses return the section title. */
+    /**
+     * Deprecated: Current section responses always include the section title. This field is ignored.
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
+     */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -355,8 +367,10 @@ interface UpdateSectionRequest {
     /** Section to update. Include `section.id`, `section.revision`, and the fields to update. */
     section?: Section;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -391,11 +405,17 @@ interface DeleteAllProgramSectionsResponse {
 interface QuerySectionsRequest {
     /** WQL expression. */
     query?: CursorQuery;
-    /** Compatibility option for existing integrations. Current section responses return the section title. */
+    /**
+     * Deprecated: Current section responses always include the section title. This field is ignored.
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
+     */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -507,11 +527,17 @@ interface ListSectionsRequest {
      * @format GUID
      */
     programId: string;
-    /** Compatibility option for existing integrations. Current section responses return the section title. */
+    /**
+     * Deprecated: Current section responses always include the section title. This field is ignored.
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
+     */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -529,8 +555,10 @@ interface CloneSectionRequest {
      */
     sectionId: string;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -552,8 +580,10 @@ interface MoveSectionRequest {
     /** Current revision of the section. When provided, it must match the current revision to protect against conflicting updates. */
     revision?: string;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -594,8 +624,10 @@ interface RestoreSectionFromTrashRequest {
      */
     sectionId?: string;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -802,8 +834,10 @@ interface AccountInfo {
 declare function createSection(section: NonNullablePaths<Section, `programId`, 0>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
 interface CreateSectionOptions {
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -827,15 +861,15 @@ interface CreateSectionOptions {
 declare function bulkCreateSections(sections: NonNullablePaths<Section, `programId`, 0>[], options?: BulkCreateSectionsOptions): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
 interface BulkCreateSectionsOptions {
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
  * Retrieves a section.
- *
- * `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
  * @param sectionId - ID of the Section to retrieve.
  * @public
  * @documentationMaturity preview
@@ -847,11 +881,17 @@ interface BulkCreateSectionsOptions {
  */
 declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
 interface GetSectionOptions {
-    /** Compatibility option for existing integrations. Current section responses return the section title. */
+    /**
+     * Deprecated: Current section responses always include the section title. This field is ignored.
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
+     */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -920,8 +960,10 @@ interface UpdateSectionOptions {
         extendedFields?: ExtendedFields;
     };
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -941,6 +983,9 @@ declare function deleteSection(sectionId: string): Promise<void>;
 /**
  * Retrieves a list of up to 1,000 sections, given the provided paging, filtering, and sorting.
  *
+ * Use this method when you need to filter sections, apply custom sorting or paging, or query across programs.
+ * When you know the program ID and need all sections in program order, call [List Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/list-sections).
+ *
  * Query Sections runs with these defaults, which you can override:
  *
  * - `createdDate` is sorted in `DESC` order.
@@ -950,7 +995,6 @@ 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).
  * @public
@@ -961,11 +1005,17 @@ declare function deleteSection(sectionId: string): Promise<void>;
  */
 declare function querySections(options?: QuerySectionsOptions): SectionsQueryBuilder;
 interface QuerySectionsOptions {
-    /** Compatibility option for existing integrations. Current section responses return the section title. */
+    /**
+     * Deprecated: Current section responses always include the section title. This field is ignored.
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
+     */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals | undefined;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[] | undefined;
 }
@@ -1122,11 +1172,13 @@ declare const utils: {
     query: _wix_sdk_types.QueryHelpers<Section, SectionQuerySpec, SectionQuery>;
 };
 /**
- * Retrieves the sections in a program.
+ * Retrieves all sections in a program.
  *
- * Results are sorted by `ordering` in ascending order. `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
+ * Use this method when you know the program ID and need all sections in program order.
  *
- * To filter or sort sections, call [Query Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/query-sections).
+ * Results are sorted by `ordering` in ascending order.
+ *
+ * To filter sections, apply custom sorting or paging, or query across programs, call [Query Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/query-sections).
  * @param programId - Program ID to list sections for.
  * @public
  * @documentationMaturity preview
@@ -1137,11 +1189,17 @@ declare const utils: {
  */
 declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
 interface ListSectionsOptions {
-    /** Compatibility option for existing integrations. Current section responses return the section title. */
+    /**
+     * Deprecated: Current section responses always include the section title. This field is ignored.
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
+     */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -1164,8 +1222,10 @@ interface ListSectionsOptions {
 declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
 interface CloneSectionOptions {
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }
@@ -1193,8 +1253,10 @@ interface MoveSectionOptions {
     /** Current revision of the section. When provided, it must match the current revision to protect against conflicting updates. */
     revision?: string;
     /**
-     * Predefined sets of fields to return.
+     * Deprecated: `total_steps` is always returned. This field is ignored.
      * @maxSize 1
+     * @deprecated
+     * @targetRemovalDate 2026-12-31
      */
     fields?: RequestedFieldsWithLiterals[];
 }