@wix/auto_sdk_online-programs_sections 1.0.16 → 1.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/build/cjs/index.d.ts +6 -16
  2. package/build/cjs/index.js +0 -149
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +9 -32
  5. package/build/cjs/index.typings.js +0 -140
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +5 -8
  8. package/build/cjs/meta.js +0 -109
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +6 -16
  11. package/build/es/index.mjs +0 -148
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +9 -32
  14. package/build/es/index.typings.mjs +0 -139
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +5 -8
  17. package/build/es/meta.mjs +0 -108
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +6 -16
  20. package/build/internal/cjs/index.typings.d.ts +13 -31
  21. package/build/internal/cjs/meta.d.ts +9 -7
  22. package/build/internal/es/index.d.mts +6 -16
  23. package/build/internal/es/index.typings.d.mts +13 -31
  24. package/build/internal/es/meta.d.mts +9 -7
  25. package/package.json +4 -11
  26. package/build/cjs/schemas.d.ts +0 -637
  27. package/build/cjs/schemas.js +0 -999
  28. package/build/cjs/schemas.js.map +0 -1
  29. package/build/es/schemas.d.mts +0 -637
  30. package/build/es/schemas.mjs +0 -941
  31. package/build/es/schemas.mjs.map +0 -1
  32. package/build/internal/cjs/index.js +0 -1593
  33. package/build/internal/cjs/index.js.map +0 -1
  34. package/build/internal/cjs/index.typings.js +0 -1475
  35. package/build/internal/cjs/index.typings.js.map +0 -1
  36. package/build/internal/cjs/meta.js +0 -1135
  37. package/build/internal/cjs/meta.js.map +0 -1
  38. package/build/internal/cjs/schemas.d.ts +0 -637
  39. package/build/internal/cjs/schemas.js +0 -999
  40. package/build/internal/cjs/schemas.js.map +0 -1
  41. package/build/internal/es/index.mjs +0 -1550
  42. package/build/internal/es/index.mjs.map +0 -1
  43. package/build/internal/es/index.typings.mjs +0 -1431
  44. package/build/internal/es/index.typings.mjs.map +0 -1
  45. package/build/internal/es/meta.mjs +0 -1090
  46. package/build/internal/es/meta.mjs.map +0 -1
  47. package/build/internal/es/schemas.d.mts +0 -637
  48. package/build/internal/es/schemas.mjs +0 -941
  49. package/build/internal/es/schemas.mjs.map +0 -1
  50. package/schemas/package.json +0 -3
