@wix/events 1.0.337 → 1.0.339

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/events",
3
- "version": "1.0.337",
3
+ "version": "1.0.339",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -27,7 +27,7 @@
27
27
  "@wix/events_notifications": "1.0.42",
28
28
  "@wix/events_orders": "1.0.60",
29
29
  "@wix/events_policies": "1.0.49",
30
- "@wix/events_ricos": "1.0.16",
30
+ "@wix/events_ricos": "1.0.18",
31
31
  "@wix/events_rsvp": "1.0.52",
32
32
  "@wix/events_rsvp-v-2": "1.0.23",
33
33
  "@wix/events_schedule": "1.0.46",
@@ -61,5 +61,5 @@
61
61
  "fqdn": ""
62
62
  }
63
63
  },
64
- "falconPackageHash": "1c206ada149d403d59d12ef5e00372807906a2619b2c0cf3ef5fb6d4"
64
+ "falconPackageHash": "42868cd0bc5d574a8f2d8ddd33b7af53796797acb48d50b147d9bc0b"
65
65
  }
@@ -10793,38 +10793,42 @@ declare namespace context$8 {
10793
10793
 
10794
10794
  interface RichContent {
10795
10795
  /**
10796
- * Unique identifier of the RichContent entity.
10796
+ * Rich content ID.
10797
10797
  * @readonly
10798
10798
  */
10799
10799
  _id?: string | null;
10800
10800
  /**
10801
- * Revision number of the RichContent.
10801
+ * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.
10802
10802
  * @readonly
10803
10803
  */
10804
10804
  revision?: string | null;
10805
10805
  /**
10806
- * Date and time the RichContent was created.
10806
+ * Date and time when rich content was created.
10807
10807
  * @readonly
10808
10808
  */
10809
10809
  _createdDate?: Date | null;
10810
10810
  /**
10811
- * Date and time the RichContent was last updated.
10811
+ * Date and time the rich content was updated.
10812
10812
  * @readonly
10813
10813
  */
10814
10814
  _updatedDate?: Date | null;
10815
- /** Optional event identifier to which the rich content is associated to. */
10815
+ /** ID of the event to which rich content is applied. */
10816
10816
  eventId?: string | null;
10817
- /** Name of the field to which the rich content is associated to. */
10817
+ /** Field name which value uses rich content. For the [`detailedDescription`](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/event-object) field use the `about` value. */
10818
10818
  fieldName?: string | null;
10819
10819
  /**
10820
- * Rich content of the associated entity.
10820
+ * Rich content of the event description.
10821
10821
  *
10822
10822
  * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="video.spoiler.linkPreview.link.lineSpacing.indent.image.html.heading.hashtag.giphy.gallery.file.emoji.divider.collapsibleList.codeBlock.audio.ai" exampleid="6ff78d07-c535-4602-b50d-6f06055f4148">
10823
10823
  * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
10824
10824
  * </widget>
10825
10825
  */
10826
10826
  content?: V1RichContent;
10827
- /** Data Extensions */
10827
+ /**
10828
+ * Custom field data for the rich content object.
10829
+ *
10830
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
10831
+ */
10828
10832
  extendedFields?: ExtendedFields$2;
10829
10833
  }
10830
10834
  interface V1RichContent {
@@ -12081,19 +12085,19 @@ interface ExtendedFields$2 {
12081
12085
  namespaces?: Record<string, Record<string, any>>;
12082
12086
  }
12083
12087
  interface CreateRichContentRequest {
12084
- /** RichContent to be created. */
12088
+ /** Rich content info. */
12085
12089
  richContent: RichContent;
12086
12090
  }
12087
12091
  interface CreateRichContentResponse {
12088
- /** The created RichContent. */
12092
+ /** Created rich content. */
12089
12093
  richContent?: RichContent;
12090
12094
  }
12091
12095
  interface GetRichContentRequest {
12092
- /** ID of the RichContent to retrieve. */
12096
+ /** Rich content ID. */
12093
12097
  richContentId: string;
12094
12098
  }
12095
12099
  interface GetRichContentResponse {
12096
- /** The requested RichContent. */
12100
+ /** The requested rich content. */
12097
12101
  richContent?: RichContent;
12098
12102
  }
12099
12103
  interface FindRichContentBySlugRequest {
@@ -12107,15 +12111,15 @@ interface FindRichContentBySlugResponse {
12107
12111
  richContent?: RichContent;
12108
12112
  }
12109
12113
  interface UpdateRichContentRequest {
12110
- /** RichContent to be updated, may be partial. */
12114
+ /** Fields to update. */
12111
12115
  richContent: RichContent;
12112
12116
  }
12113
12117
  interface UpdateRichContentResponse {
12114
- /** Updated RichContent. */
12118
+ /** Updated rich content. */
12115
12119
  richContent?: RichContent;
12116
12120
  }
12117
12121
  interface DeleteRichContentRequest {
12118
- /** Id of the RichContent to delete. */
12122
+ /** ID of rich content to delete. */
12119
12123
  richContentId: string;
12120
12124
  }
12121
12125
  interface DeleteRichContentResponse {
@@ -12193,7 +12197,7 @@ interface Cursors$5 {
12193
12197
  prev?: string | null;
12194
12198
  }
12195
12199
  interface QueryRichContentRequest {
12196
- /** WQL expression. */
12200
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
12197
12201
  query?: CursorQuery$1;
12198
12202
  }
12199
12203
  interface QueryRichContentResponse {
@@ -12861,38 +12865,42 @@ interface FindRichContentBySlugIdentifiers {
12861
12865
  }
12862
12866
  interface UpdateRichContent {
12863
12867
  /**
12864
- * Unique identifier of the RichContent entity.
12868
+ * Rich content ID.
12865
12869
  * @readonly
12866
12870
  */
12867
12871
  _id?: string | null;
12868
12872
  /**
12869
- * Revision number of the RichContent.
12873
+ * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.
12870
12874
  * @readonly
12871
12875
  */
12872
12876
  revision?: string | null;
12873
12877
  /**
12874
- * Date and time the RichContent was created.
12878
+ * Date and time when rich content was created.
12875
12879
  * @readonly
12876
12880
  */
12877
12881
  _createdDate?: Date | null;
12878
12882
  /**
12879
- * Date and time the RichContent was last updated.
12883
+ * Date and time the rich content was updated.
12880
12884
  * @readonly
12881
12885
  */
12882
12886
  _updatedDate?: Date | null;
12883
- /** Optional event identifier to which the rich content is associated to. */
12887
+ /** ID of the event to which rich content is applied. */
12884
12888
  eventId?: string | null;
12885
- /** Name of the field to which the rich content is associated to. */
12889
+ /** Field name which value uses rich content. For the [`detailedDescription`](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/event-object) field use the `about` value. */
12886
12890
  fieldName?: string | null;
12887
12891
  /**
12888
- * Rich content of the associated entity.
12892
+ * Rich content of the event description.
12889
12893
  *
12890
12894
  * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="video.spoiler.linkPreview.link.lineSpacing.indent.image.html.heading.hashtag.giphy.gallery.file.emoji.divider.collapsibleList.codeBlock.audio.ai" exampleid="6ff78d07-c535-4602-b50d-6f06055f4148">
12891
12895
  * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
12892
12896
  * </widget>
12893
12897
  */
12894
12898
  content?: V1RichContent;
12895
- /** Data Extensions */
12899
+ /**
12900
+ * Custom field data for the rich content object.
12901
+ *
12902
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
12903
+ */
12896
12904
  extendedFields?: ExtendedFields$2;
12897
12905
  }
12898
12906
  interface QueryRichContentsOptions {
@@ -12960,18 +12968,20 @@ interface RichContentQueryBuilder {
12960
12968
  declare function createRichContent$1(httpClient: HttpClient): CreateRichContentSignature;
12961
12969
  interface CreateRichContentSignature {
12962
12970
  /**
12963
- * Creates a RichContent.
12964
- * @param - RichContent to be created.
12965
- * @returns The created RichContent.
12971
+ * Creates rich content for the event description.
12972
+ *
12973
+ * This method passes rich content value to the `detailedDescription` field of an already created event.
12974
+ * @param - Rich content info.
12975
+ * @returns Created rich content.
12966
12976
  */
12967
12977
  (richContent: RichContent): Promise<RichContent & RichContentNonNullableFields>;
12968
12978
  }
12969
12979
  declare function getRichContent$1(httpClient: HttpClient): GetRichContentSignature;
12970
12980
  interface GetRichContentSignature {
12971
12981
  /**
12972
- * Retrieves a RichContent.
12973
- * @param - ID of the RichContent to retrieve.
12974
- * @returns The requested RichContent.
12982
+ * Retrieves rich content of an event description.
12983
+ * @param - Rich content ID.
12984
+ * @returns The requested rich content.
12975
12985
  */
12976
12986
  (richContentId: string): Promise<RichContent & RichContentNonNullableFields>;
12977
12987
  }
@@ -12986,41 +12996,39 @@ interface FindRichContentBySlugSignature {
12986
12996
  declare function updateRichContent$1(httpClient: HttpClient): UpdateRichContentSignature;
12987
12997
  interface UpdateRichContentSignature {
12988
12998
  /**
12989
- * Updates a RichContent.
12990
- * Each time the RichContent is updated,
12991
- * `revision` increments by 1.
12992
- * The current `revision` must be passed when updating the RichContent.
12993
- * This ensures you're working with the latest RichContent
12994
- * and prevents unintended overwrites.
12995
- * @param - Unique identifier of the RichContent entity.
12996
- * @returns Updated RichContent.
12999
+ * Updates rich content of an event description.
13000
+ *
13001
+ * Each time rich content is updated, `revision` increments by 1. The current `revision` must be passed when updating rich content. This ensures you're working with the latest rich content and prevents unintended overwrites.
13002
+ * @param - Rich content ID.
13003
+ * @returns Updated rich content.
12997
13004
  */
12998
13005
  (_id: string | null, richContent: UpdateRichContent): Promise<RichContent & RichContentNonNullableFields>;
12999
13006
  }
13000
13007
  declare function deleteRichContent$1(httpClient: HttpClient): DeleteRichContentSignature;
13001
13008
  interface DeleteRichContentSignature {
13002
13009
  /**
13003
- * Deletes a RichContent.
13004
- * Deleting a RichContent permanently removes them from the RichContent List.
13005
- * @param - Id of the RichContent to delete.
13010
+ * Deletes rich content from the event description.
13011
+ * @param - ID of rich content to delete.
13006
13012
  */
13007
13013
  (richContentId: string): Promise<void>;
13008
13014
  }
13009
13015
  declare function queryRichContents$1(httpClient: HttpClient): QueryRichContentsSignature;
13010
13016
  interface QueryRichContentsSignature {
13011
- /**
13012
- * Retrieves a list of RichContents, given the provided [paging, filtering, and sorting][1].
13013
- * Up to 1,000 RichContents can be returned per request.
13014
- * To learn how to query RichContents, see [API Query Language][2].
13015
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
13016
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
13017
- * @deprecated
13018
- */
13017
+ /** @deprecated */
13019
13018
  (options?: QueryRichContentsOptions | undefined): Promise<QueryRichContentsResponse & QueryRichContentsResponseNonNullableFields>;
13020
13019
  }
13021
13020
  declare function queryRichContent$1(httpClient: HttpClient): QueryRichContentSignature;
13022
13021
  interface QueryRichContentSignature {
13023
- /** */
13022
+ /**
13023
+ * Retrieves a list of events, given the provided paging, filtering, and sorting.
13024
+ *
13025
+ * Query Events runs with these defaults, which you can override:
13026
+ * - `createdDate` is sorted in `ASC` order
13027
+ * - `paging.limit` is `100`
13028
+ * - `paging.offset` is `0`
13029
+ * For field support for filters and sorting, see [Supported Filters and Sorting]().
13030
+ * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
13031
+ */
13024
13032
  (): RichContentQueryBuilder;
13025
13033
  }
13026
13034
  declare const onRichContentCreated$1: EventDefinition<RichContentCreatedEnvelope, "wix.events.v1.rich_content_created">;
@@ -13038,15 +13046,21 @@ declare const queryRichContents: MaybeContext<BuildRESTFunction<typeof queryRich
13038
13046
  declare const queryRichContent: MaybeContext<BuildRESTFunction<typeof queryRichContent$1> & typeof queryRichContent$1>;
13039
13047
 
13040
13048
  type _publicOnRichContentCreatedType = typeof onRichContentCreated$1;
13041
- /** */
13049
+ /**
13050
+ * Triggered when rich content is created.
13051
+ */
13042
13052
  declare const onRichContentCreated: ReturnType<typeof createEventModule$6<_publicOnRichContentCreatedType>>;
13043
13053
 
13044
13054
  type _publicOnRichContentUpdatedType = typeof onRichContentUpdated$1;
13045
- /** */
13055
+ /**
13056
+ * Triggered when rich content is updated.
13057
+ */
13046
13058
  declare const onRichContentUpdated: ReturnType<typeof createEventModule$6<_publicOnRichContentUpdatedType>>;
13047
13059
 
13048
13060
  type _publicOnRichContentDeletedType = typeof onRichContentDeleted$1;
13049
- /** */
13061
+ /**
13062
+ * Triggered when rich content is deleted.
13063
+ */
13050
13064
  declare const onRichContentDeleted: ReturnType<typeof createEventModule$6<_publicOnRichContentDeletedType>>;
13051
13065
 
13052
13066
  type context$7_Alignment = Alignment;
@@ -10793,38 +10793,42 @@ declare namespace index_d$8 {
10793
10793
 
10794
10794
  interface RichContent {
10795
10795
  /**
10796
- * Unique identifier of the RichContent entity.
10796
+ * Rich content ID.
10797
10797
  * @readonly
10798
10798
  */
10799
10799
  _id?: string | null;
10800
10800
  /**
10801
- * Revision number of the RichContent.
10801
+ * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.
10802
10802
  * @readonly
10803
10803
  */
10804
10804
  revision?: string | null;
10805
10805
  /**
10806
- * Date and time the RichContent was created.
10806
+ * Date and time when rich content was created.
10807
10807
  * @readonly
10808
10808
  */
10809
10809
  _createdDate?: Date | null;
10810
10810
  /**
10811
- * Date and time the RichContent was last updated.
10811
+ * Date and time the rich content was updated.
10812
10812
  * @readonly
10813
10813
  */
10814
10814
  _updatedDate?: Date | null;
10815
- /** Optional event identifier to which the rich content is associated to. */
10815
+ /** ID of the event to which rich content is applied. */
10816
10816
  eventId?: string | null;
10817
- /** Name of the field to which the rich content is associated to. */
10817
+ /** Field name which value uses rich content. For the [`detailedDescription`](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/event-object) field use the `about` value. */
10818
10818
  fieldName?: string | null;
10819
10819
  /**
10820
- * Rich content of the associated entity.
10820
+ * Rich content of the event description.
10821
10821
  *
10822
10822
  * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="video.spoiler.linkPreview.link.lineSpacing.indent.image.html.heading.hashtag.giphy.gallery.file.emoji.divider.collapsibleList.codeBlock.audio.ai" exampleid="6ff78d07-c535-4602-b50d-6f06055f4148">
10823
10823
  * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
10824
10824
  * </widget>
10825
10825
  */
10826
10826
  content?: V1RichContent;
10827
- /** Data Extensions */
10827
+ /**
10828
+ * Custom field data for the rich content object.
10829
+ *
10830
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
10831
+ */
10828
10832
  extendedFields?: ExtendedFields$2;
10829
10833
  }
10830
10834
  interface V1RichContent {
@@ -12081,19 +12085,19 @@ interface ExtendedFields$2 {
12081
12085
  namespaces?: Record<string, Record<string, any>>;
12082
12086
  }
12083
12087
  interface CreateRichContentRequest {
12084
- /** RichContent to be created. */
12088
+ /** Rich content info. */
12085
12089
  richContent: RichContent;
12086
12090
  }
12087
12091
  interface CreateRichContentResponse {
12088
- /** The created RichContent. */
12092
+ /** Created rich content. */
12089
12093
  richContent?: RichContent;
12090
12094
  }
12091
12095
  interface GetRichContentRequest {
12092
- /** ID of the RichContent to retrieve. */
12096
+ /** Rich content ID. */
12093
12097
  richContentId: string;
12094
12098
  }
12095
12099
  interface GetRichContentResponse {
12096
- /** The requested RichContent. */
12100
+ /** The requested rich content. */
12097
12101
  richContent?: RichContent;
12098
12102
  }
12099
12103
  interface FindRichContentBySlugRequest {
@@ -12107,15 +12111,15 @@ interface FindRichContentBySlugResponse {
12107
12111
  richContent?: RichContent;
12108
12112
  }
12109
12113
  interface UpdateRichContentRequest {
12110
- /** RichContent to be updated, may be partial. */
12114
+ /** Fields to update. */
12111
12115
  richContent: RichContent;
12112
12116
  }
12113
12117
  interface UpdateRichContentResponse {
12114
- /** Updated RichContent. */
12118
+ /** Updated rich content. */
12115
12119
  richContent?: RichContent;
12116
12120
  }
12117
12121
  interface DeleteRichContentRequest {
12118
- /** Id of the RichContent to delete. */
12122
+ /** ID of rich content to delete. */
12119
12123
  richContentId: string;
12120
12124
  }
12121
12125
  interface DeleteRichContentResponse {
@@ -12193,7 +12197,7 @@ interface Cursors$5 {
12193
12197
  prev?: string | null;
12194
12198
  }
12195
12199
  interface QueryRichContentRequest {
12196
- /** WQL expression. */
12200
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
12197
12201
  query?: CursorQuery$1;
12198
12202
  }
12199
12203
  interface QueryRichContentResponse {
@@ -12861,38 +12865,42 @@ interface FindRichContentBySlugIdentifiers {
12861
12865
  }
12862
12866
  interface UpdateRichContent {
12863
12867
  /**
12864
- * Unique identifier of the RichContent entity.
12868
+ * Rich content ID.
12865
12869
  * @readonly
12866
12870
  */
12867
12871
  _id?: string | null;
12868
12872
  /**
12869
- * Revision number of the RichContent.
12873
+ * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.
12870
12874
  * @readonly
12871
12875
  */
12872
12876
  revision?: string | null;
12873
12877
  /**
12874
- * Date and time the RichContent was created.
12878
+ * Date and time when rich content was created.
12875
12879
  * @readonly
12876
12880
  */
12877
12881
  _createdDate?: Date | null;
12878
12882
  /**
12879
- * Date and time the RichContent was last updated.
12883
+ * Date and time the rich content was updated.
12880
12884
  * @readonly
12881
12885
  */
12882
12886
  _updatedDate?: Date | null;
12883
- /** Optional event identifier to which the rich content is associated to. */
12887
+ /** ID of the event to which rich content is applied. */
12884
12888
  eventId?: string | null;
12885
- /** Name of the field to which the rich content is associated to. */
12889
+ /** Field name which value uses rich content. For the [`detailedDescription`](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/event-object) field use the `about` value. */
12886
12890
  fieldName?: string | null;
12887
12891
  /**
12888
- * Rich content of the associated entity.
12892
+ * Rich content of the event description.
12889
12893
  *
12890
12894
  * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="video.spoiler.linkPreview.link.lineSpacing.indent.image.html.heading.hashtag.giphy.gallery.file.emoji.divider.collapsibleList.codeBlock.audio.ai" exampleid="6ff78d07-c535-4602-b50d-6f06055f4148">
12891
12895
  * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
12892
12896
  * </widget>
12893
12897
  */
12894
12898
  content?: V1RichContent;
12895
- /** Data Extensions */
12899
+ /**
12900
+ * Custom field data for the rich content object.
12901
+ *
12902
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
12903
+ */
12896
12904
  extendedFields?: ExtendedFields$2;
12897
12905
  }
12898
12906
  interface QueryRichContentsOptions {
@@ -12960,18 +12968,20 @@ interface RichContentQueryBuilder {
12960
12968
  declare function createRichContent$1(httpClient: HttpClient): CreateRichContentSignature;
12961
12969
  interface CreateRichContentSignature {
12962
12970
  /**
12963
- * Creates a RichContent.
12964
- * @param - RichContent to be created.
12965
- * @returns The created RichContent.
12971
+ * Creates rich content for the event description.
12972
+ *
12973
+ * This method passes rich content value to the `detailedDescription` field of an already created event.
12974
+ * @param - Rich content info.
12975
+ * @returns Created rich content.
12966
12976
  */
12967
12977
  (richContent: RichContent): Promise<RichContent & RichContentNonNullableFields>;
12968
12978
  }
12969
12979
  declare function getRichContent$1(httpClient: HttpClient): GetRichContentSignature;
12970
12980
  interface GetRichContentSignature {
12971
12981
  /**
12972
- * Retrieves a RichContent.
12973
- * @param - ID of the RichContent to retrieve.
12974
- * @returns The requested RichContent.
12982
+ * Retrieves rich content of an event description.
12983
+ * @param - Rich content ID.
12984
+ * @returns The requested rich content.
12975
12985
  */
12976
12986
  (richContentId: string): Promise<RichContent & RichContentNonNullableFields>;
12977
12987
  }
@@ -12986,41 +12996,39 @@ interface FindRichContentBySlugSignature {
12986
12996
  declare function updateRichContent$1(httpClient: HttpClient): UpdateRichContentSignature;
12987
12997
  interface UpdateRichContentSignature {
12988
12998
  /**
12989
- * Updates a RichContent.
12990
- * Each time the RichContent is updated,
12991
- * `revision` increments by 1.
12992
- * The current `revision` must be passed when updating the RichContent.
12993
- * This ensures you're working with the latest RichContent
12994
- * and prevents unintended overwrites.
12995
- * @param - Unique identifier of the RichContent entity.
12996
- * @returns Updated RichContent.
12999
+ * Updates rich content of an event description.
13000
+ *
13001
+ * Each time rich content is updated, `revision` increments by 1. The current `revision` must be passed when updating rich content. This ensures you're working with the latest rich content and prevents unintended overwrites.
13002
+ * @param - Rich content ID.
13003
+ * @returns Updated rich content.
12997
13004
  */
12998
13005
  (_id: string | null, richContent: UpdateRichContent): Promise<RichContent & RichContentNonNullableFields>;
12999
13006
  }
13000
13007
  declare function deleteRichContent$1(httpClient: HttpClient): DeleteRichContentSignature;
13001
13008
  interface DeleteRichContentSignature {
13002
13009
  /**
13003
- * Deletes a RichContent.
13004
- * Deleting a RichContent permanently removes them from the RichContent List.
13005
- * @param - Id of the RichContent to delete.
13010
+ * Deletes rich content from the event description.
13011
+ * @param - ID of rich content to delete.
13006
13012
  */
13007
13013
  (richContentId: string): Promise<void>;
13008
13014
  }
13009
13015
  declare function queryRichContents$1(httpClient: HttpClient): QueryRichContentsSignature;
13010
13016
  interface QueryRichContentsSignature {
13011
- /**
13012
- * Retrieves a list of RichContents, given the provided [paging, filtering, and sorting][1].
13013
- * Up to 1,000 RichContents can be returned per request.
13014
- * To learn how to query RichContents, see [API Query Language][2].
13015
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
13016
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
13017
- * @deprecated
13018
- */
13017
+ /** @deprecated */
13019
13018
  (options?: QueryRichContentsOptions | undefined): Promise<QueryRichContentsResponse & QueryRichContentsResponseNonNullableFields>;
13020
13019
  }
13021
13020
  declare function queryRichContent$1(httpClient: HttpClient): QueryRichContentSignature;
13022
13021
  interface QueryRichContentSignature {
13023
- /** */
13022
+ /**
13023
+ * Retrieves a list of events, given the provided paging, filtering, and sorting.
13024
+ *
13025
+ * Query Events runs with these defaults, which you can override:
13026
+ * - `createdDate` is sorted in `ASC` order
13027
+ * - `paging.limit` is `100`
13028
+ * - `paging.offset` is `0`
13029
+ * For field support for filters and sorting, see [Supported Filters and Sorting]().
13030
+ * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
13031
+ */
13024
13032
  (): RichContentQueryBuilder;
13025
13033
  }
13026
13034
  declare const onRichContentCreated$1: EventDefinition<RichContentCreatedEnvelope, "wix.events.v1.rich_content_created">;
@@ -13038,15 +13046,21 @@ declare const queryRichContents: MaybeContext<BuildRESTFunction<typeof queryRich
13038
13046
  declare const queryRichContent: MaybeContext<BuildRESTFunction<typeof queryRichContent$1> & typeof queryRichContent$1>;
13039
13047
 
13040
13048
  type _publicOnRichContentCreatedType = typeof onRichContentCreated$1;
13041
- /** */
13049
+ /**
13050
+ * Triggered when rich content is created.
13051
+ */
13042
13052
  declare const onRichContentCreated: ReturnType<typeof createEventModule$6<_publicOnRichContentCreatedType>>;
13043
13053
 
13044
13054
  type _publicOnRichContentUpdatedType = typeof onRichContentUpdated$1;
13045
- /** */
13055
+ /**
13056
+ * Triggered when rich content is updated.
13057
+ */
13046
13058
  declare const onRichContentUpdated: ReturnType<typeof createEventModule$6<_publicOnRichContentUpdatedType>>;
13047
13059
 
13048
13060
  type _publicOnRichContentDeletedType = typeof onRichContentDeleted$1;
13049
- /** */
13061
+ /**
13062
+ * Triggered when rich content is deleted.
13063
+ */
13050
13064
  declare const onRichContentDeleted: ReturnType<typeof createEventModule$6<_publicOnRichContentDeletedType>>;
13051
13065
 
13052
13066
  type index_d$7_Alignment = Alignment;
@@ -7226,38 +7226,42 @@ declare namespace meta$8 {
7226
7226
 
7227
7227
  interface RichContent$1 {
7228
7228
  /**
7229
- * Unique identifier of the RichContent entity.
7229
+ * Rich content ID.
7230
7230
  * @readonly
7231
7231
  */
7232
7232
  id?: string | null;
7233
7233
  /**
7234
- * Revision number of the RichContent.
7234
+ * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.
7235
7235
  * @readonly
7236
7236
  */
7237
7237
  revision?: string | null;
7238
7238
  /**
7239
- * Date and time the RichContent was created.
7239
+ * Date and time when rich content was created.
7240
7240
  * @readonly
7241
7241
  */
7242
7242
  createdDate?: Date | null;
7243
7243
  /**
7244
- * Date and time the RichContent was last updated.
7244
+ * Date and time the rich content was updated.
7245
7245
  * @readonly
7246
7246
  */
7247
7247
  updatedDate?: Date | null;
7248
- /** Optional event identifier to which the rich content is associated to. */
7248
+ /** ID of the event to which rich content is applied. */
7249
7249
  eventId?: string | null;
7250
- /** Name of the field to which the rich content is associated to. */
7250
+ /** Field name which value uses rich content. For the [`detailedDescription`](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/event-object) field use the `about` value. */
7251
7251
  fieldName?: string | null;
7252
7252
  /**
7253
- * Rich content of the associated entity.
7253
+ * Rich content of the event description.
7254
7254
  *
7255
7255
  * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="video.spoiler.linkPreview.link.lineSpacing.indent.image.html.heading.hashtag.giphy.gallery.file.emoji.divider.collapsibleList.codeBlock.audio.ai" exampleid="6ff78d07-c535-4602-b50d-6f06055f4148">
7256
7256
  * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
7257
7257
  * </widget>
7258
7258
  */
7259
7259
  content?: V1RichContent$1;
7260
- /** Data Extensions */
7260
+ /**
7261
+ * Custom field data for the rich content object.
7262
+ *
7263
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
7264
+ */
7261
7265
  extendedFields?: ExtendedFields$5;
7262
7266
  }
7263
7267
  interface V1RichContent$1 {
@@ -8495,19 +8499,19 @@ interface ExtendedFields$5 {
8495
8499
  namespaces?: Record<string, Record<string, any>>;
8496
8500
  }
8497
8501
  interface CreateRichContentRequest$1 {
8498
- /** RichContent to be created. */
8502
+ /** Rich content info. */
8499
8503
  richContent: RichContent$1;
8500
8504
  }
8501
8505
  interface CreateRichContentResponse$1 {
8502
- /** The created RichContent. */
8506
+ /** Created rich content. */
8503
8507
  richContent?: RichContent$1;
8504
8508
  }
8505
8509
  interface GetRichContentRequest$1 {
8506
- /** ID of the RichContent to retrieve. */
8510
+ /** Rich content ID. */
8507
8511
  richContentId: string;
8508
8512
  }
8509
8513
  interface GetRichContentResponse$1 {
8510
- /** The requested RichContent. */
8514
+ /** The requested rich content. */
8511
8515
  richContent?: RichContent$1;
8512
8516
  }
8513
8517
  interface FindRichContentBySlugRequest$1 {
@@ -8521,15 +8525,15 @@ interface FindRichContentBySlugResponse$1 {
8521
8525
  richContent?: RichContent$1;
8522
8526
  }
8523
8527
  interface UpdateRichContentRequest$1 {
8524
- /** RichContent to be updated, may be partial. */
8528
+ /** Fields to update. */
8525
8529
  richContent: RichContent$1;
8526
8530
  }
8527
8531
  interface UpdateRichContentResponse$1 {
8528
- /** Updated RichContent. */
8532
+ /** Updated rich content. */
8529
8533
  richContent?: RichContent$1;
8530
8534
  }
8531
8535
  interface DeleteRichContentRequest$1 {
8532
- /** Id of the RichContent to delete. */
8536
+ /** ID of rich content to delete. */
8533
8537
  richContentId: string;
8534
8538
  }
8535
8539
  interface DeleteRichContentResponse$1 {
@@ -8607,7 +8611,7 @@ interface Cursors$9 {
8607
8611
  prev?: string | null;
8608
8612
  }
8609
8613
  interface QueryRichContentRequest$1 {
8610
- /** WQL expression. */
8614
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
8611
8615
  query?: CursorQuery$3;
8612
8616
  }
8613
8617
  interface QueryRichContentResponse$1 {
@@ -8887,38 +8891,42 @@ interface QueryRichContentResponseNonNullableFields$1 {
8887
8891
 
8888
8892
  interface RichContent {
8889
8893
  /**
8890
- * Unique identifier of the RichContent entity.
8894
+ * Rich content ID.
8891
8895
  * @readonly
8892
8896
  */
8893
8897
  _id?: string | null;
8894
8898
  /**
8895
- * Revision number of the RichContent.
8899
+ * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.
8896
8900
  * @readonly
8897
8901
  */
8898
8902
  revision?: string | null;
8899
8903
  /**
8900
- * Date and time the RichContent was created.
8904
+ * Date and time when rich content was created.
8901
8905
  * @readonly
8902
8906
  */
8903
8907
  _createdDate?: Date | null;
8904
8908
  /**
8905
- * Date and time the RichContent was last updated.
8909
+ * Date and time the rich content was updated.
8906
8910
  * @readonly
8907
8911
  */
8908
8912
  _updatedDate?: Date | null;
8909
- /** Optional event identifier to which the rich content is associated to. */
8913
+ /** ID of the event to which rich content is applied. */
8910
8914
  eventId?: string | null;
8911
- /** Name of the field to which the rich content is associated to. */
8915
+ /** Field name which value uses rich content. For the [`detailedDescription`](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/event-object) field use the `about` value. */
8912
8916
  fieldName?: string | null;
8913
8917
  /**
8914
- * Rich content of the associated entity.
8918
+ * Rich content of the event description.
8915
8919
  *
8916
8920
  * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="video.spoiler.linkPreview.link.lineSpacing.indent.image.html.heading.hashtag.giphy.gallery.file.emoji.divider.collapsibleList.codeBlock.audio.ai" exampleid="6ff78d07-c535-4602-b50d-6f06055f4148">
8917
8921
  * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
8918
8922
  * </widget>
8919
8923
  */
8920
8924
  content?: V1RichContent;
8921
- /** Data Extensions */
8925
+ /**
8926
+ * Custom field data for the rich content object.
8927
+ *
8928
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
8929
+ */
8922
8930
  extendedFields?: ExtendedFields$4;
8923
8931
  }
8924
8932
  interface V1RichContent {
@@ -10156,19 +10164,19 @@ interface ExtendedFields$4 {
10156
10164
  namespaces?: Record<string, Record<string, any>>;
10157
10165
  }
10158
10166
  interface CreateRichContentRequest {
10159
- /** RichContent to be created. */
10167
+ /** Rich content info. */
10160
10168
  richContent: RichContent;
10161
10169
  }
10162
10170
  interface CreateRichContentResponse {
10163
- /** The created RichContent. */
10171
+ /** Created rich content. */
10164
10172
  richContent?: RichContent;
10165
10173
  }
10166
10174
  interface GetRichContentRequest {
10167
- /** ID of the RichContent to retrieve. */
10175
+ /** Rich content ID. */
10168
10176
  richContentId: string;
10169
10177
  }
10170
10178
  interface GetRichContentResponse {
10171
- /** The requested RichContent. */
10179
+ /** The requested rich content. */
10172
10180
  richContent?: RichContent;
10173
10181
  }
10174
10182
  interface FindRichContentBySlugRequest {
@@ -10182,15 +10190,15 @@ interface FindRichContentBySlugResponse {
10182
10190
  richContent?: RichContent;
10183
10191
  }
10184
10192
  interface UpdateRichContentRequest {
10185
- /** RichContent to be updated, may be partial. */
10193
+ /** Fields to update. */
10186
10194
  richContent: RichContent;
10187
10195
  }
10188
10196
  interface UpdateRichContentResponse {
10189
- /** Updated RichContent. */
10197
+ /** Updated rich content. */
10190
10198
  richContent?: RichContent;
10191
10199
  }
10192
10200
  interface DeleteRichContentRequest {
10193
- /** Id of the RichContent to delete. */
10201
+ /** ID of rich content to delete. */
10194
10202
  richContentId: string;
10195
10203
  }
10196
10204
  interface DeleteRichContentResponse {
@@ -10268,7 +10276,7 @@ interface Cursors$8 {
10268
10276
  prev?: string | null;
10269
10277
  }
10270
10278
  interface QueryRichContentRequest {
10271
- /** WQL expression. */
10279
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
10272
10280
  query?: CursorQuery$2;
10273
10281
  }
10274
10282
  interface QueryRichContentResponse {