@simplyhomes/sos-sdk/dist/generated/src/apis/RelLeadUsersAPIV4Api.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 { V4LeadUserRelationsCreateRelLeadUserBodyDto, V4LeadUserRelationsCreateRelLeadUserResponseDto, V4LeadUserRelationsDeleteRelLeadUserResponseDto, V4LeadUserRelationsGetRelLeadUserColumnsResponseDto, V4LeadUserRelationsGetRelLeadUserResponseDto, V4LeadUserRelationsGetRelLeadUsersInViewResponseDto, V4LeadUserRelationsGetRelLeadUsersResponseDto, V4LeadUserRelationsUpdateRelLeadUserBodyDto, V4LeadUserRelationsUpdateRelLeadUserResponseDto } from '../models/index';
export interface V4LeadUserRelationsControllerCreateRelLeadUserV4Request {
    v4LeadUserRelationsCreateRelLeadUserBodyDto: V4LeadUserRelationsCreateRelLeadUserBodyDto;
}
export interface V4LeadUserRelationsControllerDeleteRelLeadUserV4Request {
    leadId: number;
    userId: string;
}
export interface V4LeadUserRelationsControllerGetRelLeadUserColumnsV4Request {
    columns: string;
    leadId: number;
    userId: string;
}
export interface V4LeadUserRelationsControllerGetRelLeadUserV4Request {
    leadId: number;
    userId: string;
    viewId?: number;
}
export interface V4LeadUserRelationsControllerGetRelLeadUsersInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4LeadUserRelationsControllerGetRelLeadUsersV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4LeadUserRelationsControllerUpdateRelLeadUserV4Request {
    leadId: number;
    userId: string;
    v4LeadUserRelationsUpdateRelLeadUserBodyDto: V4LeadUserRelationsUpdateRelLeadUserBodyDto;
}
/**
 * RelLeadUsersAPIV4Api - interface
 *
 * @export
 * @interface RelLeadUsersAPIV4ApiInterface
 */
