@wix/auto_sdk_online-programs_sections 1.0.0

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

@@ -0,0 +1,1128 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface Section {
+    /**
+     * Program Section ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Represents the time this Section was created
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Represents the time this Section was last updated
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Program Id to which this section is assigned to.
+     * @format GUID
+     * @readonly
+     */
+    programId?: string;
+    /** title, description and media content. */
+    description?: Description;
+    /** is this section published yet? */
+    state?: StateWithLiterals;
+    /**
+     * number of program steps in this section.
+     * @readonly
+     */
+    oldTotalSteps?: number;
+    /**
+     * number of program steps in this section.
+     * @readonly
+     */
+    totalSteps?: number | null;
+    /** should we open this section as a trial content even though the owning program isn't purchased yet? */
+    trialSection?: boolean;
+    /** field for manual ordering of sections */
+    ordering?: number;
+    /**
+     * open after defined number of days passed.
+     * @max 5000
+     */
+    delayInDays?: number;
+    /** extensible field */
+    extendedFields?: ExtendedFields;
+}
+interface Description extends DescriptionMediaOneOf {
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    image?: string;
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    video?: string;
+    /** @maxLength 500 */
+    title?: string;
+    /** @maxLength 10000000 */
+    details?: string | null;
+}
+/** @oneof */
+interface DescriptionMediaOneOf {
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    image?: string;
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    video?: string;
+}
+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 {
+    /** invalid default state. */
+    UNKNOWN_STATE = "UNKNOWN_STATE",
+    /** the section isn't ready to be shown to participants. */
+    DRAFT = "DRAFT",
+    /** this content is visible to participants. */
+    PUBLISHED = "PUBLISHED"
+}
+/** @enumType */
+type StateWithLiterals = State | 'UNKNOWN_STATE' | 'DRAFT' | 'PUBLISHED';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
+    /** insert/update documents */
+    update?: DocumentUpdateOperation;
+    /** delete by document ids */
+    deleteByIds?: DeleteByIdsOperation;
+    /** delete documents matching filter */
+    deleteByFilter?: DeleteByFilterOperation;
+    /** update documents matching filter */
+    updateByFilter?: UpdateByFilterOperation;
+    /** update only existing documents */
+    updateExisting?: UpdateExistingOperation;
+    /**
+     * application which owns documents
+     * @minLength 2
+     */
+    appDefId?: string | null;
+    /**
+     * type of the documents
+     * @minLength 2
+     */
+    documentType?: string | null;
+    /**
+     * language of the documents
+     * @minLength 2
+     */
+    language?: string | null;
+    /**
+     * site documents belong to
+     * @minLength 2
+     */
+    msId?: string | null;
+}
+/** @oneof */
+interface UpdateDocumentsEventOperationOneOf {
+    /** insert/update documents */
+    update?: DocumentUpdateOperation;
+    /** delete by document ids */
+    deleteByIds?: DeleteByIdsOperation;
+    /** delete documents matching filter */
+    deleteByFilter?: DeleteByFilterOperation;
+    /** update documents matching filter */
+    updateByFilter?: UpdateByFilterOperation;
+    /** update only existing documents */
+    updateExisting?: UpdateExistingOperation;
+}
+interface DocumentUpdateOperation {
+    /** documents to index or update */
+    documents?: IndexDocument[];
+}
+interface IndexDocument {
+    /** data bag with non-searchable fields (url, image) */
+    payload?: DocumentPayload;
+    /** what type of users should documents be visible to */
+    exposure?: EnumWithLiterals;
+    /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
+    document?: Record<string, any> | null;
+    /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
+    permittedMemberGroups?: string[];
+    /** if true SEO is disabled for this document */
+    seoHidden?: boolean | null;
+    /** if true the page is a lightbox popup */
+    isPopup?: boolean | null;
+}
+interface DocumentPayload {
+    /** url of the page representing the document */
+    url?: string | null;
+    /** image which represents the document */
+    documentImage?: DocumentImage;
+}
+interface DocumentImage {
+    /** the name of the image */
+    name?: string;
+    /** the width of the image */
+    width?: number;
+    /** the height of the image */
+    height?: number;
+}
+declare enum Enum {
+    /** Default value. Means that permission not set */
+    UNKNOWN = "UNKNOWN",
+    /** Protected exposure. Exposed to members and owners */
+    PROTECTED = "PROTECTED",
+    /** Private exposure. Exposed to owners */
+    PRIVATE = "PRIVATE",
+    /** Public exposure. Visible to everyone */
+    PUBLIC = "PUBLIC",
+    /** Used for partial updates, to state that exposure is not changing */
+    UNCHANGED = "UNCHANGED",
+    /** Protected to members of permitted groups and owners */
+    GROUP_PROTECTED = "GROUP_PROTECTED"
+}
+/** @enumType */
+type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED';
+interface DeleteByIdsOperation {
+    /** ids of the documents to delete */
+    documentIds?: string[];
+}
+interface DeleteByFilterOperation {
+    /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
+    filter?: Record<string, any> | null;
+}
+interface UpdateByFilterOperation {
+    /** documents matching this filter will be updated */
+    filter?: Record<string, any> | null;
+    /** partial document to apply */
+    document?: IndexDocument;
+}
+interface UpdateExistingOperation {
+    /** documents to update */
+    documents?: IndexDocument[];
+}
+interface SectionUpdated {
+    /** Section before update. */
+    previous?: Section;
+    /** Section after update. */
+    current?: Section;
+}
+interface SectionDeleted {
+    /** Full section that was deleted */
+    section?: Section;
+}
+interface SectionCloned {
+    /** Section which was used as a prototype for cloning. */
+    prototype?: Section;
+    /** Result of section cloning. */
+    cloned?: Section;
+}
+interface SectionMoved {
+    /**
+     * Moved section id
+     * @format GUID
+     */
+    sectionId?: string;
+    /** section position */
+    newSectionPositionRank?: number;
+}
+interface SectionPublished {
+    /**
+     * Published section id
+     * @format GUID
+     */
+    sectionId?: string;
+}
+interface CreateSectionRequest {
+    /** Section to be created. */
+    section: Section;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+declare enum RequestedFields {
+    /** not implemented, invalid default value. */
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** return total number of steps in this section. */
+    TOTAL_STEPS = "TOTAL_STEPS"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'TOTAL_STEPS';
+interface CreateSectionResponse {
+    /** The created Section. */
+    section?: Section;
+}
+interface BulkCreateSectionRequest {
+    /**
+     * List of sections you want to create
+     * @minSize 1
+     * @maxSize 100
+     */
+    sections: Section[];
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface BulkCreateSectionResponse {
+    /** bulk results */
+    results?: BulkSectionResult[];
+    /** bulk metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkSectionResult {
+    /** item metadata */
+    itemMetadata?: ItemMetadata;
+    /** created section */
+    item?: Section;
+    /** indicator whether it was create or update */
+    action?: BulkActionTypeWithLiterals;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+declare enum BulkActionType {
+    UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
+    INSERT = "INSERT",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE"
+}
+/** @enumType */
+type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE' | 'DELETE';
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkCreateSectionMigrationRequest {
+    /**
+     * List of sections you want to create
+     * @minSize 1
+     * @maxSize 100
+     */
+    sections: Section[];
+}
+interface BulkCreateSectionMigrationResponse {
+    /** bulk results */
+    results?: BulkSectionResult[];
+    /** bulk metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface GetSectionRequest {
+    /**
+     * ID of the Section to retrieve.
+     * @format GUID
+     */
+    sectionId: string;
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+declare enum DescriptionFieldSet {
+    STANDARD = "STANDARD",
+    EXTENDED = "EXTENDED"
+}
+/** @enumType */
+type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'STANDARD' | 'EXTENDED';
+interface GetSectionResponse {
+    /** The requested Section. */
+    section?: Section;
+}
+interface UpdateSectionRequest {
+    /** Section to be updated, may be partial. */
+    section?: Section;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface UpdateSectionResponse {
+    /** Updated Section. */
+    section?: Section;
+}
+interface DeleteSectionRequest {
+    /**
+     * Id of the Section to delete.
+     * @format GUID
+     */
+    sectionId: string;
+}
+interface DeleteSectionResponse {
+}
+interface DeleteAllProgramSectionsRequest {
+    /**
+     * Program id to delete sections from
+     * @format GUID
+     */
+    programId?: string;
+}
+interface DeleteAllProgramSectionsResponse {
+    /** Total count of sections in the program */
+    sectionsTotal?: number;
+    /** Count of successfully deleted sections */
+    successfulCount?: number;
+    /** Count of sections that failed to be deleted */
+    failedCount?: number;
+}
+interface QuerySectionsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Program id to query sections
+     * @maxLength 36
+     */
+    programId?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QuerySectionsResponse {
+    /** List of Sections. */
+    sections?: Section[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface ListSectionsRequest {
+    /**
+     * Program id to list sections
+     * @format GUID
+     */
+    programId: string;
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface ListSectionsResponse {
+    /**
+     * sections
+     * @maxSize 1000
+     */
+    sections?: Section[];
+}
+interface CloneSectionRequest {
+    /**
+     * Section to clone
+     * @format GUID
+     */
+    sectionId: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface CloneSectionResponse {
+    /** cloned section */
+    section?: Section;
+}
+interface MoveSectionRequest {
+    /**
+     * Section to move
+     * @format GUID
+     */
+    sectionId?: string;
+    /**
+     * change section position to be after the specified section. If empty insert in the "0" position.
+     * @format GUID
+     */
+    afterSectionId?: string | null;
+    /** section revision */
+    revision?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface MoveSectionResponse {
+    /** updated section which was moved */
+    section?: Section;
+}
+interface PublishSectionRequest {
+    /**
+     * Section to publish
+     * @format GUID
+     */
+    sectionId?: string;
+    /** section revision */
+    revision?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface PublishSectionResponse {
+    /** Published section */
+    section?: Section;
+}
+interface BulkCloneSectionRequest {
+    /**
+     * id of program which was cloned
+     * @format GUID
+     */
+    prototypeProgramId?: string;
+    /**
+     * id of program created after clone
+     * @format GUID
+     */
+    clonedProgramId?: string;
+}
+interface BulkCloneSectionResponse {
+    /**
+     * id of program which was cloned
+     * @format GUID
+     */
+    prototypeProgramId?: string;
+    /**
+     * id of program created after clone
+     * @format GUID
+     */
+    clonedProgramId?: string;
+    /** mapping of original to cloned section ids */
+    prototypeIdToClonedId?: Record<string, string>;
+}
+interface RestoreSectionFromTrashRequest {
+    /**
+     * section id to restore
+     * @format GUID
+     */
+    sectionId?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface RestoreSectionFromTrashResponse {
+    /** restored section */
+    section?: Section;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface SearchIndexingNotification {
+    /** new state of indexing for the site specified in ms_id */
+    indexState?: SearchIndexingNotificationStateWithLiterals;
+    /** type of the document the notification is targeted for. Applies to all types if not provided */
+    documentType?: string | null;
+    /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
+    language?: string | null;
+    /**
+     * site for which notification is targeted
+     * @minLength 2
+     */
+    msId?: string | null;
+}
+declare enum SearchIndexingNotificationState {
+    /** default state */
+    Unknown = "Unknown",
+    /** metasite does not require site search indexing */
+    Off = "Off",
+    /** metasite requires site search indexing */
+    On = "On"
+}
+/** @enumType */
+type SearchIndexingNotificationStateWithLiterals = SearchIndexingNotificationState | 'Unknown' | 'Off' | 'On';
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/**
+ * Creates a Section.
+ * @param section - Section to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField section
+ * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
+ * @applicableIdentity APP
+ * @returns The created Section.
+ * @fqn wix.onlineprograms.sections.v3.SectionsService.CreateSection
+ */
+declare function createSection(section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+interface CreateSectionOptions {
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Bulk Section creation.
+ * @param sections - List of sections you want to create
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sections
+ * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSection
+ */
+declare function bulkCreateSection(sections: Section[], options?: BulkCreateSectionOptions): Promise<NonNullablePaths<BulkCreateSectionResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.programId` | `results.${number}.item.description.title` | `results.${number}.item.state` | `results.${number}.item.oldTotalSteps` | `results.${number}.item.trialSection` | `results.${number}.item.ordering` | `results.${number}.item.delayInDays` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+interface BulkCreateSectionOptions {
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Bulk Section creation for migration.
+ * @param sections - List of sections you want to create
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sections
+ * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSectionMigration
+ */
+declare function bulkCreateSectionMigration(sections: Section[]): Promise<NonNullablePaths<BulkCreateSectionMigrationResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.programId` | `results.${number}.item.description.title` | `results.${number}.item.state` | `results.${number}.item.oldTotalSteps` | `results.${number}.item.trialSection` | `results.${number}.item.ordering` | `results.${number}.item.delayInDays` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+/**
+ * Retrieves a Section.
+ * @param sectionId - ID of the Section to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sectionId
+ * @permissionId ONLINE_PROGRAMS.SECTION_READ
+ * @applicableIdentity APP
+ * @returns The requested Section.
+ * @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
+ */
+declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+interface GetSectionOptions {
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Updates a Section.
+ * @param _id - Program Section ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options.section.revision
+ * @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
+ * @applicableIdentity APP
+ * @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` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+interface UpdateSectionOptions {
+    section: {
+        /**
+         * Program Section ID.
+         * @format GUID
+         * @readonly
+         */
+        _id?: string | null;
+        /**
+         * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision
+         * @readonly
+         */
+        revision?: string | null;
+        /**
+         * Represents the time this Section was created
+         * @readonly
+         */
+        _createdDate?: Date | null;
+        /**
+         * Represents the time this Section was last updated
+         * @readonly
+         */
+        _updatedDate?: Date | null;
+        /**
+         * Program Id to which this section is assigned to.
+         * @format GUID
+         * @readonly
+         */
+        programId?: string;
+        /** title, description and media content. */
+        description?: Description;
+        /** is this section published yet? */
+        state?: StateWithLiterals;
+        /**
+         * number of program steps in this section.
+         * @readonly
+         */
+        oldTotalSteps?: number;
+        /**
+         * number of program steps in this section.
+         * @readonly
+         */
+        totalSteps?: number | null;
+        /** should we open this section as a trial content even though the owning program isn't purchased yet? */
+        trialSection?: boolean;
+        /** field for manual ordering of sections */
+        ordering?: number;
+        /**
+         * open after defined number of days passed.
+         * @max 5000
+         */
+        delayInDays?: number;
+        /** extensible field */
+        extendedFields?: ExtendedFields;
+    };
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Deletes a Section.
+ * Deleting a Section permanently removes them from the Section List.
+ * @param sectionId - Id of the Section to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sectionId
+ * @permissionId ONLINE_PROGRAMS.SECTION_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.sections.v3.SectionsService.DeleteSection
+ */
+declare function deleteSection(sectionId: string): Promise<void>;
+/**
+ * Retrieves a list of Sections, given the provided [paging, filtering, and sorting][1].
+ *
+ * Up to 1,000 Sections can be returned per request.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ONLINE_PROGRAMS.SECTION_READ
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
+ */
+declare function querySections(options?: QuerySectionsOptions): SectionsQueryBuilder;
+interface QuerySectionsOptions {
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals | undefined;
+    /**
+     * Program id to query sections
+     * @maxLength 36
+     */
+    programId?: string | undefined;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface SectionsQueryResult extends QueryCursorResult {
+    items: Section[];
+    query: SectionsQueryBuilder;
+    next: () => Promise<SectionsQueryResult>;
+    prev: () => Promise<SectionsQueryResult>;
+}
+interface SectionsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'programId' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id', value: any) => SectionsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id', value: any) => 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' | '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' | 'ordering' | 'delayInDays'>) => SectionsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => SectionsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => SectionsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<SectionsQueryResult>;
+}
+/**
+ * List sections per program id
+ * @param programId - Program id to list sections
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId ONLINE_PROGRAMS.SECTION_READ
+ * @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}.state` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
+interface ListSectionsOptions {
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Clones section with specified id
+ * @param sectionId - Section to clone
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sectionId
+ * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
+ * @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.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+interface CloneSectionOptions {
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Places section after specified one or inserts it in the beginning
+ * @public
+ * @documentationMaturity preview
+ * @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.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+interface MoveSectionOptions {
+    /**
+     * Section to move
+     * @format GUID
+     */
+    sectionId?: string;
+    /**
+     * change section position to be after the specified section. If empty insert in the "0" position.
+     * @format GUID
+     */
+    afterSectionId?: string | null;
+    /** section revision */
+    revision?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Publishes section
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ONLINE_PROGRAMS.SECTION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.sections.v3.SectionsService.PublishSection
+ */
+declare function publishSection(options?: PublishSectionOptions): Promise<NonNullablePaths<PublishSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+interface PublishSectionOptions {
+    /**
+     * Section to publish
+     * @format GUID
+     */
+    sectionId?: string;
+    /** section revision */
+    revision?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+
+export { type ActionEvent, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionOptions, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, 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 PublishSectionOptions, 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 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, bulkCreateSection, bulkCreateSectionMigration, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, updateSection };