@@ -49,7 +49,7 @@ interface Section {
49
49
  * @readonly
50
50
  */
51
51
  totalSteps?: number | null;
52
- /** Whether participants can access the section as trial content before purchasing the parent program. */
52
+ /** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
53
53
  trialSection?: boolean;
54
54
  /** Position rank used to order sections within a program. To reorder sections, call Move Section. */
55
55
  ordering?: number;
@@ -320,8 +320,6 @@ interface BulkCreateSectionsResponse {
320
320
  interface BulkSectionResult {
321
321
  /** Metadata for the bulk operation result. */
322
322
  itemMetadata?: ItemMetadata;
323
- /** Created section. */
324
- item?: Section;
325
323
  /** Action associated with the bulk result. */
326
324
  action?: BulkActionTypeWithLiterals;
327
325
  }
@@ -365,7 +363,7 @@ interface BulkCreateSectionRequest {
365
363
  * @minSize 1
366
364
  * @maxSize 100
367
365
  */
368
- sections: Section[];
366
+ sections?: Section[];
369
367
  /**
370
368
  * Predefined sets of fields to return.
371
369
  * @maxSize 1
@@ -623,7 +621,7 @@ interface MoveSectionRequest {
623
621
  * @format GUID
624
622
  */
625
623
  afterSectionId?: string | null;
626
- /** Current revision of the section. */
624
+ /** Current revision of the section. When provided, it must match the current revision to protect against conflicting updates. */
627
625
  revision?: string;
628
626
  /**
629
627
  * Predefined sets of fields to return.
@@ -910,7 +908,7 @@ interface CreateSectionOptions {
910
908
  * @applicableIdentity APP
911
909
  * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
912
910
  */
913
- 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>>;
911
+ 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>>;
914
912
  interface BulkCreateSectionsOptions {
915
913
  /**
916
914
  * Predefined sets of fields to return.
@@ -918,29 +916,6 @@ interface BulkCreateSectionsOptions {
918
916
  */
919
917
  fields?: RequestedFieldsWithLiterals[];
920
918
  }
921
- /**
922
- * Deprecated. Use [Bulk Create Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/bulk-create-sections).
923
- *
924
- * To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
925
- * @param sections - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
926
- * @public
927
- * @documentationMaturity preview
928
- * @requiredField sections
929
- * @permissionId ONLINE_PROGRAMS.SECTION_CREATE
930
- * @applicableIdentity APP
931
- * @fqn wix.onlineprograms.sections.v3.SectionsService.BulkCreateSection
932
- * @deprecated
933
- * @replacedBy wix.onlineprograms.sections.v3.SectionsService.BulkCreateSections
934
- * @targetRemovalDate 2026-07-24
935
- */
936
- 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>>;
937
- interface BulkCreateSectionOptions {
938
- /**
939
- * Predefined sets of fields to return.
940
- * @maxSize 1
941
- */
942
- fields?: RequestedFieldsWithLiterals[];
943
- }
944
919
  /**
945
920
  * Retrieves a section.
946
921
  *
@@ -1025,7 +1000,7 @@ interface UpdateSectionOptions {
1025
1000
  * @readonly
1026
1001
  */
1027
1002
  totalSteps?: number | null;
1028
- /** Whether participants can access the section as trial content before purchasing the parent program. */
1003
+ /** Whether participants can access the section as trial content before purchasing the parent program. Default: `false`. */
1029
1004
  trialSection?: boolean;
1030
1005
  /** Position rank used to order sections within a program. To reorder sections, call Move Section. */
1031
1006
  ordering?: number;
@@ -1292,6 +1267,8 @@ interface CloneSectionOptions {
1292
1267
  /**
1293
1268
  * Moves a section within its program.
1294
1269
  *
1270
+ * 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.
1271
+ *
1295
1272
  * If `afterSectionId` isn't specified, the section is moved to the beginning of the program. The stored ordering value is recalculated automatically.
1296
1273
  * @public
1297
1274
  * @documentationMaturity preview
@@ -1311,7 +1288,7 @@ interface MoveSectionOptions {
1311
1288
  * @format GUID
1312
1289
  */
1313
1290
  afterSectionId?: string | null;
1314
- /** Current revision of the section. */
1291
+ /** Current revision of the section. When provided, it must match the current revision to protect against conflicting updates. */
1315
1292
  revision?: string;
1316
1293
  /**
1317
1294
  * Predefined sets of fields to return.
@@ -1347,4 +1324,4 @@ interface PublishSectionOptions {
1347
1324
  fields?: RequestedFieldsWithLiterals[];
1348
1325
  }
1349
1326
 
1350
- 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 };
1327
+ 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 };
@@ -287,95 +287,6 @@ function bulkCreateSections(payload) {
287
287
  }
288
288
  return __bulkCreateSections;
289
289
  }
290
- function bulkCreateSection(payload) {
291
- function __bulkCreateSection({ host }) {
292
- const serializedData = transformPaths(payload, [
293
- {
294
- transformFn: transformSDKTimestampToRESTTimestamp,
295
- paths: [
296
- { path: "sections.createdDate" },
297
- { path: "sections.updatedDate" },
298
- { path: "sections.description.image.urlExpirationDate" },
299
- { path: "sections.description.video.urlExpirationDate" },
300
- { path: "sections.description.video.resolutions.urlExpirationDate" },
301
- {
302
- path: "sections.description.video.resolutions.poster.urlExpirationDate"
303
- },
304
- { path: "sections.description.video.posters.urlExpirationDate" }
305
- ]
306
- },
307
- {
308
- transformFn: transformSDKFloatToRESTFloat,
309
- paths: [
310
- { path: "sections.ordering" },
311
- { path: "sections.description.image.focalPoint.x" },
312
- { path: "sections.description.image.focalPoint.y" },
313
- {
314
- path: "sections.description.video.resolutions.poster.focalPoint.x"
315
- },
316
- {
317
- path: "sections.description.video.resolutions.poster.focalPoint.y"
318
- },
319
- { path: "sections.description.video.posters.focalPoint.x" },
320
- { path: "sections.description.video.posters.focalPoint.y" }
321
- ]
322
- }
323
- ]);
324
- const metadata = {
325
- entityFqdn: "wix.online_programs.v3.section",
326
- method: "POST",
327
- methodFqn: "wix.onlineprograms.sections.v3.SectionsService.BulkCreateSection",
328
- packageName: PACKAGE_NAME,
329
- migrationOptions: {
330
- optInTransformResponse: true
331
- },
332
- url: resolveWixOnlineprogramsSectionsV3SectionsServiceUrl({
333
- protoPath: "/v3/bulk/sections/create-deprecated",
334
- data: serializedData,
335
- host
336
- }),
337
- data: serializedData,
338
- transformResponse: (payload2) => transformPaths(payload2, [
339
- {
340
- transformFn: transformRESTTimestampToSDKTimestamp,
341
- paths: [
342
- { path: "results.item.createdDate" },
343
- { path: "results.item.updatedDate" },
344
- { path: "results.item.description.image.urlExpirationDate" },
345
- { path: "results.item.description.video.urlExpirationDate" },
346
- {
347
- path: "results.item.description.video.resolutions.urlExpirationDate"
348
- },
349
- {
350
- path: "results.item.description.video.resolutions.poster.urlExpirationDate"
351
- },
352
- {
353
- path: "results.item.description.video.posters.urlExpirationDate"
354
- }
355
- ]
356
- },
357
- {
358
- transformFn: transformRESTFloatToSDKFloat,
359
- paths: [
360
- { path: "results.item.ordering" },
361
- { path: "results.item.description.image.focalPoint.x" },
362
- { path: "results.item.description.image.focalPoint.y" },
363
- {
364
- path: "results.item.description.video.resolutions.poster.focalPoint.x"
365
- },
366
- {
367
- path: "results.item.description.video.resolutions.poster.focalPoint.y"
368
- },
369
- { path: "results.item.description.video.posters.focalPoint.x" },
370
- { path: "results.item.description.video.posters.focalPoint.y" }
371
- ]
372
- }
373
- ])
374
- };
375
- return metadata;
376
- }
377
- return __bulkCreateSection;
378
- }
379
290
  function getSection(payload) {
380
291
  function __getSection({ host }) {
381
292
  const metadata = {
@@ -978,55 +889,6 @@ async function bulkCreateSections2(sections, options) {
978
889
  throw transformedError;
979
890
  }
980
891
  }
981
- async function bulkCreateSection2(sections, options) {
982
- const { httpClient, sideEffects } = arguments[2];
983
- const payload = transformPaths2(
984
- renameKeysFromSDKRequestToRESTRequest({
985
- sections,
986
- fields: options?.fields
987
- }),
988
- [
989
- {
990
- transformFn: transformSDKImageToRESTImage,
991
- paths: [{ path: "sections.description.image" }]
992
- },
993
- {
994
- transformFn: transformSDKVideoV2ToRESTVideoV2,
995
- paths: [{ path: "sections.description.video" }]
996
- }
997
- ]
998
- );
999
- const reqOpts = bulkCreateSection(payload);
1000
- sideEffects?.onSiteCall?.();
1001
- try {
1002
- const result = await httpClient.request(reqOpts);
1003
- sideEffects?.onSuccess?.(result);
1004
- return renameKeysFromRESTResponseToSDKResponse(
1005
- transformPaths2(result.data, [
1006
- {
1007
- transformFn: transformRESTImageToSDKImage,
1008
- paths: [{ path: "results.item.description.image" }]
1009
- },
1010
- {
1011
- transformFn: transformRESTVideoV2ToSDKVideoV2,
1012
- paths: [{ path: "results.item.description.video" }]
1013
- }
1014
- ])
1015
- );
1016
- } catch (err) {
1017
- const transformedError = sdkTransformError(
1018
- err,
1019
- {
1020
- spreadPathsToArguments: {},
1021
- explicitPathsToArguments: { sections: "$[0]", fields: "$[1].fields" },
1022
- singleArgumentUnchanged: false
1023
- },
1024
- ["sections", "options"]
1025
- );
1026
- sideEffects?.onError?.(err);
1027
- throw transformedError;
1028
- }
1029
- }
1030
892
  async function getSection2(sectionId, options) {
1031
893
  const { httpClient, sideEffects } = arguments[2];
1032
894
  const payload = renameKeysFromSDKRequestToRESTRequest({
@@ -1414,7 +1276,6 @@ export {
1414
1276
  SortOrder,
1415
1277
  State,
1416
1278
  WebhookIdentityType,
1417
- bulkCreateSection2 as bulkCreateSection,
1418
1279
  bulkCreateSections2 as bulkCreateSections,
1419
1280
  cloneSection2 as cloneSection,
1420
1281
  createSection2 as createSection,