@wix/events 1.0.343 → 1.0.345

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.343",
3
+ "version": "1.0.345",
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.43",
28
28
  "@wix/events_orders": "1.0.61",
29
29
  "@wix/events_policies": "1.0.49",
30
- "@wix/events_ricos": "1.0.19",
30
+ "@wix/events_ricos": "1.0.21",
31
31
  "@wix/events_rsvp": "1.0.53",
32
32
  "@wix/events_rsvp-v-2": "1.0.24",
33
33
  "@wix/events_schedule": "1.0.47",
@@ -61,5 +61,5 @@
61
61
  "fqdn": ""
62
62
  }
63
63
  },
64
- "falconPackageHash": "7d1b7f0159df00207de64c464bed560c8d07e100cbffd28b13fcdbc3"
64
+ "falconPackageHash": "925ad21c8aa494a4352ac0cc347b900be00e22a00f5f8c3f1900d37a"
65
65
  }
@@ -10797,7 +10797,7 @@ interface RichContent {
10797
10797
  _updatedDate?: Date | null;
10798
10798
  /** ID of the event to which rich content is applied. */
10799
10799
  eventId?: string | null;
10800
- /** 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. */
10800
+ /** Field name whose value uses rich content. For the event description, specify the `about` value. */
10801
10801
  fieldName?: string | null;
10802
10802
  /**
10803
10803
  * Rich content of the event description.
@@ -12068,7 +12068,7 @@ interface ExtendedFields$2 {
12068
12068
  namespaces?: Record<string, Record<string, any>>;
12069
12069
  }
12070
12070
  interface CreateRichContentRequest {
12071
- /** Rich content info. */
12071
+ /** Rich content details. */
12072
12072
  richContent: RichContent;
12073
12073
  }
