@wix/auto_sdk_online-programs_sections 1.0.15 → 1.0.17

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

@@ -111,8 +111,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: string;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 declare enum State {
     /** the section isn't ready to be shown to participants. */
@@ -320,7 +380,10 @@ interface BulkCreateSectionsResponse {
 interface BulkSectionResult {
     /** Metadata for the bulk operation result. */
     itemMetadata?: ItemMetadata;
-    /** Created section. */
+    /**
+     * Internal placeholder. Use `item_metadata` to identify the created section.
+     * @internal
+     */
     item?: Section;
     /** Action associated with the bulk result. */
     action?: BulkActionTypeWithLiterals;
@@ -365,7 +428,7 @@ interface BulkCreateSectionRequest {
      * @minSize 1
      * @maxSize 100
      */
-    sections: Section[];
+    sections?: Section[];
     /**
      * Predefined sets of fields to return.
      * @maxSize 1
@@ -421,6 +484,13 @@ interface GetSectionResponse {
 interface UpdateSectionRequest {
     /** Section to update. Include `section.id`, `section.revision`, and the fields to update. */
     section?: Section;
+    /**
+     * Field mask that specifies which fields to update.
+     *
+     * Fields that aren't included in `fieldMask.paths` are ignored.
+     * @internal
+     */
+    fieldMask?: string[];
     /**
      * Predefined sets of fields to return.
      * @maxSize 1
@@ -511,6 +581,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -562,6 +646,13 @@ interface CursorPagingMetadata {
      * + `false`: This is the last page.
      */
     hasNext?: boolean | null;
+    /**
+     * Total number of items matching the filter.
+     * Available only on the first page of *Search* results, not included in *Query* or *List* results.
+     * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
+     * @internal
+     */
+    total?: number | null;
 }
 interface Cursors {
     /**
@@ -623,7 +714,7 @@ interface MoveSectionRequest {
      * @format GUID
      */
     afterSectionId?: string | null;
-    /** Current revision of the section. */
+    /** Current revision of the section. When provided, it must match the current revision to protect against conflicting updates. */
     revision?: string;
     /**
      * Predefined sets of fields to return.
@@ -910,7 +1001,7 @@ interface CreateSectionOptions {
  * @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}.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 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>>;
 interface BulkCreateSectionsOptions {
     /**
      * Predefined sets of fields to return.
@@ -918,29 +1009,6 @@ interface BulkCreateSectionsOptions {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
-/**
- * Deprecated. Use [Bulk Create Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/bulk-create-sections).
- *
- * 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.
- * @public
- * @documentationMaturity preview
- * @requiredField sections
- * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSection
- * @deprecated
- * @replacedBy wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
- * @targetRemovalDate 2026-07-24
- */
-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[];
-}
 /**
  * Retrieves a section.
  *
@@ -1142,11 +1210,6 @@ interface SectionsQueryBuilder {
      * @documentationMaturity preview
      */
     startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     * @documentationMaturity preview
-     */
-    hasSome: (propertyName: '_id' | 'state' | 'trialSection' | 'delayInDays', value: any[]) => SectionsQueryBuilder;
     /** @documentationMaturity preview */
     in: (propertyName: '_id' | 'state' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
     /** @documentationMaturity preview */
@@ -1241,6 +1304,20 @@ type SectionQuery = {
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
         /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
+        /**
       Origin point for geo-distance sorting on a GEO field
       results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
       */
@@ -1248,11 +1325,7 @@ type SectionQuery = {
     }[];
 };
 declare const utils: {
-    query: {
-        QueryBuilder: () => _wix_sdk_types.QueryBuilder<Section, SectionQuerySpec, SectionQuery>;
-        Filter: _wix_sdk_types.FilterFactory<Section, SectionQuerySpec>;
-        Sort: _wix_sdk_types.SortFactory<SectionQuerySpec>;
-    };
+    query: _wix_sdk_types.QueryHelpers<Section, SectionQuerySpec, SectionQuery>;
 };
 /**
  * Retrieves the sections in a program.
@@ -1301,6 +1374,8 @@ interface CloneSectionOptions {
 /**
  * Moves a section within its program.
  *
+ * Each time the section is updated, its `revision` increments by 1. When provided, `revision` must match the current section revision to protect against conflicting updates.
+ *
  * If `afterSectionId` isn't specified, the section is moved to the beginning of the program. The stored ordering value is recalculated automatically.
  * @public
  * @documentationMaturity preview
@@ -1320,7 +1395,7 @@ interface MoveSectionOptions {
      * @format GUID
      */
     afterSectionId?: string | null;
-    /** Current revision of the section. */
+    /** Current revision of the section. When provided, it must match the current revision to protect against conflicting updates. */
     revision?: string;
     /**
      * Predefined sets of fields to return.
@@ -1356,4 +1431,4 @@ interface PublishSectionOptions {
     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 BulkCreateSectionOptions, 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, bulkCreateSection, 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 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 };

package/build/internal/es/index.typings.mjs

@@ -287,95 +287,6 @@ function bulkCreateSections(payload) {
   }
   return __bulkCreateSections;
 }
-function bulkCreateSection(payload) {
-  function __bulkCreateSection({ host }) {
-    const serializedData = transformPaths(payload, [
-      {
-        transformFn: 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: 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.BulkCreateSection",
-      packageName: PACKAGE_NAME,
-      migrationOptions: {
-        optInTransformResponse: true
-      },
-      url: resolveWixOnlineprogramsSectionsV3SectionsServiceUrl({
-        protoPath: "/v3/bulk/sections/create-deprecated",
-        data: serializedData,
-        host
-      }),
-      data: serializedData,
-      transformResponse: (payload2) => transformPaths(payload2, [
-        {
-          transformFn: 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: 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 __bulkCreateSection;
-}
 function getSection(payload) {
   function __getSection({ host }) {
     const metadata = {
@@ -978,55 +889,6 @@ async function bulkCreateSections2(sections, options) {
     throw transformedError;
   }
 }
-async function bulkCreateSection2(sections, options) {
-  const { httpClient, sideEffects } = arguments[2];
-  const payload = transformPaths2(
-    renameKeysFromSDKRequestToRESTRequest({
-      sections,
-      fields: options?.fields
-    }),
-    [
-      {
-        transformFn: transformSDKImageToRESTImage,
-        paths: [{ path: "sections.description.image" }]
-      },
-      {
-        transformFn: transformSDKVideoV2ToRESTVideoV2,
-        paths: [{ path: "sections.description.video" }]
-      }
-    ]
-  );
-  const reqOpts = bulkCreateSection(payload);
-  sideEffects?.onSiteCall?.();
-  try {
-    const result = await httpClient.request(reqOpts);
-    sideEffects?.onSuccess?.(result);
-    return renameKeysFromRESTResponseToSDKResponse(
-      transformPaths2(result.data, [
-        {
-          transformFn: transformRESTImageToSDKImage,
-          paths: [{ path: "results.item.description.image" }]
-        },
-        {
-          transformFn: transformRESTVideoV2ToSDKVideoV2,
-          paths: [{ path: "results.item.description.video" }]
-        }
-      ])
-    );
-  } catch (err) {
-    const transformedError = sdkTransformError(
-      err,
-      {
-        spreadPathsToArguments: {},
-        explicitPathsToArguments: { sections: "$[0]", fields: "$[1].fields" },
-        singleArgumentUnchanged: false
-      },
-      ["sections", "options"]
-    );
-    sideEffects?.onError?.(err);
-    throw transformedError;
-  }
-}
 async function getSection2(sectionId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = renameKeysFromSDKRequestToRESTRequest({
@@ -1238,9 +1100,7 @@ async function typedQuerySections(query, options) {
   }
 }
 var utils = {
-  query: {
-    ...createQueryUtils()
-  }
+  query: /* @__PURE__ */ createQueryUtils()
 };
 async function listSections2(programId, options) {
   const { httpClient, sideEffects } = arguments[2];
@@ -1416,7 +1276,6 @@ export {
   SortOrder,
   State,
   WebhookIdentityType,
-  bulkCreateSection2 as bulkCreateSection,
   bulkCreateSections2 as bulkCreateSections,
   cloneSection2 as cloneSection,
   createSection2 as createSection,