@simplyhomes/sos-sdk/dist/generated/src/apis/ContactPropertyRelationsAPIV4Api.d.ts

TypeScript SDK for Simply Homes SoS API v4

/**
 * API v4
 * Swagger documentation for API v4
 *
 * The version of the OpenAPI document: 4.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { V4ContactPropertyRelationsCreateRelContactPropertyBodyDto, V4ContactPropertyRelationsCreateRelContactPropertyResponseDto, V4ContactPropertyRelationsDeleteRelContactPropertyResponseDto, V4ContactPropertyRelationsGetRelContactPropertiesInViewResponseDto, V4ContactPropertyRelationsGetRelContactPropertiesResponseDto, V4ContactPropertyRelationsGetRelContactPropertyColumnsResponseDto, V4ContactPropertyRelationsGetRelContactPropertyResponseDto, V4ContactPropertyRelationsUpdateRelContactPropertyBodyDto, V4ContactPropertyRelationsUpdateRelContactPropertyResponseDto } from '../models/index';
export interface V4ContactPropertyRelationsControllerCreateRelContactPropertyV4Request {
    v4ContactPropertyRelationsCreateRelContactPropertyBodyDto: V4ContactPropertyRelationsCreateRelContactPropertyBodyDto;
}
export interface V4ContactPropertyRelationsControllerDeleteRelContactPropertyV4Request {
    contactId: number;
    pid: string;
}
export interface V4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4ContactPropertyRelationsControllerGetRelContactPropertiesV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4Request {
    columns: string;
    contactId: number;
    pid: string;
}
export interface V4ContactPropertyRelationsControllerGetRelContactPropertyV4Request {
    contactId: number;
    pid: string;
    viewId?: number;
}
export interface V4ContactPropertyRelationsControllerUpdateRelContactPropertyV4Request {
    contactId: number;
    pid: string;
    v4ContactPropertyRelationsUpdateRelContactPropertyBodyDto: V4ContactPropertyRelationsUpdateRelContactPropertyBodyDto;
}
/**
 * ContactPropertyRelationsAPIV4Api - interface
 *
 * @export
 * @interface ContactPropertyRelationsAPIV4ApiInterface
 */
