@wix/auto_sdk_events_wix-events-v-2 1.0.38 → 1.0.40

package/build/cjs/meta.d.ts

@@ -19,7 +19,7 @@ interface V3Event {
      */
     title?: string | null;
     /**
-     * Short description that appears under the event title. <br>
+     * Short description that appears under the event title.
      * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
      * @maxLength 500
      */
@@ -395,13 +395,13 @@ declare enum RegistrationTypeType {
     TICKETING = "TICKETING",
     /** Guests register externally using some other site or platform. */
     EXTERNAL = "EXTERNAL",
-    /** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */
+    /** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from `RSVP` or `TICKETING `to `EXTERNAL` or `NONE` after the event is created, depending on any additional configurations applied to the event. */
     NONE = "NONE"
 }
 /** @enumType */
 type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
 declare enum RegistrationStatusStatus {
-    /** Registration status is not applicable */
+    /** Registration status isn't applicable. */
     UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
     /** Registration is closed after tickets are sold out. */
     CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
@@ -425,7 +425,7 @@ interface RsvpRegistration {
     responseType?: ResponseTypeWithLiterals;
     /** How many guests can RSVP to an event. */
     limit?: number | null;
-    /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */
+    /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically added to the waitlist with the `IN_WAITLIST` status. */
     waitlistEnabled?: boolean;
     /** Registration start date. */
     startDate?: Date | null;
@@ -508,7 +508,7 @@ interface TaxSettings {
      */
     name?: string | null;
     /**
-     * Tax rate (for example,`21.55`).
+     * Tax rate. For example, `21.55`.
      * @decimalValue options { gte:0.001, lte:100, maxScale:3 }
      */
     rate?: string | null;
@@ -519,9 +519,9 @@ interface TaxSettings {
 declare enum TaxType {
     /** Unknown tax type. */
     UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
-    /** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
+    /** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
     INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
-    /** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket ticket service fee of $0.25 and pays $10.25 in total. */
+    /** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket service fee of $0.25 and pays $10.25 in total. */
     ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
 }
 /** @enumType */
@@ -579,7 +579,7 @@ interface CommonImage {
 }
 interface CalendarUrls {
     /**
-     * "Add to Google calendar" URL.
+     * "Add to Google Calendar" URL.
      * @readonly
      */
     google?: string;
@@ -851,7 +851,7 @@ interface TicketsUnavailableMessages {
 interface Summaries {
     /** RSVP summary of guests. */
     rsvps?: Rsvps;
-    /** Summary of revenue and sold tickets. Archived orders are not included. */
+    /** Summary of revenue and sold tickets. Archived orders aren't included. */
     tickets?: Tickets;
 }
 interface EventsMoney {
@@ -862,7 +862,7 @@ interface EventsMoney {
      */
     amount?: string;
     /**
-     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
      * @format CURRENCY
      */
     currency?: string;
@@ -906,7 +906,7 @@ interface Tickets {
      */
     revenue?: EventsMoney;
     /**
-     * Whether the currency is locked and can’t be changed.
+     * Whether the currency is locked and can't be changed.
      * @readonly
      */
     currencyLocked?: boolean;
@@ -922,11 +922,11 @@ interface Tickets {
     totalSales?: EventsMoney;
 }
 interface GuestListSettings {
-    /** Whether the guest list is public for all guests. */
+    /** Whether the guest list is displayed publicly to all guests. */
     displayedPublicly?: boolean;
 }
 interface OnlineConferencing {
-    /** Whether online conferencing is enabled. Not applicable for events, where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
+    /** Whether online conferencing is enabled. Not applicable for events where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
     enabled?: boolean;
     /**
      * Conference host ID.
@@ -984,7 +984,7 @@ interface SeoSettings {
     /** Advanced SEO data. */
     advancedSeoData?: SeoSchema;
     /**
-     * Whether the slug is hidden from the SEO Site Map.
+     * Whether the slug is hidden from the SEO sitemap.
      * @readonly
      */
     hidden?: boolean | null;
@@ -1489,7 +1489,7 @@ interface DividerData {
     /** Divider width. */
     width?: WidthWithLiterals;
     /** Divider alignment. */
-    alignment?: AlignmentWithLiterals;
+    alignment?: DividerDataAlignmentWithLiterals;
 }
 declare enum LineStyle {
     /** Single Line */
@@ -1513,7 +1513,7 @@ declare enum Width {
 }
 /** @enumType */
 type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
-declare enum Alignment {
+declare enum DividerDataAlignment {
     /** Center alignment */
     CENTER = "CENTER",
     /** Left alignment */
@@ -1522,7 +1522,7 @@ declare enum Alignment {
     RIGHT = "RIGHT"
 }
 /** @enumType */
-type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
+type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
 interface FileData {
     /** Styling for the file's container. */
     containerData?: PluginContainerData;
@@ -1647,7 +1647,7 @@ interface ItemDataOneOf {
 }
 interface GalleryOptions {
     /** Gallery layout. */
-    layout?: Layout;
+    layout?: GalleryOptionsLayout;
     /** Styling for gallery items. */
     item?: ItemStyle;
     /** Styling for gallery thumbnail images. */
@@ -1707,7 +1707,7 @@ declare enum ThumbnailsAlignment {
 }
 /** @enumType */
 type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
-interface Layout {
+interface GalleryOptionsLayout {
     /** Gallery layout type. */
     type?: LayoutTypeWithLiterals;
     /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -1869,7 +1869,7 @@ interface LinkPreviewData {
     /** Styling for the link preview. */
     styles?: LinkPreviewDataStyles;
 }
-declare enum Position {
+declare enum StylesPosition {
     /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
     START = "START",
     /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -1880,7 +1880,7 @@ declare enum Position {
     HIDDEN = "HIDDEN"
 }
 /** @enumType */
-type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
+type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
 interface LinkPreviewDataStyles {
     /**
      * Background color as a hexadecimal value.
@@ -1912,7 +1912,7 @@ interface LinkPreviewDataStyles {
      */
     borderColor?: string | null;
     /** Position of thumbnail. Defaults to `START`. */
-    thumbnailPosition?: PositionWithLiterals;
+    thumbnailPosition?: StylesPositionWithLiterals;
 }
 interface MapData {
     /** Styling for the map's container. */
@@ -2266,6 +2266,32 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
     url?: string | null;
     /** An image for the embedded content. */
     image?: Media;
+    /** Whether to hide the image. */
+    hideImage?: boolean | null;
+    /** Whether to hide the title. */
+    hideTitle?: boolean | null;
+    /** Whether to hide the price. */
+    hidePrice?: boolean | null;
+    /** Whether to hide the description (Event and Booking). */
+    hideDescription?: boolean | null;
+    /** Whether to hide the date and time (Event). */
+    hideDateTime?: boolean | null;
+    /** Whether to hide the location (Event). */
+    hideLocation?: boolean | null;
+    /** Whether to hide the duration (Booking). */
+    hideDuration?: boolean | null;
+    /** Whether to hide the button. */
+    hideButton?: boolean | null;
+    /** Whether to hide the ribbon. */
+    hideRibbon?: boolean | null;
+    /** Button styling options. */
+    buttonStyles?: ButtonStyles;
+    /** Image styling options. */
+    imageStyles?: ImageStyles;
+    /** Ribbon styling options. */
+    ribbonStyles?: RibbonStyles;
+    /** Card styling options. */
+    cardStyles?: CardStyles;
 }
 /** @oneof */
 interface AppEmbedDataAppDataOneOf {
@@ -2274,6 +2300,66 @@ interface AppEmbedDataAppDataOneOf {
     /** Data for embedded Wix Events content. */
     eventData?: EventData;
 }
+declare enum Position {
+    /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
+    START = "START",
+    /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
+    END = "END",
+    /** Image positioned at the top */
+    TOP = "TOP"
+}
+/** @enumType */
+type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
+declare enum AspectRatio {
+    /** 1:1 aspect ratio */
+    SQUARE = "SQUARE",
+    /** 16:9 aspect ratio */
+    RECTANGLE = "RECTANGLE"
+}
+/** @enumType */
+type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
+declare enum Resizing {
+    /** Fill the container, may crop the image */
+    FILL = "FILL",
+    /** Fit the image within the container */
+    FIT = "FIT"
+}
+/** @enumType */
+type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
+declare enum Placement {
+    /** Ribbon placed on the image */
+    IMAGE = "IMAGE",
+    /** Ribbon placed on the product information */
+    PRODUCT_INFO = "PRODUCT_INFO"
+}
+/** @enumType */
+type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
+declare enum CardStylesType {
+    /** Card with visible border and background */
+    CONTAINED = "CONTAINED",
+    /** Card without visible border */
+    FRAMELESS = "FRAMELESS"
+}
+/** @enumType */
+type CardStylesTypeWithLiterals = CardStylesType | 'CONTAINED' | 'FRAMELESS';
+declare enum Alignment {
+    /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
+    START = "START",
+    /** Content centered */
+    CENTER = "CENTER",
+    /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
+    END = "END"
+}
+/** @enumType */
+type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
+declare enum Layout {
+    /** Elements stacked vertically */
+    STACKED = "STACKED",
+    /** Elements arranged horizontally */
+    SIDE_BY_SIDE = "SIDE_BY_SIDE"
+}
+/** @enumType */
+type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
 declare enum AppType {
     PRODUCT = "PRODUCT",
     EVENT = "EVENT",
@@ -2291,6 +2377,122 @@ interface EventData {
     /** Event location. */
     location?: string | null;
 }
+interface ButtonStyles {
+    /** Text to display on the button. */
+    buttonText?: string | null;
+    /** Border width in pixels. */
+    borderWidth?: number | null;
+    /** Border radius in pixels. */
+    borderRadius?: number | null;
+    /**
+     * Border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Border color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    borderColorHover?: string | null;
+    /**
+     * Text color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    textColorHover?: string | null;
+    /**
+     * Background color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    backgroundColorHover?: string | null;
+    /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
+    buttonSize?: string | null;
+}
+interface ImageStyles {
+    /** Whether to hide the image. */
+    hideImage?: boolean | null;
+    /** Position of image. Defaults to `START`. */
+    imagePosition?: PositionWithLiterals;
+    /** Aspect ratio for the image. Defaults to `SQUARE`. */
+    aspectRatio?: AspectRatioWithLiterals;
+    /** How the image should be resized. Defaults to `FILL`. */
+    resizing?: ResizingWithLiterals;
+    /**
+     * Image border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /** Image border width in pixels. */
+    borderWidth?: number | null;
+    /** Image border radius in pixels. */
+    borderRadius?: number | null;
+}
+interface RibbonStyles {
+    /** Text to display on the ribbon. */
+    ribbonText?: string | null;
+    /**
+     * Ribbon background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Ribbon text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Ribbon border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /** Ribbon border width in pixels. */
+    borderWidth?: number | null;
+    /** Ribbon border radius in pixels. */
+    borderRadius?: number | null;
+    /** Placement of the ribbon. Defaults to `IMAGE`. */
+    ribbonPlacement?: PlacementWithLiterals;
+}
+interface CardStyles {
+    /**
+     * Card background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Card border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /** Card border width in pixels. */
+    borderWidth?: number | null;
+    /** Card border radius in pixels. */
+    borderRadius?: number | null;
+    /** Card type. Defaults to `CONTAINED`. */
+    type?: CardStylesTypeWithLiterals;
+    /** Content alignment. Defaults to `START`. */
+    alignment?: AlignmentWithLiterals;
+    /** Layout for title and price. Defaults to `STACKED`. */
+    titlePriceLayout?: LayoutWithLiterals;
+    /**
+     * Title text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    titleColor?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+}
 interface VideoData {
     /** Styling for the video's container. */
     containerData?: PluginContainerData;
@@ -2588,12 +2790,12 @@ interface CloneEventRequest {
      * @format GUID
      */
     eventId: string;
-    /** Field values to be changed when cloning the event. */
+    /** Event info to change in the cloned event. */
     event?: V3Event;
     /** Whether to clone the event as a draft. */
     draft?: boolean;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2603,10 +2805,10 @@ interface CloneEventResponse {
     event?: V3Event;
 }
 interface UpdateEventRequest {
-    /** Field values to be changed. */
+    /** Event info to update. */
     event?: V3Event;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2622,7 +2824,7 @@ interface PublishDraftEventRequest {
      */
     eventId: string;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2638,7 +2840,7 @@ interface CancelEventRequest {
      */
     eventId: string;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2648,7 +2850,7 @@ interface CancelEventResponse {
     event?: V3Event;
 }
 interface BulkCancelEventsByFilterRequest {
-    /** Filter. See [supported fields and operators](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/filter-and-sort). */
+    /** Filter. For supported filters, see [Events v3: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/filter-and-sort). */
     filter?: CommonQueryV2;
 }
 interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
@@ -2720,13 +2922,13 @@ interface DeleteEventResponse {
     eventId?: string;
 }
 interface BulkDeleteEventsByFilterRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     filter?: CommonQueryV2;
 }
 interface BulkDeleteEventsByFilterResponse {
 }
 interface QueryEventsRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     query?: CommonQueryV2;
     /**
      * Predefined sets of fields to return.