@wix/auto_sdk_online-programs_programs 1.0.33 → 1.0.35

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.
@@ -51,7 +51,11 @@ interface Program {
51
51
  timeline?: Timeline;
52
52
  /** Program access, participation, and progression rules. */
53
53
  restrictions?: Restrictions;
54
- /** Optional one-time payment price for joining the program. */
54
+ /**
55
+ * Optional one-time payment price for joining the program. When creating or updating a program,
56
+ * provide `price.value` only. `price.currency` is read-only and is populated from the site's
57
+ * payment currency in Site Properties.
58
+ */
55
59
  price?: Money;
56
60
  /** SEO settings used for the program page. */
57
61
  seo?: Seo;
@@ -177,10 +181,7 @@ declare enum AccessType {
177
181
  }
178
182
  /** @enumType */
179
183
  type AccessTypeWithLiterals = AccessType | 'PUBLIC' | 'PRIVATE' | 'SECRET';
180
- /**
181
- * Money.
182
- * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
183
- */
184
+ /** Monetary amount for an Online Program. */
184
185
  interface Money {
185
186
  /**
186
187
  * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).
@@ -188,7 +189,8 @@ interface Money {
188
189
  */
189
190
  value?: string;
190
191
  /**
191
- * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
192
+ * Site payment currency code in ISO 4217 format (for example, `USD`). This field is read-only and
193
+ * is populated from Site Properties. Don't provide it when creating or updating a program.
192
194
  * @format CURRENCY
193
195
  * @readonly
194
196
  */
@@ -685,14 +687,24 @@ interface Schema {
685
687
  label?: string;
686
688
  clusterName?: string;
687
689
  }
690
+ /** Domain event emitted when a program is published. */
688
691
  interface ProgramPublished {
692
+ /** Snapshot of the program after it was published. */
693
+ program?: Program;
689
694
  }
695
+ /** Domain event emitted when a program ends. */
690
696
  interface ProgramEnded {
691
697
  /** Whether the program was ended manually by the owner. */
692
698
  endedByOwner?: boolean;
699
+ /** Snapshot of the program after it ended. */
700
+ program?: Program;
693
701
  }
702
+ /** Domain event emitted when a program is archived. */
694
703
  interface ProgramArchived {
704
+ /** Snapshot of the program after it was archived. */
705
+ program?: Program;
695
706
  }
707
+ /** Domain event emitted when a program is duplicated. */
696
708
  interface ProgramDuplicated {
697
709
  /** Newly created program. */
698
710
  program?: Program;
@@ -2697,7 +2709,11 @@ interface UpdateProgram {
2697
2709
  timeline?: Timeline;
2698
2710
  /** Program access, participation, and progression rules. */
2699
2711
  restrictions?: Restrictions;
2700
- /** Optional one-time payment price for joining the program. */
2712
+ /**
2713
+ * Optional one-time payment price for joining the program. When creating or updating a program,
2714
+ * provide `price.value` only. `price.currency` is read-only and is populated from the site's
2715
+ * payment currency in Site Properties.
2716
+ */
2701
2717
  price?: Money;
2702
2718
  /** SEO settings used for the program page. */
2703
2719
  seo?: Seo;
@@ -1,6 +1,6 @@
1
1
  import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { P as Program, D as DuplicateProgramResponse, U as UpdateProgram, a as UpdateProgramApplicationErrors, b as ProgramSearch, S as SearchProgramsResponse, c as PublishProgramResponse, d as PublishProgramApplicationErrors, E as EndProgramResponse, A as ArchiveProgramResponse, M as MaskedProgram, B as BulkUpdateProgramsOptions, e as BulkUpdateProgramsResponse, C as CountProgramsOptions, f as CountProgramsResponse, L as ListSampleProgramsResponse, g as ProgramsQueryBuilder, h as ProgramQuery, t as typedQueryPrograms } from './online-programs-v3-program-programs.universal-UuyolOfn.mjs';
3
- export { j as AccessType, cR as AccessTypeWithLiterals, cL as AccountInfo, bT as ActionEvent, cz as Address, cA as AddressHint, b4 as Aggregation, bk as AggregationData, b5 as AggregationKindOneOf, bD as AggregationResults, bE as AggregationResultsResultOneOf, br as AggregationResultsScalarResult, r as AggregationType, d0 as AggregationTypeWithLiterals, ah as App, aE as ApplicationError, bH as ArchiveProgramRequest, b_ as Asset, aF as BulkActionMetadata, l as BulkActionType, cU as BulkActionTypeWithLiterals, az as BulkCreateProgramsMigrationRequest, aB as BulkCreateProgramsMigrationResponse, aC as BulkProgramResult, bJ as BulkUpdateProgramResult, bI as BulkUpdateProgramsRequest, cC as BusinessSchedule, cx as Categories, a1 as Certificate, db as CommonQueryWithEntityContext, dc as CommonSearchWithEntityContext, cH as ConsentPolicy, a4 as ContentSummary, bK as CountProgramsRequest, ax as CreateProgramRequest, ay as CreateProgramResponse, aZ as CursorPaging, bj as CursorPagingMetadata, b2 as CursorSearch, b3 as CursorSearchPagingMethodOneOf, b0 as Cursors, al as CustomTag, bc as DateHistogramAggregation, bz as DateHistogramResult, bB as DateHistogramResults, F as DayOfWeek, d8 as DayOfWeekWithLiterals, ar as Delete, aG as DeleteAllProgramsMigrationRequest, aH as DeleteAllProgramsMigrationResponse, ac as DeleteByFilterOperation, ab as DeleteByIdsOperation, c2 as DeleteContext, aS as DeleteProgramRequest, aT as DeleteProgramResponse, x as DeleteStatus, d5 as DeleteStatusWithLiterals, G as Description, H as DescriptionMediaOneOf, aa as DocumentImage, a9 as DocumentPayload, a7 as DocumentUpdateOperation, bN as DomainEvent, bO as DomainEventBodyOneOf, aI as DuplicateProgramRequest, aQ as DuplicatedSlugErrorDetails, cr as EditorlessAssigned, cs as EditorlessUnassigned, bU as Empty, bG as EndProgramRequest, bP as EntityCreatedEvent, bS as EntityDeletedEvent, bR as EntityUpdatedEvent, k as Enum, cT as EnumWithLiterals, a2 as ExtendedFields, ak as File, J as FocalPoint, cB as GeoCoordinates, aJ as GetProgramRequest, aK as GetProgramResponse, bg as GroupByAggregation, bh as GroupByAggregationKindOneOf, bA as GroupByValueResults, cJ as IdentificationData, cK as IdentificationDataIdOneOf, b7 as IncludeMissingValuesOptions, a8 as IndexDocument, I as Interval, c$ as IntervalWithLiterals, af as InvalidateCache, ag as InvalidateCacheGetByOneOf, aD as ItemMetadata, Z as Keyword, bM as LabeledProgram, bL as ListSampleProgramsRequest, cy as Locale, cI as MessageEnvelope, bY as MetaSiteSpecialEvent, bZ as MetaSiteSpecialEventPayloadOneOf, bX as MissingMetasiteIdErrorDetails, p as MissingValues, cY as MissingValuesWithLiterals, s as Mode, d1 as ModeWithLiterals, Q as Money, cF as Multilingual, w as Namespace, cc as NamespaceChanged, d4 as NamespaceWithLiterals, bf as NestedAggregation, bd as NestedAggregationItem, be as NestedAggregationItemKindOneOf, bn as NestedAggregationResults, bo as NestedAggregationResultsResultOneOf, N as NestedAggregationType, c_ as NestedAggregationTypeWithLiterals, bw as NestedResultValue, bx as NestedResultValueResultOneOf, bC as NestedResults, bs as NestedValueAggregationResult, ch as OdeditorAssigned, ci as OdeditorUnassigned, ai as Page, am as Pages, aY as Paging, a$ as PagingMetadataV2, cj as PicassoAssigned, ck as PicassoUnassigned, z as PlacementType, d7 as PlacementTypeWithLiterals, av as ProgramArchived, aw as ProgramDuplicated, au as ProgramEnded, aA as ProgramMigration, at as ProgramPublished, cN as ProgramQuerySpec, cO as ProgramSearchSpec, cM as ProgramsQueryResult, cw as Properties, bF as PublishProgramRequest, aU as QueryProgramsRequest, a_ as QueryProgramsResponse, aV as QueryV2, aW as QueryV2PagingMethodOneOf, ba as RangeAggregation, bm as RangeAggregationResult, b6 as RangeBucket, bu as RangeResult, bq as RangeResults, ao as ReindexMessage, ap as ReindexMessageActionOneOf, R as ResolutionMethod, d9 as ResolutionMethodWithLiterals, bV as ResolveProgramSlugRequest, bW as ResolveProgramSlugResponse, bQ as RestoreInfo, O as Restrictions, by as Results, a0 as Reward, bb as ScalarAggregation, bv as ScalarResult, q as ScalarType, cZ as ScalarTypeWithLiterals, as as Schema, bi as SearchDetails, ct as SearchIndexingNotification, y as SearchIndexingNotificationState, d6 as SearchIndexingNotificationStateWithLiterals, b1 as SearchProgramsRequest, X as Seo, Y as SeoSchema, c8 as ServiceProvisioned, c9 as ServiceRemoved, $ as Settings, b$ as SiteCreated, v as SiteCreatedContext, d3 as SiteCreatedContextWithLiterals, c1 as SiteDeleted, cb as SiteHardDeleted, c6 as SiteMarkedAsTemplate, c7 as SiteMarkedAsWixSite, cv as SitePropertiesEvent, cu as SitePropertiesUpdated, c4 as SitePublished, cg as SitePurgedExternally, ca as SiteRenamed, c0 as SiteTransferred, c3 as SiteUndeleted, c5 as SiteUnpublished, cf as SiteUrlChanged, o as SortDirection, cX as SortDirectionWithLiterals, m as SortOrder, cV as SortOrderWithLiterals, n as SortType, cW as SortTypeWithLiterals, aX as Sorting, cE as SpecialHourPeriod, u as State, d2 as StateWithLiterals, i as Status, cQ as StatusWithLiterals, cd as StudioAssigned, cn as StudioTwoAssigned, co as StudioTwoUnassigned, ce as StudioUnassigned, cG as SupportedLanguage, _ as Tag, cD as TimePeriod, K as Timeline, aR as TimelineSwitchForbiddenErrorDetails, T as Trigger, cS as TriggerWithLiterals, aj as URI, an as URIs, ad as UpdateByFilterOperation, a5 as UpdateDocumentsEvent, a6 as UpdateDocumentsEventOperationOneOf, ae as UpdateExistingOperation, aL as UpdateProgramRequest, aM as UpdateProgramResponse, aq as Upsert, cq as UserDomainMediaDisabled, cp as UserDomainMediaEnabled, b8 as ValueAggregation, b9 as ValueAggregationOptionsOneOf, bl as ValueAggregationResult, bt as ValueResult, bp as ValueResults, V as VideoResolution, a3 as VideoStepsSettings, W as WebhookIdentityType, da as WebhookIdentityTypeWithLiterals, cl as WixelAssigned, cm as WixelUnassigned, aP as WrongParticipantsNumberErrorDetails, aO as WrongStartDateErrorDetails, aN as WrongStateErrorDetails, cP as utils } from './online-programs-v3-program-programs.universal-UuyolOfn.mjs';
2
+ import { P as Program, D as DuplicateProgramResponse, U as UpdateProgram, a as UpdateProgramApplicationErrors, b as ProgramSearch, S as SearchProgramsResponse, c as PublishProgramResponse, d as PublishProgramApplicationErrors, E as EndProgramResponse, A as ArchiveProgramResponse, M as MaskedProgram, B as BulkUpdateProgramsOptions, e as BulkUpdateProgramsResponse, C as CountProgramsOptions, f as CountProgramsResponse, L as ListSampleProgramsResponse, g as ProgramsQueryBuilder, h as ProgramQuery, t as typedQueryPrograms } from './online-programs-v3-program-programs.universal-7yJy1Sk4.mjs';
3
+ export { j as AccessType, cR as AccessTypeWithLiterals, cL as AccountInfo, bT as ActionEvent, cz as Address, cA as AddressHint, b4 as Aggregation, bk as AggregationData, b5 as AggregationKindOneOf, bD as AggregationResults, bE as AggregationResultsResultOneOf, br as AggregationResultsScalarResult, r as AggregationType, d0 as AggregationTypeWithLiterals, ah as App, aE as ApplicationError, bH as ArchiveProgramRequest, b_ as Asset, aF as BulkActionMetadata, l as BulkActionType, cU as BulkActionTypeWithLiterals, az as BulkCreateProgramsMigrationRequest, aB as BulkCreateProgramsMigrationResponse, aC as BulkProgramResult, bJ as BulkUpdateProgramResult, bI as BulkUpdateProgramsRequest, cC as BusinessSchedule, cx as Categories, a1 as Certificate, db as CommonQueryWithEntityContext, dc as CommonSearchWithEntityContext, cH as ConsentPolicy, a4 as ContentSummary, bK as CountProgramsRequest, ax as CreateProgramRequest, ay as CreateProgramResponse, aZ as CursorPaging, bj as CursorPagingMetadata, b2 as CursorSearch, b3 as CursorSearchPagingMethodOneOf, b0 as Cursors, al as CustomTag, bc as DateHistogramAggregation, bz as DateHistogramResult, bB as DateHistogramResults, F as DayOfWeek, d8 as DayOfWeekWithLiterals, ar as Delete, aG as DeleteAllProgramsMigrationRequest, aH as DeleteAllProgramsMigrationResponse, ac as DeleteByFilterOperation, ab as DeleteByIdsOperation, c2 as DeleteContext, aS as DeleteProgramRequest, aT as DeleteProgramResponse, x as DeleteStatus, d5 as DeleteStatusWithLiterals, G as Description, H as DescriptionMediaOneOf, aa as DocumentImage, a9 as DocumentPayload, a7 as DocumentUpdateOperation, bN as DomainEvent, bO as DomainEventBodyOneOf, aI as DuplicateProgramRequest, aQ as DuplicatedSlugErrorDetails, cr as EditorlessAssigned, cs as EditorlessUnassigned, bU as Empty, bG as EndProgramRequest, bP as EntityCreatedEvent, bS as EntityDeletedEvent, bR as EntityUpdatedEvent, k as Enum, cT as EnumWithLiterals, a2 as ExtendedFields, ak as File, J as FocalPoint, cB as GeoCoordinates, aJ as GetProgramRequest, aK as GetProgramResponse, bg as GroupByAggregation, bh as GroupByAggregationKindOneOf, bA as GroupByValueResults, cJ as IdentificationData, cK as IdentificationDataIdOneOf, b7 as IncludeMissingValuesOptions, a8 as IndexDocument, I as Interval, c$ as IntervalWithLiterals, af as InvalidateCache, ag as InvalidateCacheGetByOneOf, aD as ItemMetadata, Z as Keyword, bM as LabeledProgram, bL as ListSampleProgramsRequest, cy as Locale, cI as MessageEnvelope, bY as MetaSiteSpecialEvent, bZ as MetaSiteSpecialEventPayloadOneOf, bX as MissingMetasiteIdErrorDetails, p as MissingValues, cY as MissingValuesWithLiterals, s as Mode, d1 as ModeWithLiterals, Q as Money, cF as Multilingual, w as Namespace, cc as NamespaceChanged, d4 as NamespaceWithLiterals, bf as NestedAggregation, bd as NestedAggregationItem, be as NestedAggregationItemKindOneOf, bn as NestedAggregationResults, bo as NestedAggregationResultsResultOneOf, N as NestedAggregationType, c_ as NestedAggregationTypeWithLiterals, bw as NestedResultValue, bx as NestedResultValueResultOneOf, bC as NestedResults, bs as NestedValueAggregationResult, ch as OdeditorAssigned, ci as OdeditorUnassigned, ai as Page, am as Pages, aY as Paging, a$ as PagingMetadataV2, cj as PicassoAssigned, ck as PicassoUnassigned, z as PlacementType, d7 as PlacementTypeWithLiterals, av as ProgramArchived, aw as ProgramDuplicated, au as ProgramEnded, aA as ProgramMigration, at as ProgramPublished, cN as ProgramQuerySpec, cO as ProgramSearchSpec, cM as ProgramsQueryResult, cw as Properties, bF as PublishProgramRequest, aU as QueryProgramsRequest, a_ as QueryProgramsResponse, aV as QueryV2, aW as QueryV2PagingMethodOneOf, ba as RangeAggregation, bm as RangeAggregationResult, b6 as RangeBucket, bu as RangeResult, bq as RangeResults, ao as ReindexMessage, ap as ReindexMessageActionOneOf, R as ResolutionMethod, d9 as ResolutionMethodWithLiterals, bV as ResolveProgramSlugRequest, bW as ResolveProgramSlugResponse, bQ as RestoreInfo, O as Restrictions, by as Results, a0 as Reward, bb as ScalarAggregation, bv as ScalarResult, q as ScalarType, cZ as ScalarTypeWithLiterals, as as Schema, bi as SearchDetails, ct as SearchIndexingNotification, y as SearchIndexingNotificationState, d6 as SearchIndexingNotificationStateWithLiterals, b1 as SearchProgramsRequest, X as Seo, Y as SeoSchema, c8 as ServiceProvisioned, c9 as ServiceRemoved, $ as Settings, b$ as SiteCreated, v as SiteCreatedContext, d3 as SiteCreatedContextWithLiterals, c1 as SiteDeleted, cb as SiteHardDeleted, c6 as SiteMarkedAsTemplate, c7 as SiteMarkedAsWixSite, cv as SitePropertiesEvent, cu as SitePropertiesUpdated, c4 as SitePublished, cg as SitePurgedExternally, ca as SiteRenamed, c0 as SiteTransferred, c3 as SiteUndeleted, c5 as SiteUnpublished, cf as SiteUrlChanged, o as SortDirection, cX as SortDirectionWithLiterals, m as SortOrder, cV as SortOrderWithLiterals, n as SortType, cW as SortTypeWithLiterals, aX as Sorting, cE as SpecialHourPeriod, u as State, d2 as StateWithLiterals, i as Status, cQ as StatusWithLiterals, cd as StudioAssigned, cn as StudioTwoAssigned, co as StudioTwoUnassigned, ce as StudioUnassigned, cG as SupportedLanguage, _ as Tag, cD as TimePeriod, K as Timeline, aR as TimelineSwitchForbiddenErrorDetails, T as Trigger, cS as TriggerWithLiterals, aj as URI, an as URIs, ad as UpdateByFilterOperation, a5 as UpdateDocumentsEvent, a6 as UpdateDocumentsEventOperationOneOf, ae as UpdateExistingOperation, aL as UpdateProgramRequest, aM as UpdateProgramResponse, aq as Upsert, cq as UserDomainMediaDisabled, cp as UserDomainMediaEnabled, b8 as ValueAggregation, b9 as ValueAggregationOptionsOneOf, bl as ValueAggregationResult, bt as ValueResult, bp as ValueResults, V as VideoResolution, a3 as VideoStepsSettings, W as WebhookIdentityType, da as WebhookIdentityTypeWithLiterals, cl as WixelAssigned, cm as WixelUnassigned, aP as WrongParticipantsNumberErrorDetails, aO as WrongStartDateErrorDetails, aN as WrongStateErrorDetails, cP as utils } from './online-programs-v3-program-programs.universal-7yJy1Sk4.mjs';
4
4
 
5
5
  declare function createProgram$1(httpClient: HttpClient): CreateProgramSignature;
6
6
  interface CreateProgramSignature {