export interface RelLeadUsersAPIV4ApiInterface {
    /**
     *  ## POST /v4/rel-lead-users  ### Overview Creates a new relationship between a lead and a user. This endpoint allows you to assign leads to users for management, ownership, or follow-up responsibilities 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 lead and user identifiers to create the relationship.  #### Required Fields - **leadId** (number): Lead identifier - **userId** (number): User identifier  ### Request Body Example ```json {   \"leadId\": 123,   \"userId\": 456 } ```  ### Business Use Cases - **Lead Assignment**: Assigning leads to specific users for follow-up - **Ownership Management**: Establishing lead ownership and responsibility - **Team Coordination**: Distributing leads across team members - **Workflow Management**: Managing the flow of leads through the sales process - **Performance Tracking**: Connecting users to leads for performance analysis - **Territory Assignment**: Assigning leads based on geographic territories - **Specialization**: Assigning leads based on user expertise areas
     * @summary Create a new rel-lead-user
     * @param {V4LeadUserRelationsCreateRelLeadUserBodyDto} v4LeadUserRelationsCreateRelLeadUserBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RelLeadUsersAPIV4ApiInterface
     */
    v4LeadUserRelationsControllerCreateRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerCreateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsCreateRelLeadUserResponseDto>>;
    /**
     *  ## POST /v4/rel-lead-users  ### Overview Creates a new relationship between a lead and a user. This endpoint allows you to assign leads to users for management, ownership, or follow-up responsibilities 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 lead and user identifiers to create the relationship.  #### Required Fields - **leadId** (number): Lead identifier - **userId** (number): User identifier  ### Request Body Example ```json {   \"leadId\": 123,   \"userId\": 456 } ```  ### Business Use Cases - **Lead Assignment**: Assigning leads to specific users for follow-up - **Ownership Management**: Establishing lead ownership and responsibility - **Team Coordination**: Distributing leads across team members - **Workflow Management**: Managing the flow of leads through the sales process - **Performance Tracking**: Connecting users to leads for performance analysis - **Territory Assignment**: Assigning leads based on geographic territories - **Specialization**: Assigning leads based on user expertise areas
     * Create a new rel-lead-user
     */
    v4LeadUserRelationsControllerCreateRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerCreateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsCreateRelLeadUserResponseDto>;
    /**
     *  ## DELETE /v4/rel-lead-users/{leadId}/{userId}  ### Overview Deletes a specific lead-user relationship by its composite key. This endpoint removes the association between a lead and user, effectively unassigning the lead from the user.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Business Use Cases - **Lead Reassignment**: Remove current assignment before reassigning to another user - **Team Changes**: Unassign leads when team members change roles or leave - **Workflow Management**: Remove assignments when leads move to different stages - **Cleanup Operations**: Remove outdated or incorrect assignments - **Territory Changes**: Unassign leads during territory restructuring  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance
     * @summary Delete a specific rel-lead-user by leadId and userId
     * @param {number} leadId The unique identifier of the lead
     * @param {string} userId The unique identifier of the user
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RelLeadUsersAPIV4ApiInterface
     */
    v4LeadUserRelationsControllerDeleteRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerDeleteRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsDeleteRelLeadUserResponseDto>>;
    /**
     *  ## DELETE /v4/rel-lead-users/{leadId}/{userId}  ### Overview Deletes a specific lead-user relationship by its composite key. This endpoint removes the association between a lead and user, effectively unassigning the lead from the user.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Business Use Cases - **Lead Reassignment**: Remove current assignment before reassigning to another user - **Team Changes**: Unassign leads when team members change roles or leave - **Workflow Management**: Remove assignments when leads move to different stages - **Cleanup Operations**: Remove outdated or incorrect assignments - **Territory Changes**: Unassign leads during territory restructuring  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance
     * Delete a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerDeleteRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerDeleteRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsDeleteRelLeadUserResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}/{columns}  ### Overview Retrieves specific columns of a lead-user relationship by its composite key. This endpoint allows you to get only the specified columns/fields of a particular relationship, which is useful for optimizing data transfer and focusing on specific information.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Optimized Queries**: Retrieve only the needed columns to reduce data transfer - **Specific Information**: Get targeted information from relationships - **Performance Optimization**: Minimize payload size for better performance - **Custom Data Views**: Create custom data views with specific column sets
     * @summary Get specific columns of a rel-lead-user by leadId and userId
     * @param {string} columns Comma-separated list of column names
     * @param {number} leadId The unique identifier of the lead
     * @param {string} userId The unique identifier of the user
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RelLeadUsersAPIV4ApiInterface
     */
    v4LeadUserRelationsControllerGetRelLeadUserColumnsV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUserColumnsResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}/{columns}  ### Overview Retrieves specific columns of a lead-user relationship by its composite key. This endpoint allows you to get only the specified columns/fields of a particular relationship, which is useful for optimizing data transfer and focusing on specific information.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Optimized Queries**: Retrieve only the needed columns to reduce data transfer - **Specific Information**: Get targeted information from relationships - **Performance Optimization**: Minimize payload size for better performance - **Custom Data Views**: Create custom data views with specific column sets
     * Get specific columns of a rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerGetRelLeadUserColumnsV4(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUserColumnsResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}  ### Overview Retrieves a specific lead-user relationship by its composite key (leadId and userId). This endpoint allows you to get detailed information about a particular assignment or ownership relationship.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection and related data  ### Business Use Cases - **Assignment Verification**: Verify if a specific user is assigned to a lead - **Relationship Details**: Get detailed information about a lead-user relationship - **Audit Trail**: Track specific assignment relationships for compliance - **Status Checking**: Check the status of a particular assignment
     * @summary Get a specific rel-lead-user by leadId and userId
     * @param {number} leadId The unique identifier of the lead
     * @param {string} userId The unique identifier of the user
     * @param {number} [viewId] The ID of the view to use for retrieving the repository
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RelLeadUsersAPIV4ApiInterface
     */
    v4LeadUserRelationsControllerGetRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUserResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}  ### Overview Retrieves a specific lead-user relationship by its composite key (leadId and userId). This endpoint allows you to get detailed information about a particular assignment or ownership relationship.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection and related data  ### Business Use Cases - **Assignment Verification**: Verify if a specific user is assigned to a lead - **Relationship Details**: Get detailed information about a lead-user relationship - **Audit Trail**: Track specific assignment relationships for compliance - **Status Checking**: Check the status of a particular assignment
     * Get a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerGetRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUserResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users/viewId/{viewId}  ### Overview Retrieves lead-user relationships filtered by a specific view configuration. This endpoint allows you to get relationships with pre-defined filters, sorting, and column selections based on the view settings.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): The ID of the view to apply 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 - **Custom Views**: Apply saved view configurations for specific business needs - **Team Views**: Get relationships filtered by team-specific criteria - **Status Views**: Filter relationships by assignment status or activity - **Performance Views**: Apply filters for performance analysis and reporting
     * @summary Get rel-lead-users 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 RelLeadUsersAPIV4ApiInterface
     */
    v4LeadUserRelationsControllerGetRelLeadUsersInViewV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUsersInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUsersInViewResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users/viewId/{viewId}  ### Overview Retrieves lead-user relationships filtered by a specific view configuration. This endpoint allows you to get relationships with pre-defined filters, sorting, and column selections based on the view settings.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): The ID of the view to apply 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 - **Custom Views**: Apply saved view configurations for specific business needs - **Team Views**: Get relationships filtered by team-specific criteria - **Status Views**: Filter relationships by assignment status or activity - **Performance Views**: Apply filters for performance analysis and reporting
     * Get rel-lead-users with a specific viewId
     */
    v4LeadUserRelationsControllerGetRelLeadUsersInViewV4(requestParameters: V4LeadUserRelationsControllerGetRelLeadUsersInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUsersInViewResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users  ### Overview Retrieves lead-user relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between leads and users, typically representing assignment or ownership relationships in the real estate investment pipeline.  ### 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 - **Lead Assignment**: Understanding which users are assigned to which leads - **Ownership Tracking**: Tracking lead ownership and responsibility across team members - **Team Management**: Managing lead distribution and workload balance - **Performance Analysis**: Analyzing user performance with lead conversions - **Workload Distribution**: Balancing lead assignments for optimal productivity - **Territory Management**: Managing lead assignments by geographic or specialty areas  ### Response Format Returns paginated list of lead-user relationships with metadata including total count.
     * @summary Get rel-lead-users 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 RelLeadUsersAPIV4ApiInterface
     */
    v4LeadUserRelationsControllerGetRelLeadUsersV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUsersV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUsersResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users  ### Overview Retrieves lead-user relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between leads and users, typically representing assignment or ownership relationships in the real estate investment pipeline.  ### 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 - **Lead Assignment**: Understanding which users are assigned to which leads - **Ownership Tracking**: Tracking lead ownership and responsibility across team members - **Team Management**: Managing lead distribution and workload balance - **Performance Analysis**: Analyzing user performance with lead conversions - **Workload Distribution**: Balancing lead assignments for optimal productivity - **Territory Management**: Managing lead assignments by geographic or specialty areas  ### Response Format Returns paginated list of lead-user relationships with metadata including total count.
     * Get rel-lead-users with optional viewId
     */
    v4LeadUserRelationsControllerGetRelLeadUsersV4(requestParameters: V4LeadUserRelationsControllerGetRelLeadUsersV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUsersResponseDto>;
    /**
     *  ## PATCH /v4/rel-lead-users/{leadId}/{userId}  ### Overview Updates a specific lead-user relationship by its composite key. Note that relationship tables typically have minimal updateable fields since they primarily manage associations between entities.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Request Body The request body should contain the fields to update. For relationship tables, this is typically empty or contains metadata fields.  ### Business Use Cases - **Relationship Metadata**: Update any metadata associated with the relationship - **Status Changes**: Modify relationship status or flags if applicable - **Audit Trail**: Update relationship audit information  ### Note This endpoint is rarely used for pure relationship tables as they typically only contain foreign keys. It\'s included for API completeness and future extensibility.
     * @summary Update a specific rel-lead-user by leadId and userId
     * @param {number} leadId The unique identifier of the lead
     * @param {string} userId The unique identifier of the user
     * @param {V4LeadUserRelationsUpdateRelLeadUserBodyDto} v4LeadUserRelationsUpdateRelLeadUserBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RelLeadUsersAPIV4ApiInterface
     */
    v4LeadUserRelationsControllerUpdateRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerUpdateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsUpdateRelLeadUserResponseDto>>;
    /**
     *  ## PATCH /v4/rel-lead-users/{leadId}/{userId}  ### Overview Updates a specific lead-user relationship by its composite key. Note that relationship tables typically have minimal updateable fields since they primarily manage associations between entities.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Request Body The request body should contain the fields to update. For relationship tables, this is typically empty or contains metadata fields.  ### Business Use Cases - **Relationship Metadata**: Update any metadata associated with the relationship - **Status Changes**: Modify relationship status or flags if applicable - **Audit Trail**: Update relationship audit information  ### Note This endpoint is rarely used for pure relationship tables as they typically only contain foreign keys. It\'s included for API completeness and future extensibility.
     * Update a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerUpdateRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerUpdateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsUpdateRelLeadUserResponseDto>;
}
/**
 *
 */
export declare class RelLeadUsersAPIV4Api extends runtime.BaseAPI implements RelLeadUsersAPIV4ApiInterface {
    /**
     *  ## POST /v4/rel-lead-users  ### Overview Creates a new relationship between a lead and a user. This endpoint allows you to assign leads to users for management, ownership, or follow-up responsibilities 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 lead and user identifiers to create the relationship.  #### Required Fields - **leadId** (number): Lead identifier - **userId** (number): User identifier  ### Request Body Example ```json {   \"leadId\": 123,   \"userId\": 456 } ```  ### Business Use Cases - **Lead Assignment**: Assigning leads to specific users for follow-up - **Ownership Management**: Establishing lead ownership and responsibility - **Team Coordination**: Distributing leads across team members - **Workflow Management**: Managing the flow of leads through the sales process - **Performance Tracking**: Connecting users to leads for performance analysis - **Territory Assignment**: Assigning leads based on geographic territories - **Specialization**: Assigning leads based on user expertise areas
     * Create a new rel-lead-user
     */
    v4LeadUserRelationsControllerCreateRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerCreateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsCreateRelLeadUserResponseDto>>;
    /**
     *  ## POST /v4/rel-lead-users  ### Overview Creates a new relationship between a lead and a user. This endpoint allows you to assign leads to users for management, ownership, or follow-up responsibilities 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 lead and user identifiers to create the relationship.  #### Required Fields - **leadId** (number): Lead identifier - **userId** (number): User identifier  ### Request Body Example ```json {   \"leadId\": 123,   \"userId\": 456 } ```  ### Business Use Cases - **Lead Assignment**: Assigning leads to specific users for follow-up - **Ownership Management**: Establishing lead ownership and responsibility - **Team Coordination**: Distributing leads across team members - **Workflow Management**: Managing the flow of leads through the sales process - **Performance Tracking**: Connecting users to leads for performance analysis - **Territory Assignment**: Assigning leads based on geographic territories - **Specialization**: Assigning leads based on user expertise areas
     * Create a new rel-lead-user
     */
    v4LeadUserRelationsControllerCreateRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerCreateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsCreateRelLeadUserResponseDto>;
    /**
     *  ## DELETE /v4/rel-lead-users/{leadId}/{userId}  ### Overview Deletes a specific lead-user relationship by its composite key. This endpoint removes the association between a lead and user, effectively unassigning the lead from the user.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Business Use Cases - **Lead Reassignment**: Remove current assignment before reassigning to another user - **Team Changes**: Unassign leads when team members change roles or leave - **Workflow Management**: Remove assignments when leads move to different stages - **Cleanup Operations**: Remove outdated or incorrect assignments - **Territory Changes**: Unassign leads during territory restructuring  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance
     * Delete a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerDeleteRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerDeleteRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsDeleteRelLeadUserResponseDto>>;
    /**
     *  ## DELETE /v4/rel-lead-users/{leadId}/{userId}  ### Overview Deletes a specific lead-user relationship by its composite key. This endpoint removes the association between a lead and user, effectively unassigning the lead from the user.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Business Use Cases - **Lead Reassignment**: Remove current assignment before reassigning to another user - **Team Changes**: Unassign leads when team members change roles or leave - **Workflow Management**: Remove assignments when leads move to different stages - **Cleanup Operations**: Remove outdated or incorrect assignments - **Territory Changes**: Unassign leads during territory restructuring  ### Important Notes - This operation is irreversible - Ensure proper authorization before deleting relationships - Consider audit trail requirements for compliance
     * Delete a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerDeleteRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerDeleteRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsDeleteRelLeadUserResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}/{columns}  ### Overview Retrieves specific columns of a lead-user relationship by its composite key. This endpoint allows you to get only the specified columns/fields of a particular relationship, which is useful for optimizing data transfer and focusing on specific information.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Optimized Queries**: Retrieve only the needed columns to reduce data transfer - **Specific Information**: Get targeted information from relationships - **Performance Optimization**: Minimize payload size for better performance - **Custom Data Views**: Create custom data views with specific column sets
     * Get specific columns of a rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerGetRelLeadUserColumnsV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUserColumnsResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}/{columns}  ### Overview Retrieves specific columns of a lead-user relationship by its composite key. This endpoint allows you to get only the specified columns/fields of a particular relationship, which is useful for optimizing data transfer and focusing on specific information.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user - **columns** (string, required): Comma-separated list of column names to retrieve  ### Business Use Cases - **Optimized Queries**: Retrieve only the needed columns to reduce data transfer - **Specific Information**: Get targeted information from relationships - **Performance Optimization**: Minimize payload size for better performance - **Custom Data Views**: Create custom data views with specific column sets
     * Get specific columns of a rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerGetRelLeadUserColumnsV4(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUserColumnsResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}  ### Overview Retrieves a specific lead-user relationship by its composite key (leadId and userId). This endpoint allows you to get detailed information about a particular assignment or ownership relationship.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection and related data  ### Business Use Cases - **Assignment Verification**: Verify if a specific user is assigned to a lead - **Relationship Details**: Get detailed information about a lead-user relationship - **Audit Trail**: Track specific assignment relationships for compliance - **Status Checking**: Check the status of a particular assignment
     * Get a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerGetRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUserResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users/{leadId}/{userId}  ### Overview Retrieves a specific lead-user relationship by its composite key (leadId and userId). This endpoint allows you to get detailed information about a particular assignment or ownership relationship.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Query Parameters - **viewId** (number, optional): View ID to apply specific column selection and related data  ### Business Use Cases - **Assignment Verification**: Verify if a specific user is assigned to a lead - **Relationship Details**: Get detailed information about a lead-user relationship - **Audit Trail**: Track specific assignment relationships for compliance - **Status Checking**: Check the status of a particular assignment
     * Get a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerGetRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerGetRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUserResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users/viewId/{viewId}  ### Overview Retrieves lead-user relationships filtered by a specific view configuration. This endpoint allows you to get relationships with pre-defined filters, sorting, and column selections based on the view settings.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): The ID of the view to apply 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 - **Custom Views**: Apply saved view configurations for specific business needs - **Team Views**: Get relationships filtered by team-specific criteria - **Status Views**: Filter relationships by assignment status or activity - **Performance Views**: Apply filters for performance analysis and reporting
     * Get rel-lead-users with a specific viewId
     */
    v4LeadUserRelationsControllerGetRelLeadUsersInViewV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUsersInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUsersInViewResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users/viewId/{viewId}  ### Overview Retrieves lead-user relationships filtered by a specific view configuration. This endpoint allows you to get relationships with pre-defined filters, sorting, and column selections based on the view settings.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **viewId** (number, required): The ID of the view to apply 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 - **Custom Views**: Apply saved view configurations for specific business needs - **Team Views**: Get relationships filtered by team-specific criteria - **Status Views**: Filter relationships by assignment status or activity - **Performance Views**: Apply filters for performance analysis and reporting
     * Get rel-lead-users with a specific viewId
     */
    v4LeadUserRelationsControllerGetRelLeadUsersInViewV4(requestParameters: V4LeadUserRelationsControllerGetRelLeadUsersInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUsersInViewResponseDto>;
    /**
     *  ## GET /v4/rel-lead-users  ### Overview Retrieves lead-user relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between leads and users, typically representing assignment or ownership relationships in the real estate investment pipeline.  ### 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 - **Lead Assignment**: Understanding which users are assigned to which leads - **Ownership Tracking**: Tracking lead ownership and responsibility across team members - **Team Management**: Managing lead distribution and workload balance - **Performance Analysis**: Analyzing user performance with lead conversions - **Workload Distribution**: Balancing lead assignments for optimal productivity - **Territory Management**: Managing lead assignments by geographic or specialty areas  ### Response Format Returns paginated list of lead-user relationships with metadata including total count.
     * Get rel-lead-users with optional viewId
     */
    v4LeadUserRelationsControllerGetRelLeadUsersV4Raw(requestParameters: V4LeadUserRelationsControllerGetRelLeadUsersV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsGetRelLeadUsersResponseDto>>;
    /**
     *  ## GET /v4/rel-lead-users  ### Overview Retrieves lead-user relationships with optional filtering, sorting, and pagination capabilities. This endpoint provides access to the associations between leads and users, typically representing assignment or ownership relationships in the real estate investment pipeline.  ### 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 - **Lead Assignment**: Understanding which users are assigned to which leads - **Ownership Tracking**: Tracking lead ownership and responsibility across team members - **Team Management**: Managing lead distribution and workload balance - **Performance Analysis**: Analyzing user performance with lead conversions - **Workload Distribution**: Balancing lead assignments for optimal productivity - **Territory Management**: Managing lead assignments by geographic or specialty areas  ### Response Format Returns paginated list of lead-user relationships with metadata including total count.
     * Get rel-lead-users with optional viewId
     */
    v4LeadUserRelationsControllerGetRelLeadUsersV4(requestParameters?: V4LeadUserRelationsControllerGetRelLeadUsersV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsGetRelLeadUsersResponseDto>;
    /**
     *  ## PATCH /v4/rel-lead-users/{leadId}/{userId}  ### Overview Updates a specific lead-user relationship by its composite key. Note that relationship tables typically have minimal updateable fields since they primarily manage associations between entities.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Request Body The request body should contain the fields to update. For relationship tables, this is typically empty or contains metadata fields.  ### Business Use Cases - **Relationship Metadata**: Update any metadata associated with the relationship - **Status Changes**: Modify relationship status or flags if applicable - **Audit Trail**: Update relationship audit information  ### Note This endpoint is rarely used for pure relationship tables as they typically only contain foreign keys. It\'s included for API completeness and future extensibility.
     * Update a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerUpdateRelLeadUserV4Raw(requestParameters: V4LeadUserRelationsControllerUpdateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeadUserRelationsUpdateRelLeadUserResponseDto>>;
    /**
     *  ## PATCH /v4/rel-lead-users/{leadId}/{userId}  ### Overview Updates a specific lead-user relationship by its composite key. Note that relationship tables typically have minimal updateable fields since they primarily manage associations between entities.  ### Authentication - **x-api-key**: Required API key for authentication - **organization-id**: Required organization identifier in header  ### Path Parameters - **leadId** (number, required): Unique identifier for the lead - **userId** (number, required): Unique identifier for the user  ### Request Body The request body should contain the fields to update. For relationship tables, this is typically empty or contains metadata fields.  ### Business Use Cases - **Relationship Metadata**: Update any metadata associated with the relationship - **Status Changes**: Modify relationship status or flags if applicable - **Audit Trail**: Update relationship audit information  ### Note This endpoint is rarely used for pure relationship tables as they typically only contain foreign keys. It\'s included for API completeness and future extensibility.
     * Update a specific rel-lead-user by leadId and userId
     */
    v4LeadUserRelationsControllerUpdateRelLeadUserV4(requestParameters: V4LeadUserRelationsControllerUpdateRelLeadUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeadUserRelationsUpdateRelLeadUserResponseDto>;
}
//# sourceMappingURL=RelLeadUsersAPIV4Api.d.ts.map