@realforce-software/api-client 0.0.11

package/dist/client.generated.d.ts

@@ -0,0 +1,2379 @@
+import type { AxiosInstance, AxiosResponse, CancelToken } from 'axios';
+export interface IRealforceApiClient {
+    /**
+     * Get a specific agent by ID.
+     * @param agentId The agent's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The agent object.
+     */
+    getAgent(agentId: string, x_Workspace_ID: string): Promise<Agent>;
+    /**
+     * Update an agent.
+     * @param agentId The agent's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The agent fields to update. Only fields included in the body are changed.
+     * @return Agent updated.
+     */
+    putAgent(agentId: string, x_Workspace_ID: string, body?: UpdateAgentRequest | undefined): Promise<string>;
+    /**
+     * Returns a list of agents.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of agents.
+     */
+    queryAgents(x_Workspace_ID: string, body?: AgentQueryRequest | undefined): Promise<AgentListResponse>;
+    /**
+     * Create an agent. If the agent already exists, the information will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The agent data to create or update.
+     * @return Agent created. Returns the agent ID.
+     */
+    postAgent(x_Workspace_ID: string, body?: CreateAgentRequest | undefined): Promise<string>;
+    /**
+     * Delete an agent.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The agent to delete (by AgentId, ExternalId, or Email).
+     * @return Agent deleted.
+     */
+    deleteAgent(x_Workspace_ID: string, body?: DeleteAgentRequest | undefined): Promise<string>;
+    /**
+     * Upload an asset and link it to one or more subjects.
+     * @param body (optional) Asset name, source, file type, source URLs, and target subjects.
+     * @return Asset uploaded and linked.
+     */
+    createAsset(body?: CreateAssetRequest | undefined): Promise<void>;
+    /**
+     * Get a list of all campaigns with optional filters.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of campaigns.
+     */
+    queryCampaigns(x_Workspace_ID: string, body?: CampaignQueryRequest | undefined): Promise<CampaignListResponse>;
+    /**
+     * Get a single campaign by ID.
+     * @param campaignId The campaign's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The campaign object.
+     */
+    getCampaign(campaignId: string, x_Workspace_ID: string): Promise<Campaign>;
+    /**
+     * Upsert a property together with its office and agent in a single request.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The combined property, office, and agent data to upsert.
+     * @return Request processed. Inspect `errorMessage` for partial-failure details.
+     */
+    postFullData(x_Workspace_ID: string, body?: CreateFullDataRequest | undefined): Promise<CreateFullDataResponse>;
+    /**
+     * Publish a lead against a property, agent, or office.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The lead data including subject type and identifiers.
+     * @return Lead published.
+     */
+    postLead(x_Workspace_ID: string, body?: CreateLeadRequest | undefined): Promise<CreateLeadResponse>;
+    /**
+     * Generate a magic link for a property or marketing opportunity.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The magic link type, subject ID, and target user email.
+     * @return Magic link generated.
+     */
+    createMagicLink(x_Workspace_ID: string, body?: CreateMagicLinkRequest | undefined): Promise<MagicLinkResponse>;
+    /**
+     * Cancel autopublish of a marketing opportunity.
+     * @param marketingOpportunityId The marketing opportunity ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return Autopublish cancelled.
+     */
+    cancelMarketingOpportunitiesAutoPublish(marketingOpportunityId: string, x_Workspace_ID: string): Promise<CancelAutopublishResponse>;
+    /**
+     * Make a marketing opportunity's order page available or unavailable.
+     * @param marketingOpportunityId The marketing opportunity ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The new order page availability and an optional unavailable reason.
+     * @return Order page availability updated.
+     */
+    setOrderPageAvailability(marketingOpportunityId: string, x_Workspace_ID: string, body?: SetOrderPageAvailabilityRequest | undefined): Promise<SetOrderPageAvailabilityResponse>;
+    /**
+     * Get available marketing opportunities with optional filters.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) List request with pagination, sorting, and filter criteria.
+     * @return Paginated list of marketing opportunities.
+     */
+    queryMarketingOpportunities(x_Workspace_ID: string, body?: MarketingOpportunityQueryRequest | undefined): Promise<MarketingOpportunityListResponse>;
+    /**
+     * Get a specific office by ID.
+     * @param officeId The office's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The office object.
+     */
+    getOffice(officeId: string, x_Workspace_ID: string): Promise<Office>;
+    /**
+     * Update an office.
+     * @param officeId The office's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The office fields to update. Only fields included in the body are changed.
+     * @return Office updated.
+     */
+    putOffice(officeId: string, x_Workspace_ID: string, body?: PutOfficeRequest | undefined): Promise<string>;
+    /**
+     * Get a list of all offices.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of offices.
+     */
+    queryOffices(x_Workspace_ID: string, body?: OfficeQueryRequest | undefined): Promise<OfficeListResponse>;
+    /**
+     * Create an office. If an office with the same ExternalId already exists, the existing office will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The office data to create or update.
+     * @return Office created or updated. Returns the office ID.
+     */
+    postOffice(x_Workspace_ID: string, body?: PostOfficeRequest | undefined): Promise<string>;
+    /**
+     * Delete an office.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The office to delete (by OfficeId or ExternalId).
+     * @return Office deleted.
+     */
+    deleteOffice(x_Workspace_ID: string, body?: DeleteOfficeRequest | undefined): Promise<string>;
+    /**
+     * Place an order. Creating orders may take some time and therefor an order request id is returned which can be queried to get the status of the order
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The order details including marketing opportunity and product.
+     * @return Order request accepted. Returns the request ID.
+     */
+    createOrder(x_Workspace_ID: string, body?: OrderRequest | undefined): Promise<string>;
+    /**
+     * Get the status of a previously placed order request.
+     * @param orderRequestId The request ID returned when placing the order.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The current order status.
+     */
+    getOrderStatus(orderRequestId: string, x_Workspace_ID: string): Promise<OrderStatusResponse>;
+    /**
+     * Get a list of all orders with optional filters.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of orders.
+     */
+    queryOrders(x_Workspace_ID: string, body?: OrderQueryRequest | undefined): Promise<OrderListResponse>;
+    /**
+     * Get a specific order by ID.
+     * @param orderId The order's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The order object.
+     */
+    getOrder(orderId: string, x_Workspace_ID: string): Promise<Order>;
+    /**
+     * Get info about the personal access token used to authenticate this request.
+     * @return Personal access token details.
+     */
+    get(): Promise<PatResponse>;
+    /**
+     * Revoke the personal access token used to authenticate this request.
+     * @return The token was revoked.
+     */
+    revoke(): Promise<void>;
+    /**
+     * Rotate the personal access token used to authenticate this request.
+     * @return The new token was issued. The response body contains the only copy of the new secret.
+     */
+    rotate(): Promise<RotatePatResponse>;
+    /**
+     * Returns a list of products.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of products.
+     */
+    queryProducts(x_Workspace_ID: string, body?: ProductQueryRequest | undefined): Promise<ProductListResponse>;
+    /**
+     * Get data about a specific property.
+     * @param propertyId The property's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The property object.
+     */
+    getProperty(propertyId: string, x_Workspace_ID: string): Promise<Property>;
+    /**
+     * Update a property with the specified PropertyId.
+     * @param propertyId The property's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The property fields to update. Only fields included in the body are changed.
+     * @return Property updated. Returns the property ID.
+     */
+    putProperty(propertyId: string, x_Workspace_ID: string, body?: UpdatePropertyRequest | undefined): Promise<string>;
+    /**
+     * Create a property. If a property with the same unique identifier already exists, the existing property will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The property data to create or update.
+     * @return Property created or updated. Returns the property ID.
+     */
+    postProperty(x_Workspace_ID: string, body?: CreatePropertyRequest | undefined): Promise<string>;
+    /**
+     * Delete a property.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The property to delete (by PropertyId or ExternalId).
+     * @return Property deleted.
+     */
+    deleteProperty(x_Workspace_ID: string, body?: DeletePropertyRequest | undefined): Promise<string>;
+    /**
+     * Apply a single set of values to many properties in one request.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Targets and the values to apply to each.
+     * @return Batch processed. Inspect each `result.status` for individual outcomes.
+     */
+    batchUpdateProperties(x_Workspace_ID: string, body?: BatchUpdatePropertyRequest | undefined): Promise<BatchUpdatePropertyResponse>;
+    /**
+     * Get a list of all properties and their data.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of properties.
+     */
+    queryProperties(x_Workspace_ID: string, body?: PropertyQueryRequest | undefined): Promise<PropertyListResponse>;
+    /**
+     * Generates a URL to be returned to the customer where a token is attached.
+     * @param propertyId The property's Realforce ID.
+     * @param emailAddress The email address of the seller.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return Returns the invite URL.
+     */
+    postInviteSeller(propertyId: string, emailAddress: string, x_Workspace_ID: string): Promise<InvitedSellerResponse>;
+    /**
+     * List all triggers configured for the current workspace.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The list of configured triggers.
+     */
+    getTriggersForWorkspace(x_Workspace_ID: string): Promise<TriggerResponse>;
+    /**
+     * Fire a trigger against a resolved subject.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Subject type, trigger ID, and lookup criteria (subjectId or externalId).
+     * @return Trigger fired. Returns the resolved subject and request ID.
+     */
+    postTriggerByFilter(x_Workspace_ID: string, body?: TriggerRequest | undefined): Promise<TriggerByFilterResponse>;
+    /**
+     * Get the profile of the authenticated user.
+     * @return The user profile.
+     */
+    getUserProfile(): Promise<UserProfile>;
+    /**
+     * Returns a list of users.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of users.
+     */
+    queryUsers(x_Workspace_ID: string, body?: UserQueryRequest | undefined): Promise<UserListResponse>;
+    /**
+     * Create a user. If a user with the same email already exists on the workspace, the existing user will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The user data to create or update.
+     * @return User created or updated. Returns the user ID.
+     */
+    postUser(x_Workspace_ID: string, body?: CreateUserRequest | undefined): Promise<string>;
+    /**
+     * Get information about the workspace associated with the current API token.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The workspace object.
+     */
+    getWorkspace(x_Workspace_ID: string): Promise<Workspace>;
+}
+export declare class RealforceApiClient implements IRealforceApiClient {
+    protected instance: AxiosInstance;
+    protected baseUrl: string;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Get a specific agent by ID.
+     * @param agentId The agent's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The agent object.
+     */
+    getAgent(agentId: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<Agent>;
+    protected processGetAgent(response: AxiosResponse): Promise<Agent>;
+    /**
+     * Update an agent.
+     * @param agentId The agent's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The agent fields to update. Only fields included in the body are changed.
+     * @return Agent updated.
+     */
+    putAgent(agentId: string, x_Workspace_ID: string, body?: UpdateAgentRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processPutAgent(response: AxiosResponse): Promise<string>;
+    /**
+     * Returns a list of agents.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of agents.
+     */
+    queryAgents(x_Workspace_ID: string, body?: AgentQueryRequest | undefined, cancelToken?: CancelToken): Promise<AgentListResponse>;
+    protected processQueryAgents(response: AxiosResponse): Promise<AgentListResponse>;
+    /**
+     * Create an agent. If the agent already exists, the information will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The agent data to create or update.
+     * @return Agent created. Returns the agent ID.
+     */
+    postAgent(x_Workspace_ID: string, body?: CreateAgentRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processPostAgent(response: AxiosResponse): Promise<string>;
+    /**
+     * Delete an agent.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The agent to delete (by AgentId, ExternalId, or Email).
+     * @return Agent deleted.
+     */
+    deleteAgent(x_Workspace_ID: string, body?: DeleteAgentRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processDeleteAgent(response: AxiosResponse): Promise<string>;
+    /**
+     * Upload an asset and link it to one or more subjects.
+     * @param body (optional) Asset name, source, file type, source URLs, and target subjects.
+     * @return Asset uploaded and linked.
+     */
+    createAsset(body?: CreateAssetRequest | undefined, cancelToken?: CancelToken): Promise<void>;
+    protected processCreateAsset(response: AxiosResponse): Promise<void>;
+    /**
+     * Get a list of all campaigns with optional filters.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of campaigns.
+     */
+    queryCampaigns(x_Workspace_ID: string, body?: CampaignQueryRequest | undefined, cancelToken?: CancelToken): Promise<CampaignListResponse>;
+    protected processQueryCampaigns(response: AxiosResponse): Promise<CampaignListResponse>;
+    /**
+     * Get a single campaign by ID.
+     * @param campaignId The campaign's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The campaign object.
+     */
+    getCampaign(campaignId: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<Campaign>;
+    protected processGetCampaign(response: AxiosResponse): Promise<Campaign>;
+    /**
+     * Upsert a property together with its office and agent in a single request.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The combined property, office, and agent data to upsert.
+     * @return Request processed. Inspect `errorMessage` for partial-failure details.
+     */
+    postFullData(x_Workspace_ID: string, body?: CreateFullDataRequest | undefined, cancelToken?: CancelToken): Promise<CreateFullDataResponse>;
+    protected processPostFullData(response: AxiosResponse): Promise<CreateFullDataResponse>;
+    /**
+     * Publish a lead against a property, agent, or office.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The lead data including subject type and identifiers.
+     * @return Lead published.
+     */
+    postLead(x_Workspace_ID: string, body?: CreateLeadRequest | undefined, cancelToken?: CancelToken): Promise<CreateLeadResponse>;
+    protected processPostLead(response: AxiosResponse): Promise<CreateLeadResponse>;
+    /**
+     * Generate a magic link for a property or marketing opportunity.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The magic link type, subject ID, and target user email.
+     * @return Magic link generated.
+     */
+    createMagicLink(x_Workspace_ID: string, body?: CreateMagicLinkRequest | undefined, cancelToken?: CancelToken): Promise<MagicLinkResponse>;
+    protected processCreateMagicLink(response: AxiosResponse): Promise<MagicLinkResponse>;
+    /**
+     * Cancel autopublish of a marketing opportunity.
+     * @param marketingOpportunityId The marketing opportunity ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return Autopublish cancelled.
+     */
+    cancelMarketingOpportunitiesAutoPublish(marketingOpportunityId: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<CancelAutopublishResponse>;
+    protected processCancelMarketingOpportunitiesAutoPublish(response: AxiosResponse): Promise<CancelAutopublishResponse>;
+    /**
+     * Make a marketing opportunity's order page available or unavailable.
+     * @param marketingOpportunityId The marketing opportunity ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The new order page availability and an optional unavailable reason.
+     * @return Order page availability updated.
+     */
+    setOrderPageAvailability(marketingOpportunityId: string, x_Workspace_ID: string, body?: SetOrderPageAvailabilityRequest | undefined, cancelToken?: CancelToken): Promise<SetOrderPageAvailabilityResponse>;
+    protected processSetOrderPageAvailability(response: AxiosResponse): Promise<SetOrderPageAvailabilityResponse>;
+    /**
+     * Get available marketing opportunities with optional filters.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) List request with pagination, sorting, and filter criteria.
+     * @return Paginated list of marketing opportunities.
+     */
+    queryMarketingOpportunities(x_Workspace_ID: string, body?: MarketingOpportunityQueryRequest | undefined, cancelToken?: CancelToken): Promise<MarketingOpportunityListResponse>;
+    protected processQueryMarketingOpportunities(response: AxiosResponse): Promise<MarketingOpportunityListResponse>;
+    /**
+     * Get a specific office by ID.
+     * @param officeId The office's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The office object.
+     */
+    getOffice(officeId: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<Office>;
+    protected processGetOffice(response: AxiosResponse): Promise<Office>;
+    /**
+     * Update an office.
+     * @param officeId The office's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The office fields to update. Only fields included in the body are changed.
+     * @return Office updated.
+     */
+    putOffice(officeId: string, x_Workspace_ID: string, body?: PutOfficeRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processPutOffice(response: AxiosResponse): Promise<string>;
+    /**
+     * Get a list of all offices.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of offices.
+     */
+    queryOffices(x_Workspace_ID: string, body?: OfficeQueryRequest | undefined, cancelToken?: CancelToken): Promise<OfficeListResponse>;
+    protected processQueryOffices(response: AxiosResponse): Promise<OfficeListResponse>;
+    /**
+     * Create an office. If an office with the same ExternalId already exists, the existing office will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The office data to create or update.
+     * @return Office created or updated. Returns the office ID.
+     */
+    postOffice(x_Workspace_ID: string, body?: PostOfficeRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processPostOffice(response: AxiosResponse): Promise<string>;
+    /**
+     * Delete an office.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The office to delete (by OfficeId or ExternalId).
+     * @return Office deleted.
+     */
+    deleteOffice(x_Workspace_ID: string, body?: DeleteOfficeRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processDeleteOffice(response: AxiosResponse): Promise<string>;
+    /**
+     * Place an order. Creating orders may take some time and therefor an order request id is returned which can be queried to get the status of the order
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The order details including marketing opportunity and product.
+     * @return Order request accepted. Returns the request ID.
+     */
+    createOrder(x_Workspace_ID: string, body?: OrderRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processCreateOrder(response: AxiosResponse): Promise<string>;
+    /**
+     * Get the status of a previously placed order request.
+     * @param orderRequestId The request ID returned when placing the order.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The current order status.
+     */
+    getOrderStatus(orderRequestId: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<OrderStatusResponse>;
+    protected processGetOrderStatus(response: AxiosResponse): Promise<OrderStatusResponse>;
+    /**
+     * Get a list of all orders with optional filters.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of orders.
+     */
+    queryOrders(x_Workspace_ID: string, body?: OrderQueryRequest | undefined, cancelToken?: CancelToken): Promise<OrderListResponse>;
+    protected processQueryOrders(response: AxiosResponse): Promise<OrderListResponse>;
+    /**
+     * Get a specific order by ID.
+     * @param orderId The order's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The order object.
+     */
+    getOrder(orderId: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<Order>;
+    protected processGetOrder(response: AxiosResponse): Promise<Order>;
+    /**
+     * Get info about the personal access token used to authenticate this request.
+     * @return Personal access token details.
+     */
+    get(cancelToken?: CancelToken): Promise<PatResponse>;
+    protected processGet(response: AxiosResponse): Promise<PatResponse>;
+    /**
+     * Revoke the personal access token used to authenticate this request.
+     * @return The token was revoked.
+     */
+    revoke(cancelToken?: CancelToken): Promise<void>;
+    protected processRevoke(response: AxiosResponse): Promise<void>;
+    /**
+     * Rotate the personal access token used to authenticate this request.
+     * @return The new token was issued. The response body contains the only copy of the new secret.
+     */
+    rotate(cancelToken?: CancelToken): Promise<RotatePatResponse>;
+    protected processRotate(response: AxiosResponse): Promise<RotatePatResponse>;
+    /**
+     * Returns a list of products.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of products.
+     */
+    queryProducts(x_Workspace_ID: string, body?: ProductQueryRequest | undefined, cancelToken?: CancelToken): Promise<ProductListResponse>;
+    protected processQueryProducts(response: AxiosResponse): Promise<ProductListResponse>;
+    /**
+     * Get data about a specific property.
+     * @param propertyId The property's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The property object.
+     */
+    getProperty(propertyId: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<Property>;
+    protected processGetProperty(response: AxiosResponse): Promise<Property>;
+    /**
+     * Update a property with the specified PropertyId.
+     * @param propertyId The property's Realforce ID.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The property fields to update. Only fields included in the body are changed.
+     * @return Property updated. Returns the property ID.
+     */
+    putProperty(propertyId: string, x_Workspace_ID: string, body?: UpdatePropertyRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processPutProperty(response: AxiosResponse): Promise<string>;
+    /**
+     * Create a property. If a property with the same unique identifier already exists, the existing property will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The property data to create or update.
+     * @return Property created or updated. Returns the property ID.
+     */
+    postProperty(x_Workspace_ID: string, body?: CreatePropertyRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processPostProperty(response: AxiosResponse): Promise<string>;
+    /**
+     * Delete a property.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The property to delete (by PropertyId or ExternalId).
+     * @return Property deleted.
+     */
+    deleteProperty(x_Workspace_ID: string, body?: DeletePropertyRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processDeleteProperty(response: AxiosResponse): Promise<string>;
+    /**
+     * Apply a single set of values to many properties in one request.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Targets and the values to apply to each.
+     * @return Batch processed. Inspect each `result.status` for individual outcomes.
+     */
+    batchUpdateProperties(x_Workspace_ID: string, body?: BatchUpdatePropertyRequest | undefined, cancelToken?: CancelToken): Promise<BatchUpdatePropertyResponse>;
+    protected processBatchUpdateProperties(response: AxiosResponse): Promise<BatchUpdatePropertyResponse>;
+    /**
+     * Get a list of all properties and their data.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of properties.
+     */
+    queryProperties(x_Workspace_ID: string, body?: PropertyQueryRequest | undefined, cancelToken?: CancelToken): Promise<PropertyListResponse>;
+    protected processQueryProperties(response: AxiosResponse): Promise<PropertyListResponse>;
+    /**
+     * Generates a URL to be returned to the customer where a token is attached.
+     * @param propertyId The property's Realforce ID.
+     * @param emailAddress The email address of the seller.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return Returns the invite URL.
+     */
+    postInviteSeller(propertyId: string, emailAddress: string, x_Workspace_ID: string, cancelToken?: CancelToken): Promise<InvitedSellerResponse>;
+    protected processPostInviteSeller(response: AxiosResponse): Promise<InvitedSellerResponse>;
+    /**
+     * List all triggers configured for the current workspace.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The list of configured triggers.
+     */
+    getTriggersForWorkspace(x_Workspace_ID: string, cancelToken?: CancelToken): Promise<TriggerResponse>;
+    protected processGetTriggersForWorkspace(response: AxiosResponse): Promise<TriggerResponse>;
+    /**
+     * Fire a trigger against a resolved subject.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Subject type, trigger ID, and lookup criteria (subjectId or externalId).
+     * @return Trigger fired. Returns the resolved subject and request ID.
+     */
+    postTriggerByFilter(x_Workspace_ID: string, body?: TriggerRequest | undefined, cancelToken?: CancelToken): Promise<TriggerByFilterResponse>;
+    protected processPostTriggerByFilter(response: AxiosResponse): Promise<TriggerByFilterResponse>;
+    /**
+     * Get the profile of the authenticated user.
+     * @return The user profile.
+     */
+    getUserProfile(cancelToken?: CancelToken): Promise<UserProfile>;
+    protected processGetUserProfile(response: AxiosResponse): Promise<UserProfile>;
+    /**
+     * Returns a list of users.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) Filter and pagination options.
+     * @return Paginated list of users.
+     */
+    queryUsers(x_Workspace_ID: string, body?: UserQueryRequest | undefined, cancelToken?: CancelToken): Promise<UserListResponse>;
+    protected processQueryUsers(response: AxiosResponse): Promise<UserListResponse>;
+    /**
+     * Create a user. If a user with the same email already exists on the workspace, the existing user will be updated.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @param body (optional) The user data to create or update.
+     * @return User created or updated. Returns the user ID.
+     */
+    postUser(x_Workspace_ID: string, body?: CreateUserRequest | undefined, cancelToken?: CancelToken): Promise<string>;
+    protected processPostUser(response: AxiosResponse): Promise<string>;
+    /**
+     * Get information about the workspace associated with the current API token.
+     * @param x_Workspace_ID The workspace ID (GUID) to operate on. Must match one of the workspaces your token has access to.
+     * @return The workspace object.
+     */
+    getWorkspace(x_Workspace_ID: string, cancelToken?: CancelToken): Promise<Workspace>;
+    protected processGetWorkspace(response: AxiosResponse): Promise<Workspace>;
+}
+/** Account model for V2 API. Represents the organizational account a workspace belongs to. */
+export interface Account {
+    /** Unique identifier for the account. */
+    id: string;
+    /** The account's name. */
+    name?: string | undefined;
+}
+/** Agent model for V2 API. */
+export interface Agent {
+    /** Unique identifier for the agent. */
+    id: string;
+    /** The agent's full name. */
+    name?: string | undefined;
+    /** The agent's email address. */
+    email?: string | undefined;
+    /** The agent's phone number. */
+    phone?: string | undefined;
+    /** External identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Media assets for the agent. */
+    media?: MediaModel | undefined;
+    /** Agent website landingPage. */
+    landingPage?: string | undefined;
+    /** Primary profile image or logo URL. */
+    profileImage?: MediaModel | undefined;
+    /** Logo image URL. */
+    logo?: MediaModel | undefined;
+    /** List of additional image URLs. */
+    images?: MediaModel[] | undefined;
+    /** Custom attributes defined by the Workspace. */
+    customAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** Timestamp information. */
+    timestamps?: TimestampsModel | undefined;
+    /** The office this agent belongs to. Null when Agent is embedded in another response. */
+    office?: Office | undefined;
+}
+/** Agent data */
+export interface AgentData {
+    /** Agent email address */
+    email: string;
+    /** Agent name */
+    name: string;
+    /** Agent licenseNumber */
+    licenseNumber?: string | undefined;
+    /** Phone number */
+    phoneNumber?: string | undefined;
+    /** Id in customer system. */
+    externalId?: string | undefined;
+    /** List of external identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Title */
+    jobTitle?: string | undefined;
+    /** Agent landing page to redirect to */
+    landingPage?: string | undefined;
+    /** Longitude of agent used for targeting */
+    longitude?: number | undefined;
+    /** Latitude of agent used for targeting */
+    latitude?: number | undefined;
+    /** Agent image */
+    imageUrl?: string | undefined;
+    /** List of additional attributes */
+    additionalAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of urls to additional images */
+    additionalImages?: {
+        [key: string]: string;
+    } | undefined;
+}
+/** Filter criteria for listing agents. */
+export interface AgentFilter {
+    /** Filter by external ID (exact match). */
+    externalId?: string | undefined;
+    /** Filter by email address (exact match). */
+    email?: string | undefined;
+    /** Filter by office ID to get agents belonging to a specific office. */
+    officeId?: string | undefined;
+    /** Filter by multiple office IDs. */
+    officeIds?: string[] | undefined;
+    /** Filter by name (exact match). */
+    name?: string | undefined;
+    /** Free-text search across name and email (partial match, case-insensitive). */
+    search?: string | undefined;
+    /** Filter by last updated date range. */
+    updatedDateRange?: DateRangeFilter | undefined;
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface AgentListResponse {
+    /** The list of items for the current page. */
+    data: Agent[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: AgentFilter | undefined;
+}
+/** Query request for agents. */
+export interface AgentQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: AgentFilter | undefined;
+}
+/** Standardized error response model for all API errors. */
+export interface ApiError {
+    /** Machine-readable error code for programmatic handling. */
+    errorCode: string;
+    /** Human-readable error message. */
+    message: string;
+    /** Optional detailed error information or validation errors. */
+    details?: {
+        [key: string]: string[];
+    } | undefined;
+    /** Timestamp when the error occurred. */
+    timestamp: Date;
+}
+/** The type of file being uploaded as an asset. */
+export declare enum AssetFileType {
+    Image = "Image",
+    Video = "Video",
+    Pdf = "Pdf"
+}
+/** A subject that the asset belongs to. */
+export interface AssetSubject {
+    /** The subject's Realforce ID. */
+    subjectId: string;
+    /** The type of subject (Property, Agent, Office). */
+    subjectType: AssetSubjectType;
+}
+/** Subject types that an asset can belong to. */
+export declare enum AssetSubjectType {
+    Property = "Property",
+    Agent = "Agent",
+    Office = "Office"
+}
+/** Batch update request for properties. Applies a single set of values to many properties at once. Targets are listed by Realforce RealforceApiService.Models.BatchUpdatePropertyRequest.Ids, customer RealforceApiService.Models.BatchUpdatePropertyRequest.ExternalIds, or both — references that resolve to the same property are deduplicated. */
+export interface BatchUpdatePropertyRequest {
+    /** Realforce IDs to update. */
+    ids?: string[] | undefined;
+    /** Customer-system IDs to update. */
+    externalIds?: string[] | undefined;
+    /** The values to apply to every targeted property. */
+    update?: BatchUpdatePropertyValues | undefined;
+}
+/** Response from a property batch update. Targets that resolved to the same property are deduplicated — the same Realforce property never appears twice in RealforceApiService.Models.BatchUpdatePropertyResponse.Results. Per-item failures (lookup misses, service errors) are reported in RealforceApiService.Models.BatchUpdatePropertyResult.Error and do not fail the batch — the overall HTTP status is 200 as long as the request shape was valid. */
+export interface BatchUpdatePropertyResponse {
+    /** One entry per unique property processed, plus one entry per unresolved id or externalId. */
+    results?: BatchUpdatePropertyResult[];
+    /** Aggregate counts for the batch. */
+    summary: BatchUpdatePropertySummary;
+}
+/** Outcome for a single property in a batch update. */
+export interface BatchUpdatePropertyResult {
+    /** The Realforce property ID this result is about. Null only when the customer
+supplied an RealforceApiService.Models.BatchUpdatePropertyResult.ExternalId that did not resolve to any property. */
+    propertyId?: string | undefined;
+    /** Echo of the externalId the customer supplied for this property, when applicable. */
+    externalId?: string | undefined;
+    /** Either `"updated"` or `"failed"`. */
+    status: string;
+    /** Populated only when RealforceApiService.Models.BatchUpdatePropertyResult.Status is `"failed"`. */
+    error?: ApiError | undefined;
+}
+/** Aggregate counts for a property batch update. */
+export interface BatchUpdatePropertySummary {
+    /** Total number of unique results returned. */
+    total: number;
+    /** Number of properties updated successfully. */
+    succeeded: number;
+    /** Number of failures (unresolved targets or service errors). */
+    failed: number;
+}
+/** The values applied to every property in a batch update. Only fields that are set are changed. Identifier fields (`id`, `externalId`) cannot be changed via batch update — use the single-property endpoint for that. */
+export interface BatchUpdatePropertyValues {
+    /** Status of the property. */
+    propertyStatus?: PropertyStatus | undefined;
+    /** Office name where the property is listed. */
+    office?: string | undefined;
+    /** Office ID in the customer system. */
+    externalOfficeId?: string | undefined;
+    /** Agent ID in the Realforce system. */
+    agentId?: string | undefined;
+    /** Agent email. */
+    agentEmail?: string | undefined;
+    /** Agent ID in the customer system. */
+    externalAgentId?: string | undefined;
+    /** Additional agents to add by email. */
+    additionalAgentsEmails?: string[] | undefined;
+    /** Additional agents to add by external ID. */
+    additionalAgentsExternalIds?: string[] | undefined;
+    /** Property street address. */
+    street?: string | undefined;
+    /** Property city. */
+    city?: string | undefined;
+    /** Property postal code. */
+    postCode?: string | undefined;
+    /** City area where the property is located. */
+    area?: string | undefined;
+    /** Property URL. */
+    propertyUrl?: string | undefined;
+    /** Longitude used for targeting. */
+    longitude?: number | undefined;
+    /** Latitude used for targeting. */
+    latitude?: number | undefined;
+    /** List of URLs to images. */
+    images?: string[] | undefined;
+    /** Main image to use. Falls back to the first image in RealforceApiService.Models.BatchUpdatePropertyValues.Images. */
+    mainImage?: string | undefined;
+    /** Shorter property description. */
+    propertyHeadline?: string | undefined;
+    /** The full property description. */
+    propertyDescription?: string | undefined;
+    /** Type of property. */
+    homeType?: string | undefined;
+    /** Type of transaction the property is intended for (sale, rent). */
+    transactionType?: string | undefined;
+    /** Size of property in square meters. */
+    areaSquareMeters?: number | undefined;
+    /** Number of rooms. */
+    numberOfRooms?: number | undefined;
+    /** Number of bedrooms. */
+    numberOfBedrooms?: number | undefined;
+    /** Number of bathrooms. */
+    numberOfBathRooms?: number | undefined;
+    /** Number of parking spots. */
+    numberOfParking?: number | undefined;
+    /** Asking price. */
+    askingPrice?: number | undefined;
+    /** Custom data that can be used for triggering ads. */
+    customAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of events occurring on the property. */
+    propertyEvents?: PropertyEventTime[] | undefined;
+    /** Additional property landing page. */
+    additionalLandingPage?: string | undefined;
+    /** Sold price. */
+    soldPrice?: number | undefined;
+    /** Currency in which the property was sold. */
+    soldCurrency?: string | undefined;
+    /** The source feed name of the property. */
+    sourceName?: string | undefined;
+}
+/** Campaign model. */
+export interface Campaign {
+    /** Unique identifier for the campaign. */
+    id: string;
+    /** The campaign's name. */
+    name?: string | undefined;
+    /** Status of the campaign. */
+    status?: string | undefined;
+    /** Type of campaign (e.g., "facebook", "displayAd", "custom"). */
+    type?: string | undefined;
+    /** Campaign date range (start and end dates). */
+    dateRange?: DateRangeModel | undefined;
+    /** Budget allocated for the campaign. */
+    budget?: MoneyModel | undefined;
+    /** Amount spent so far. */
+    spent?: MoneyModel | undefined;
+    /** Campaign performance statistics. */
+    statistics?: CampaignStatisticsModel | undefined;
+    /** Urls associated with the campaign. */
+    campaignUrls?: CampaignUrlModel[] | undefined;
+    /** Name of the Marketing activity which triggered the campaign */
+    marketingActivityName?: string | undefined;
+    /** External identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Custom attributes defined by the Workspace. */
+    customAttributes?: {
+        [key: string]: any;
+    } | undefined;
+    /** Timestamp information. */
+    timestamps?: TimestampsModel | undefined;
+    /** The product that created this campaign. Null when Campaign is embedded in another response. */
+    product?: Product | undefined;
+    /** The property this campaign is for. Null when Campaign is embedded in another response. */
+    property?: Property | undefined;
+    /** The order that created this campaign. Null when Campaign is embedded in another response. */
+    order?: Order | undefined;
+}
+/** Filter criteria for listing campaigns. */
+export interface CampaignFilter {
+    /** Filter by campaign types.
+If empty or null, returns all types. */
+    types?: CampaignType[] | undefined;
+    /** Filter by campaign statuses.
+If empty or null, returns all statuses. */
+    statuses?: CampaignStatus[] | undefined;
+    /** Filter campaigns whose run window overlaps the given date range.
+A campaign matches when its start is on or before `To` and its end is on or after `From`.
+Campaigns with no recorded end date are not currently matched. */
+    dateRange?: DateRangeFilter | undefined;
+    /** Filter by the date the campaign was created. */
+    createdDateRange?: DateRangeFilter | undefined;
+    /** Filter by product ID. */
+    productId?: string | undefined;
+    /** Filter by property ID to get campaigns for a specific property. */
+    propertyId?: string | undefined;
+    /** Filter by office ID. */
+    officeId?: string | undefined;
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface CampaignListResponse {
+    /** The list of items for the current page. */
+    data: Campaign[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: CampaignFilter | undefined;
+}
+/** List request for campaigns. */
+export interface CampaignQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: CampaignFilter | undefined;
+}
+/** Campaign performance statistics. */
+export interface CampaignStatisticsModel {
+    /** Number of impressions. */
+    impressions?: number | undefined;
+    /** Number of clicks. */
+    clicks?: number | undefined;
+    /** Number of conversions. */
+    conversions?: number | undefined;
+    /** Click frequency. */
+    clickFrequency?: number | undefined;
+    /** Conversion rate (percentage). */
+    conversionRate?: number | undefined;
+    /** Campaing Reach. */
+    reach?: number | undefined;
+}
+/** Lifecycle status of a campaign. */
+export declare enum CampaignStatus {
+    New = "New",
+    Creating = "Creating",
+    Blocked = "Blocked",
+    InReview = "InReview",
+    Scheduled = "Scheduled",
+    Rejected = "Rejected",
+    Active = "Active",
+    Stopped = "Stopped",
+    Completed = "Completed",
+    Unknown = "Unknown"
+}
+/** The broad channel classification of a campaign. */
+export declare enum CampaignType {
+    Facebook = "Facebook",
+    Display = "Display",
+    Custom = "Custom"
+}
+/** A single campaign URL and the channel it was published through. */
+export interface CampaignUrlModel {
+    /** The live URL for the campaign creative on the channel. */
+    url: string;
+    /** The channel/type of campaign this URL belongs to. */
+    campaignType?: CampaignUrlType | undefined;
+}
+export declare enum CampaignUrlType {
+    Facebook = "Facebook",
+    Instagram = "Instagram",
+    DisplayAd = "DisplayAd",
+    Custom = "Custom"
+}
+/** Response returned after cancelling autopublish for a marketing opportunity. */
+export interface CancelAutopublishResponse {
+    /** Human-readable confirmation message. */
+    message?: string;
+}
+/** Contact information. */
+export interface ContactModel {
+    /** Email address. */
+    email?: string | undefined;
+    /** Phone number. */
+    phone?: string | undefined;
+    /** Website URL. */
+    website?: string | undefined;
+}
+/** Geographic coordinates. */
+export interface CoordinateModel {
+    /** Latitude in decimal degrees. */
+    latitude?: number;
+    /** Longitude in decimal degrees. */
+    longitude?: number;
+}
+/** Request to create an agent */
+export interface CreateAgentRequest {
+    /** Agent email address */
+    email: string;
+    /** Agent name */
+    name: string;
+    /** Office id. */
+    officeId: string;
+    /** Agent licenseNumber */
+    licenseNumber?: string | undefined;
+    /** Phone number */
+    phoneNumber?: string | undefined;
+    /** List of external identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Title */
+    jobTitle?: string | undefined;
+    /** Agent landing page to redirect to */
+    landingPage?: string | undefined;
+    /** Longitude of agent used for targeting */
+    longitude?: number | undefined;
+    /** Latitude of agent used for targeting */
+    latitude?: number | undefined;
+    /** Agent image */
+    imageUrl?: string | undefined;
+    /** List of additional attributes */
+    additionalAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of urls to additional images */
+    additionalImages?: {
+        [key: string]: string;
+    } | undefined;
+}
+/** Request to create an asset from one or more file URLs. */
+export interface CreateAssetRequest {
+    /** Display name for the asset. */
+    name: string;
+    /** The source system uploading the asset. */
+    source: string;
+    /** The type of file (Image, Video, Pdf). */
+    fileType: AssetFileType;
+    /** The URLs of the files that make up this asset. At least one is required. */
+    urls: string[];
+    /** The subjects this asset belongs to. At least one is required. */
+    subjects: AssetSubject[];
+}
+/** Request to create a property */
+export interface CreateFullDataRequest {
+    /** Data for creating property */
+    property: PropertyData;
+    /** Data for creating office */
+    office: OfficeData;
+    /** Data for creating agent */
+    agent: AgentData;
+}
+/** Response from the full data creation endpoint, containing the IDs of created resources. */
+export interface CreateFullDataResponse {
+    /** Created property id */
+    propertyId?: string | undefined;
+    /** Created office id */
+    officeId?: string | undefined;
+    /** Created agent id */
+    agentId?: string | undefined;
+    /** Describes the error message, if any, encountered during the creation process */
+    errorMessage?: string | undefined;
+}
+/** Request to create a lead for a Property, Agent, or Office */
+export interface CreateLeadRequest {
+    /** Type of lead: Property, Agent, or Office */
+    leadType: LeadSubjectType;
+    /** SubjectId in the Realforce system (Requires at least one of: subjectId, externalId) */
+    subjectId?: string | undefined;
+    /** External Id in customer system (alternative to using PropertyId, AgentId, or OfficeId) (Requires at least one of: subjectId, externalId) */
+    externalId?: string | undefined;
+    /** External Lead Id from customer system to track the lead */
+    externalLeadId?: string | undefined;
+    /** Source of the lead (e.g., Api, Facebook, Google, etc.) */
+    leadSource: LeadSource;
+    /** External Campaign Id to tie Lead to Meta or Google campaign (needs to be in the Realforce system) */
+    externalCampaignId?: string | undefined;
+    /** URL associated with the lead */
+    url?: string | undefined;
+    /** First name of the lead */
+    firstName?: string | undefined;
+    /** Last name of the lead */
+    lastName?: string | undefined;
+    /** Email address of the lead */
+    email?: string | undefined;
+    /** Phone number of the lead */
+    phoneNumber?: string | undefined;
+    /** Physical address of the lead */
+    address?: string | undefined;
+    /** Postal/ZIP code of the lead */
+    postalCode?: string | undefined;
+    /** Intent or purpose of the lead */
+    intent?: string | undefined;
+}
+/** Response returned after a lead is successfully published. */
+export interface CreateLeadResponse {
+    /** Human-readable confirmation message. */
+    message?: string;
+}
+/** Request object for creating a magic link. */
+export interface CreateMagicLinkRequest {
+    /** The type of the generated link. */
+    type?: MagicLinkType;
+    /** The unique identifier of the magic link type object. MarketingOpportunityId for OrderPages and PropertyId for ResultPages */
+    id?: string;
+    /** The email address connected to the user in the Realforce system. */
+    email?: string;
+}
+/** Request to create a property */
+export interface CreatePropertyRequest {
+    /** Id in customer system. These needs to be unique for each property on the Workspace */
+    externalId: string;
+    /** Office id in the customer system. (Requires at least one of: externalOfficeId, office) */
+    externalOfficeId?: string | undefined;
+    /** Office name where property is listed. (Requires at least one of: externalOfficeId, office) */
+    office?: string | undefined;
+    /** Status of property */
+    propertyStatus?: PropertyStatus;
+    /** Agent email (Requires at least one of: agentEmail, externalAgentId, agentId) */
+    agentEmail?: string | undefined;
+    /** Agent id in customer system (Requires at least one of: agentEmail, externalAgentId, agentId) */
+    externalAgentId?: string | undefined;
+    /** Agent Id in the Realforce system (Requires at least one of: agentEmail, externalAgentId, agentId) */
+    agentId?: string | undefined;
+    /** Property street address */
+    street?: string | undefined;
+    /** Property city */
+    city?: string | undefined;
+    /** Property postal code */
+    postCode?: string | undefined;
+    /** City area where property is located */
+    area?: string | undefined;
+    /** Property url */
+    propertyUrl?: string | undefined;
+    /** Longitude of property used for targeting */
+    longitude?: number | undefined;
+    /** Latitude of property used for targeting */
+    latitude?: number | undefined;
+    /** List of urls to images */
+    images?: string[] | undefined;
+    /** Main image to use. If empty first image in Images will be used */
+    mainImage?: string | undefined;
+    /** Shorter property description */
+    propertyHeadline?: string | undefined;
+    /** The full property description */
+    propertyDescription?: string | undefined;
+    /** Type of property */
+    homeType?: string | undefined;
+    /** The type of transaction the Property is intended for (sale, rent) */
+    transactionType?: string | undefined;
+    /** Size of property in square meters */
+    areaSquareMeters?: number | undefined;
+    /** Number of rooms */
+    numberOfRooms?: number | undefined;
+    /** Number of bedrooms */
+    numberOfBedrooms?: number | undefined;
+    /** Number of bathrooms */
+    numberOfBathRooms?: number | undefined;
+    /** Number of parking spots */
+    numberOfParking?: number | undefined;
+    /** Asking price */
+    askingPrice?: number | undefined;
+    /** Custom data that can be used for triggering ads */
+    customAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of events occuring on the property */
+    propertyEvents?: PropertyEventTime[] | undefined;
+    /** Additional property landing page */
+    additionalLandingPage?: string | undefined;
+    /** Additional agents to be added to the property. (Can be added by either email or externalId or a combination) */
+    additionalAgentsEmails?: string[] | undefined;
+    /** Additional agents to be added to the property. (Can be added by either email or externalId or a combination) */
+    additionalAgentsExternalIds?: string[] | undefined;
+    /** Sold price */
+    soldPrice?: number | undefined;
+    /** Currency in which the property was sold */
+    soldCurrency?: string | undefined;
+    /** The source feed name of the property. Can be used to keep track of properties available on multiple feeds. */
+    sourceName?: string | undefined;
+}
+/** Request to create a User */
+export interface CreateUserRequest {
+    /** User email address */
+    email: string;
+    /** User full name */
+    name: string;
+    /** User Role. */
+    role: UserRole;
+    /** Phone number */
+    phoneNumber?: string | undefined;
+    /** User Offices. */
+    officeIds?: string[] | undefined;
+    /** User Workspaces. */
+    workspaceIds?: string[] | undefined;
+    /** Id in customer system. */
+    externalId?: string | undefined;
+    /** List of external identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Custom attributes for the user. */
+    customAttributes?: {
+        [key: string]: any;
+    } | undefined;
+    /** User profile image URL. */
+    imageUrl?: string | undefined;
+}
+/** Filter for date ranges with optional start and end dates. */
+export interface DateRangeFilter {
+    /** Start date (inclusive). If null, no lower bound is applied. */
+    from?: Date | undefined;
+    /** End date (inclusive). If null, no upper bound is applied. */
+    to?: Date | undefined;
+}
+/** A date/time range with start and end. */
+export interface DateRangeModel {
+    /** Start date/time. */
+    start?: Date | undefined;
+    /** End date/time. */
+    end?: Date | undefined;
+}
+/** Request to delete an agent. Provide at least one identifier (AgentId, ExternalId, or Email). */
+export interface DeleteAgentRequest {
+    /** Agent email address (Requires at least one of: agentId, externalId, email) */
+    email?: string | undefined;
+    /** Agent id in Realforce system (Requires at least one of: agentId, externalId, email) */
+    agentId?: string | undefined;
+    /** Id in customer system. (Requires at least one of: agentId, externalId, email) */
+    externalId?: string | undefined;
+}
+/** Request to delete an office */
+export interface DeleteOfficeRequest {
+    /** Office id in Realforce system (Requires at least one of: officeId, externalId) */
+    officeId?: string | undefined;
+    /** Id in customer system. (Requires at least one of: officeId, externalId) */
+    externalId?: string | undefined;
+}
+/** Request to delete a property */
+export interface DeletePropertyRequest {
+    /** Property id in Realforce system (Requires at least one of: propertyId, externalId) */
+    propertyId?: string | undefined;
+    /** Id in customer system. (Requires at least one of: propertyId, externalId) */
+    externalId?: string | undefined;
+}
+/** Type of event occuring */
+export declare enum EventTimeType {
+    OpenHouse = "OpenHouse",
+    AddedInErp = "AddedInErp",
+    Sold = "Sold",
+    Unknown = "Unknown",
+    Auction = "Auction",
+    Start = "Start",
+    Listed = "Listed",
+    FirstListed = "FirstListed"
+}
+/** Represents an external identifier with its type. */
+export interface ExternalId {
+    /** The external identifier value. */
+    id: string;
+    /** The type/source of the external identifier (e.g., "crm", "mls", "legacy"). */
+    type: string;
+    /** Indicates whether this is the primary external id of the property. */
+    isPrimary: boolean;
+}
+/** Response containing the URL for an invited seller to access the property result page. */
+export interface InvitedSellerResponse {
+    /** The URL with an attached authentication token for the seller. */
+    url?: string;
+}
+export declare enum LeadSource {
+    Portal = "Portal",
+    PriceAlert = "PriceAlert",
+    ArrangeViewing = "ArrangeViewing",
+    SimilarProperties = "SimilarProperties",
+    BookValuation = "BookValuation",
+    StandaloneQualification = "StandaloneQualification",
+    Meta = "Meta",
+    Google = "Google"
+}
+/** Type of subject for the lead */
+export declare enum LeadSubjectType {
+    Property = "Property",
+    Agent = "Agent",
+    Office = "Office"
+}
+/** Filter for location-based queries. */
+export interface LocationFilter {
+    /** Filter by country code (ISO 3166-1 alpha-2). */
+    country?: string | undefined;
+    /** Filter by state/region/province. */
+    state?: string | undefined;
+    /** Filter by city name. */
+    city?: string | undefined;
+    /** Filter by postal/zip code. */
+    zipCode?: string | undefined;
+}
+/** Location/address information. */
+export interface LocationModel {
+    /** Full street address. */
+    address?: string | undefined;
+    /** City name. */
+    city?: string | undefined;
+    /** State, region, or province. */
+    state?: string | undefined;
+    /** Postal or ZIP code. */
+    postalCode?: string | undefined;
+    /** Country name or ISO code. */
+    country?: string | undefined;
+    /** Area or neighborhood name. */
+    area?: string | undefined;
+    /** Geographic coordinates. */
+    coordinates?: CoordinateModel | undefined;
+}
+/** Response object for returning a created magic link. */
+export interface MagicLinkResponse {
+    /** The generated magic link URL. */
+    magicLink?: string;
+}
+/** The kind of destination a magic link resolves to. */
+export declare enum MagicLinkType {
+    OrderPage = "OrderPage",
+    ResultPage = "ResultPage",
+    SellerOrderPage = "SellerOrderPage"
+}
+/** Marketing opportunity model for V2 API. Represents an instance of a marketing program available for a given subject (property, agent, or office) that can be ordered. */
+export interface MarketingOpportunity {
+    /** Unique identifier for the marketing opportunity. */
+    id: string;
+    /** The workspace this opportunity belongs to. */
+    workspaceId: string;
+    /** The subject type this opportunity is for (Property, Agent, or Office). */
+    subjectType?: SubjectType;
+    /** The subject ID (the property, agent, or office ID) this opportunity is for. */
+    subjectId: string;
+    /** Name of the program backing this opportunity. */
+    programName?: string | undefined;
+    /** Identifier of the program backing this opportunity. */
+    programId?: string;
+    /** URL to the order page where this opportunity can be purchased. Null if no order page is available. */
+    orderPageUrl?: string | undefined;
+    /** Products available to order within this opportunity. */
+    products?: Product[] | undefined;
+    /** Delay in hours between order placement and publication of the resulting campaign. */
+    publicationDelayInHours?: number;
+    /** How campaigns originating from this opportunity are published
+(e.g. manual, auto-publish, seller-paid). */
+    publishingMode?: PublishingMode | undefined;
+}
+/** Filter criteria for listing marketing opportunities (formerly program instances). */
+export interface MarketingOpportunityFilter {
+    /** Filter by subject type: Office, Agent, or Property. */
+    subjectType?: MarketingOpportunitySubjectType | undefined;
+    /** Filter by subject ID (the ID of the property, agent, or office). */
+    subjectId?: string | undefined;
+    /** Filter by external subject ID. */
+    externalSubjectId?: string | undefined;
+    /** Filter to only show opportunities (true) or non-opportunities (false).
+If null, returns both. */
+    isOpportunity?: boolean | undefined;
+    /** Filter by program ID. */
+    programId?: string | undefined;
+    /** Filter to only show running (true) or not-running (false) opportunities.
+If null, returns both. */
+    isRunning?: boolean | undefined;
+    /** Filter to only show opportunities where the order page is available (true)
+or unavailable (false). If null, returns both. */
+    orderPageAvailable?: boolean | undefined;
+    /** Filter to only show opportunities of a certain publishing mode. */
+    publishingMode?: PublishingMode | undefined;
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface MarketingOpportunityListResponse {
+    /** The list of items for the current page. */
+    data: MarketingOpportunity[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: MarketingOpportunityFilter | undefined;
+}
+/** Query request for marketing opportunities. */
+export interface MarketingOpportunityQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: MarketingOpportunityFilter | undefined;
+}
+/** Subject types that a marketing opportunity can be attached to. */
+export declare enum MarketingOpportunitySubjectType {
+    Office = "Office",
+    Agent = "Agent",
+    Property = "Property"
+}
+/** Media assets associated with a resource. */
+export interface MediaModel {
+    url: string;
+}
+/** Monetary amount with currency. */
+export interface MoneyModel {
+    /** The amount in the smallest currency unit or as decimal. */
+    amount?: number;
+    /** ISO 4217 currency code (e.g., "USD", "EUR", "SEK"). */
+    currency: string;
+}
+/** Office model for V2 API. */
+export interface Office {
+    /** Unique identifier for the office. */
+    id: string;
+    /** The office's name. */
+    name?: string | undefined;
+    /** Media assets for the office. */
+    images?: MediaModel[] | undefined;
+    /** Location/address of the office. */
+    location?: LocationModel | undefined;
+    /** Contact information for the office. */
+    contact?: ContactModel | undefined;
+    /** External identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Custom attributes defined by the Workspace. */
+    customAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** Timestamp information. */
+    timestamps?: TimestampsModel | undefined;
+    /** The workspace this office belongs to. Null when Office is embedded in another response. */
+    workspace?: Workspace | undefined;
+}
+/** Office data */
+export interface OfficeData {
+    /** Id in customer system. These needs to be unique for each office on the Workspace */
+    externalId: string;
+    /** List of external identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Name of the office */
+    officeName?: string | undefined;
+    /** Controls if office is active in the platform */
+    active?: boolean | undefined;
+    /** Logo image of the office */
+    logoImageUrl?: string | undefined;
+    /** Primary color in RGB format (e.g. #FFFFFF) */
+    primaryColorInRgb?: string | undefined;
+    /** Home page url of the office */
+    homePageUrl?: string | undefined;
+    /** Address of the office location */
+    address?: string | undefined;
+    /** City of the office location */
+    city?: string | undefined;
+    /** State of the office location */
+    state?: string | undefined;
+    /** Longitude of office */
+    longitude?: number | undefined;
+    /** Latitude of office */
+    latitude?: number | undefined;
+    /** ZipCode of office */
+    zipCode?: string | undefined;
+    /** Contact phone number of the office */
+    contactPhoneNumber?: string | undefined;
+    /** Contact email of the office */
+    contactEmail?: string | undefined;
+    /** List of additional attributes */
+    additionalAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of urls to additional images */
+    additionalImages?: {
+        [key: string]: string;
+    } | undefined;
+}
+/** Filter criteria for listing offices. */
+export interface OfficeFilter {
+    /** Filter by external ID (exact match). */
+    externalId?: string | undefined;
+    /** Filter by name (exact match). */
+    name?: string | undefined;
+    /** Free-text search across name and city (partial match, case-insensitive). */
+    search?: string | undefined;
+    /** Filter by location criteria. */
+    location?: LocationFilter | undefined;
+    /** Filter by active status.
+If null, returns all offices regardless of status. */
+    isActive?: boolean | undefined;
+    /** Filter by last updated date range. */
+    updatedDateRange?: DateRangeFilter | undefined;
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface OfficeListResponse {
+    /** The list of items for the current page. */
+    data: Office[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: OfficeFilter | undefined;
+}
+/** Query request for offices. */
+export interface OfficeQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: OfficeFilter | undefined;
+}
+/** Order model for V2 API. */
+export interface Order {
+    /** Unique identifier for the order. */
+    id: string;
+    /** Human-readable order number. */
+    orderNumber?: string | undefined;
+    /** The subject type for this order (e.g., Property, Agent). */
+    subjectType?: SubjectType;
+    /** The subject ID for this order. */
+    subjectId?: string | undefined;
+    /** The program ID this order belongs to. */
+    programId?: string | undefined;
+    /** The program name this order belongs to. */
+    programName?: string | undefined;
+    /** Who pays for the order. */
+    paidBy?: PaidBy;
+    /** Cost center for the order. */
+    costCenter?: string | undefined;
+    /** Total price of the order, calculated as the sum of the line items' product prices. */
+    total?: MoneyModel | undefined;
+    /** Line items in the order. */
+    lineItems?: OrderLineItemModel[] | undefined;
+    /** Payment information. */
+    payment?: PaymentInfoModel | undefined;
+    /** External identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Custom attributes defined by the Workspace. */
+    customAttributes?: {
+        [key: string]: any;
+    } | undefined;
+    /** Timestamp information. */
+    timestamps?: TimestampsModel | undefined;
+    /** The property this order is for. Null when Order is embedded in another response. */
+    property?: Property | undefined;
+    /** The agent associated with the order. Null when Order is embedded in another response. */
+    agent?: Agent | undefined;
+    /** The office the order belongs to. Null when Order is embedded in another response. */
+    office?: Office | undefined;
+    /** The user who originated/placed the order. */
+    originator?: User | undefined;
+}
+/** Filter criteria for listing orders. */
+export interface OrderFilter {
+    /** Filter by property ID. */
+    propertyId?: string | undefined;
+    /** Filter by office ID. */
+    officeId?: string | undefined;
+    /** Filter by user ID who created the order. */
+    userId?: string | undefined;
+    /** Filter by marketing opportunity ID. */
+    marketingOpportunityId?: string | undefined;
+    /** Filter by product ID. */
+    productId?: string | undefined;
+    /** Filter by order creation date range. */
+    createdDateRange?: DateRangeFilter | undefined;
+    /** Filter by price range. */
+    priceRange?: PriceRangeFilter | undefined;
+}
+/** A line item in an order. */
+export interface OrderLineItemModel {
+    /** The product for this line item. */
+    product?: Product | undefined;
+    /** Total price for this line item. */
+    total?: MoneyModel | undefined;
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface OrderListResponse {
+    /** The list of items for the current page. */
+    data: Order[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: OrderFilter | undefined;
+}
+/** Query request for orders. */
+export interface OrderQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: OrderFilter | undefined;
+}
+/** Request to place an order for a product on a marketing opportunity. */
+export interface OrderRequest {
+    /** The ID of the marketing opportunity to order for. */
+    marketingOpportunityId?: string;
+    /** The ID of the product to order. */
+    productId?: string;
+}
+/** Response returned when querying the status of an order. */
+export interface OrderStatusResponse {
+    /** The current status of the order. */
+    status?: string;
+}
+/** Pagination parameters for list requests. Supports two modes: cursor-based (using Cursor) or page-based (using Page). Do not combine both — if Cursor is set, Page is ignored. */
+export interface PaginationRequest {
+    /** Number of records to return per page. Default is 20, maximum is 1000. */
+    pageSize?: number;
+    /** Opaque cursor for cursor-based pagination (returned as cursor from the previous response).
+When set, Page is ignored. */
+    cursor?: string | undefined;
+    /** Page number for page-based pagination (1-indexed). Use either Cursor or Page, not both. */
+    page?: number | undefined;
+}
+/** Pagination metadata for list responses. */
+export interface PaginationResponse {
+    /** Total number of items matching the filter criteria. */
+    totalCount?: number | undefined;
+    /** Number of items per page. */
+    pageSize?: number;
+    /** Opaque cursor for the next page of results. Null if this is the last page.
+Pass this value as cursor in the pagination object of your next request to fetch the next page.
+Only present when using cursor-based pagination. */
+    cursor?: string | undefined;
+    /** Current page number (1-indexed).
+Only present when using page-based pagination. */
+    page?: number | undefined;
+    /** Total number of pages available.
+Only present when using page-based pagination. */
+    totalPages?: number | undefined;
+}
+export declare enum PaidBy {
+    Unknown = "Unknown",
+    Hq = "Hq",
+    Office = "Office",
+    Agent = "Agent",
+    Seller = "Seller",
+    Orderer = "Orderer",
+    Account = "Account"
+}
+/** Details of a personal access token (without the full token value). */
+export interface PatResponse {
+    /** The unique identifier of the PAT. */
+    patId?: string;
+    /** The human-readable name of the token. */
+    name?: string;
+    /** The first few characters of the token for identification (e.g. "rfk_abc..."). */
+    tokenPrefix?: string;
+    /** The permission scopes granted to this token. */
+    scopes?: string[];
+    /** When the token was created (UTC). */
+    issuedAt?: Date;
+    /** When the token expires (UTC). */
+    expiresAt?: Date;
+    /** When the token was revoked (UTC), or null if still active. */
+    revokedAt?: Date | undefined;
+    /** When the token was last used for authentication (UTC), or null if never used. */
+    lastUsedAt?: Date | undefined;
+    /** The workspace IDs this token is authorized to access. */
+    workspaceIds?: string[];
+    /** The account IDs this token is authorized to access. Account grants imply access to all workspaces within the account. */
+    accountIds?: string[];
+}
+/** Payment information for an order. */
+export interface PaymentInfoModel {
+    /** Payment status (e.g., "pending", "paid", "failed", "refunded"). */
+    status?: string | undefined;
+    /** Payment method used (e.g., "card", "invoice", "bank_transfer"). */
+    method?: string | undefined;
+    /** When the payment was created. */
+    createdAt?: Date | undefined;
+    /** Whether the payment has been refunded. */
+    refunded?: boolean;
+    /** Tax percentage applied to the payment. */
+    taxPercentage?: number | undefined;
+    /** Tax amount on the payment. */
+    taxAmount?: number | undefined;
+    /** Total amount paid for the order, summed across all payments. */
+    totalPaid?: MoneyModel | undefined;
+}
+/** Request to Post an office */
+export interface PostOfficeRequest {
+    /** Id in customer system. These needs to be unique for each office in the Workspace */
+    externalId: string;
+    /** List of external identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Name of the office. This field is required when creating a new office, but optional when updating an existing office. */
+    officeName?: string | undefined;
+    /** Controls if office is active in the platform */
+    active?: boolean | undefined;
+    /** Logo image of the office */
+    logoImageUrl?: string | undefined;
+    /** Primary color in RGB format (e.g. #FFFFFF) */
+    primaryColorInRgb?: string | undefined;
+    /** Home page url of the office */
+    homePageUrl?: string | undefined;
+    /** Address of the office location */
+    address?: string | undefined;
+    /** City of the office location */
+    city?: string | undefined;
+    /** State of the office location */
+    state?: string | undefined;
+    /** Longitude of office */
+    longitude?: number | undefined;
+    /** Latitude of office */
+    latitude?: number | undefined;
+    /** ZipCode of office */
+    zipCode?: string | undefined;
+    /** Contact phone number of the office */
+    contactPhoneNumber?: string | undefined;
+    /** Contact email of the office */
+    contactEmail?: string | undefined;
+    /** List of additional attributes */
+    additionalAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of urls to additional images */
+    additionalImages?: {
+        [key: string]: string;
+    } | undefined;
+}
+/** Filter for price ranges with optional min and max values. */
+export interface PriceRangeFilter {
+    /** Minimum price (inclusive). If null, no lower bound is applied. */
+    min?: number | undefined;
+    /** Maximum price (inclusive). If null, no upper bound is applied. */
+    max?: number | undefined;
+}
+/** Product model for V2 API. */
+export interface Product {
+    /** Unique identifier for the product. */
+    id?: string;
+    /** The product's name. */
+    name?: string | undefined;
+    /** Short description of the product. */
+    description?: string | undefined;
+    /** Is default product on Program. */
+    isDefault?: boolean;
+    /** Product archived at. */
+    archivedAt?: Date | undefined;
+    /** Product is paid by. */
+    paidBy?: PaidBy;
+    /** Price of the product. */
+    price?: MoneyModel | undefined;
+}
+/** Filter criteria for listing products. */
+export interface ProductFilter {
+    /** Include archived products in the results.
+If null or false, only active products are returned. */
+    includeArchived?: boolean | undefined;
+    /** Filter by product types.
+If empty or null, returns all types. */
+    types?: string[] | undefined;
+    /** Filter by name (exact match). */
+    name?: string | undefined;
+    /** Free-text search across name and description (partial match, case-insensitive). */
+    search?: string | undefined;
+    /** Filter by price range. */
+    priceRange?: PriceRangeFilter | undefined;
+    /** Filter by who pays for the product. */
+    paidBy?: PaidBy[] | undefined;
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface ProductListResponse {
+    /** The list of items for the current page. */
+    data: Product[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: ProductFilter | undefined;
+}
+/** Query request for products. */
+export interface ProductQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: ProductFilter | undefined;
+}
+/** Property model for V2 API. */
+export interface Property {
+    /** Unique identifier for the property. */
+    id: string;
+    /** Location/address of the property. */
+    location?: LocationModel | undefined;
+    /** Price information for the property. */
+    price?: MoneyModel | undefined;
+    /** Status of the property (e.g., "Available", "Acquired", "Upcoming"). */
+    status?: PropertyStatus | undefined;
+    /** Type of property (e.g., "house", "apartment", "condo"). */
+    propertyType?: string | undefined;
+    /** Property details and specifications. */
+    details?: PropertyDetailsModel | undefined;
+    /** Images for the property. */
+    images?: MediaModel[] | undefined;
+    /** Url to property landingpage. */
+    propertyPageUrl?: string | undefined;
+    /** Url to property order page. */
+    orderPageUrl?: string | undefined;
+    /** Url to property result page. */
+    resultPageUrl?: string | undefined;
+    /** External identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Custom attributes defined by the Workspace. */
+    customAttributes?: {
+        [key: string]: string[];
+    } | undefined;
+    /** Amount of vistors on the property website. */
+    visitorCounts?: VisitorCount[] | undefined;
+    /** Timestamp information. */
+    timestamps?: TimestampsModel | undefined;
+    /** The agent handling this property. Null when Property is embedded in another response. */
+    agent?: Agent | undefined;
+    /** The office handling this property. Null when Property is embedded in another response. */
+    office?: Office | undefined;
+    /** List of campaigns started on the property. Null when Property is embedded in another response. */
+    campaigns?: Campaign[] | undefined;
+}
+/** Property data */
+export interface PropertyData {
+    /** Id in customer system. These needs to be unique for each property on the Workspace */
+    externalId: string;
+    /** Status of property */
+    propertyStatus?: PropertyStatus;
+    /** Property street address */
+    street?: string | undefined;
+    /** Property city */
+    city?: string | undefined;
+    /** Property postal code */
+    postCode?: string | undefined;
+    /** City area where property is located */
+    area?: string | undefined;
+    /** Property url */
+    propertyUrl?: string | undefined;
+    /** Longitude of property used for targeting */
+    longitude?: number | undefined;
+    /** Latitude of property used for targeting */
+    latitude?: number | undefined;
+    /** List of urls to images */
+    images?: string[] | undefined;
+    /** Main image to use. If empty first image in Images will be used */
+    mainImage?: string | undefined;
+    /** Shorter property description */
+    propertyHeadline?: string | undefined;
+    /** The full property description */
+    propertyDescription?: string | undefined;
+    /** Type of property */
+    homeType?: string | undefined;
+    /** The type of transaction the Property is intended for (sale, rent) */
+    transactionType?: string | undefined;
+    /** Size of property in square meters */
+    areaSquareMeters?: number | undefined;
+    /** Number of rooms */
+    numberOfRooms?: number | undefined;
+    /** Number of bedrooms */
+    numberOfBedrooms?: number | undefined;
+    /** Number of bathrooms */
+    numberOfBathRooms?: number | undefined;
+    /** Number of parking spots */
+    numberOfParking?: number | undefined;
+    /** Asking price */
+    askingPrice?: number | undefined;
+    /** Custom data that can be used for triggering ads */
+    customAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of events occuring on the property */
+    propertyEvents?: PropertyEventTime[] | undefined;
+    /** Additional property landing page */
+    additionalLandingPage?: string | undefined;
+    /** Sold price */
+    soldPrice?: number | undefined;
+    /** Sold currency */
+    soldCurrency?: string | undefined;
+    /** The source feed name of the property. Can be used to keep track of properties available on multiple feeds. */
+    sourceName?: string | undefined;
+}
+/** Detailed specifications for a property. */
+export interface PropertyDetailsModel {
+    /** Number of bedrooms. */
+    bedrooms?: number | undefined;
+    /** Number of bathrooms. */
+    bathrooms?: number | undefined;
+    /** Total living area in square meters or feet. */
+    livingArea?: number | undefined;
+    /** Total lot/land size. */
+    lotSize?: number | undefined;
+    /** Unit of measurement for area (e.g., "sqm", "sqft"). */
+    areaUnit?: string | undefined;
+    /** Year the property was built. */
+    yearBuilt?: number | undefined;
+    /** Number of floors/stories. */
+    floors?: number | undefined;
+    /** Number of rooms. */
+    rooms?: number | undefined;
+    /** Property description text. */
+    description?: string | undefined;
+    /** List of features/amenities. */
+    features?: string[] | undefined;
+}
+/** Event occuring on a property */
+export interface PropertyEventTime {
+    /** Type of event occuring */
+    eventTimeType?: EventTimeType;
+    /** Event time UTC */
+    eventTimeUtc?: Date;
+}
+/** Filter criteria for listing properties. */
+export interface PropertyFilter {
+    /** Filter by property URL (exact match). */
+    url?: string | undefined;
+    /** Filter by external ID (exact match). */
+    externalId?: string | undefined;
+    /** Filter by office ID. */
+    officeId?: string | undefined;
+    /** Filter by agent ID. */
+    agentId?: string | undefined;
+    /** Filter by property statuses.
+If empty or null, returns all statuses. */
+    statuses?: PropertyFilterStatus[] | undefined;
+    /** Filter by property types (e.g., "apartment", "house", "condo").
+If empty or null, returns all types. */
+    propertyTypes?: string[] | undefined;
+    /** Free-text search across headline, description, and address (partial match, case-insensitive). */
+    search?: string | undefined;
+    /** Filter by price range. */
+    priceRange?: PriceRangeFilter | undefined;
+    /** Filter by location criteria. */
+    location?: LocationFilter | undefined;
+    /** Filter by creation date range. */
+    createdDateRange?: DateRangeFilter | undefined;
+    /** Filter by last updated date range. */
+    updatedDateRange?: DateRangeFilter | undefined;
+}
+/** Status values accepted when filtering properties. */
+export declare enum PropertyFilterStatus {
+    Available = "Available",
+    Upcoming = "Upcoming",
+    Removed = "Removed",
+    Acquired = "Acquired",
+    Unpublished = "Unpublished"
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface PropertyListResponse {
+    /** The list of items for the current page. */
+    data: Property[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: PropertyFilter | undefined;
+}
+/** Query request for properties. */
+export interface PropertyQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: PropertyFilter | undefined;
+}
+export declare enum PropertyStatus {
+    Unknown = "Unknown",
+    Upcoming = "Upcoming",
+    Available = "Available",
+    Acquired = "Acquired",
+    Removed = "Removed",
+    Unpublished = "Unpublished",
+    ManuallyRemoved = "ManuallyRemoved"
+}
+/** Controls how a marketing opportunity is published into a campaign. */
+export declare enum PublishingMode {
+    Manual = "Manual",
+    PremiumAutoPublish = "PremiumAutoPublish",
+    MachineAutoPublish = "MachineAutoPublish",
+    SellerPaid = "SellerPaid"
+}
+/** Request to update an office. All fields are optional — only fields present in the request body are changed. Fields you omit are left as-is on the office. */
+export interface PutOfficeRequest {
+    /** Id in customer system. This needs to be unique for each office on the Workspace */
+    externalId?: string | undefined;
+    /** List of external identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Name of the office */
+    officeName?: string | undefined;
+    /** Controls if office is active in the platform */
+    active?: boolean | undefined;
+    /** Logo image of the office */
+    logoImageUrl?: string | undefined;
+    /** Primary color in RGB format (e.g. #FFFFFF) */
+    primaryColorInRgb?: string | undefined;
+    /** Home page url of the office */
+    homePageUrl?: string | undefined;
+    /** Address of the office location */
+    address?: string | undefined;
+    /** City of the office location */
+    city?: string | undefined;
+    /** State of the office location */
+    state?: string | undefined;
+    /** Longitude of office */
+    longitude?: number | undefined;
+    /** Latitude of office */
+    latitude?: number | undefined;
+    /** ZipCode of office */
+    zipCode?: string | undefined;
+    /** Contact phone number of the office */
+    contactPhoneNumber?: string | undefined;
+    /** Contact email of the office */
+    contactEmail?: string | undefined;
+    /** List of additional attributes */
+    additionalAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of urls to additional images */
+    additionalImages?: {
+        [key: string]: string;
+    } | undefined;
+}
+/** Response returned after rotating a personal access token. Contains the new token and grace period info for the old token. */
+export interface RotatePatResponse {
+    /** The unique identifier of the new PAT. */
+    newPatId?: string;
+    /** The full new token value. This is only returned at rotation time and cannot be retrieved again. */
+    token?: string;
+    /** The human-readable name of the token (inherited from the old token). */
+    name?: string;
+    /** The permission scopes granted to the new token (inherited from the old token). */
+    scopes?: string[];
+    /** The workspace IDs the new token is authorized to access (inherited from the old token). */
+    workspaceIds?: string[];
+    /** The account IDs the new token is authorized to access (inherited from the old token). */
+    accountIds?: string[];
+    /** When the new token expires (UTC). */
+    expiresAt?: Date;
+    /** The unique identifier of the old (rotated) PAT. */
+    oldPatId?: string;
+    /** When the old token will stop working (UTC). There is a short grace period (default 5 minutes) after rotation. */
+    oldPatExpiresAt?: Date;
+}
+/** Request to make a marketing opportunity's order page available or unavailable. */
+export interface SetOrderPageAvailabilityRequest {
+    /** Whether the order page should be available (true) or unavailable (false). */
+    available: boolean;
+    /** Reason the order page is being made unavailable. Recorded for audit purposes.
+Only meaningful when RealforceApiService.Models.SetOrderPageAvailabilityRequest.Available is false. */
+    unavailableReason?: string | undefined;
+}
+/** Response returned after toggling the order page availability of a marketing opportunity. */
+export interface SetOrderPageAvailabilityResponse {
+    /** Human-readable confirmation message. */
+    message?: string;
+}
+/** Sort criteria for a single field. */
+export interface SortCriteria {
+    /** The field to sort by. */
+    field: string;
+    /** Sort direction: "asc" or "desc". */
+    direction: string;
+}
+/** Sort direction for list requests. */
+export declare enum SortDirection {
+    Asc = "Asc",
+    Desc = "Desc"
+}
+/** Standard sort parameters for list requests. */
+export interface SortRequest {
+    /** Field to sort by. */
+    field?: string | undefined;
+    /** Sort direction. Default is ascending. */
+    direction?: SortDirection;
+}
+export declare enum SubjectType {
+    Unknown = "Unknown",
+    Hq = "Hq",
+    Office = "Office",
+    Agent = "Agent",
+    Property = "Property",
+    Account = "Account"
+}
+/** Standard timestamp fields for resources. */
+export interface TimestampsModel {
+    /** When the resource was created. */
+    created?: Date;
+    /** When the resource was last updated. */
+    updated?: Date | undefined;
+    /** Open house */
+    openHouses?: Date[] | undefined;
+    /** Added in Erp system */
+    addedInErp?: Date | undefined;
+    /** Sold date */
+    sold?: Date | undefined;
+    /** Auction date */
+    auction?: Date | undefined;
+    /** Listed date */
+    listed?: Date | undefined;
+    /** First listed date */
+    firstListed?: Date | undefined;
+}
+export interface Trigger {
+    triggerId?: string;
+    targetSubjectType?: SubjectType;
+    name?: string;
+    receivedEvents?: number;
+    lastTriggered?: Date | undefined;
+    created?: Date;
+}
+/** Response after successfully resolving and emitting a trigger. */
+export interface TriggerByFilterResponse {
+    /** The resolved Realforce subject ID. */
+    subjectId?: string;
+    /** The type of subject that was triggered. */
+    subjectType?: TriggerSubjectType;
+    /** The ID of the trigger that was fired. */
+    triggerId?: string;
+    /** The idempotency key for this trigger request. */
+    requestId?: string;
+}
+/** Request to send a trigger for a subject resolved by filter. */
+export interface TriggerRequest {
+    /** The type of subject to trigger (e.g. Property, Agent, Office). */
+    subjectType: TriggerSubjectType;
+    /** The ID of the trigger to fire. */
+    triggerId: string;
+    /** Optional idempotency key. If not provided, a new GUID will be generated. */
+    requestId?: string | undefined;
+    /** The Realforce subject ID. Either this or ExternalId must be provided. */
+    subjectId?: string | undefined;
+    /** The external ID in the customer system. Either this or SubjectId must be provided. */
+    externalId?: string | undefined;
+}
+/** Response containing all triggers configured for a workspace. */
+export interface TriggerResponse {
+    /** The list of triggers available on the workspace. */
+    triggers?: Trigger[];
+}
+/** Subject types that can be used with the trigger API. */
+export declare enum TriggerSubjectType {
+    Office = "Office",
+    Agent = "Agent",
+    Property = "Property"
+}
+/** Request to update an existing agent. All fields are optional — only fields present in the request body are changed. Fields you omit are left as-is on the agent. */
+export interface UpdateAgentRequest {
+    /** Office id. Omit to leave unchanged. */
+    officeId?: string | undefined;
+    /** Agent licenseNumber. */
+    licenseNumber?: string | undefined;
+    /** Phone number. */
+    phoneNumber?: string | undefined;
+    /** List of external identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Title. */
+    jobTitle?: string | undefined;
+    /** Agent landing page to redirect to. */
+    landingPage?: string | undefined;
+    /** Longitude of agent used for targeting. */
+    longitude?: number | undefined;
+    /** Latitude of agent used for targeting. */
+    latitude?: number | undefined;
+    /** Agent image. */
+    imageUrl?: string | undefined;
+    /** List of additional attributes. */
+    additionalAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of urls to additional images. */
+    additionalImages?: {
+        [key: string]: string;
+    } | undefined;
+}
+/** Request to update a property. All fields are optional — only fields present in the request body are changed. Fields you omit are left as-is on the property. */
+export interface UpdatePropertyRequest {
+    /** Id in customer system. These needs to be unique for each property on the Workspace */
+    externalId?: string | undefined;
+    /** Status of property. */
+    propertyStatus?: PropertyStatus | undefined;
+    /** Office name where property is listed */
+    office?: string | undefined;
+    /** Office id in customer system */
+    externalOfficeId?: string | undefined;
+    /** Agent id in Realforce system */
+    agentId?: string | undefined;
+    /** Agent email */
+    agentEmail?: string | undefined;
+    /** Agent id in customer system */
+    externalAgentId?: string | undefined;
+    /** Property street address */
+    street?: string | undefined;
+    /** Property city */
+    city?: string | undefined;
+    /** Property postal code */
+    postCode?: string | undefined;
+    /** City area where property is located */
+    area?: string | undefined;
+    /** Property url */
+    propertyUrl?: string | undefined;
+    /** Longitude of property used for targeting */
+    longitude?: number | undefined;
+    /** Latitude of property used for targeting */
+    latitude?: number | undefined;
+    /** List of urls to images */
+    images?: string[] | undefined;
+    /** Main image to use. If empty first image in Images will be used */
+    mainImage?: string | undefined;
+    /** Shorter property description */
+    propertyHeadline?: string | undefined;
+    /** The full property description */
+    propertyDescription?: string | undefined;
+    /** Type of property */
+    homeType?: string | undefined;
+    /** The type of transaction the Property is intended for (sale, rent) */
+    transactionType?: string | undefined;
+    /** Size of property in square meters */
+    areaSquareMeters?: number | undefined;
+    /** Number of rooms */
+    numberOfRooms?: number | undefined;
+    /** Number of bedrooms */
+    numberOfBedrooms?: number | undefined;
+    /** Number of bathrooms */
+    numberOfBathRooms?: number | undefined;
+    /** Number of parking spots */
+    numberOfParking?: number | undefined;
+    /** Asking price */
+    askingPrice?: number | undefined;
+    /** Custom data that can be used for triggering ads */
+    customAttributes?: {
+        [key: string]: string;
+    } | undefined;
+    /** List of events occuring on the property */
+    propertyEvents?: PropertyEventTime[] | undefined;
+    /** Additional property landing page */
+    additionalLandingPage?: string | undefined;
+    /** Additional agents to be added to the property. (Can be added by either email or externalId or a combination) */
+    additionalAgentsEmails?: string[] | undefined;
+    /** Additional agents to be added to the property. (Can be added by either email or externalId or a combination) */
+    additionalAgentsExternalIds?: string[] | undefined;
+    /** Sold price */
+    soldPrice?: number | undefined;
+    /** Currency in which the property was sold */
+    soldCurrency?: string | undefined;
+    /** The source feed name of the property. Can be used to keep track of properties available on multiple feeds. */
+    sourceName?: string | undefined;
+}
+/** User model for V2 API. */
+export interface User {
+    /** Unique identifier for the user. */
+    id: string;
+    /** The user's full name. */
+    name?: string | undefined;
+    /** The user's email address. */
+    email?: string | undefined;
+    /** The user's phone number. */
+    phone?: string | undefined;
+    /** The user's roles. */
+    roles?: string[] | undefined;
+    /** Status of the user account (e.g., "active", "inactive", "pending"). */
+    status?: string | undefined;
+    /** Media assets for the user. */
+    media?: MediaModel | undefined;
+    /** External identifiers from other systems. */
+    externalIds?: ExternalId[] | undefined;
+    /** Custom attributes defined by the Workspace. */
+    customAttributes?: {
+        [key: string]: any;
+    } | undefined;
+    /** Timestamp information. */
+    timestamps?: TimestampsModel | undefined;
+    /** When the user last logged in. */
+    lastLoginAt?: Date | undefined;
+    /** The workspace this user belongs to. Null when User is embedded in another response. */
+    workspace?: Workspace | undefined;
+    /** The office this user belongs to. Null when User is embedded in another response. */
+    office?: Office | undefined;
+}
+/** Filter criteria for listing users. */
+export interface UserFilter {
+    /** Filter by external ID (exact match). */
+    externalId?: string | undefined;
+    /** Filter by email address (exact match). */
+    email?: string | undefined;
+    /** Filter by name (exact match). */
+    name?: string | undefined;
+    /** Free-text search across name and email (partial match, case-insensitive). */
+    search?: string | undefined;
+    /** Filter by role names.
+If empty or null, returns all roles. */
+    roles?: string[] | undefined;
+    /** Filter by office ID to get users associated with a specific office. */
+    officeId?: string | undefined;
+    /** Filter by multiple office IDs. */
+    officeIds?: string[] | undefined;
+    /** Filter by creation date range. */
+    createdDateRange?: DateRangeFilter | undefined;
+    /** Filter by last updated date range. */
+    updatedDateRange?: DateRangeFilter | undefined;
+}
+/** Standard list response with pagination, sort, and filter metadata. */
+export interface UserListResponse {
+    /** The list of items for the current page. */
+    data: User[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+    /** Sort criteria that was applied. Null if no sorting was specified. */
+    sort?: SortCriteria[] | undefined;
+    /** Filter criteria that was applied. */
+    filter?: UserFilter | undefined;
+}
+/** User Profile model */
+export interface UserProfile {
+    /** The preferred language of the user */
+    preferredLanguage?: string | undefined;
+    /** A list of workspaces with their associated locale settings for the user. */
+    workspaces: WorkspaceInfo[];
+}
+/** Query request for users. */
+export interface UserQueryRequest {
+    /** Sort parameters. */
+    sort?: SortRequest | undefined;
+    /** Pagination parameters. */
+    pagination?: PaginationRequest | undefined;
+    /** Filter criteria for this resource. */
+    filter?: UserFilter | undefined;
+}
+/** The organizational scope at which a user operates. */
+export declare enum UserRole {
+    Account = "Account",
+    Workspace = "Workspace",
+    Office = "Office"
+}
+export interface VisitorCount {
+    category?: string;
+    visits?: number;
+}
+/** Workspace model for V2 API. */
+export interface Workspace {
+    /** Unique identifier for the workspace. */
+    id: string;
+    /** The account this workspace belongs to. */
+    account?: Account | undefined;
+    /** The workspace's name. */
+    name?: string | undefined;
+    /** Descriptive name for the workspace. */
+    descriptiveName?: string | undefined;
+    /** Domain associated with the workspace. */
+    domain?: string | undefined;
+    /** Logo URL for the workspace. */
+    logo?: string | undefined;
+    /** Favicon URL for the workspace. */
+    favIcon?: string | undefined;
+    /** Primary color in RGB format. */
+    primaryColor?: string | undefined;
+    /** Currency used by the workspace. */
+    currency?: string | undefined;
+    /** Culture/locale for the workspace. */
+    culture?: string | undefined;
+}
+/** Represents workspace information including locale and country details. */
+export interface WorkspaceInfo {
+    /** The workspace ID. */
+    id: string;
+    /** The preferred locale in BCP 47 language tag format (e.g. en-US, sv-SE). */
+    locale: string;
+    /** The country code in ISO 3166-1 alpha-2 format (e.g. US, SE). */
+    countryCode: string;
+    /** The name of the workspace. */
+    name: string;
+}
+export declare class ApiException extends Error {
+    message: string;
+    status: number;
+    response: string;
+    headers: {
+        [key: string]: any;
+    };
+    result: any;
+    constructor(message: string, status: number, response: string, headers: {
+        [key: string]: any;
+    }, result: any);
+    protected isApiException: boolean;
+    static isApiException(obj: any): obj is ApiException;
+}
+//# sourceMappingURL=client.generated.d.ts.map