@wix/bookings 1.0.310 → 1.0.312

package/build/es/src/bookings-services-v2-service.types.d.ts

@@ -9,11 +9,8 @@ export interface Service {
     type?: ServiceType;
     /** Order of a service within a category. */
     sortOrder?: number | null;
-    /** Service name. */
     name?: string | null;
-    /** Service description, such as `High-class hair styling, cuts, straightening and color.` */
     description?: string | null;
-    /** Short service description, such as `Hair styling.` */
     tagLine?: string | null;
     /** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */
     defaultCapacity?: number | null;
@@ -33,9 +30,8 @@ export interface Service {
     conferencing?: Conferencing;
     /**
      * The locations this service is offered at.
-     * Only multiple locations of type `BUSINESS` are supported. multiple locations of type `CUSTOM` or `CUSTOMER` are not supported.
+     * In case of multiple (more than 1) location, All locations must be of type `BUSINESS`.
      * For courses only: Currently, only 1 location is supported, for all location types.
-     * Use `setServiceLocations` method to update the locations this service is offered at.
      */
     locations?: Location[];
     /** Policy determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins. */
@@ -86,11 +82,11 @@ export interface Service {
 }
 export declare enum ServiceType {
     UNKNOWN_SERVICE_TYPE = "UNKNOWN_SERVICE_TYPE",
-    /** The service is an appointment. */
+    /** Service is an appointment. */
     APPOINTMENT = "APPOINTMENT",
-    /** The service is a class. */
+    /** Service is a class. */
     CLASS = "CLASS",
-    /** The service is a course. */
+    /** Service is a course. */
     COURSE = "COURSE"
 }
 export interface Media {
@@ -814,6 +810,8 @@ export interface ExtendedFields {
      * The value of each key is structured according to the schema defined when the extended fields were configured.
      *
      * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
      */
     namespaces?: Record<string, Record<string, any>>;
 }
@@ -1023,8 +1021,6 @@ export interface BulkUpdateServicesRequest {
 export interface MaskedService {
     /** Service to update. [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported. */
     service?: Service;
-    /** Explicit list of fields to update. */
-    mask?: string[];
 }
 export interface BulkUpdateServicesResponse {
     /** The result of each service update. */
@@ -1035,13 +1031,21 @@ export interface BulkUpdateServicesResponse {
 export interface DeleteServiceRequest {
     /** ID of the service to delete. */
     serviceId: string;
-    /** Whether to preserve future sessions with participants. Optional, default is false. */
+    /**
+     * Whether to preserve future sessions with participants.
+     *
+     * Default: `false`
+     */
     preserveFutureSessionsWithParticipants?: boolean;
     /** Whether to notify participants about the change and an optional custom message. */
     participantNotification?: ParticipantNotification;
 }
 export interface ParticipantNotification {
-    /** Whether to send the message about the changes to the customer. `false` by default */
+    /**
+     * Whether to send the message about the changes to the customer.
+     *
+     * Default: `false`
+     */
     notifyParticipants?: boolean | null;
     /** Custom message to send to the participants about the changes to the booking. */
     message?: string | null;
@@ -1050,9 +1054,12 @@ export interface DeleteServiceResponse {
 }
 export interface BulkDeleteServicesRequest {
     ids?: string[];
-    /** Whether to preserve future sessions with participants. Optional, default is false. */
     preserveFutureSessionsWithParticipants?: boolean;
-    /** Whether to notify participants about the change and an optional custom message. */
+    /**
+     * Whether to preserve future sessions with participants.
+     *
+     * Default: `false`.
+     */
     participantNotification?: ParticipantNotification;
 }
 export interface BulkDeleteServicesResponse {
@@ -1148,16 +1155,234 @@ export interface Cursors {
     prev?: string | null;
 }
 export interface SearchServicesRequest {
-    /** The search term used to match services. */
-    query?: string | null;
-    /** Pagination, including offset, and limit. */
-    paging?: Paging;
+    search?: CursorSearch;
+}
+export interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
+    cursorPaging?: CursorPaging;
+    /** A filter object. See documentation [here](https:// bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    sort?: Sorting[];
+    /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
+    aggregations?: Aggregation[];
+    /** Free text to match in searchable fields */
+    search?: SearchDetails;
+}
+/** @oneof */
+export interface CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
+    cursorPaging?: CursorPaging;
+}
+export interface Aggregation extends AggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Range aggregation */
+    range?: RangeAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** Name of the aggregation. Optional and can be used as an identifier of the requested aggregation in response. */
+    name?: string | null;
+    /** Aggregation type. Supported values: VALUE, RANGE, SCALAR. */
+    type?: AggregationType;
+    /** Path of the field. For example, "singleResource.locationOptions.availableInAllLocations" */
+    fieldPath?: string;
+    /** Group by aggregation */
+    groupBy?: GroupByAggregation;
+}
+/** @oneof */
+export interface AggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Range aggregation */
+    range?: RangeAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+}
+export interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if to is not given. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if from is not given. */
+    to?: number | null;
+}
+export declare enum SortType {
+    COUNT = "COUNT",
+    VALUE = "VALUE"
+}
+export declare enum SortDirection {
+    DESC = "DESC",
+    ASC = "ASC"
+}
+export declare enum ScalarType {
+    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    MIN = "MIN",
+    MAX = "MAX",
+    SUM = "SUM",
+    AVG = "AVG"
+}
+export interface ValueAggregation {
+    /** Sort type. Can be COUNT or VALUE. COUNT is the default. */
+    sortType?: SortType;
+    /** Sort direction. Can be DESC or ASC. DESC is the default. */
+    sortDirection?: SortDirection;
+    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    limit?: number | null;
+}
+export declare enum AggregationType {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    VALUE = "VALUE",
+    RANGE = "RANGE",
+    SCALAR = "SCALAR"
+}
+export interface RangeAggregation {
+    /** Range buckets */
+    buckets?: RangeBucket[];
+}
+export interface ScalarAggregation {
+    /** Scalar type */
+    type?: ScalarType;
+}
+export interface GroupByAggregation extends GroupByAggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Name of the GroupByAggregation. Optional and can be used as an identifier of the requested aggregation in response. */
+    name?: string | null;
+    /** Path of the field to group by. For example, "type" */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface GroupByAggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+}
+export interface SearchDetails {
+    /** Boolean search mode */
+    mode?: Mode;
+    /** Search term or expression */
+    expression?: string | null;
+    /** Fields to search in. If empty - server will search in own default fields */
+    fields?: string[];
+    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    fuzzy?: boolean;
+}
+export declare enum Mode {
+    /** Any */
+    OR = "OR",
+    /** All */
+    AND = "AND"
 }
 export interface SearchServicesResponse {
     /** The retrieved services. */
     services?: Service[];
-    /** Paging metadata, including offset and count. */
-    pagingMetadata?: PagingMetadataV2;
+    /** Cursor paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Response aggregation data */
+    aggregationData?: AggregationData;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface AggregationData {
+    /** Key = aggregation name (as derived from search request) */
+    results?: AggregationResults[];
+}
+export interface ValueAggregationResult {
+    /** Value */
+    value?: string;
+    /** Count */
+    count?: number;
+}
+export interface RangeAggregationResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count */
+    count?: number;
+}
+export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** Value results */
+    values?: ValueResults;
+    /** Range results */
+    ranges?: RangeResults;
+    /** Scalar result */
+    scalar?: ScalarResult;
+    /** Name of the requested nested aggregation. */
+    name?: string;
+    /** Aggregation type. Supported values: VALUE, RANGE, SCALAR. */
+    type?: AggregationType;
+    /** Path of the field. For example, "singleResource.locationOptions.availableInAllLocations" */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface NestedAggregationResultsResultOneOf {
+    /** Value results */
+    values?: ValueResults;
+    /** Range results */
+    ranges?: RangeResults;
+    /** Scalar result */
+    scalar?: ScalarResult;
+}
+export interface ValueResults {
+    /** Value aggregation results */
+    results?: ValueAggregationResult[];
+}
+export interface RangeResults {
+    /** Aggregation results */
+    results?: RangeAggregationResult[];
+}
+export interface ScalarResult {
+    /** Scalar type */
+    type?: ScalarType;
+    /** Value */
+    value?: number;
+}
+export interface NestedValueAggregationResult {
+    /** Value */
+    value?: string;
+    /** Nested results */
+    nestedResults?: NestedAggregationResults;
+}
+export interface GroupByValueResults {
+    /** Nested value aggregation results */
+    results?: NestedValueAggregationResult[];
+}
+export interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value results */
+    values?: ValueResults;
+    /** Range results */
+    ranges?: RangeResults;
+    /** Scalar result */
+    scalar?: ScalarResult;
+    /** Group by value results */
+    groupedByValue?: GroupByValueResults;
+    /** Name of the requested aggregation. */
+    name?: string;
+    /** Aggregation type. Supported values: VALUE, RANGE, SCALAR. */
+    type?: AggregationType;
+    /** Path of the field. For example, "singleResource.locationOptions.availableInAllLocations" */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface AggregationResultsResultOneOf {
+    /** Value results */
+    values?: ValueResults;
+    /** Range results */
+    ranges?: RangeResults;
+    /** Scalar result */
+    scalar?: ScalarResult;
+    /** Group by value results */
+    groupedByValue?: GroupByValueResults;
 }
 export interface QueryPoliciesRequest {
     /** WQL expression. */
@@ -1202,18 +1427,6 @@ export interface BookingPolicyWithServices {
     /** The number of services associated with the booking policy. */
     countOfServices?: number;
 }
-export interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
-    cursors?: Cursors;
-    /**
-     * Indicates if there are more results after the current page.
-     * If `true`, another page of results can be retrieved.
-     * If `false`, this is the last page.
-     */
-    hasNext?: boolean | null;
-}
 export interface CountServicesRequest {
     /** The filters for performing the count. */
     filter?: Record<string, any> | null;
@@ -1230,20 +1443,22 @@ export interface CategoryNotification {
 /** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
 export interface Category {
     /**
-     * Category ID. Read-only.
+     * Category ID.
      * @readonly
      */
     id?: string | null;
     /** Category name. */
     name?: string | null;
-    /** Custom properties that can be associated with the category. */
-    customProperties?: Record<string, string>;
     /**
-     * Category status Read-only.
+     * Category status.
+     * Supported values:
+     * - "CREATED". The category is created.
+     * - "DELETED". The category is deleted.
+     * Default: "CREATED"
      * @readonly
      */
     status?: Status;
-    /** Sorting order of the category for Wix Bookings UI. */
+    /** Sort order of the category in the Dashboard. */
     sortOrder?: number | null;
 }
 export declare enum Status {
@@ -1320,6 +1535,8 @@ export interface EntityUpdatedEvent {
     currentEntityAsJson?: string;
 }
 export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
 }
 export interface ActionEvent {
     bodyAsJson?: string;
@@ -2468,6 +2685,250 @@ export declare enum BenefitNotificationEvent {
     Deleted = "Deleted",
     Created = "Created"
 }
+export interface UserDomainInfoChangedEvent {
+    domainName?: string;
+    crudType?: CrudType;
+    metaSiteId?: string | null;
+    changeTime?: Date;
+}
+export declare enum CrudType {
+    INVALID_CRUD_TYPE = "INVALID_CRUD_TYPE",
+    CREATE = "CREATE",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE",
+    /** Unfortunately this action is used by hibernate save in wix-war */
+    CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
+}
+export interface HtmlSitePublished {
+    /** Application instance ID */
+    appInstanceId?: string;
+    /** Application type */
+    appType?: string;
+    /** Revision */
+    revision?: string;
+    /** MSID */
+    metaSiteId?: string | null;
+    /** optional branch id if publish is done from branch */
+    branchId?: string | null;
+    /** The site's last transactionId */
+    lastTransactionId?: string | null;
+    /** A list of the site's pages */
+    pages?: Page[];
+    /** Site's publish date */
+    publishDate?: string;
+}
+export interface Page {
+    /** Page's Id */
+    id?: string;
+}
+/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
+export interface SitePropertiesNotification {
+    /** The site ID for which this update notification applies. */
+    metasiteId?: string;
+    /** The actual update event. */
+    event?: SitePropertiesEvent;
+    /** A convenience set of mappings from the MetaSite ID to its constituent services. */
+    translations?: Translation[];
+    /** Context of the notification */
+    changeContext?: ChangeContext;
+}
+/** The actual update event for a particular notification. */
+export interface SitePropertiesEvent {
+    /** Version of the site's properties represented by this update. */
+    version?: number;
+    /** Updated properties. */
+    properties?: Properties;
+}
+export interface Properties {
+    /** Site categories. */
+    categories?: Categories;
+    /** Site locale. */
+    locale?: Locale;
+    /**
+     * Site language.
+     *
+     * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     */
+    language?: string | null;
+    /**
+     * Site currency format used to bill customers.
+     *
+     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    paymentCurrency?: string | null;
+    /** Timezone in `America/New_York` format. */
+    timeZone?: string | null;
+    /** Email address. */
+    email?: string | null;
+    /** Phone number. */
+    phone?: string | null;
+    /** Fax number. */
+    fax?: string | null;
+    /** Address. */
+    address?: V4Address;
+    /** Site display name. */
+    siteDisplayName?: string | null;
+    /** Business name. */
+    businessName?: string | null;
+    /** Path to the site's logo in Wix Media (without Wix Media base URL). */
+    logo?: string | null;
+    /** Site description. */
+    description?: string | null;
+    /**
+     * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
+     *
+     * __Note:__ Not supported by Wix Bookings.
+     */
+    businessSchedule?: BusinessSchedule;
+    /** Supported languages of a site and the primary language. */
+    multilingual?: Multilingual;
+    /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */
+    consentPolicy?: ConsentPolicy;
+    /**
+     * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
+     *
+     * Site business type.
+     */
+    businessConfig?: string | null;
+    /** External site url that uses Wix as its headless business solution */
+    externalSiteUrl?: string | null;
+    /** Track clicks analytics */
+    trackClicksAnalytics?: boolean;
+}
+export interface Categories {
+    /** Primary site category. */
+    primary?: string;
+    /** Secondary site category. */
+    secondary?: string[];
+    /** Business Term Id */
+    businessTermId?: string | null;
+}
+export interface Locale {
+    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
+    languageCode?: string;
+    /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
+    country?: string;
+}
+export interface V4Address {
+    /** Street name. */
+    street?: string;
+    /** City name. */
+    city?: string;
+    /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
+    country?: string;
+    /** State. */
+    state?: string;
+    /** Zip or postal code. */
+    zip?: string;
+    /** Extra information to be displayed in the address. */
+    hint?: AddressHint;
+    /** Whether this address represents a physical location. */
+    isPhysical?: boolean;
+    /** Google-formatted version of this address. */
+    googleFormattedAddress?: string;
+    /** Street number. */
+    streetNumber?: string;
+    /** Apartment number. */
+    apartmentNumber?: string;
+    /** Geographic coordinates of location. */
+    coordinates?: GeoCoordinates;
+}
+/**
+ * Extra information on displayed addresses.
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
+ * Free text. In addition the user can state where he wants that additional description - before, after, or instead
+ * the address string.
+ */
+export interface AddressHint {
+    /** Extra text displayed next to, or instead of, the actual address. */
+    text?: string;
+    /** Where the extra text should be displayed. */
+    placement?: PlacementType;
+}
+/** Where the extra text should be displayed: before, after or instead of the actual address. */
+export declare enum PlacementType {
+    BEFORE = "BEFORE",
+    AFTER = "AFTER",
+    REPLACE = "REPLACE"
+}
+/** Geocoordinates for a particular address. */
+export interface GeoCoordinates {
+    /** Latitude of the location. Must be between -90 and 90. */
+    latitude?: number;
+    /** Longitude of the location. Must be between -180 and 180. */
+    longitude?: number;
+}
+export interface Multilingual {
+    /** Supported languages list. */
+    supportedLanguages?: SupportedLanguage[];
+    /** Whether to redirect to user language. */
+    autoRedirect?: boolean;
+}
+export interface SupportedLanguage {
+    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
+    languageCode?: string;
+    /** Locale. */
+    locale?: Locale;
+    /** Whether the supported language is the primary language for the site. */
+    isPrimary?: boolean;
+    /** Language icon. */
+    countryCode?: string;
+    /** How the language will be resolved. For internal use. */
+    resolutionMethod?: ResolutionMethod;
+}
+export declare enum ResolutionMethod {
+    QUERY_PARAM = "QUERY_PARAM",
+    SUBDOMAIN = "SUBDOMAIN",
+    SUBDIRECTORY = "SUBDIRECTORY"
+}
+export interface ConsentPolicy {
+    /** Whether the site uses cookies that are essential to site operation. */
+    essential?: boolean | null;
+    /** Whether the site uses cookies that affect site performance and other functional measurements. */
+    functional?: boolean | null;
+    /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
+    analytics?: boolean | null;
+    /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
+    advertising?: boolean | null;
+    /** CCPA compliance flag. */
+    dataToThirdParty?: boolean | null;
+}
+/** A single mapping from the MetaSite ID to a particular service. */
+export interface Translation {
+    /** The service type. */
+    serviceType?: string;
+    /** The application definition ID; this only applies to services of type ThirdPartyApps. */
+    appDefId?: string;
+    /** The instance ID of the service. */
+    instanceId?: string;
+}
+export interface ChangeContext extends ChangeContextPayloadOneOf {
+    /** Properties were updated. */
+    propertiesChange?: PropertiesChange;
+    /** Default properties were created on site creation. */
+    siteCreated?: SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+/** @oneof */
+export interface ChangeContextPayloadOneOf {
+    /** Properties were updated. */
+    propertiesChange?: PropertiesChange;
+    /** Default properties were created on site creation. */
+    siteCreated?: SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+export interface PropertiesChange {
+}
+export interface SiteCreated {
+    /** Origin template site id. */
+    originTemplateId?: string | null;
+}
+export interface SiteCloned {
+    /** Origin site id. */
+    originMetaSiteId?: string;
+}
 export interface SetServiceLocationsRequest {
     /** ID of the service. */
     serviceId?: string;
@@ -2522,9 +2983,9 @@ export interface EnablePricingPlansForServiceRequest {
     pricingPlanIds?: string[];
 }
 export interface EnablePricingPlansForServiceResponse {
-    /** IDs of the pricing plans connect to the service. */
+    /** IDs of the pricing plans connected to the service. */
     pricingPlanIds?: string[];
-    /** The service after the pricing plans update */
+    /** The service after the pricing plans update. */
     service?: Service;
 }
 export interface InvalidPricingPlan {
@@ -2540,7 +3001,7 @@ export interface DisablePricingPlansForServiceRequest {
     pricingPlanIds?: string[];
 }
 export interface DisablePricingPlansForServiceResponse {
-    /** The service after the pricing plans update */
+    /** The service after the pricing plans update. */
     service?: Service;
 }
 export interface SetCustomSlugRequest {
@@ -2603,6 +3064,129 @@ export declare enum CloneErrors {
     /** Failed to clone pricing plans connected to the source service */
     PRICING_PLANS = "PRICING_PLANS"
 }
+export interface MultiServiceEnabledNotification {
+}
+export interface PlanEvent extends PlanEventEventOneOf {
+    created?: PlanCreated;
+    updated?: PlanUpdated;
+    archived?: PlanArchived;
+}
+/** @oneof */
+export interface PlanEventEventOneOf {
+    created?: PlanCreated;
+    updated?: PlanUpdated;
+    archived?: PlanArchived;
+}
+export interface PlanCreated {
+    plan?: Plan;
+}
+export interface Plan {
+    /**
+     * Plan id.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Id of role/group in groups and permissions for service that is provided for the plan subscriber.
+     * @readonly
+     */
+    roleId?: string;
+    details?: PlanDetails;
+    paymentOptions?: PlansPaymentOptions;
+    /** If true, the plan is visible. */
+    visible?: boolean;
+    /**
+     * Indicates whether plan is archived.
+     * @readonly
+     */
+    archived?: boolean;
+    /**
+     * If true, the plan is marked as primary.
+     * @readonly
+     */
+    primary?: boolean;
+    /**
+     * Indicates whether plan has orders.
+     * @readonly
+     */
+    hasOrders?: boolean;
+    /**
+     * Date when plan was created.
+     * @readonly
+     */
+    dateCreated?: Date;
+    /**
+     * Date when plan was last updated.
+     * @readonly
+     */
+    dateUpdated?: Date;
+    slug?: string;
+    /**
+     * The plan is created from the templates (meaning it was created automatically with the site’s creation, not by the site owner).
+     * @readonly
+     */
+    template?: boolean;
+    /** Limits on the possible purchase */
+    purchaseLimitations?: PurchaseLimitations;
+    /** Member is allowed to cancel his/her plan. If no value is given it's set to true. */
+    memberCanCancel?: boolean | null;
+    /** Buyer can pick a later start date than the time of purchase. */
+    buyerCanPickFutureStartDate?: boolean | null;
+}
+export interface PlanDetails {
+    /** Plan name. */
+    name?: string;
+    /** Plan description. */
+    description?: string;
+    /** Plan ribbon allows to show additional information for the plan i.e. ‘Best deal’. */
+    ribbon?: string;
+    /** Plan benefits. */
+    benefits?: string[];
+    /** Any terms & conditions that apply to the plan. This information will be displayed on the plan’s checkout screen. */
+    disclaimer?: string | null;
+    clientData?: Record<string, string>;
+}
+export interface PlansPaymentOptions {
+    price?: V1Money;
+    /** Recurring payments are payments billed Weekly, Monthly or Yearly. False - payment is one time; true - price is deducted from UoU every week, month or year. */
+    recurring?: boolean;
+    validFor?: Validity;
+    /** Free trial period for the plan is in days only. It’s available only for recurring plans. */
+    freeTrialDays?: number | null;
+}
+export interface V1Money {
+    /** Monetary amount i.e. 3.99. */
+    amount?: string;
+    /** Currency in ISO 4217 format i.e. USD. */
+    currency?: string;
+}
+export interface Validity {
+    /** If true, plan is valid until canceled. */
+    forever?: boolean;
+    period?: Period;
+}
+export interface Period {
+    /** The amount of Days, Months, Weeks or Years. */
+    amount?: number;
+    unit?: PeriodUnit;
+}
+export declare enum PeriodUnit {
+    MONTH = "MONTH",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    YEAR = "YEAR"
+}
+export interface PurchaseLimitations {
+    /** Number of times plan can be purchased. If plan has no limits value should be NULL */
+    amount?: number | null;
+}
+export interface PlanUpdated {
+    plan?: Plan;
+    previousPlan?: Plan;
+}
+export interface PlanArchived {
+    plan?: Plan;
+}
 export interface CreateServiceResponseNonNullableFields {
     service?: {
         type: ServiceType;