@wix/auto_sdk_online-programs_sections 1.0.24 → 1.0.26

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

@@ -35,13 +35,8 @@ interface Section {
      * @immutable
      */
     programId?: string;
-    /** Section title and deprecated backward-compatibility content fields. */
+    /** Section title. */
     description?: Description;
-    /**
-     * Legacy total number of steps in the section.
-     * @readonly
-     */
-    oldTotalSteps?: number;
     /**
      * Total number of steps in the section.
      * @readonly
@@ -57,33 +52,10 @@ interface Section {
     /** Custom field data for the section. */
     extendedFields?: ExtendedFields;
 }
-interface Description extends DescriptionMediaOneOf {
+interface Description {
     /** @maxLength 500 */
     title?: string;
 }
-/** @oneof */
-interface DescriptionMediaOneOf {
-}
-interface FocalPoint {
-    /** X-coordinate of the focal point. */
-    x?: number;
-    /** Y-coordinate of the focal point. */
-    y?: number;
-    /** crop by height */
-    height?: number | null;
-    /** crop by width */
-    width?: number | null;
-}
-interface VideoResolution {
-    /** Video URL. */
-    url?: string;
-    /** Video height. */
-    height?: number;
-    /** Video width. */
-    width?: number;
-    /** Video format for example, mp4, hls. */
-    format?: string;
-}
 declare enum State {
     /** Retained for backward compatibility. Doesn't affect whether the section is served. */
     DRAFT = "DRAFT",
@@ -844,7 +816,7 @@ interface AccountInfo {
 /**
  * Creates a section.
  *
- * 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. `section.description.details`, `section.description.image`, and `section.description.video` are deprecated backward-compatibility fields. The stored ordering value is assigned automatically.
+ * 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.
  *
  * 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`.
@@ -857,7 +829,7 @@ interface AccountInfo {
  * @returns Created section.
  * @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
  */
-declare function createSection(section: NonNullablePaths<Section, `programId`, 0>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 1>>;
+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.
@@ -868,7 +840,7 @@ interface CreateSectionOptions {
 /**
  * Creates up to 100 sections in a single API call.
  *
- * All sections in the request must include `program_id` and belong to the same program. Set `description.title` for each section title. `description.details`, `description.image`, and `description.video` are deprecated backward-compatibility fields. The stored ordering values are assigned automatically.
+ * 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.
  *
  * 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.
@@ -901,7 +873,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` | `ordering` | `delayInDays`, 1>>;
+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. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
@@ -927,7 +899,7 @@ interface GetSectionOptions {
  * @returns Updated section.
  * @fqn wix.onlineprograms.sections.v3.SectionsService.UpdateSection
  */
-declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 1>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `ordering` | `delayInDays`, 1>>;
+declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 1>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
 interface UpdateSectionOptions {
     section?: {
         /**
@@ -958,13 +930,8 @@ interface UpdateSectionOptions {
          * @immutable
          */
         programId?: string;
-        /** Section title and deprecated backward-compatibility content fields. */
+        /** Section title. */
         description?: Description;
-        /**
-         * Legacy total number of steps in the section.
-         * @readonly
-         */
-        oldTotalSteps?: number;
         /**
          * Total number of steps in the section.
          * @readonly
@@ -1113,7 +1080,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}.ordering` | `sections.${number}.delayInDays`, 3>>;
+declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 3>>;
 interface SectionQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
@@ -1202,7 +1169,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}.ordering` | `sections.${number}.delayInDays`, 3>>;
+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. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
@@ -1224,7 +1191,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.ordering` | `section.delayInDays`, 2>>;
+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.
@@ -1244,7 +1211,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.ordering` | `section.delayInDays`, 2>>;
+declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
 interface MoveSectionOptions {
     /**
      * ID of the section to move.
@@ -1265,4 +1232,4 @@ interface MoveSectionOptions {
     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 DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, 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 PublishSectionRequest, type PublishSectionResponse, 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 SectionPublished, 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, type VideoResolution, 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 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 PublishSectionRequest, type PublishSectionResponse, 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 SectionPublished, 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 };