@wix/auto_sdk_online-programs_sections 1.0.33 → 1.0.34

package/build/cjs/index.d.ts

@@ -1,18 +1,18 @@
-import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { Section, CreateSectionOptions, BulkCreateSectionsOptions, BulkCreateSectionsResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.js';
-export { AccountInfo, ActionEvent, AddressLocation, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, ExtendedFields, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { Section, CreateSectionOptions, BulkCreateSectionsOptions, BulkCreateSectionsResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionUpdatedEnvelope, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, EventMetadata, ExtendedFields, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
 
 declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
 interface CreateSectionSignature {
     /**
      * 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 to create. Must include `section.program_id`.
+     * @param - Section to create. Must include `section.programId`.
      * @returns Created section.
      */
     (section: NonNullablePaths<Section, `programId`, 0>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `ordering` | `delayInDays`, 1>>;
@@ -22,12 +22,12 @@ interface BulkCreateSectionsSignature {
     /**
      * 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 - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
+     * @param - List of sections to create. Each section must include `programId`, and all sections must belong to the same program.
      */
     (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>>;
 }
@@ -84,6 +84,8 @@ interface CloneSectionSignature {
      *
      * 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.
@@ -103,6 +105,10 @@ interface MoveSectionSignature {
      */
     (sectionId: string, options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.ordering` | `section.delayInDays`, 2>>;
 }
+declare const onSectionCloned$1: EventDefinition<SectionClonedEnvelope, "wix.online_programs.v3.section_cloned">;
+declare const onSectionCreated$1: EventDefinition<SectionCreatedEnvelope, "wix.online_programs.v3.section_created">;
+declare const onSectionDeleted$1: EventDefinition<SectionDeletedEnvelope, "wix.online_programs.v3.section_deleted">;
+declare const onSectionUpdated$1: EventDefinition<SectionUpdatedEnvelope, "wix.online_programs.v3.section_updated">;
 
 declare function customQuerySections(httpClient: HttpClient): {
     (query: SectionQuery, options?: QuerySectionsOptions): ReturnType<typeof typedQuerySections>;
@@ -117,5 +123,21 @@ declare const listSections: MaybeContext<BuildRESTFunction<typeof listSections$1
 declare const cloneSection: MaybeContext<BuildRESTFunction<typeof cloneSection$1> & typeof cloneSection$1>;
 declare const moveSection: MaybeContext<BuildRESTFunction<typeof moveSection$1> & typeof moveSection$1>;
 declare const querySections: MaybeContext<BuildRESTFunction<typeof customQuerySections> & typeof customQuerySections>;
+/**
+ * Triggered when a section is cloned.
+ */
+declare const onSectionCloned: BuildEventDefinition<typeof onSectionCloned$1> & typeof onSectionCloned$1;
+/**
+ * Triggered when a section is created.
+ */
+declare const onSectionCreated: BuildEventDefinition<typeof onSectionCreated$1> & typeof onSectionCreated$1;
+/**
+ * Triggered when a section is deleted.
+ */
+declare const onSectionDeleted: BuildEventDefinition<typeof onSectionDeleted$1> & typeof onSectionDeleted$1;
+/**
+ * Triggered when a section is updated.
+ */
+declare const onSectionUpdated: BuildEventDefinition<typeof onSectionUpdated$1> & typeof onSectionUpdated$1;
 
-export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, QuerySectionsOptions, Section, SectionQuery, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, updateSection };
+export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, QuerySectionsOptions, Section, SectionClonedEnvelope, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionQuery, SectionUpdatedEnvelope, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, onSectionCloned, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };

package/build/cjs/index.js

@@ -35,12 +35,23 @@ __export(index_exports, {
   getSection: () => getSection4,
   listSections: () => listSections4,
   moveSection: () => moveSection4,
+  onSectionCloned: () => onSectionCloned2,
+  onSectionCreated: () => onSectionCreated2,
+  onSectionDeleted: () => onSectionDeleted2,
+  onSectionUpdated: () => onSectionUpdated2,
   querySections: () => querySections4,
   updateSection: () => updateSection4,
   utils: () => utils
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/online-programs-v3-section-sections.public.ts
+var import_rename_all_nested_keys2 = require("@wix/sdk-runtime/rename-all-nested-keys");
+var import_float3 = require("@wix/sdk-runtime/transformations/float");
+var import_timestamp3 = require("@wix/sdk-runtime/transformations/timestamp");
+var import_transform_paths3 = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_sdk_types = require("@wix/sdk-types");
+
 // src/online-programs-v3-section-sections.universal.ts
 var import_transform_error = require("@wix/sdk-runtime/transform-error");
 var import_query_builder = require("@wix/sdk-runtime/query-builder");
@@ -934,9 +945,100 @@ function moveSection3(httpClient) {
     { httpClient }
   );
 }
+var onSectionCloned = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.online_programs.v3.section_cloned",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "data.prototype.createdDate" },
+          { path: "data.prototype.updatedDate" },
+          { path: "data.cloned.createdDate" },
+          { path: "data.cloned.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_float3.transformRESTFloatToSDKFloat,
+        paths: [
+          { path: "data.prototype.ordering" },
+          { path: "data.cloned.ordering" }
+        ]
+      }
+    ])
+  )
+)();
+var onSectionCreated = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.online_programs.v3.section_created",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "entity.createdDate" },
+          { path: "entity.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_float3.transformRESTFloatToSDKFloat,
+        paths: [{ path: "entity.ordering" }]
+      }
+    ])
+  )
+)();
+var onSectionDeleted = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.online_programs.v3.section_deleted",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "entity.createdDate" },
+          { path: "entity.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_float3.transformRESTFloatToSDKFloat,
+        paths: [{ path: "entity.ordering" }]
+      }
+    ])
+  )
+)();
+var onSectionUpdated = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.online_programs.v3.section_updated",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "entity.createdDate" },
+          { path: "entity.updatedDate" },
+          { path: "metadata.eventTime" },
+          { path: "modifiedFields.createdDate" },
+          { path: "modifiedFields.updatedDate" }
+        ]
+      },
+      {
+        transformFn: import_float3.transformRESTFloatToSDKFloat,
+        paths: [
+          { path: "entity.ordering" },
+          { path: "modifiedFields.ordering" }
+        ]
+      }
+    ])
+  )
+)();
 
 // src/online-programs-v3-section-sections.context.ts
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
+var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
 var import_query_method_router = require("@wix/sdk-runtime/query-method-router");
 function customQuerySections(httpClient) {
   const router = /* @__PURE__ */ (0, import_query_method_router.createQueryOverloadRouter)({
@@ -958,6 +1060,18 @@ var listSections4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(l
 var cloneSection4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(cloneSection3);
 var moveSection4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(moveSection3);
 var querySections4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQuerySections);
+var onSectionCloned2 = /* @__PURE__ */ (0, import_event_definition_modules.createEventModule)(
+  onSectionCloned
+);
+var onSectionCreated2 = /* @__PURE__ */ (0, import_event_definition_modules.createEventModule)(
+  onSectionCreated
+);
+var onSectionDeleted2 = /* @__PURE__ */ (0, import_event_definition_modules.createEventModule)(
+  onSectionDeleted
+);
+var onSectionUpdated2 = /* @__PURE__ */ (0, import_event_definition_modules.createEventModule)(
+  onSectionUpdated
+);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BulkActionType,
@@ -975,6 +1089,10 @@ var querySections4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(
   getSection,
   listSections,
   moveSection,
+  onSectionCloned,
+  onSectionCreated,
+  onSectionDeleted,
+  onSectionUpdated,
   querySections,
   updateSection,
   utils