@wix/auto_sdk_online-programs_sections 1.0.20 → 1.0.22

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

@@ -37,8 +37,6 @@ interface Section {
     programId?: string;
     /** Section title and deprecated backward-compatibility content fields. */
     description?: Description;
-    /** Publication state of the section. If omitted when creating a section, the state defaults to `PUBLISHED`. */
-    state?: StateWithLiterals;
     /**
      * Legacy total number of steps in the section.
      * @readonly
@@ -855,12 +853,13 @@ interface AccountInfo {
  * @public
  * @documentationMaturity preview
  * @requiredField section
+ * @requiredField section.programId
  * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
  * @applicableIdentity APP
  * @returns 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>>;
+declare function createSection(section: NonNullablePaths<Section, `programId`, 2>, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
 interface CreateSectionOptions {
     /**
      * Predefined sets of fields to return.
@@ -878,11 +877,12 @@ interface CreateSectionOptions {
  * @public
  * @documentationMaturity preview
  * @requiredField sections
+ * @requiredField sections.programId
  * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
  */
-declare function bulkCreateSections(sections: Section[], 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`, 6>>;
+declare function bulkCreateSections(sections: NonNullablePaths<Section, `programId`, 2>[], 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`, 6>>;
 interface BulkCreateSectionsOptions {
     /**
      * Predefined sets of fields to return.
@@ -903,7 +903,7 @@ interface BulkCreateSectionsOptions {
  * @returns Retrieved section.
  * @fqn wix.onlineprograms.sections.v3.SectionsService.GetSection
  */
-declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+declare function getSection(sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
 interface GetSectionOptions {
     /** Compatibility option for existing integrations. Current section responses return the section title. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
@@ -918,7 +918,7 @@ interface GetSectionOptions {
  *
  * 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).
+ * 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).
  * @param _id - Section ID.
  * @public
  * @documentationMaturity preview
@@ -929,7 +929,7 @@ interface GetSectionOptions {
  * @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>>;
+declare function updateSection(_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
 interface UpdateSectionOptions {
     section?: {
         /**
@@ -962,8 +962,6 @@ interface UpdateSectionOptions {
         programId?: string;
         /** Section title and deprecated backward-compatibility content fields. */
         description?: Description;
-        /** Publication state of the section. If omitted when creating a section, the state defaults to `PUBLISHED`. */
-        state?: StateWithLiterals;
         /**
          * Legacy total number of steps in the section.
          * @readonly
@@ -1014,8 +1012,8 @@ declare function deleteSection(sectionId: string): Promise<void>;
  * - `paging.limit` is `1000`.
  * - `paging.offset` is `0`.
  *
- * Supported filter fields are `programId`, `id`, `delayInDays`, `trialSection`, and `state`.
- * Supported sorting fields are `id`, `delayInDays`, `trialSection`, `state`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
+ * Supported filter fields are `programId`, `id`, `delayInDays`, and `trialSection`.
+ * Supported sorting fields are `id`, `delayInDays`, `trialSection`, `createdDate`, and `ordering`. When sorting by a field other than `programId`, also filter by `programId`.
  * `descriptionFieldSet` is retained for backward compatibility. Current section responses return the section title.
  *
  * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
@@ -1060,12 +1058,12 @@ interface SectionsQueryBuilder {
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    eq: (propertyName: '_id' | 'programId' | 'state' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
+    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' | 'state' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
+    ne: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -1092,9 +1090,9 @@ interface SectionsQueryBuilder {
      */
     startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
     /** @documentationMaturity preview */
-    in: (propertyName: '_id' | 'state' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
+    in: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
     /** @documentationMaturity preview */
-    exists: (propertyName: '_id' | 'state' | 'trialSection' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
+    exists: (propertyName: '_id' | 'trialSection' | 'delayInDays', value: boolean) => SectionsQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
      * @documentationMaturity preview
      */
@@ -1119,7 +1117,7 @@ interface SectionsQueryBuilder {
  * @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
  * @requiredField query
  */
-declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.state` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
+declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
 interface SectionQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
@@ -1129,7 +1127,7 @@ interface SectionQuerySpec extends QuerySpec {
             sort: 'NONE';
         },
         {
-            fields: ['_id', 'delayInDays', 'state', 'trialSection'];
+            fields: ['_id', 'delayInDays', 'trialSection'];
             operators: '*';
             sort: 'BOTH';
         },
@@ -1208,7 +1206,7 @@ declare const utils: {
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.ListSections
  */
-declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.state` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
+declare function listSections(programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
 interface ListSectionsOptions {
     /** Compatibility option for existing integrations. Current section responses return the section title. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
@@ -1230,7 +1228,7 @@ interface ListSectionsOptions {
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.CloneSection
  */
-declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+declare function cloneSection(sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
 interface CloneSectionOptions {
     /**
      * Predefined sets of fields to return.
@@ -1250,7 +1248,7 @@ interface CloneSectionOptions {
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.sections.v3.SectionsService.MoveSection
  */
-declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+declare function moveSection(options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
 interface MoveSectionOptions {
     /**
      * ID of the section to move.
@@ -1270,32 +1268,5 @@ interface MoveSectionOptions {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-/**
- * 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`.
- * @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 {
-    /**
-     * ID of the section to publish.
-     * @format GUID
-     */
-    sectionId?: string;
-    /** Current revision of the section. */
-    revision?: string;
-    /**
-     * Predefined sets of fields to return.
-     * @maxSize 1
-     */
-    fields?: RequestedFieldsWithLiterals[];
-}
 
-export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type 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 SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateSectionOptions, type UpdateSectionRequest, type UpdateSectionResponse, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, typedQuerySections, updateSection, utils };
+export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type PublishSectionRequest, type PublishSectionResponse, type QuerySectionsOptions, type QuerySectionsRequest, type QuerySectionsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RestoreSectionFromTrashRequest, type RestoreSectionFromTrashResponse, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type Section, type SectionCloned, type SectionDeleted, type SectionMoved, type SectionPublished, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateSectionOptions, type UpdateSectionRequest, type UpdateSectionResponse, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, typedQuerySections, updateSection, utils };

package/build/cjs/index.typings.js

@@ -35,7 +35,6 @@ __export(index_typings_exports, {
   getSection: () => getSection2,
   listSections: () => listSections2,
   moveSection: () => moveSection2,
-  publishSection: () => publishSection2,
   querySections: () => querySections2,
   typedQuerySections: () => typedQuerySections,
   updateSection: () => updateSection2,
@@ -721,61 +720,6 @@ function moveSection(payload) {
   }
   return __moveSection;
 }
-function publishSection(payload) {
-  function __publishSection({ host }) {
-    const metadata = {
-      entityFqdn: "wix.online_programs.v3.section",
-      method: "PATCH",
-      methodFqn: "wix.onlineprograms.sections.v3.SectionsService.PublishSection",
-      packageName: PACKAGE_NAME,
-      migrationOptions: {
-        optInTransformResponse: true
-      },
-      url: resolveWixOnlineprogramsSectionsV3SectionsServiceUrl({
-        protoPath: "/v3/sections/publish",
-        data: payload,
-        host
-      }),
-      data: payload,
-      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
-        {
-          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
-          paths: [
-            { path: "section.createdDate" },
-            { path: "section.updatedDate" },
-            { path: "section.description.image.urlExpirationDate" },
-            { path: "section.description.video.urlExpirationDate" },
-            {
-              path: "section.description.video.resolutions.urlExpirationDate"
-            },
-            {
-              path: "section.description.video.resolutions.poster.urlExpirationDate"
-            },
-            { path: "section.description.video.posters.urlExpirationDate" }
-          ]
-        },
-        {
-          transformFn: import_float2.transformRESTFloatToSDKFloat,
-          paths: [
-            { path: "section.ordering" },
-            { path: "section.description.image.focalPoint.x" },
-            { path: "section.description.image.focalPoint.y" },
-            {
-              path: "section.description.video.resolutions.poster.focalPoint.x"
-            },
-            {
-              path: "section.description.video.resolutions.poster.focalPoint.y"
-            },
-            { path: "section.description.video.posters.focalPoint.x" },
-            { path: "section.description.video.posters.focalPoint.y" }
-          ]
-        }
-      ])
-    };
-    return metadata;
-  }
-  return __publishSection;
-}
 
 // src/online-programs-v3-section-sections.universal.ts
 var import_image = require("@wix/sdk-runtime/transformations/image");
@@ -1267,48 +1211,6 @@ async function moveSection2(options) {
     throw transformedError;
   }
 }
-async function publishSection2(options) {
-  const { httpClient, sideEffects } = arguments[1];
-  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
-    sectionId: options?.sectionId,
-    revision: options?.revision,
-    fields: options?.fields
-  });
-  const reqOpts = publishSection(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: "section.description.image" }]
-        },
-        {
-          transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
-          paths: [{ path: "section.description.video" }]
-        }
-      ])
-    );
-  } catch (err) {
-    const transformedError = (0, import_transform_error.transformError)(
-      err,
-      {
-        spreadPathsToArguments: {},
-        explicitPathsToArguments: {
-          sectionId: "$[0].sectionId",
-          revision: "$[0].revision",
-          fields: "$[0].fields"
-        },
-        singleArgumentUnchanged: false
-      },
-      ["options"]
-    );
-    sideEffects?.onError?.(err);
-    throw transformedError;
-  }
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BulkActionType,
@@ -1326,7 +1228,6 @@ async function publishSection2(options) {
   getSection,
   listSections,
   moveSection,
-  publishSection,
   querySections,
   typedQuerySections,
   updateSection,