@wix/auto_sdk_online-programs_sections 1.0.32 → 1.0.34

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

@@ -42,10 +42,13 @@ interface Section {
      * @readonly
      */
     totalSteps?: number | null;
-    /** Position rank used to order sections within a program. To reorder sections, call Move Section. */
+    /**
+     * Position rank used to order sections within a program. To reorder sections, call Move Section.
+     * @readonly
+     */
     ordering?: number;
     /**
-     * Number of days before the section becomes available — counted from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced ones. Someone joining a scheduled program after it began may find several sections already open. Use 0 for a section available from the start.
+     * Number of days before the section becomes available. The count starts from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced ones. Someone joining a scheduled program after it began may find several sections already open. Use `0` for a section available from the start.
      * @max 5000
      */
     delayInDays?: number;
@@ -202,7 +205,7 @@ interface SectionDeleted {
 interface SectionCloned {
     /** Source section used for cloning. */
     prototype?: Section;
-    /** Cloned section. */
+    /** Cloned section. Steps are cloned asynchronously after this event is sent, so `totalSteps` may not reflect the eventual number of cloned steps. Retrieve the section later for the current count. */
     cloned?: Section;
 }
 interface SectionMoved {
@@ -215,7 +218,7 @@ interface SectionMoved {
     newSectionPositionRank?: number;
 }
 interface CreateSectionRequest {
-    /** Section to create. Must include `section.program_id`. */
+    /** Section to create. Must include `section.programId`. */
     section: Section;
     /**
      * Deprecated: `total_steps` is always returned. This field is ignored.
@@ -237,7 +240,7 @@ interface CreateSectionResponse {
 }
 interface BulkCreateSectionsRequest {
     /**
-     * List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
+     * List of sections to create. Each section must include `programId`, and all sections must belong to the same program.
      * @minSize 1
      * @maxSize 100
      */
@@ -298,7 +301,7 @@ interface BulkActionMetadata {
 }
 interface BulkCreateSectionRequest {
     /**
-     * List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
+     * List of sections to create. Each section must include `programId`, and all sections must belong to the same program.
      * @minSize 1
      * @maxSize 100
      */
@@ -799,15 +802,132 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** 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;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface SectionClonedEnvelope {
+    data: SectionCloned;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a section is cloned.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.SECTION_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.section_cloned
+ * @slug cloned
+ * @documentationMaturity preview
+ */
+declare function onSectionCloned(handler: (event: SectionClonedEnvelope) => void | Promise<void>): void;
+interface SectionCreatedEnvelope {
+    entity: Section;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a section is created.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.SECTION_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.section_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onSectionCreated(handler: (event: SectionCreatedEnvelope) => void | Promise<void>): void;
+interface SectionDeletedEnvelope {
+    entity: Section;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a section is deleted.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.SECTION_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.section_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onSectionDeleted(handler: (event: SectionDeletedEnvelope) => void | Promise<void>): void;
+interface SectionUpdatedEnvelope {
+    entity: Section;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/**
+ * Triggered when a section is updated.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.SECTION_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.section_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onSectionUpdated(handler: (event: SectionUpdatedEnvelope) => void | Promise<void>): void;
 /**
  * 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. The stored ordering value is assigned automatically.
+ * The section is added to the program identified by `section.programId`. Specify 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`.
+ * @param section - Section to create. Must include `section.programId`.
  * @public
  * @documentationMaturity preview
  * @requiredField section
@@ -830,12 +950,12 @@ 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. The stored ordering values are assigned automatically.
+ * All sections in the request must include `programId` 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.
+ * @param sections - List of sections to create. Each section must include `programId`, and all sections must belong to the same program.
  * @public
  * @documentationMaturity preview
  * @requiredField sections
@@ -935,10 +1055,13 @@ interface UpdateSectionOptions {
          * @readonly
          */
         totalSteps?: number | null;
-        /** Position rank used to order sections within a program. To reorder sections, call Move Section. */
+        /**
+         * Position rank used to order sections within a program. To reorder sections, call Move Section.
+         * @readonly
+         */
         ordering?: number;
         /**
-         * Number of days before the section becomes available — counted from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced ones. Someone joining a scheduled program after it began may find several sections already open. Use 0 for a section available from the start.
+         * Number of days before the section becomes available. The count starts from the program's start date for scheduled programs, or from the participant's enrollment date for self-paced ones. Someone joining a scheduled program after it began may find several sections already open. Use `0` for a section available from the start.
          * @max 5000
          */
         delayInDays?: number;
@@ -1194,6 +1317,8 @@ interface ListSectionsOptions {
  *
  * 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.
  *
+ * This method triggers both a Section Created lifecycle event for the new section and a Section Cloned action event containing the source and cloned sections.
+ *
  * 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.
@@ -1247,4 +1372,4 @@ interface MoveSectionOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 
-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 };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type ApplicationError, type BaseEventMetadata, 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 EventMetadata, 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 SectionClonedEnvelope, type SectionCreatedEnvelope, type SectionDeleted, type SectionDeletedEnvelope, type SectionMoved, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionUpdatedEnvelope, 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, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, typedQuerySections, updateSection, utils };