export interface ContactPropertyRelationsAPIV4ApiInterface {
    /**
     *  ## POST /v4/contact-property-relations  ### Overview Creates a new relationship between a contact and a property. This endpoint allows you to establish connections between contacts and properties for various relationship types such as property management, ownership, or other associations in the real estate investment pipeline.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Request Body The request body should contain the contact and property identifiers to create the relationship.  #### Required Fields - **contactId** (number): Contact identifier - **pid** (string): Property identifier  #### Optional Fields - **type** (string): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"contactId\": 123,   \"pid\": \"property123\",   \"type\": \"Property Manager\" } ```  ### Business Use Cases - **Property Management**: Assigning property managers to specific properties - **Ownership Tracking**: Establishing property ownership relationships - **Tenant Management**: Connecting tenants to their rental properties - **Contractor Assignment**: Linking contractors to properties for maintenance - **Agent Assignment**: Assigning real estate agents to property listings - **Vendor Management**: Connecting vendors to properties for services - **Emergency Contacts**: Establishing emergency contact relationships for properties
     * @summary Create a new contact-property relationship
     * @param {V4ContactPropertyRelationsCreateRelContactPropertyBodyDto} v4ContactPropertyRelationsCreateRelContactPropertyBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContactPropertyRelationsAPIV4ApiInterface
     */
    v4ContactPropertyRelationsControllerCreateRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerCreateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsCreateRelContactPropertyResponseDto>>;
    /**
     *  ## POST /v4/contact-property-relations  ### Overview Creates a new relationship between a contact and a property. This endpoint allows you to establish connections between contacts and properties for various relationship types such as property management, ownership, or other associations in the real estate investment pipeline.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Request Body The request body should contain the contact and property identifiers to create the relationship.  #### Required Fields - **contactId** (number): Contact identifier - **pid** (string): Property identifier  #### Optional Fields - **type** (string): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"contactId\": 123,   \"pid\": \"property123\",   \"type\": \"Property Manager\" } ```  ### Business Use Cases - **Property Management**: Assigning property managers to specific properties - **Ownership Tracking**: Establishing property ownership relationships - **Tenant Management**: Connecting tenants to their rental properties - **Contractor Assignment**: Linking contractors to properties for maintenance - **Agent Assignment**: Assigning real estate agents to property listings - **Vendor Management**: Connecting vendors to properties for services - **Emergency Contacts**: Establishing emergency contact relationships for properties
     * Create a new contact-property relationship
     */
    v4ContactPropertyRelationsControllerCreateRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerCreateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsCreateRelContactPropertyResponseDto>;
    /**
     *  ## DELETE /v4/contact-property-relations/{contactId}/{pid}  ### Overview Deletes a specific contact-property relationship by its composite key. This endpoint removes the association between a contact and property, effectively severing their connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Business Use Cases - **Relationship Termination**: Remove contacts when their role with a property ends - **Property Management Changes**: Unassign property managers during transitions - **Tenant Move-out**: Remove tenant relationships when they vacate - **Ownership Transfer**: Remove previous owners during property sales - **Contract Completion**: Remove contractor relationships after work completion - **Cleanup Operations**: Remove outdated or incorrect associations - **Data Management**: Clean up duplicate or erroneous relationships  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance - May affect related business processes and notifications
     * @summary Delete a contact-property relationship
     * @param {number} contactId The unique identifier of the contact
     * @param {string} pid The pid parameter
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContactPropertyRelationsAPIV4ApiInterface
     */
    v4ContactPropertyRelationsControllerDeleteRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerDeleteRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsDeleteRelContactPropertyResponseDto>>;
    /**
     *  ## DELETE /v4/contact-property-relations/{contactId}/{pid}  ### Overview Deletes a specific contact-property relationship by its composite key. This endpoint removes the association between a contact and property, effectively severing their connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Business Use Cases - **Relationship Termination**: Remove contacts when their role with a property ends - **Property Management Changes**: Unassign property managers during transitions - **Tenant Move-out**: Remove tenant relationships when they vacate - **Ownership Transfer**: Remove previous owners during property sales - **Contract Completion**: Remove contractor relationships after work completion - **Cleanup Operations**: Remove outdated or incorrect associations - **Data Management**: Clean up duplicate or erroneous relationships  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance - May affect related business processes and notifications
     * Delete a contact-property relationship
     */
    v4ContactPropertyRelationsControllerDeleteRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerDeleteRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsDeleteRelContactPropertyResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations/viewId/{viewId}  ### Overview Retrieves contact-property relationships for a specific view ID with optional filtering and pagination. This endpoint provides access to relationships filtered by a predefined view configuration.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): View ID to apply specific filters and column selection  ### Query Parameters - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Filtered Views**: Access predefined filtered sets of contact-property relationships - **Dashboard Data**: Populate dashboard views with specific relationship data - **Reporting**: Generate reports based on predefined view configurations
     * @summary Get contact-property relationships with a specific viewId
     * @param {number} viewId The unique identifier of the view
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContactPropertyRelationsAPIV4ApiInterface
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertiesInViewResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations/viewId/{viewId}  ### Overview Retrieves contact-property relationships for a specific view ID with optional filtering and pagination. This endpoint provides access to relationships filtered by a predefined view configuration.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): View ID to apply specific filters and column selection  ### Query Parameters - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Filtered Views**: Access predefined filtered sets of contact-property relationships - **Dashboard Data**: Populate dashboard views with specific relationship data - **Reporting**: Generate reports based on predefined view configurations
     * Get contact-property relationships with a specific viewId
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertiesInViewResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations  ### Overview Retrieves contact-property relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between contacts and properties, representing various relationship types such as ownership, management, or tenancy.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Query Parameters - **viewId** (number, optional): View ID to apply specific filters and column selection - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Property Management**: Understanding which contacts manage which properties - **Ownership Tracking**: Tracking property ownership across contacts - **Tenant Management**: Managing tenant-property relationships - **Contractor Assignment**: Tracking which contractors work on specific properties - **Emergency Contacts**: Managing emergency contact relationships for properties - **Vendor Management**: Tracking vendor-property service relationships  ### Response Format Returns paginated list of contact-property relationships with metadata including total count.
     * @summary Get contact-property relationships with optional viewId
     * @param {number} [viewId] The ID of the view to use for retrieving the repository
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContactPropertyRelationsAPIV4ApiInterface
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertiesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertiesResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations  ### Overview Retrieves contact-property relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between contacts and properties, representing various relationship types such as ownership, management, or tenancy.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Query Parameters - **viewId** (number, optional): View ID to apply specific filters and column selection - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Property Management**: Understanding which contacts manage which properties - **Ownership Tracking**: Tracking property ownership across contacts - **Tenant Management**: Managing tenant-property relationships - **Contractor Assignment**: Tracking which contractors work on specific properties - **Emergency Contacts**: Managing emergency contact relationships for properties - **Vendor Management**: Tracking vendor-property service relationships  ### Response Format Returns paginated list of contact-property relationships with metadata including total count.
     * Get contact-property relationships with optional viewId
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesV4(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertiesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertiesResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}/{columns}  ### Overview Retrieves specific columns of a contact-property relationship by its composite key.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Performance Optimization**: Retrieve only needed columns to reduce bandwidth - **Partial Data**: Get specific fields for lightweight operations - **Custom Views**: Build custom displays with selected relationship data
     * @summary Get specific columns of a contact-property relationship by contactId and pid
     * @param {string} columns Comma-separated list of column names
     * @param {number} contactId The unique identifier of the contact
     * @param {string} pid The pid parameter
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContactPropertyRelationsAPIV4ApiInterface
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertyColumnsResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}/{columns}  ### Overview Retrieves specific columns of a contact-property relationship by its composite key.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Performance Optimization**: Retrieve only needed columns to reduce bandwidth - **Partial Data**: Get specific fields for lightweight operations - **Custom Views**: Build custom displays with selected relationship data
     * Get specific columns of a contact-property relationship by contactId and pid
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertyColumnsResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}  ### Overview Retrieves a specific contact-property relationship by its composite key (contactId and pid).  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection  ### Business Use Cases - **Relationship Details**: Get specific details about a contact-property relationship - **Verification**: Verify the existence and type of a specific relationship - **Data Retrieval**: Fetch relationship data for forms or displays
     * @summary Get a specific contact-property relationship by contactId and pid
     * @param {number} contactId The unique identifier of the contact
     * @param {string} pid The pid parameter
     * @param {number} [viewId] The ID of the view to use for retrieving the repository
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContactPropertyRelationsAPIV4ApiInterface
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertyResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}  ### Overview Retrieves a specific contact-property relationship by its composite key (contactId and pid).  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection  ### Business Use Cases - **Relationship Details**: Get specific details about a contact-property relationship - **Verification**: Verify the existence and type of a specific relationship - **Data Retrieval**: Fetch relationship data for forms or displays
     * Get a specific contact-property relationship by contactId and pid
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertyResponseDto>;
    /**
     *  ## PATCH /v4/contact-property-relations/{contactId}/{pid}  ### Overview Updates a specific contact-property relationship by its composite key. This endpoint allows you to modify the relationship type or other metadata associated with the contact-property connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Request Body The request body should contain the fields to update within the relationship.  #### Updateable Fields - **type** (string, optional): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"relContactProperty\": {     \"type\": \"Owner\"   } } ```  ### Business Use Cases - **Role Changes**: Update a contact\'s role for a property (e.g., from tenant to owner) - **Relationship Type**: Modify the type of relationship between contact and property - **Status Updates**: Change relationship status or metadata - **Responsibility Transfer**: Update relationship when responsibilities change
     * @summary Update a contact-property relationship
     * @param {number} contactId The unique identifier of the contact
     * @param {string} pid The pid parameter
     * @param {V4ContactPropertyRelationsUpdateRelContactPropertyBodyDto} v4ContactPropertyRelationsUpdateRelContactPropertyBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContactPropertyRelationsAPIV4ApiInterface
     */
    v4ContactPropertyRelationsControllerUpdateRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerUpdateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsUpdateRelContactPropertyResponseDto>>;
    /**
     *  ## PATCH /v4/contact-property-relations/{contactId}/{pid}  ### Overview Updates a specific contact-property relationship by its composite key. This endpoint allows you to modify the relationship type or other metadata associated with the contact-property connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Request Body The request body should contain the fields to update within the relationship.  #### Updateable Fields - **type** (string, optional): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"relContactProperty\": {     \"type\": \"Owner\"   } } ```  ### Business Use Cases - **Role Changes**: Update a contact\'s role for a property (e.g., from tenant to owner) - **Relationship Type**: Modify the type of relationship between contact and property - **Status Updates**: Change relationship status or metadata - **Responsibility Transfer**: Update relationship when responsibilities change
     * Update a contact-property relationship
     */
    v4ContactPropertyRelationsControllerUpdateRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerUpdateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsUpdateRelContactPropertyResponseDto>;
}
/**
 *
 */
