@wix/auto_sdk_online-programs_sections 1.0.13 → 1.0.14

package/build/cjs/index.d.ts

@@ -1,86 +1,105 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { Section, CreateSectionOptions, BulkCreateSectionOptions, BulkCreateSectionResponse, BulkCreateSectionMigrationResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, PublishSectionOptions, PublishSectionResponse, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.js';
-export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionMigrationRequest, BulkCreateSectionRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DescriptionMediaOneOf, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, ExtendedFields, FocalPoint, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, PublishSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionPublished, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, VideoResolution, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
+import { Section, CreateSectionOptions, BulkCreateSectionOptions, BulkCreateSectionResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, PublishSectionOptions, PublishSectionResponse, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.js';
+export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionMigrationRequest, BulkCreateSectionMigrationResponse, BulkCreateSectionRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DescriptionMediaOneOf, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, ExtendedFields, FocalPoint, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, PublishSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionPublished, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, VideoResolution, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
 
 declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
 interface CreateSectionSignature {
     /**
-     * Creates a Section.
-     * @param - Section to be created.
-     * @returns The created Section.
+     * 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.
+     *
+     * To create multiple sections in a single API call, call [Bulk Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/bulk-create-section).
+     * @param - Section to create. Must include `section.program_id`.
+     * @returns Created section.
      */
     (section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
 }
 declare function bulkCreateSection$1(httpClient: HttpClient): BulkCreateSectionSignature;
 interface BulkCreateSectionSignature {
     /**
-     * Bulk Section creation.
-     * @param - List of sections you want to create
+     * 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.
+     *
+     * 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.
      */
     (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>>;
 }
-declare function bulkCreateSectionMigration$1(httpClient: HttpClient): BulkCreateSectionMigrationSignature;
-interface BulkCreateSectionMigrationSignature {
-    /**
-     * Bulk Section creation for migration.
-     * @param - List of sections you want to create
-     */
-    (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>>;
-}
 declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
 interface GetSectionSignature {
     /**
-     * Retrieves a Section.
+     * Retrieves a section.
+     *
+     * `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
      * @param - ID of the Section to retrieve.
-     * @returns The requested Section.
+     * @returns Retrieved section.
      */
     (sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
 }
 declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
 interface UpdateSectionSignature {
     /**
-     * Updates a Section.
-     * @param - Program Section ID.
-     * @returns Updated Section.
+     * Updates a section.
+     *
+     * Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when updating the section. This ensures you're working with the latest section and prevents unintended overwrites.
+     *
+     * Use this method to update section content and settings. To reorder a section, call [Move Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/move-section). To publish a section, call [Publish Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/publish-section).
+     * @param - Section ID.
+     * @returns Updated section.
      */
     (_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
 }
 declare function deleteSection$1(httpClient: HttpClient): DeleteSectionSignature;
 interface DeleteSectionSignature {
     /**
-     * Deletes a Section.
-     * Deleting a Section permanently removes them from the Section List.
-     * @param - Id of the Section to delete.
+     * Permanently deletes a section from the public API.
+     *
+     * Deleted sections aren't returned by standard retrieval and list methods. The public API doesn't expose trash-bin or restore operations.
+     * @param - ID of the section to delete.
      */
     (sectionId: string): Promise<void>;
 }
 declare function listSections$1(httpClient: HttpClient): ListSectionsSignature;
 interface ListSectionsSignature {
     /**
-     * List sections per program id
-     * @param - Program id to list sections
+     * Retrieves the 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.
+     *
+     * To filter or sort sections, call [Query Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/query-sections).
+     * @param - Program ID to list sections for.
      */
     (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>>;
 }
 declare function cloneSection$1(httpClient: HttpClient): CloneSectionSignature;
 interface CloneSectionSignature {
     /**
-     * Clones section with specified id
-     * @param - Section to clone
+     * Clones a section.
+     *
+     * The cloned section is added to the same program after the current last section. Translation content is copied to the cloned section.
+     * @param - ID of the section to clone.
      */
     (sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
 }
 declare function moveSection$1(httpClient: HttpClient): MoveSectionSignature;
 interface MoveSectionSignature {
     /**
-     * Places section after specified one or inserts it in the beginning
+     * Moves a section within its program.
+     *
+     * If `afterSectionId` isn't specified, the section is moved to the beginning of the program. The stored ordering value is recalculated automatically.
      */
     (options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
 }
 declare function publishSection$1(httpClient: HttpClient): PublishSectionSignature;
 interface PublishSectionSignature {
     /**
-     * Publishes section
+     * Publishes a section.
+     *
+     * Each time the section is updated, `revision` increments by 1. The current `revision` must be passed when publishing the section. This ensures you're working with the latest section and prevents unintended overwrites.
+     *
+     * Publishing sets the section's `state` to `PUBLISHED`.
      */
     (options?: PublishSectionOptions): Promise<NonNullablePaths<PublishSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
 }
@@ -91,7 +110,6 @@ declare function customQuerySections(httpClient: HttpClient): {
 };
 declare const createSection: MaybeContext<BuildRESTFunction<typeof createSection$1> & typeof createSection$1>;
 declare const bulkCreateSection: MaybeContext<BuildRESTFunction<typeof bulkCreateSection$1> & typeof bulkCreateSection$1>;
-declare const bulkCreateSectionMigration: MaybeContext<BuildRESTFunction<typeof bulkCreateSectionMigration$1> & typeof bulkCreateSectionMigration$1>;
 declare const getSection: MaybeContext<BuildRESTFunction<typeof getSection$1> & typeof getSection$1>;
 declare const updateSection: MaybeContext<BuildRESTFunction<typeof updateSection$1> & typeof updateSection$1>;
 declare const deleteSection: MaybeContext<BuildRESTFunction<typeof deleteSection$1> & typeof deleteSection$1>;
@@ -101,4 +119,4 @@ declare const moveSection: MaybeContext<BuildRESTFunction<typeof moveSection$1>
 declare const publishSection: MaybeContext<BuildRESTFunction<typeof publishSection$1> & typeof publishSection$1>;
 declare const querySections: MaybeContext<BuildRESTFunction<typeof customQuerySections> & typeof customQuerySections>;
 
-export { BulkCreateSectionMigrationResponse, BulkCreateSectionOptions, BulkCreateSectionResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, PublishSectionOptions, PublishSectionResponse, QuerySectionsOptions, Section, SectionQuery, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSection, bulkCreateSectionMigration, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, updateSection };
+export { BulkCreateSectionOptions, BulkCreateSectionResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, PublishSectionOptions, PublishSectionResponse, QuerySectionsOptions, Section, SectionQuery, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSection, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, updateSection };

package/build/cjs/index.js

@@ -29,7 +29,6 @@ __export(index_exports, {
   State: () => State,
   WebhookIdentityType: () => WebhookIdentityType,
   bulkCreateSection: () => bulkCreateSection4,
-  bulkCreateSectionMigration: () => bulkCreateSectionMigration4,
   cloneSection: () => cloneSection4,
   createSection: () => createSection4,
   deleteSection: () => deleteSection4,
@@ -143,6 +142,14 @@ function resolveWixOnlineprogramsSectionsV3SectionsServiceUrl(opts) {
       {
         srcPath: "/program-sections-service",
         destPath: ""
+      },
+      {
+        srcPath: "/online-programs/v3/sections",
+        destPath: "/v3/sections"
+      },
+      {
+        srcPath: "/online-programs/v3/bulk/sections",
+        destPath: "/v3/bulk/sections"
       }
     ]
   };
@@ -321,95 +328,6 @@ function bulkCreateSection(payload) {
   }
   return __bulkCreateSection;
 }
-function bulkCreateSectionMigration(payload) {
-  function __bulkCreateSectionMigration({ host }) {
-    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
-      {
-        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
-        paths: [
-          { path: "sections.createdDate" },
-          { path: "sections.updatedDate" },
-          { path: "sections.description.image.urlExpirationDate" },
-          { path: "sections.description.video.urlExpirationDate" },
-          { path: "sections.description.video.resolutions.urlExpirationDate" },
-          {
-            path: "sections.description.video.resolutions.poster.urlExpirationDate"
-          },
-          { path: "sections.description.video.posters.urlExpirationDate" }
-        ]
-      },
-      {
-        transformFn: import_float.transformSDKFloatToRESTFloat,
-        paths: [
-          { path: "sections.ordering" },
-          { path: "sections.description.image.focalPoint.x" },
-          { path: "sections.description.image.focalPoint.y" },
-          {
-            path: "sections.description.video.resolutions.poster.focalPoint.x"
-          },
-          {
-            path: "sections.description.video.resolutions.poster.focalPoint.y"
-          },
-          { path: "sections.description.video.posters.focalPoint.x" },
-          { path: "sections.description.video.posters.focalPoint.y" }
-        ]
-      }
-    ]);
-    const metadata = {
-      entityFqdn: "wix.online_programs.v3.section",
-      method: "POST",
-      methodFqn: "wix.onlineprograms.sections.v3.SectionsService.BulkCreateSectionMigration",
-      packageName: PACKAGE_NAME,
-      migrationOptions: {
-        optInTransformResponse: true
-      },
-      url: resolveWixOnlineprogramsSectionsV3SectionsServiceUrl({
-        protoPath: "/v3/bulk/sections/create/migration",
-        data: serializedData,
-        host
-      }),
-      data: serializedData,
-      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
-        {
-          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "results.item.createdDate" },
-            { path: "results.item.updatedDate" },
-            { path: "results.item.description.image.urlExpirationDate" },
-            { path: "results.item.description.video.urlExpirationDate" },
-            {
-              path: "results.item.description.video.resolutions.urlExpirationDate"
-            },
-            {
-              path: "results.item.description.video.resolutions.poster.urlExpirationDate"
-            },
-            {
-              path: "results.item.description.video.posters.urlExpirationDate"
-            }
-          ]
-        },
-        {
-          transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            { path: "results.item.ordering" },
-            { path: "results.item.description.image.focalPoint.x" },
-            { path: "results.item.description.image.focalPoint.y" },
-            {
-              path: "results.item.description.video.resolutions.poster.focalPoint.x"
-            },
-            {
-              path: "results.item.description.video.resolutions.poster.focalPoint.y"
-            },
-            { path: "results.item.description.video.posters.focalPoint.x" },
-            { path: "results.item.description.video.posters.focalPoint.y" }
-          ]
-        }
-      ])
-    };
-    return metadata;
-  }
-  return __bulkCreateSectionMigration;
-}
 function getSection(payload) {
   function __getSection({ host }) {
     const metadata = {
@@ -1003,52 +921,6 @@ async function bulkCreateSection2(sections, options) {
     throw transformedError;
   }
 }
-async function bulkCreateSectionMigration2(sections) {
-  const { httpClient, sideEffects } = arguments[1];
-  const payload = (0, import_transform_paths2.transformPaths)(
-    (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ sections }),
-    [
-      {
-        transformFn: import_image.transformSDKImageToRESTImage,
-        paths: [{ path: "sections.description.image" }]
-      },
-      {
-        transformFn: import_video_v2.transformSDKVideoV2ToRESTVideoV2,
-        paths: [{ path: "sections.description.video" }]
-      }
-    ]
-  );
-  const reqOpts = bulkCreateSectionMigration(payload);
-  sideEffects?.onSiteCall?.();
-  try {
-    const result = await httpClient.request(reqOpts);
-    sideEffects?.onSuccess?.(result);
-    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(
-      (0, import_transform_paths2.transformPaths)(result.data, [
-        {
-          transformFn: import_image2.transformRESTImageToSDKImage,
-          paths: [{ path: "results.item.description.image" }]
-        },
-        {
-          transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
-          paths: [{ path: "results.item.description.video" }]
-        }
-      ])
-    );
-  } catch (err) {
-    const transformedError = (0, import_transform_error.transformError)(
-      err,
-      {
-        spreadPathsToArguments: {},
-        explicitPathsToArguments: { sections: "$[0]" },
-        singleArgumentUnchanged: false
-      },
-      ["sections"]
-    );
-    sideEffects?.onError?.(err);
-    throw transformedError;
-  }
-}
 async function getSection2(sectionId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -1447,13 +1319,6 @@ function bulkCreateSection3(httpClient) {
     { httpClient }
   );
 }
-function bulkCreateSectionMigration3(httpClient) {
-  return (sections) => bulkCreateSectionMigration2(
-    sections,
-    // @ts-ignore
-    { httpClient }
-  );
-}
 function getSection3(httpClient) {
   return (sectionId, options) => getSection2(
     sectionId,
@@ -1539,7 +1404,6 @@ function customQuerySections(httpClient) {
 }
 var createSection4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(createSection3);
 var bulkCreateSection4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkCreateSection3);
-var bulkCreateSectionMigration4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkCreateSectionMigration3);
 var getSection4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getSection3);
 var updateSection4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateSection3);
 var deleteSection4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteSection3);
@@ -1559,7 +1423,6 @@ var querySections4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(
   State,
   WebhookIdentityType,
   bulkCreateSection,
-  bulkCreateSectionMigration,
   cloneSection,
   createSection,
   deleteSection,