12074
12074
  interface CreateRichContentResponse {
@@ -12141,7 +12141,9 @@ interface Sorting$5 {
12141
12141
  order?: SortOrder$5;
12142
12142
  }
12143
12143
  declare enum SortOrder$5 {
12144
+ /** Sorting in ascending order. */
12144
12145
  ASC = "ASC",
12146
+ /** Sorting in descending order. */
12145
12147
  DESC = "DESC"
12146
12148
  }
12147
12149
  interface CursorPaging$5 {
@@ -12184,9 +12186,9 @@ interface QueryRichContentRequest {
12184
12186
  query?: CursorQuery$1;
12185
12187
  }
12186
12188
  interface QueryRichContentResponse {
12187
- /** List of RichContents. */
12189
+ /** List of rich content entities. */
12188
12190
  richContent?: RichContent[];
12189
- /** Paging metadata */
12191
+ /** Paging metadata. */
12190
12192
  pagingMetadata?: CursorPagingMetadata$1;
12191
12193
  }
12192
12194
  interface EventCopied$2 {
@@ -12832,11 +12834,11 @@ interface RichContentCreatedEnvelope {
12832
12834
  entity: RichContent;
12833
12835
  metadata: EventMetadata$3;
12834
12836
  }
12835
- interface RichContentUpdatedEnvelope {
12837
+ interface RichContentDeletedEnvelope {
12836
12838
  entity: RichContent;
12837
12839
  metadata: EventMetadata$3;
12838
12840
  }
12839
- interface RichContentDeletedEnvelope {
12841
+ interface RichContentUpdatedEnvelope {
12840
12842
  entity: RichContent;
12841
12843
  metadata: EventMetadata$3;
12842
12844
  }
@@ -12869,7 +12871,7 @@ interface UpdateRichContent {
12869
12871
  _updatedDate?: Date | null;
12870
12872
  /** ID of the event to which rich content is applied. */
12871
12873
  eventId?: string | null;
12872
- /** 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. */
12874
+ /** Field name whose value uses rich content. For the event description, specify the `about` value. */
12873
12875
  fieldName?: string | null;
12874
12876
  /**
12875
12877
  * Rich content of the event description.
@@ -12951,10 +12953,10 @@ interface RichContentQueryBuilder {
12951
12953
  declare function createRichContent$1(httpClient: HttpClient): CreateRichContentSignature;
12952
12954
  interface CreateRichContentSignature {
12953
12955
  /**
12954
- * Creates rich content for an event description.
12956
+ * Creates rich content, such as for an event description.
12955
12957
  *
12956
- * This method passes rich content value to the `detailedDescription` field of an already created event.
12957
- * @param - Rich content info.
12958
+ * This method passes rich content value to the description of an already created event.
12959
+ * @param - Rich content details.
12958
12960
  * @returns Created rich content.
12959
12961
  */
12960
12962
  (richContent: RichContent): Promise<RichContent & RichContentNonNullableFields>;
@@ -12962,7 +12964,7 @@ interface CreateRichContentSignature {
12962
12964
  declare function getRichContent$1(httpClient: HttpClient): GetRichContentSignature;
12963
12965
  interface GetRichContentSignature {
12964
12966
  /**
12965
- * Retrieves rich content of an event description.
12967
+ * Retrieves rich content of an event's field.
12966
12968
  * @param - Rich content ID.
12967
12969
  * @returns The requested rich content.
12968
12970
  */
@@ -13003,20 +13005,21 @@ interface QueryRichContentsSignature {
13003
13005
  declare function queryRichContent$1(httpClient: HttpClient): QueryRichContentSignature;
13004
13006
  interface QueryRichContentSignature {
13005
13007
  /**
13006
- * Retrieves a list of rich content, given the provided paging, filtering, and sorting.
13008
+ * Retrieves a list of rich content entities, given the provided paging, filtering, and sorting.
13007
13009
  *
13008
13010
  * Query Rich Content runs with these defaults, which you can override:
13009
13011
  * - `createdDate` is sorted in `ASC` order
13010
13012
  * - `paging.limit` is `100`
13011
13013
  * - `paging.offset` is `0`
13014
+ *
13012
13015
  * For field support for filters and sorting, see [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/rich-content/filter-and-sort).
13013
13016
  * 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).
13014
13017
  */
13015
13018
  (): RichContentQueryBuilder;
13016
13019
  }
13017
13020
  declare const onRichContentCreated$1: EventDefinition<RichContentCreatedEnvelope, "wix.events.v1.rich_content_created">;
13018
- declare const onRichContentUpdated$1: EventDefinition<RichContentUpdatedEnvelope, "wix.events.v1.rich_content_updated">;
13019
13021
  declare const onRichContentDeleted$1: EventDefinition<RichContentDeletedEnvelope, "wix.events.v1.rich_content_deleted">;
13022
+ declare const onRichContentUpdated$1: EventDefinition<RichContentUpdatedEnvelope, "wix.events.v1.rich_content_updated">;
13020
13023
 
13021
13024
  declare function createEventModule$6<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
13022
13025
 
@@ -13034,18 +13037,18 @@ type _publicOnRichContentCreatedType = typeof onRichContentCreated$1;
13034
13037
  */
13035
13038
  declare const onRichContentCreated: ReturnType<typeof createEventModule$6<_publicOnRichContentCreatedType>>;
13036
13039
 
13037
- type _publicOnRichContentUpdatedType = typeof onRichContentUpdated$1;
13038
- /**
13039
- * Triggered when rich content is updated.
13040
- */
13041
- declare const onRichContentUpdated: ReturnType<typeof createEventModule$6<_publicOnRichContentUpdatedType>>;
13042
-
13043
13040
  type _publicOnRichContentDeletedType = typeof onRichContentDeleted$1;
13044
13041
  /**
13045
13042
  * Triggered when rich content is deleted.
13046
13043
  */
13047
13044
  declare const onRichContentDeleted: ReturnType<typeof createEventModule$6<_publicOnRichContentDeletedType>>;
13048
13045
 
13046
+ type _publicOnRichContentUpdatedType = typeof onRichContentUpdated$1;
13047
+ /**
13048
+ * Triggered when rich content is updated.
13049
+ */
13050
+ declare const onRichContentUpdated: ReturnType<typeof createEventModule$6<_publicOnRichContentUpdatedType>>;
13051
+
13049
13052
  type context$7_Alignment = Alignment;
13050
13053
  declare const context$7_Alignment: typeof Alignment;
13051
13054
  type context$7_AnchorData = AnchorData;
@@ -10797,7 +10797,7 @@ interface RichContent {
10797
10797
  _updatedDate?: Date | null;
10798
10798
  /** ID of the event to which rich content is applied. */
10799
10799
  eventId?: string | null;
10800
- /** 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. */
10800
+ /** Field name whose value uses rich content. For the event description, specify the `about` value. */
10801
10801
  fieldName?: string | null;
10802
10802
  /**
10803
10803
  * Rich content of the event description.
@@ -12068,7 +12068,7 @@ interface ExtendedFields$2 {
12068
12068
  namespaces?: Record<string, Record<string, any>>;
12069
12069
  }
12070
12070
  interface CreateRichContentRequest {
12071
- /** Rich content info. */
12071
+ /** Rich content details. */
12072
12072
  richContent: RichContent;
12073
12073
  }
12074
12074
  interface CreateRichContentResponse {
@@ -12141,7 +12141,9 @@ interface Sorting$5 {
12141
12141
  order?: SortOrder$5;
12142
12142
  }
12143
12143
  declare enum SortOrder$5 {
12144
+ /** Sorting in ascending order. */
12144
12145
  ASC = "ASC",
12146
+ /** Sorting in descending order. */
12145
12147
  DESC = "DESC"
12146
12148
  }
12147
12149
  interface CursorPaging$5 {
@@ -12184,9 +12186,9 @@ interface QueryRichContentRequest {
12184
12186
  query?: CursorQuery$1;
12185
12187
  }
12186
12188
  interface QueryRichContentResponse {
12187
- /** List of RichContents. */
12189
+ /** List of rich content entities. */
12188
12190
  richContent?: RichContent[];
12189
- /** Paging metadata */
12191
+ /** Paging metadata. */
12190
12192
  pagingMetadata?: CursorPagingMetadata$1;
12191
12193
  }
12192
12194
  interface EventCopied$2 {
@@ -12832,11 +12834,11 @@ interface RichContentCreatedEnvelope {
12832
12834
  entity: RichContent;
12833
12835
  metadata: EventMetadata$3;
12834
12836
  }
12835
- interface RichContentUpdatedEnvelope {
12837
+ interface RichContentDeletedEnvelope {
12836
12838
  entity: RichContent;
12837
12839
  metadata: EventMetadata$3;
12838
12840
  }
12839
- interface RichContentDeletedEnvelope {
12841
+ interface RichContentUpdatedEnvelope {
12840
12842
  entity: RichContent;
12841
12843
  metadata: EventMetadata$3;
12842
12844
  }
@@ -12869,7 +12871,7 @@ interface UpdateRichContent {
12869
12871
  _updatedDate?: Date | null;
12870
12872
  /** ID of the event to which rich content is applied. */
12871
12873
  eventId?: string | null;
12872
- /** 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. */
12874
+ /** Field name whose value uses rich content. For the event description, specify the `about` value. */
12873
12875
  fieldName?: string | null;
12874
12876
  /**
12875
12877
  * Rich content of the event description.
@@ -12951,10 +12953,10 @@ interface RichContentQueryBuilder {
12951
12953
  declare function createRichContent$1(httpClient: HttpClient): CreateRichContentSignature;
12952
12954
  interface CreateRichContentSignature {
12953
12955
  /**
12954
- * Creates rich content for an event description.
12956
+ * Creates rich content, such as for an event description.
12955
12957
  *
12956
- * This method passes rich content value to the `detailedDescription` field of an already created event.
12957
- * @param - Rich content info.
12958
+ * This method passes rich content value to the description of an already created event.
12959
+ * @param - Rich content details.
12958
12960
  * @returns Created rich content.
12959
12961
  */
12960
12962
  (richContent: RichContent): Promise<RichContent & RichContentNonNullableFields>;
@@ -12962,7 +12964,7 @@ interface CreateRichContentSignature {
12962
12964
  declare function getRichContent$1(httpClient: HttpClient): GetRichContentSignature;
12963
12965
  interface GetRichContentSignature {
12964
12966
  /**
12965
- * Retrieves rich content of an event description.
12967
+ * Retrieves rich content of an event's field.
12966
12968
  * @param - Rich content ID.
12967
12969
  * @returns The requested rich content.
12968
12970
  */
@@ -13003,20 +13005,21 @@ interface QueryRichContentsSignature {
13003
13005
  declare function queryRichContent$1(httpClient: HttpClient): QueryRichContentSignature;
13004
13006
  interface QueryRichContentSignature {
13005
13007
  /**
13006
- * Retrieves a list of rich content, given the provided paging, filtering, and sorting.
13008
+ * Retrieves a list of rich content entities, given the provided paging, filtering, and sorting.
13007
13009
  *
13008
13010
  * Query Rich Content runs with these defaults, which you can override:
13009
13011
  * - `createdDate` is sorted in `ASC` order
13010
13012
  * - `paging.limit` is `100`
13011
13013
  * - `paging.offset` is `0`
13014
+ *
13012
13015
  * For field support for filters and sorting, see [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/rich-content/filter-and-sort).
13013
13016
  * 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).
13014
13017
  */
13015
13018
  (): RichContentQueryBuilder;
13016
13019
  }
13017
13020
  declare const onRichContentCreated$1: EventDefinition<RichContentCreatedEnvelope, "wix.events.v1.rich_content_created">;
13018
- declare const onRichContentUpdated$1: EventDefinition<RichContentUpdatedEnvelope, "wix.events.v1.rich_content_updated">;
13019
13021
  declare const onRichContentDeleted$1: EventDefinition<RichContentDeletedEnvelope, "wix.events.v1.rich_content_deleted">;
13022
+ declare const onRichContentUpdated$1: EventDefinition<RichContentUpdatedEnvelope, "wix.events.v1.rich_content_updated">;
13020
13023
 
13021
13024
  declare function createEventModule$6<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
13022
13025
 
@@ -13034,18 +13037,18 @@ type _publicOnRichContentCreatedType = typeof onRichContentCreated$1;
13034
13037
  */
13035
13038
  declare const onRichContentCreated: ReturnType<typeof createEventModule$6<_publicOnRichContentCreatedType>>;
13036
13039
 
13037
- type _publicOnRichContentUpdatedType = typeof onRichContentUpdated$1;
13038
- /**
13039
- * Triggered when rich content is updated.
13040
- */
13041
- declare const onRichContentUpdated: ReturnType<typeof createEventModule$6<_publicOnRichContentUpdatedType>>;
13042
-
13043
13040
  type _publicOnRichContentDeletedType = typeof onRichContentDeleted$1;
13044
13041
  /**
13045
13042
  * Triggered when rich content is deleted.
13046
13043
  */
13047
13044
  declare const onRichContentDeleted: ReturnType<typeof createEventModule$6<_publicOnRichContentDeletedType>>;
13048
13045
 
13046
+ type _publicOnRichContentUpdatedType = typeof onRichContentUpdated$1;
13047
+ /**
13048
+ * Triggered when rich content is updated.
13049
+ */
13050
+ declare const onRichContentUpdated: ReturnType<typeof createEventModule$6<_publicOnRichContentUpdatedType>>;
13051
+
13049
13052
  type index_d$7_Alignment = Alignment;
13050
13053
  declare const index_d$7_Alignment: typeof Alignment;
13051
13054
  type index_d$7_AnchorData = AnchorData;
@@ -7235,7 +7235,7 @@ interface RichContent$1 {
7235
7235
  updatedDate?: Date | null;
7236
7236
  /** ID of the event to which rich content is applied. */
7237
7237
  eventId?: string | null;
7238
- /** 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. */
7238
+ /** Field name whose value uses rich content. For the event description, specify the `about` value. */
7239
7239
  fieldName?: string | null;
7240
7240
  /**
7241
7241
  * Rich content of the event description.
@@ -8487,7 +8487,7 @@ interface ExtendedFields$5 {
8487
8487
  namespaces?: Record<string, Record<string, any>>;
8488
8488
  }
8489
8489
  interface CreateRichContentRequest$1 {
8490
- /** Rich content info. */
8490
+ /** Rich content details. */
8491
8491
  richContent: RichContent$1;
8492
8492
  }
8493
8493
  interface CreateRichContentResponse$1 {
@@ -8560,7 +8560,9 @@ interface Sorting$9 {
8560
8560
  order?: SortOrder$9;
8561
8561
  }
8562
8562
  declare enum SortOrder$9 {
8563
+ /** Sorting in ascending order. */
8563
8564
  ASC = "ASC",
8565
+ /** Sorting in descending order. */
8564
8566
  DESC = "DESC"
8565
8567
  }
8566
8568
  interface CursorPaging$9 {
@@ -8603,9 +8605,9 @@ interface QueryRichContentRequest$1 {
8603
8605
  query?: CursorQuery$3;
8604
8606
  }
8605
8607
  interface QueryRichContentResponse$1 {
8606
- /** List of RichContents. */
8608
+ /** List of rich content entities. */
8607
8609
  richContent?: RichContent$1[];
8608
- /** Paging metadata */
8610
+ /** Paging metadata. */
8609
8611
  pagingMetadata?: CursorPagingMetadata$3;
8610
8612
  }
8611
8613
  interface PluginContainerDataWidthNonNullableFields$1 {
@@ -8900,7 +8902,7 @@ interface RichContent {
8900
8902
  _updatedDate?: Date | null;
8901
8903
  /** ID of the event to which rich content is applied. */
8902
8904
  eventId?: string | null;
8903
- /** 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. */
8905
+ /** Field name whose value uses rich content. For the event description, specify the `about` value. */
8904
8906
  fieldName?: string | null;
8905
8907
  /**
8906
8908
  * Rich content of the event description.
@@ -10152,7 +10154,7 @@ interface ExtendedFields$4 {
10152
10154
  namespaces?: Record<string, Record<string, any>>;
10153
10155
  }
10154
10156
  interface CreateRichContentRequest {
10155
- /** Rich content info. */
10157
+ /** Rich content details. */
10156
10158
  richContent: RichContent;
10157
10159
  }
10158
10160
  interface CreateRichContentResponse {
@@ -10225,7 +10227,9 @@ interface Sorting$8 {
10225
10227
  order?: SortOrder$8;
10226
10228
  }
10227
10229
  declare enum SortOrder$8 {
10230
+ /** Sorting in ascending order. */
10228
10231
  ASC = "ASC",
10232
+ /** Sorting in descending order. */
10229
10233
  DESC = "DESC"
10230
10234
  }
10231
10235
  interface CursorPaging$8 {
@@ -10268,9 +10272,9 @@ interface QueryRichContentRequest {
10268
10272
  query?: CursorQuery$2;
10269
10273
  }
10270
10274
  interface QueryRichContentResponse {
10271
- /** List of RichContents. */
10275
+ /** List of rich content entities. */
10272
10276
  richContent?: RichContent[];
10273
- /** Paging metadata */
10277
+ /** Paging metadata. */
10274
10278
  pagingMetadata?: CursorPagingMetadata$2;
10275
10279
  }
10276
10280
  interface PluginContainerDataWidthNonNullableFields {