export declare class ContactPropertyRelationsAPIV4Api extends runtime.BaseAPI implements ContactPropertyRelationsAPIV4ApiInterface {
    /**
     *  ## POST /v4/contact-property-relations  ### Overview Creates a new relationship between a contact and a property. This endpoint allows you to establish connections between contacts and properties for various relationship types such as property management, ownership, or other associations in the real estate investment pipeline.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Request Body The request body should contain the contact and property identifiers to create the relationship.  #### Required Fields - **contactId** (number): Contact identifier - **pid** (string): Property identifier  #### Optional Fields - **type** (string): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"contactId\": 123,   \"pid\": \"property123\",   \"type\": \"Property Manager\" } ```  ### Business Use Cases - **Property Management**: Assigning property managers to specific properties - **Ownership Tracking**: Establishing property ownership relationships - **Tenant Management**: Connecting tenants to their rental properties - **Contractor Assignment**: Linking contractors to properties for maintenance - **Agent Assignment**: Assigning real estate agents to property listings - **Vendor Management**: Connecting vendors to properties for services - **Emergency Contacts**: Establishing emergency contact relationships for properties
     * Create a new contact-property relationship
     */
    v4ContactPropertyRelationsControllerCreateRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerCreateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsCreateRelContactPropertyResponseDto>>;
    /**
     *  ## POST /v4/contact-property-relations  ### Overview Creates a new relationship between a contact and a property. This endpoint allows you to establish connections between contacts and properties for various relationship types such as property management, ownership, or other associations in the real estate investment pipeline.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Request Body The request body should contain the contact and property identifiers to create the relationship.  #### Required Fields - **contactId** (number): Contact identifier - **pid** (string): Property identifier  #### Optional Fields - **type** (string): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"contactId\": 123,   \"pid\": \"property123\",   \"type\": \"Property Manager\" } ```  ### Business Use Cases - **Property Management**: Assigning property managers to specific properties - **Ownership Tracking**: Establishing property ownership relationships - **Tenant Management**: Connecting tenants to their rental properties - **Contractor Assignment**: Linking contractors to properties for maintenance - **Agent Assignment**: Assigning real estate agents to property listings - **Vendor Management**: Connecting vendors to properties for services - **Emergency Contacts**: Establishing emergency contact relationships for properties
     * Create a new contact-property relationship
     */
    v4ContactPropertyRelationsControllerCreateRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerCreateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsCreateRelContactPropertyResponseDto>;
    /**
     *  ## DELETE /v4/contact-property-relations/{contactId}/{pid}  ### Overview Deletes a specific contact-property relationship by its composite key. This endpoint removes the association between a contact and property, effectively severing their connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Business Use Cases - **Relationship Termination**: Remove contacts when their role with a property ends - **Property Management Changes**: Unassign property managers during transitions - **Tenant Move-out**: Remove tenant relationships when they vacate - **Ownership Transfer**: Remove previous owners during property sales - **Contract Completion**: Remove contractor relationships after work completion - **Cleanup Operations**: Remove outdated or incorrect associations - **Data Management**: Clean up duplicate or erroneous relationships  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance - May affect related business processes and notifications
     * Delete a contact-property relationship
     */
    v4ContactPropertyRelationsControllerDeleteRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerDeleteRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsDeleteRelContactPropertyResponseDto>>;
    /**
     *  ## DELETE /v4/contact-property-relations/{contactId}/{pid}  ### Overview Deletes a specific contact-property relationship by its composite key. This endpoint removes the association between a contact and property, effectively severing their connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Business Use Cases - **Relationship Termination**: Remove contacts when their role with a property ends - **Property Management Changes**: Unassign property managers during transitions - **Tenant Move-out**: Remove tenant relationships when they vacate - **Ownership Transfer**: Remove previous owners during property sales - **Contract Completion**: Remove contractor relationships after work completion - **Cleanup Operations**: Remove outdated or incorrect associations - **Data Management**: Clean up duplicate or erroneous relationships  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance - May affect related business processes and notifications
     * Delete a contact-property relationship
     */
    v4ContactPropertyRelationsControllerDeleteRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerDeleteRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsDeleteRelContactPropertyResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations/viewId/{viewId}  ### Overview Retrieves contact-property relationships for a specific view ID with optional filtering and pagination. This endpoint provides access to relationships filtered by a predefined view configuration.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): View ID to apply specific filters and column selection  ### Query Parameters - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Filtered Views**: Access predefined filtered sets of contact-property relationships - **Dashboard Data**: Populate dashboard views with specific relationship data - **Reporting**: Generate reports based on predefined view configurations
     * Get contact-property relationships with a specific viewId
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertiesInViewResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations/viewId/{viewId}  ### Overview Retrieves contact-property relationships for a specific view ID with optional filtering and pagination. This endpoint provides access to relationships filtered by a predefined view configuration.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): View ID to apply specific filters and column selection  ### Query Parameters - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Filtered Views**: Access predefined filtered sets of contact-property relationships - **Dashboard Data**: Populate dashboard views with specific relationship data - **Reporting**: Generate reports based on predefined view configurations
     * Get contact-property relationships with a specific viewId
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertiesInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertiesInViewResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations  ### Overview Retrieves contact-property relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between contacts and properties, representing various relationship types such as ownership, management, or tenancy.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Query Parameters - **viewId** (number, optional): View ID to apply specific filters and column selection - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Property Management**: Understanding which contacts manage which properties - **Ownership Tracking**: Tracking property ownership across contacts - **Tenant Management**: Managing tenant-property relationships - **Contractor Assignment**: Tracking which contractors work on specific properties - **Emergency Contacts**: Managing emergency contact relationships for properties - **Vendor Management**: Tracking vendor-property service relationships  ### Response Format Returns paginated list of contact-property relationships with metadata including total count.
     * Get contact-property relationships with optional viewId
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertiesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertiesResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations  ### Overview Retrieves contact-property relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between contacts and properties, representing various relationship types such as ownership, management, or tenancy.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Query Parameters - **viewId** (number, optional): View ID to apply specific filters and column selection - **limit** (number, optional): Maximum number of relationships to return (default: 20, max: 100) - **offset** (number, optional): Number of relationships to skip for pagination (default: 0) - **countOnly** (boolean, optional): Return only the count without actual data  ### Business Use Cases - **Property Management**: Understanding which contacts manage which properties - **Ownership Tracking**: Tracking property ownership across contacts - **Tenant Management**: Managing tenant-property relationships - **Contractor Assignment**: Tracking which contractors work on specific properties - **Emergency Contacts**: Managing emergency contact relationships for properties - **Vendor Management**: Tracking vendor-property service relationships  ### Response Format Returns paginated list of contact-property relationships with metadata including total count.
     * Get contact-property relationships with optional viewId
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertiesV4(requestParameters?: V4ContactPropertyRelationsControllerGetRelContactPropertiesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertiesResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}/{columns}  ### Overview Retrieves specific columns of a contact-property relationship by its composite key.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Performance Optimization**: Retrieve only needed columns to reduce bandwidth - **Partial Data**: Get specific fields for lightweight operations - **Custom Views**: Build custom displays with selected relationship data
     * Get specific columns of a contact-property relationship by contactId and pid
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertyColumnsResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}/{columns}  ### Overview Retrieves specific columns of a contact-property relationship by its composite key.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Performance Optimization**: Retrieve only needed columns to reduce bandwidth - **Partial Data**: Get specific fields for lightweight operations - **Custom Views**: Build custom displays with selected relationship data
     * Get specific columns of a contact-property relationship by contactId and pid
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertyColumnsResponseDto>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}  ### Overview Retrieves a specific contact-property relationship by its composite key (contactId and pid).  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection  ### Business Use Cases - **Relationship Details**: Get specific details about a contact-property relationship - **Verification**: Verify the existence and type of a specific relationship - **Data Retrieval**: Fetch relationship data for forms or displays
     * Get a specific contact-property relationship by contactId and pid
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsGetRelContactPropertyResponseDto>>;
    /**
     *  ## GET /v4/contact-property-relations/{contactId}/{pid}  ### Overview Retrieves a specific contact-property relationship by its composite key (contactId and pid).  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Contact identifier - **pid** (string, required): Property identifier  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection  ### Business Use Cases - **Relationship Details**: Get specific details about a contact-property relationship - **Verification**: Verify the existence and type of a specific relationship - **Data Retrieval**: Fetch relationship data for forms or displays
     * Get a specific contact-property relationship by contactId and pid
     */
    v4ContactPropertyRelationsControllerGetRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerGetRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsGetRelContactPropertyResponseDto>;
    /**
     *  ## PATCH /v4/contact-property-relations/{contactId}/{pid}  ### Overview Updates a specific contact-property relationship by its composite key. This endpoint allows you to modify the relationship type or other metadata associated with the contact-property connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Request Body The request body should contain the fields to update within the relationship.  #### Updateable Fields - **type** (string, optional): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"relContactProperty\": {     \"type\": \"Owner\"   } } ```  ### Business Use Cases - **Role Changes**: Update a contact\'s role for a property (e.g., from tenant to owner) - **Relationship Type**: Modify the type of relationship between contact and property - **Status Updates**: Change relationship status or metadata - **Responsibility Transfer**: Update relationship when responsibilities change
     * Update a contact-property relationship
     */
    v4ContactPropertyRelationsControllerUpdateRelContactPropertyV4Raw(requestParameters: V4ContactPropertyRelationsControllerUpdateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContactPropertyRelationsUpdateRelContactPropertyResponseDto>>;
    /**
     *  ## PATCH /v4/contact-property-relations/{contactId}/{pid}  ### Overview Updates a specific contact-property relationship by its composite key. This endpoint allows you to modify the relationship type or other metadata associated with the contact-property connection.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **contactId** (number, required): Unique identifier for the contact - **pid** (string, required): Unique identifier for the property  ### Request Body The request body should contain the fields to update within the relationship.  #### Updateable Fields - **type** (string, optional): Type of relationship (e.g., \"Property Manager\", \"Owner\", \"Tenant\")  ### Request Body Example ```json {   \"relContactProperty\": {     \"type\": \"Owner\"   } } ```  ### Business Use Cases - **Role Changes**: Update a contact\'s role for a property (e.g., from tenant to owner) - **Relationship Type**: Modify the type of relationship between contact and property - **Status Updates**: Change relationship status or metadata - **Responsibility Transfer**: Update relationship when responsibilities change
     * Update a contact-property relationship
     */
    v4ContactPropertyRelationsControllerUpdateRelContactPropertyV4(requestParameters: V4ContactPropertyRelationsControllerUpdateRelContactPropertyV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContactPropertyRelationsUpdateRelContactPropertyResponseDto>;
}
//# sourceMappingURL=ContactPropertyRelationsAPIV4Api.d.ts.map