@wix/auto_sdk_property_property 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,1216 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
+
+/** Represents a real estate property listing. */
+interface Property {
+    /**
+     * Property ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Property is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the Property.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Property was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Property was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Full street address of the property (not personal address).
+     * @maxLength 200
+     */
+    address?: string;
+    /**
+     * City.
+     * @maxLength 100
+     */
+    city?: string;
+    /**
+     * State or province.
+     * @maxLength 100
+     */
+    state?: string;
+    /**
+     * ZIP or postal code of the property (not personal address).
+     * @maxLength 20
+     */
+    zip?: string;
+    /** Listing price. */
+    price?: Money;
+    /** Property status. */
+    status?: PropertyStatusWithLiterals;
+    /** Property type. */
+    propertyType?: PropertyTypeWithLiterals;
+    /**
+     * Number of bedrooms.
+     * @max 100
+     */
+    beds?: number | null;
+    /**
+     * Number of bathrooms.
+     * @max 100
+     */
+    baths?: number | null;
+    /**
+     * Living area in square feet.
+     * @max 1000000
+     */
+    sqft?: number | null;
+    /**
+     * Lot size in square feet.
+     * @max 100000000
+     */
+    lotSize?: number | null;
+    /**
+     * Year the property was built.
+     * @min 1600
+     * @max 2200
+     */
+    yearBuilt?: number | null;
+    /**
+     * Public description.
+     * @maxLength 10000
+     */
+    description?: string;
+    /**
+     * Property features (e.g., Pool, Waterfront, Garage, AC).
+     * @maxSize 100
+     * @maxLength 100
+     */
+    features?: string[];
+    /**
+     * Property photos.
+     * @maxSize 100
+     */
+    photos?: PropertyPhoto[];
+    /**
+     * 360-degree virtual tour URL.
+     * @format WEB_URL
+     */
+    virtualTourUrl?: string | null;
+    /**
+     * Property documents (floor plans, disclosures, brochures).
+     * @maxSize 50
+     */
+    documents?: PropertyDocument[];
+    /**
+     * Custom fields for additional property information.
+     * @maxSize 100
+     */
+    customFields?: CustomField[];
+    /**
+     * Latitude coordinate.
+     * @min -90
+     * @max 90
+     */
+    lat?: number | null;
+    /**
+     * Longitude coordinate.
+     * @min -180
+     * @max 180
+     */
+    lng?: number | null;
+    /**
+     * Date when property was listed (status changed to Active).
+     * @readonly
+     */
+    listingDate?: Date | null;
+    /**
+     * Date when property was sold (status changed to Sold).
+     * @readonly
+     */
+    saleDate?: Date | null;
+    /**
+     * Number of days the property has been on the market.
+     * @readonly
+     */
+    daysOnMarket?: number | null;
+    /**
+     * Source of the property listing.
+     * @readonly
+     */
+    source?: PropertySourceWithLiterals;
+    /**
+     * MLS identifier (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    mlsId?: string | null;
+    /**
+     * MLS listing number (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    listingId?: string | null;
+    /**
+     * MLS listing agent ID (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    listingAgentId?: string | null;
+    /**
+     * MLS listing office ID (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    listingOfficeId?: string | null;
+    /**
+     * Whether the property is editable by the agent.
+     * @readonly
+     */
+    editable?: boolean;
+    /**
+     * Wix Bookings Service ID for scheduling property viewings.
+     * Populated asynchronously after property creation.
+     * @format GUID
+     * @readonly
+     */
+    serviceId?: string | null;
+    /** Data Extensions. */
+    extendedFields?: ExtendedFields;
+    /** Tags for classification. */
+    tags?: Tags;
+}
+/**
+ * Money.
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
+ */
+interface Money {
+    /**
+     * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:2 }
+     */
+    value?: string;
+    /**
+     * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
+     * @format CURRENCY
+     */
+    currency?: string;
+    /**
+     * Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
+     * @maxLength 50
+     */
+    formattedValue?: string | null;
+}
+/** Property status. */
+declare enum PropertyStatus {
+    /** Unknown status. */
+    PROPERTY_STATUS_UNKNOWN = "PROPERTY_STATUS_UNKNOWN",
+    /** Property is currently for sale or rent. */
+    ACTIVE = "ACTIVE",
+    /** Property is under contract. */
+    PENDING = "PENDING",
+    /** Property transaction is closed. */
+    SOLD = "SOLD",
+    /** Property is not publicly listed. */
+    OFF_MARKET = "OFF_MARKET",
+    /** Property is incomplete and not published. */
+    DRAFT = "DRAFT"
+}
+/** @enumType */
+type PropertyStatusWithLiterals = PropertyStatus | 'PROPERTY_STATUS_UNKNOWN' | 'ACTIVE' | 'PENDING' | 'SOLD' | 'OFF_MARKET' | 'DRAFT';
+/** Property type. */
+declare enum PropertyType {
+    /** Unknown property type. */
+    PROPERTY_TYPE_UNKNOWN = "PROPERTY_TYPE_UNKNOWN",
+    /** Single-family home. */
+    SINGLE_FAMILY = "SINGLE_FAMILY",
+    /** Condominium. */
+    CONDO = "CONDO",
+    /** Townhouse. */
+    TOWNHOUSE = "TOWNHOUSE",
+    /** Multi-family home. */
+    MULTI_FAMILY = "MULTI_FAMILY",
+    /** Land. */
+    LAND = "LAND",
+    /** Commercial property. */
+    COMMERCIAL = "COMMERCIAL"
+}
+/** @enumType */
+type PropertyTypeWithLiterals = PropertyType | 'PROPERTY_TYPE_UNKNOWN' | 'SINGLE_FAMILY' | 'CONDO' | 'TOWNHOUSE' | 'MULTI_FAMILY' | 'LAND' | 'COMMERCIAL';
+/** Property photo. */
+interface PropertyPhoto {
+    /**
+     * Photo URL.
+     * @format WEB_URL
+     */
+    url?: string;
+    /**
+     * Alt text for accessibility.
+     * @maxLength 200
+     */
+    altText?: string;
+    /** Display order. */
+    order?: number;
+}
+/** Property document. */
+interface PropertyDocument {
+    /**
+     * Document URL.
+     * @format WEB_URL
+     */
+    url?: string;
+    /**
+     * Document title.
+     * @maxLength 200
+     */
+    title?: string;
+    /** Document type. */
+    type?: DocumentTypeWithLiterals;
+}
+/** Document type. */
+declare enum DocumentType {
+    /** Unknown document type. */
+    DOCUMENT_TYPE_UNKNOWN = "DOCUMENT_TYPE_UNKNOWN",
+    /** Floor plan. */
+    FLOOR_PLAN = "FLOOR_PLAN",
+    /** Disclosure document. */
+    DISCLOSURE = "DISCLOSURE",
+    /** Brochure. */
+    BROCHURE = "BROCHURE",
+    /** Other document. */
+    OTHER = "OTHER"
+}
+/** @enumType */
+type DocumentTypeWithLiterals = DocumentType | 'DOCUMENT_TYPE_UNKNOWN' | 'FLOOR_PLAN' | 'DISCLOSURE' | 'BROCHURE' | 'OTHER';
+/** Custom field for additional property information. */
+interface CustomField {
+    /**
+     * Field key.
+     * @maxLength 100
+     */
+    key?: string;
+    /**
+     * Field value.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Field type. */
+    type?: CustomFieldTypeWithLiterals;
+}
+/** Custom field type. */
+declare enum CustomFieldType {
+    /** Unknown field type. */
+    CUSTOM_FIELD_TYPE_UNKNOWN = "CUSTOM_FIELD_TYPE_UNKNOWN",
+    /** String value. */
+    STRING = "STRING",
+    /** Number value. */
+    NUMBER = "NUMBER",
+    /** Boolean value. */
+    BOOLEAN = "BOOLEAN",
+    /** Date value. */
+    DATE = "DATE"
+}
+/** @enumType */
+type CustomFieldTypeWithLiterals = CustomFieldType | 'CUSTOM_FIELD_TYPE_UNKNOWN' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE';
+/** Property source. */
+declare enum PropertySource {
+    /** Unknown source. */
+    PROPERTY_SOURCE_UNKNOWN = "PROPERTY_SOURCE_UNKNOWN",
+    /** Manually created by agent. */
+    MANUAL = "MANUAL",
+    /** Synced from MLS (Phase 2). */
+    MLS = "MLS"
+}
+/** @enumType */
+type PropertySourceWithLiterals = PropertySource | 'PROPERTY_SOURCE_UNKNOWN' | 'MANUAL' | 'MLS';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * 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>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * public_tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, typically restricted from site members and visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone with access to the entity, including site members and visitors. */
+    publicTags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs.
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+/** PropertyStatusChanged action event payload. */
+interface PropertyStatusChanged {
+    /**
+     * Property ID.
+     * @format GUID
+     */
+    propertyId?: string;
+    /** Previous status. */
+    oldStatus?: PropertyStatusWithLiterals;
+    /** New status. */
+    newStatus?: PropertyStatusWithLiterals;
+    /** Timestamp of the status change. */
+    timestamp?: Date | null;
+}
+/** TagsModified action event payload. */
+interface TagsModified {
+    /** Updated Property. */
+    property?: Property;
+    /** Tags that were assigned to the Property. */
+    assignedTags?: Tags;
+    /** Tags that were unassigned from the Property. */
+    unassignedTags?: Tags;
+}
+interface CreatePropertyRequest {
+    /** Property to be created. */
+    property: Property;
+}
+interface CreatePropertyResponse {
+    /** The created Property. */
+    property?: Property;
+}
+interface GetPropertyRequest {
+    /**
+     * ID of the Property to retrieve.
+     * @format GUID
+     */
+    propertyId: string;
+}
+interface GetPropertyResponse {
+    /** The requested Property. */
+    property?: Property;
+}
+interface UpdatePropertyRequest {
+    /** Property to be updated, may be partial. */
+    property: Property;
+}
+interface UpdatePropertyResponse {
+    /** Updated Property. */
+    property?: Property;
+}
+interface DeletePropertyRequest {
+    /**
+     * ID of the Property to delete.
+     * @format GUID
+     */
+    propertyId: string;
+}
+interface DeletePropertyResponse {
+}
+interface QueryPropertiesRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryPropertiesResponse {
+    /** List of Properties. */
+    properties?: Property[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface BulkCreatePropertiesRequest {
+    /**
+     * List of Properties to be created.
+     * @minSize 1
+     * @maxSize 100
+     */
+    properties: Property[];
+    /** Set to `true` to receive back the created Properties in the response. */
+    returnEntity?: boolean;
+}
+interface BulkCreatePropertiesResponse {
+    /**
+     * List of the bulk create operation results including the Properties and metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPropertyResult[];
+    /** Metadata regarding the bulk create operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkPropertyResult {
+    /** Metadata regarding the specific single create operation. */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request. */
+    item?: Property;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdatePropertiesRequest {
+    /**
+     * List of Properties to be updated.
+     * @minSize 1
+     * @maxSize 100
+     */
+    properties: MaskedProperty[];
+    /** Set to `true` to receive back the updated Properties in the response. */
+    returnEntity?: boolean;
+}
+interface MaskedProperty {
+    /** Property to be updated, may be partial. */
+    property?: Property;
+}
+interface BulkUpdatePropertiesResponse {
+    /**
+     * Results.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdatePropertiesResponseBulkPropertyResult[];
+    /** Metadata regarding the bulk update operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdatePropertiesResponseBulkPropertyResult {
+    /** Metadata regarding the specific single update operation. */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request. */
+    item?: Property;
+}
+interface BulkDeletePropertiesRequest {
+    /**
+     * Property IDs to be deleted.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    propertyIds: string[];
+}
+interface BulkDeletePropertiesResponse {
+    /**
+     * Results.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkDeletePropertiesResponseBulkPropertyResult[];
+    /** Metadata regarding the bulk delete operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeletePropertiesResponseBulkPropertyResult {
+    /** Metadata regarding the specific single delete operation. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkUpdatePropertyTagsRequest {
+    /**
+     * List of Property IDs whose tags will be updated.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    propertyIds: string[];
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePropertyTagsResponse {
+    /**
+     * Results.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdatePropertyTagsResult[];
+    /** Metadata regarding the bulk update operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdatePropertyTagsResult {
+    /** Metadata regarding the specific single update operation. */
+    itemMetadata?: ItemMetadata;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface BulkUpdatePropertyTagsByFilterRequest {
+    /** Filter. */
+    filter: Record<string, any> | null;
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePropertyTagsByFilterResponse {
+    /**
+     * Job ID for tracking the async operation.
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** @docsIgnore */
+type BulkUpdatePropertyTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdatePropertyTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface UpdateProperty {
+    /**
+     * Property ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Property is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the Property.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Property was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Property was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Full street address of the property (not personal address).
+     * @maxLength 200
+     */
+    address?: string;
+    /**
+     * City.
+     * @maxLength 100
+     */
+    city?: string;
+    /**
+     * State or province.
+     * @maxLength 100
+     */
+    state?: string;
+    /**
+     * ZIP or postal code of the property (not personal address).
+     * @maxLength 20
+     */
+    zip?: string;
+    /** Listing price. */
+    price?: Money;
+    /** Property status. */
+    status?: PropertyStatusWithLiterals;
+    /** Property type. */
+    propertyType?: PropertyTypeWithLiterals;
+    /**
+     * Number of bedrooms.
+     * @max 100
+     */
+    beds?: number | null;
+    /**
+     * Number of bathrooms.
+     * @max 100
+     */
+    baths?: number | null;
+    /**
+     * Living area in square feet.
+     * @max 1000000
+     */
+    sqft?: number | null;
+    /**
+     * Lot size in square feet.
+     * @max 100000000
+     */
+    lotSize?: number | null;
+    /**
+     * Year the property was built.
+     * @min 1600
+     * @max 2200
+     */
+    yearBuilt?: number | null;
+    /**
+     * Public description.
+     * @maxLength 10000
+     */
+    description?: string;
+    /**
+     * Property features (e.g., Pool, Waterfront, Garage, AC).
+     * @maxSize 100
+     * @maxLength 100
+     */
+    features?: string[];
+    /**
+     * Property photos.
+     * @maxSize 100
+     */
+    photos?: PropertyPhoto[];
+    /**
+     * 360-degree virtual tour URL.
+     * @format WEB_URL
+     */
+    virtualTourUrl?: string | null;
+    /**
+     * Property documents (floor plans, disclosures, brochures).
+     * @maxSize 50
+     */
+    documents?: PropertyDocument[];
+    /**
+     * Custom fields for additional property information.
+     * @maxSize 100
+     */
+    customFields?: CustomField[];
+    /**
+     * Latitude coordinate.
+     * @min -90
+     * @max 90
+     */
+    lat?: number | null;
+    /**
+     * Longitude coordinate.
+     * @min -180
+     * @max 180
+     */
+    lng?: number | null;
+    /**
+     * Date when property was listed (status changed to Active).
+     * @readonly
+     */
+    listingDate?: Date | null;
+    /**
+     * Date when property was sold (status changed to Sold).
+     * @readonly
+     */
+    saleDate?: Date | null;
+    /**
+     * Number of days the property has been on the market.
+     * @readonly
+     */
+    daysOnMarket?: number | null;
+    /**
+     * Source of the property listing.
+     * @readonly
+     */
+    source?: PropertySourceWithLiterals;
+    /**
+     * MLS identifier (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    mlsId?: string | null;
+    /**
+     * MLS listing number (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    listingId?: string | null;
+    /**
+     * MLS listing agent ID (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    listingAgentId?: string | null;
+    /**
+     * MLS listing office ID (Phase 2).
+     * @readonly
+     * @maxLength 100
+     */
+    listingOfficeId?: string | null;
+    /**
+     * Whether the property is editable by the agent.
+     * @readonly
+     */
+    editable?: boolean;
+    /**
+     * Wix Bookings Service ID for scheduling property viewings.
+     * Populated asynchronously after property creation.
+     * @format GUID
+     * @readonly
+     */
+    serviceId?: string | null;
+    /** Data Extensions. */
+    extendedFields?: ExtendedFields;
+    /** Tags for classification. */
+    tags?: Tags;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface PropertiesQueryResult extends QueryCursorResult {
+    items: Property[];
+    query: PropertiesQueryBuilder;
+    next: () => Promise<PropertiesQueryResult>;
+    prev: () => Promise<PropertiesQueryResult>;
+}
+interface PropertiesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'status' | 'propertyType' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'features' | 'serviceId' | 'tags', value: any) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'status' | 'propertyType' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'features' | 'serviceId' | 'tags', value: any) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'serviceId', value: any) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'serviceId', value: any) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'serviceId', value: any) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'serviceId', value: any) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'city' | 'state' | 'zip' | 'price.value' | 'serviceId', value: string) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'status' | 'propertyType' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'features' | 'serviceId' | 'tags', value: any[]) => PropertiesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasAll: (propertyName: 'features', value: any[]) => PropertiesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'status' | 'propertyType' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'features' | 'serviceId' | 'tags', value: any) => PropertiesQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'status' | 'propertyType' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'features' | 'serviceId' | 'tags', value: boolean) => PropertiesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'status' | 'propertyType' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'features' | 'serviceId' | 'tags'>) => PropertiesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'city' | 'state' | 'zip' | 'price.value' | 'status' | 'propertyType' | 'beds' | 'baths' | 'sqft' | 'lotSize' | 'yearBuilt' | 'features' | 'serviceId' | 'tags'>) => PropertiesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => PropertiesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => PropertiesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<PropertiesQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.real_estate.v1.PropertyService.QueryProperties
+ * @requiredField query
+ */
+declare function typedQueryProperties(query: PropertyQuery): Promise<NonNullablePaths<QueryPropertiesResponse, `properties` | `properties.${number}.address` | `properties.${number}.city` | `properties.${number}.state` | `properties.${number}.zip` | `properties.${number}.price.value` | `properties.${number}.price.currency` | `properties.${number}.status` | `properties.${number}.propertyType` | `properties.${number}.description` | `properties.${number}.source` | `properties.${number}.editable`, 5>>;
+interface PropertyQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['features'];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'BOTH';
+        },
+        {
+            fields: [
+                '_createdDate',
+                '_id',
+                '_updatedDate',
+                'baths',
+                'beds',
+                'city',
+                'lotSize',
+                'price.value',
+                'propertyType',
+                'serviceId',
+                'sqft',
+                'state',
+                'status',
+                'tags',
+                'yearBuilt',
+                'zip'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Property, PropertyQuerySpec>;
+type PropertyQuery = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const QueryBuilder: () => _wix_sdk_types.QueryBuilder<Property, PropertyQuerySpec, PropertyQuery>;
+declare const Filter: _wix_sdk_types.FilterFactory<Property, PropertyQuerySpec>;
+declare const Sort: _wix_sdk_types.SortFactory<PropertyQuerySpec>;
+interface BulkCreatePropertiesOptions {
+    /** Set to `true` to receive back the created Properties in the response. */
+    returnEntity?: boolean;
+}
+interface BulkUpdatePropertiesOptions {
+    /** Set to `true` to receive back the updated Properties in the response. */
+    returnEntity?: boolean;
+}
+interface BulkUpdatePropertyTagsOptions {
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePropertyTagsByFilterOptions {
+    /** List of tags to assign. */
+    assignTags?: Tags;
+    /** List of tags to unassign. */
+    unassignTags?: Tags;
+}
+
+export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkCreatePropertiesOptions, type BulkCreatePropertiesRequest, type BulkCreatePropertiesResponse, type BulkDeletePropertiesRequest, type BulkDeletePropertiesResponse, type BulkDeletePropertiesResponseBulkPropertyResult, type BulkPropertyResult, type BulkUpdatePropertiesOptions, type BulkUpdatePropertiesRequest, type BulkUpdatePropertiesResponse, type BulkUpdatePropertiesResponseBulkPropertyResult, type BulkUpdatePropertyTagsApplicationErrors, type BulkUpdatePropertyTagsByFilterApplicationErrors, type BulkUpdatePropertyTagsByFilterOptions, type BulkUpdatePropertyTagsByFilterRequest, type BulkUpdatePropertyTagsByFilterResponse, type BulkUpdatePropertyTagsOptions, type BulkUpdatePropertyTagsRequest, type BulkUpdatePropertyTagsResponse, type BulkUpdatePropertyTagsResult, type CommonQueryWithEntityContext, type CreatePropertyRequest, type CreatePropertyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, CustomFieldType, type CustomFieldTypeWithLiterals, type DeletePropertyRequest, type DeletePropertyResponse, DocumentType, type DocumentTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, Filter, type GetPropertyRequest, type GetPropertyResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MaskedProperty, type MessageEnvelope, type Money, type PropertiesQueryBuilder, type PropertiesQueryResult, type Property, type PropertyDocument, type PropertyPhoto, type PropertyQuery, type PropertyQuerySpec, PropertySource, type PropertySourceWithLiterals, PropertyStatus, type PropertyStatusChanged, type PropertyStatusWithLiterals, PropertyType, type PropertyTypeWithLiterals, QueryBuilder, type QueryPropertiesRequest, type QueryPropertiesResponse, type RestoreInfo, Sort, SortOrder, type SortOrderWithLiterals, type Sorting, type TagList, type Tags, type TagsModified, type UpdateProperty, type UpdatePropertyRequest, type UpdatePropertyResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, typedQueryProperties };