@wix/auto_sdk_online-programs_sections 1.0.30 → 1.0.32

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

@@ -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[];
 }
@@ -311,31 +317,23 @@ interface BulkCreateSectionResponse {
     /** Summary of the bulk create operation. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface BulkCreateSectionMigrationRequest {
-    /**
-     * List of sections to create.
-     * @minSize 1
-     * @maxSize 100
-     */
-    sections?: Section[];
-}
-interface BulkCreateSectionMigrationResponse {
-    /** Results for the bulk create operation. */
-    results?: BulkSectionResult[];
-    /** Summary of the bulk create operation. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
 interface GetSectionRequest {
     /**
      * ID of the Section to retrieve.
      * @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 +353,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 +391,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 +513,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 +541,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 +566,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 +610,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 +820,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 +847,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 +867,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 +946,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 +969,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 +981,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 +991,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 +1158,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 +1175,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 +1208,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,10 +1239,12 @@ 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[];
 }
 
-export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, 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 DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, 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 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 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, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, typedQuerySections, updateSection, utils };
+export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, 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 DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, 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 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 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, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, typedQuerySections, updateSection, utils };