@simplyhomes/sos-sdk/dist/generated/src/apis/NeighborhoodsAPIV4Api.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 { V4NeighborhoodsGetNeighborhoodColumnsResponseDto, V4NeighborhoodsGetNeighborhoodResponseDto, V4NeighborhoodsGetNeighborhoodsInViewResponseDto, V4NeighborhoodsGetNeighborhoodsResponseDto, V4NeighborhoodsUpdateNeighborhoodBodyDto, V4NeighborhoodsUpdateNeighborhoodResponseDto } from '../models/index';
export interface V4NeighborhoodsControllerGetNeighborhoodColumnsV4Request {
    columns: string;
    neighborhoodId: string;
}
export interface V4NeighborhoodsControllerGetNeighborhoodV4Request {
    neighborhoodId: string;
    viewId?: number;
}
export interface V4NeighborhoodsControllerGetNeighborhoodsInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4NeighborhoodsControllerGetNeighborhoodsV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4NeighborhoodsControllerUpdateNeighborhoodV4Request {
    neighborhoodId: string;
    v4NeighborhoodsUpdateNeighborhoodBodyDto: V4NeighborhoodsUpdateNeighborhoodBodyDto;
}
/**
 * NeighborhoodsAPIV4Api - interface
 *
 * @export
 * @interface NeighborhoodsAPIV4ApiInterface
 */
export interface NeighborhoodsAPIV4ApiInterface {
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}/{columns}  ## Overview Retrieves specific columns of a neighborhood by its unique identifier. This endpoint allows you to fetch only the data you need, improving performance and reducing bandwidth usage by specifying exactly which neighborhood attributes to return.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve | | `columns` | string | Yes | Comma-separated list of column names to return |  ## Column Selection  Available columns include: - **nid**: Neighborhood identifier - **name**: Neighborhood name - **description**: Neighborhood description - **city**: City name - **state**: State abbreviation - **zip**: ZIP/postal code - **coordinates**: Geographic coordinates - **boundaries**: Neighborhood boundaries - **status**: Current status - **marketId**: Associated market ID - **countyId**: County identifier - **demographics**: Demographic information - **economicIndicators**: Economic data - **createdAt**: Creation timestamp - **updatedAt**: Last update timestamp  ## Response Structure  Returns only the requested columns for the specified neighborhood, maintaining the same object structure but with limited fields.  ## Use Cases  - Performance optimization for specific use cases - Reducing bandwidth usage in mobile applications - Fetching only required data for forms or displays - Supporting lightweight API integrations - Building custom data exports with specific fields
     * @summary Get specific columns of a neighborhood by neighborhoodId
     * @param {string} columns Comma-separated list of column names
     * @param {string} neighborhoodId The unique identifier of the neighborhood
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NeighborhoodsAPIV4ApiInterface
     */
    v4NeighborhoodsControllerGetNeighborhoodColumnsV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodColumnsResponseDto>>;
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}/{columns}  ## Overview Retrieves specific columns of a neighborhood by its unique identifier. This endpoint allows you to fetch only the data you need, improving performance and reducing bandwidth usage by specifying exactly which neighborhood attributes to return.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve | | `columns` | string | Yes | Comma-separated list of column names to return |  ## Column Selection  Available columns include: - **nid**: Neighborhood identifier - **name**: Neighborhood name - **description**: Neighborhood description - **city**: City name - **state**: State abbreviation - **zip**: ZIP/postal code - **coordinates**: Geographic coordinates - **boundaries**: Neighborhood boundaries - **status**: Current status - **marketId**: Associated market ID - **countyId**: County identifier - **demographics**: Demographic information - **economicIndicators**: Economic data - **createdAt**: Creation timestamp - **updatedAt**: Last update timestamp  ## Response Structure  Returns only the requested columns for the specified neighborhood, maintaining the same object structure but with limited fields.  ## Use Cases  - Performance optimization for specific use cases - Reducing bandwidth usage in mobile applications - Fetching only required data for forms or displays - Supporting lightweight API integrations - Building custom data exports with specific fields
     * Get specific columns of a neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerGetNeighborhoodColumnsV4(requestParameters: V4NeighborhoodsControllerGetNeighborhoodColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodColumnsResponseDto>;
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}  ## Overview Retrieves detailed information for a specific neighborhood by its unique identifier. This endpoint returns comprehensive neighborhood data including geographic boundaries, demographics, and market information.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply column selections and formatting |  ## Response Structure  Returns detailed information for the specified neighborhood, including all available attributes and related data.  ## Use Cases  - Displaying detailed neighborhood profiles - Populating neighborhood edit forms - Generating neighborhood-specific reports - Supporting neighborhood selection interfaces - Integrating neighborhood data into property analysis
     * @summary Get a specific neighborhood by neighborhoodId
     * @param {string} neighborhoodId The unique identifier of the neighborhood
     * @param {number} [viewId] The ID of the view to use for retrieving the repository
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NeighborhoodsAPIV4ApiInterface
     */
    v4NeighborhoodsControllerGetNeighborhoodV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodResponseDto>>;
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}  ## Overview Retrieves detailed information for a specific neighborhood by its unique identifier. This endpoint returns comprehensive neighborhood data including geographic boundaries, demographics, and market information.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply column selections and formatting |  ## Response Structure  Returns detailed information for the specified neighborhood, including all available attributes and related data.  ## Use Cases  - Displaying detailed neighborhood profiles - Populating neighborhood edit forms - Generating neighborhood-specific reports - Supporting neighborhood selection interfaces - Integrating neighborhood data into property analysis
     * Get a specific neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerGetNeighborhoodV4(requestParameters: V4NeighborhoodsControllerGetNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodResponseDto>;
    /**
     *  # GET /v4/neighborhoods/viewId/{viewId}  ## Overview Retrieves neighborhoods using a specific view configuration. This endpoint applies the filters, sorts, and column selections defined in the specified view to return a customized dataset of neighborhoods.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | Yes | The unique identifier of the view to apply |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ## View Processing  The specified view controls: - **Filtering**: Only neighborhoods matching view filters are returned - **Sorting**: Results are ordered according to view sort configuration - **Columns**: Only columns specified in the view are included in response - **Permissions**: View must belong to the authenticated user\'s organization  ## Response Structure  Returns the same structure as GET /v4/neighborhoods but filtered and formatted according to the view specification.  ## Use Cases  - Implementing saved searches and filters - Creating custom neighborhood dashboards - Generating consistent reports with predefined criteria - Supporting user-personalized neighborhood views
     * @summary Get neighborhoods 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 NeighborhoodsAPIV4ApiInterface
     */
    v4NeighborhoodsControllerGetNeighborhoodsInViewV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodsInViewResponseDto>>;
    /**
     *  # GET /v4/neighborhoods/viewId/{viewId}  ## Overview Retrieves neighborhoods using a specific view configuration. This endpoint applies the filters, sorts, and column selections defined in the specified view to return a customized dataset of neighborhoods.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | Yes | The unique identifier of the view to apply |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ## View Processing  The specified view controls: - **Filtering**: Only neighborhoods matching view filters are returned - **Sorting**: Results are ordered according to view sort configuration - **Columns**: Only columns specified in the view are included in response - **Permissions**: View must belong to the authenticated user\'s organization  ## Response Structure  Returns the same structure as GET /v4/neighborhoods but filtered and formatted according to the view specification.  ## Use Cases  - Implementing saved searches and filters - Creating custom neighborhood dashboards - Generating consistent reports with predefined criteria - Supporting user-personalized neighborhood views
     * Get neighborhoods with a specific viewId
     */
    v4NeighborhoodsControllerGetNeighborhoodsInViewV4(requestParameters: V4NeighborhoodsControllerGetNeighborhoodsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodsInViewResponseDto>;
    /**
     *  # GET /v4/neighborhoods  ## Overview Retrieves a list of neighborhoods with optional filtering, sorting, and pagination capabilities. This endpoint allows you to query neighborhoods using view configurations or direct parameters to get customized neighborhood datasets.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply filters, sorts, and column selections | | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ### View Integration  When a `viewId` is provided: - **Filters**: View filters are automatically applied to the query - **Sorts**: View sort configurations determine result ordering - **Columns**: View column selections determine returned fields - **Validation**: View must exist and belong to the authenticated user  ### Pagination  The endpoint supports offset-based pagination: - **Default Limit**: 20 neighborhoods per request - **Maximum Limit**: 100 neighborhoods per request - **Offset Calculation**: Use `offset = page * limit` for page-based pagination  ## Response Structure  The response contains an array of neighborhood objects with pagination metadata.  ## Use Cases  This endpoint is ideal for: - Building neighborhood listing interfaces - Implementing neighborhood search and filtering - Creating neighborhood dashboards and analytics - Generating neighborhood reports and exports - Providing neighborhood data for mobile applications  ## Performance Considerations  - **Pagination**: Use appropriate limit values to balance performance and data needs - **View Optimization**: Well-designed views with targeted filters improve response times - **Column Selection**: Limit returned columns through views for better performance - **Caching**: Consider implementing client-side caching for frequently accessed data  ## Integration Patterns  **Standard Listing:** - No viewId: Returns all organization neighborhoods with default columns - Basic pagination: Use limit/offset for page navigation  **Filtered Views:** - With viewId: Returns neighborhoods matching view criteria - Consistent Results: Same view always returns same filtered dataset - User Personalization: Each user can have custom views for different purposes
     * @summary Get neighborhoods 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 NeighborhoodsAPIV4ApiInterface
     */
    v4NeighborhoodsControllerGetNeighborhoodsV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodsResponseDto>>;
    /**
     *  # GET /v4/neighborhoods  ## Overview Retrieves a list of neighborhoods with optional filtering, sorting, and pagination capabilities. This endpoint allows you to query neighborhoods using view configurations or direct parameters to get customized neighborhood datasets.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply filters, sorts, and column selections | | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ### View Integration  When a `viewId` is provided: - **Filters**: View filters are automatically applied to the query - **Sorts**: View sort configurations determine result ordering - **Columns**: View column selections determine returned fields - **Validation**: View must exist and belong to the authenticated user  ### Pagination  The endpoint supports offset-based pagination: - **Default Limit**: 20 neighborhoods per request - **Maximum Limit**: 100 neighborhoods per request - **Offset Calculation**: Use `offset = page * limit` for page-based pagination  ## Response Structure  The response contains an array of neighborhood objects with pagination metadata.  ## Use Cases  This endpoint is ideal for: - Building neighborhood listing interfaces - Implementing neighborhood search and filtering - Creating neighborhood dashboards and analytics - Generating neighborhood reports and exports - Providing neighborhood data for mobile applications  ## Performance Considerations  - **Pagination**: Use appropriate limit values to balance performance and data needs - **View Optimization**: Well-designed views with targeted filters improve response times - **Column Selection**: Limit returned columns through views for better performance - **Caching**: Consider implementing client-side caching for frequently accessed data  ## Integration Patterns  **Standard Listing:** - No viewId: Returns all organization neighborhoods with default columns - Basic pagination: Use limit/offset for page navigation  **Filtered Views:** - With viewId: Returns neighborhoods matching view criteria - Consistent Results: Same view always returns same filtered dataset - User Personalization: Each user can have custom views for different purposes
     * Get neighborhoods with optional viewId
     */
    v4NeighborhoodsControllerGetNeighborhoodsV4(requestParameters: V4NeighborhoodsControllerGetNeighborhoodsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodsResponseDto>;
    /**
     *  # PATCH /v4/neighborhoods/{neighborhoodId}  ## Overview Updates a specific neighborhood by its unique identifier. This endpoint allows partial updates to neighborhood information, including geographic boundaries, demographics, and status changes.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to update |  ### Request Body  The request body should contain the neighborhood fields to update. Only provided fields will be modified; omitted fields remain unchanged.  #### Updatable Fields  | Field | Type | Description | |-------|------|-------------| | `name` | string | Neighborhood name | | `description` | string | Detailed description | | `city` | string | City name | | `state` | string | State abbreviation | | `zip` | string | ZIP/postal code | | `coordinates` | object | Geographic coordinates with lat/lng | | `boundaries` | object | GeoJSON polygon defining boundaries | | `status` | string | Neighborhood status (Active, Inactive, etc.) | | `marketId` | string | Associated market identifier | | `countyId` | string | County identifier | | `demographics` | object | Demographic information | | `economicIndicators` | object | Economic data and statistics |  ## Validation  - **Permissions**: User must have update permissions for the neighborhood - **Organization**: Neighborhood must belong to user\'s organization - **Data Integrity**: Geographic coordinates and boundaries are validated - **Status Values**: Status must be from predefined list of valid values - **Reference Integrity**: Associated IDs (marketId, countyId) must exist  ## Response Structure  Returns the updated neighborhood object with all current field values.  ## Use Cases  - Updating neighborhood information through admin interfaces - Correcting geographic boundaries or coordinates - Modifying neighborhood status and classifications - Updating demographic and economic data - Bulk neighborhood data management operations
     * @summary Update a specific neighborhood by neighborhoodId
     * @param {string} neighborhoodId The unique identifier of the neighborhood
     * @param {V4NeighborhoodsUpdateNeighborhoodBodyDto} v4NeighborhoodsUpdateNeighborhoodBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NeighborhoodsAPIV4ApiInterface
     */
    v4NeighborhoodsControllerUpdateNeighborhoodV4Raw(requestParameters: V4NeighborhoodsControllerUpdateNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsUpdateNeighborhoodResponseDto>>;
    /**
     *  # PATCH /v4/neighborhoods/{neighborhoodId}  ## Overview Updates a specific neighborhood by its unique identifier. This endpoint allows partial updates to neighborhood information, including geographic boundaries, demographics, and status changes.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to update |  ### Request Body  The request body should contain the neighborhood fields to update. Only provided fields will be modified; omitted fields remain unchanged.  #### Updatable Fields  | Field | Type | Description | |-------|------|-------------| | `name` | string | Neighborhood name | | `description` | string | Detailed description | | `city` | string | City name | | `state` | string | State abbreviation | | `zip` | string | ZIP/postal code | | `coordinates` | object | Geographic coordinates with lat/lng | | `boundaries` | object | GeoJSON polygon defining boundaries | | `status` | string | Neighborhood status (Active, Inactive, etc.) | | `marketId` | string | Associated market identifier | | `countyId` | string | County identifier | | `demographics` | object | Demographic information | | `economicIndicators` | object | Economic data and statistics |  ## Validation  - **Permissions**: User must have update permissions for the neighborhood - **Organization**: Neighborhood must belong to user\'s organization - **Data Integrity**: Geographic coordinates and boundaries are validated - **Status Values**: Status must be from predefined list of valid values - **Reference Integrity**: Associated IDs (marketId, countyId) must exist  ## Response Structure  Returns the updated neighborhood object with all current field values.  ## Use Cases  - Updating neighborhood information through admin interfaces - Correcting geographic boundaries or coordinates - Modifying neighborhood status and classifications - Updating demographic and economic data - Bulk neighborhood data management operations
     * Update a specific neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerUpdateNeighborhoodV4(requestParameters: V4NeighborhoodsControllerUpdateNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsUpdateNeighborhoodResponseDto>;
}
/**
 *
 */
export declare class NeighborhoodsAPIV4Api extends runtime.BaseAPI implements NeighborhoodsAPIV4ApiInterface {
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}/{columns}  ## Overview Retrieves specific columns of a neighborhood by its unique identifier. This endpoint allows you to fetch only the data you need, improving performance and reducing bandwidth usage by specifying exactly which neighborhood attributes to return.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve | | `columns` | string | Yes | Comma-separated list of column names to return |  ## Column Selection  Available columns include: - **nid**: Neighborhood identifier - **name**: Neighborhood name - **description**: Neighborhood description - **city**: City name - **state**: State abbreviation - **zip**: ZIP/postal code - **coordinates**: Geographic coordinates - **boundaries**: Neighborhood boundaries - **status**: Current status - **marketId**: Associated market ID - **countyId**: County identifier - **demographics**: Demographic information - **economicIndicators**: Economic data - **createdAt**: Creation timestamp - **updatedAt**: Last update timestamp  ## Response Structure  Returns only the requested columns for the specified neighborhood, maintaining the same object structure but with limited fields.  ## Use Cases  - Performance optimization for specific use cases - Reducing bandwidth usage in mobile applications - Fetching only required data for forms or displays - Supporting lightweight API integrations - Building custom data exports with specific fields
     * Get specific columns of a neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerGetNeighborhoodColumnsV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodColumnsResponseDto>>;
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}/{columns}  ## Overview Retrieves specific columns of a neighborhood by its unique identifier. This endpoint allows you to fetch only the data you need, improving performance and reducing bandwidth usage by specifying exactly which neighborhood attributes to return.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve | | `columns` | string | Yes | Comma-separated list of column names to return |  ## Column Selection  Available columns include: - **nid**: Neighborhood identifier - **name**: Neighborhood name - **description**: Neighborhood description - **city**: City name - **state**: State abbreviation - **zip**: ZIP/postal code - **coordinates**: Geographic coordinates - **boundaries**: Neighborhood boundaries - **status**: Current status - **marketId**: Associated market ID - **countyId**: County identifier - **demographics**: Demographic information - **economicIndicators**: Economic data - **createdAt**: Creation timestamp - **updatedAt**: Last update timestamp  ## Response Structure  Returns only the requested columns for the specified neighborhood, maintaining the same object structure but with limited fields.  ## Use Cases  - Performance optimization for specific use cases - Reducing bandwidth usage in mobile applications - Fetching only required data for forms or displays - Supporting lightweight API integrations - Building custom data exports with specific fields
     * Get specific columns of a neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerGetNeighborhoodColumnsV4(requestParameters: V4NeighborhoodsControllerGetNeighborhoodColumnsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodColumnsResponseDto>;
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}  ## Overview Retrieves detailed information for a specific neighborhood by its unique identifier. This endpoint returns comprehensive neighborhood data including geographic boundaries, demographics, and market information.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply column selections and formatting |  ## Response Structure  Returns detailed information for the specified neighborhood, including all available attributes and related data.  ## Use Cases  - Displaying detailed neighborhood profiles - Populating neighborhood edit forms - Generating neighborhood-specific reports - Supporting neighborhood selection interfaces - Integrating neighborhood data into property analysis
     * Get a specific neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerGetNeighborhoodV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodResponseDto>>;
    /**
     *  # GET /v4/neighborhoods/{neighborhoodId}  ## Overview Retrieves detailed information for a specific neighborhood by its unique identifier. This endpoint returns comprehensive neighborhood data including geographic boundaries, demographics, and market information.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to retrieve |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply column selections and formatting |  ## Response Structure  Returns detailed information for the specified neighborhood, including all available attributes and related data.  ## Use Cases  - Displaying detailed neighborhood profiles - Populating neighborhood edit forms - Generating neighborhood-specific reports - Supporting neighborhood selection interfaces - Integrating neighborhood data into property analysis
     * Get a specific neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerGetNeighborhoodV4(requestParameters: V4NeighborhoodsControllerGetNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodResponseDto>;
    /**
     *  # GET /v4/neighborhoods/viewId/{viewId}  ## Overview Retrieves neighborhoods using a specific view configuration. This endpoint applies the filters, sorts, and column selections defined in the specified view to return a customized dataset of neighborhoods.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | Yes | The unique identifier of the view to apply |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ## View Processing  The specified view controls: - **Filtering**: Only neighborhoods matching view filters are returned - **Sorting**: Results are ordered according to view sort configuration - **Columns**: Only columns specified in the view are included in response - **Permissions**: View must belong to the authenticated user\'s organization  ## Response Structure  Returns the same structure as GET /v4/neighborhoods but filtered and formatted according to the view specification.  ## Use Cases  - Implementing saved searches and filters - Creating custom neighborhood dashboards - Generating consistent reports with predefined criteria - Supporting user-personalized neighborhood views
     * Get neighborhoods with a specific viewId
     */
    v4NeighborhoodsControllerGetNeighborhoodsInViewV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodsInViewResponseDto>>;
    /**
     *  # GET /v4/neighborhoods/viewId/{viewId}  ## Overview Retrieves neighborhoods using a specific view configuration. This endpoint applies the filters, sorts, and column selections defined in the specified view to return a customized dataset of neighborhoods.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | Yes | The unique identifier of the view to apply |  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ## View Processing  The specified view controls: - **Filtering**: Only neighborhoods matching view filters are returned - **Sorting**: Results are ordered according to view sort configuration - **Columns**: Only columns specified in the view are included in response - **Permissions**: View must belong to the authenticated user\'s organization  ## Response Structure  Returns the same structure as GET /v4/neighborhoods but filtered and formatted according to the view specification.  ## Use Cases  - Implementing saved searches and filters - Creating custom neighborhood dashboards - Generating consistent reports with predefined criteria - Supporting user-personalized neighborhood views
     * Get neighborhoods with a specific viewId
     */
    v4NeighborhoodsControllerGetNeighborhoodsInViewV4(requestParameters: V4NeighborhoodsControllerGetNeighborhoodsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodsInViewResponseDto>;
    /**
     *  # GET /v4/neighborhoods  ## Overview Retrieves a list of neighborhoods with optional filtering, sorting, and pagination capabilities. This endpoint allows you to query neighborhoods using view configurations or direct parameters to get customized neighborhood datasets.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply filters, sorts, and column selections | | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ### View Integration  When a `viewId` is provided: - **Filters**: View filters are automatically applied to the query - **Sorts**: View sort configurations determine result ordering - **Columns**: View column selections determine returned fields - **Validation**: View must exist and belong to the authenticated user  ### Pagination  The endpoint supports offset-based pagination: - **Default Limit**: 20 neighborhoods per request - **Maximum Limit**: 100 neighborhoods per request - **Offset Calculation**: Use `offset = page * limit` for page-based pagination  ## Response Structure  The response contains an array of neighborhood objects with pagination metadata.  ## Use Cases  This endpoint is ideal for: - Building neighborhood listing interfaces - Implementing neighborhood search and filtering - Creating neighborhood dashboards and analytics - Generating neighborhood reports and exports - Providing neighborhood data for mobile applications  ## Performance Considerations  - **Pagination**: Use appropriate limit values to balance performance and data needs - **View Optimization**: Well-designed views with targeted filters improve response times - **Column Selection**: Limit returned columns through views for better performance - **Caching**: Consider implementing client-side caching for frequently accessed data  ## Integration Patterns  **Standard Listing:** - No viewId: Returns all organization neighborhoods with default columns - Basic pagination: Use limit/offset for page navigation  **Filtered Views:** - With viewId: Returns neighborhoods matching view criteria - Consistent Results: Same view always returns same filtered dataset - User Personalization: Each user can have custom views for different purposes
     * Get neighborhoods with optional viewId
     */
    v4NeighborhoodsControllerGetNeighborhoodsV4Raw(requestParameters: V4NeighborhoodsControllerGetNeighborhoodsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsGetNeighborhoodsResponseDto>>;
    /**
     *  # GET /v4/neighborhoods  ## Overview Retrieves a list of neighborhoods with optional filtering, sorting, and pagination capabilities. This endpoint allows you to query neighborhoods using view configurations or direct parameters to get customized neighborhood datasets.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Query Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewId` | number | No | Optional view ID to apply filters, sorts, and column selections | | `limit` | number | No | Maximum number of neighborhoods to return (default: 20, max: 100) | | `offset` | number | No | Number of neighborhoods to skip for pagination (default: 0) | | `countOnly` | boolean | No | Return only the count of neighborhoods without the actual data |  ### View Integration  When a `viewId` is provided: - **Filters**: View filters are automatically applied to the query - **Sorts**: View sort configurations determine result ordering - **Columns**: View column selections determine returned fields - **Validation**: View must exist and belong to the authenticated user  ### Pagination  The endpoint supports offset-based pagination: - **Default Limit**: 20 neighborhoods per request - **Maximum Limit**: 100 neighborhoods per request - **Offset Calculation**: Use `offset = page * limit` for page-based pagination  ## Response Structure  The response contains an array of neighborhood objects with pagination metadata.  ## Use Cases  This endpoint is ideal for: - Building neighborhood listing interfaces - Implementing neighborhood search and filtering - Creating neighborhood dashboards and analytics - Generating neighborhood reports and exports - Providing neighborhood data for mobile applications  ## Performance Considerations  - **Pagination**: Use appropriate limit values to balance performance and data needs - **View Optimization**: Well-designed views with targeted filters improve response times - **Column Selection**: Limit returned columns through views for better performance - **Caching**: Consider implementing client-side caching for frequently accessed data  ## Integration Patterns  **Standard Listing:** - No viewId: Returns all organization neighborhoods with default columns - Basic pagination: Use limit/offset for page navigation  **Filtered Views:** - With viewId: Returns neighborhoods matching view criteria - Consistent Results: Same view always returns same filtered dataset - User Personalization: Each user can have custom views for different purposes
     * Get neighborhoods with optional viewId
     */
    v4NeighborhoodsControllerGetNeighborhoodsV4(requestParameters?: V4NeighborhoodsControllerGetNeighborhoodsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsGetNeighborhoodsResponseDto>;
    /**
     *  # PATCH /v4/neighborhoods/{neighborhoodId}  ## Overview Updates a specific neighborhood by its unique identifier. This endpoint allows partial updates to neighborhood information, including geographic boundaries, demographics, and status changes.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to update |  ### Request Body  The request body should contain the neighborhood fields to update. Only provided fields will be modified; omitted fields remain unchanged.  #### Updatable Fields  | Field | Type | Description | |-------|------|-------------| | `name` | string | Neighborhood name | | `description` | string | Detailed description | | `city` | string | City name | | `state` | string | State abbreviation | | `zip` | string | ZIP/postal code | | `coordinates` | object | Geographic coordinates with lat/lng | | `boundaries` | object | GeoJSON polygon defining boundaries | | `status` | string | Neighborhood status (Active, Inactive, etc.) | | `marketId` | string | Associated market identifier | | `countyId` | string | County identifier | | `demographics` | object | Demographic information | | `economicIndicators` | object | Economic data and statistics |  ## Validation  - **Permissions**: User must have update permissions for the neighborhood - **Organization**: Neighborhood must belong to user\'s organization - **Data Integrity**: Geographic coordinates and boundaries are validated - **Status Values**: Status must be from predefined list of valid values - **Reference Integrity**: Associated IDs (marketId, countyId) must exist  ## Response Structure  Returns the updated neighborhood object with all current field values.  ## Use Cases  - Updating neighborhood information through admin interfaces - Correcting geographic boundaries or coordinates - Modifying neighborhood status and classifications - Updating demographic and economic data - Bulk neighborhood data management operations
     * Update a specific neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerUpdateNeighborhoodV4Raw(requestParameters: V4NeighborhoodsControllerUpdateNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NeighborhoodsUpdateNeighborhoodResponseDto>>;
    /**
     *  # PATCH /v4/neighborhoods/{neighborhoodId}  ## Overview Updates a specific neighborhood by its unique identifier. This endpoint allows partial updates to neighborhood information, including geographic boundaries, demographics, and status changes.  ## Authentication - **Required**: Yes - **Security**:    - `x-api-key` header   - `organization-id` header  ## Request Parameters  ### Path Parameters  | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `neighborhoodId` | string | Yes | The unique identifier of the neighborhood to update |  ### Request Body  The request body should contain the neighborhood fields to update. Only provided fields will be modified; omitted fields remain unchanged.  #### Updatable Fields  | Field | Type | Description | |-------|------|-------------| | `name` | string | Neighborhood name | | `description` | string | Detailed description | | `city` | string | City name | | `state` | string | State abbreviation | | `zip` | string | ZIP/postal code | | `coordinates` | object | Geographic coordinates with lat/lng | | `boundaries` | object | GeoJSON polygon defining boundaries | | `status` | string | Neighborhood status (Active, Inactive, etc.) | | `marketId` | string | Associated market identifier | | `countyId` | string | County identifier | | `demographics` | object | Demographic information | | `economicIndicators` | object | Economic data and statistics |  ## Validation  - **Permissions**: User must have update permissions for the neighborhood - **Organization**: Neighborhood must belong to user\'s organization - **Data Integrity**: Geographic coordinates and boundaries are validated - **Status Values**: Status must be from predefined list of valid values - **Reference Integrity**: Associated IDs (marketId, countyId) must exist  ## Response Structure  Returns the updated neighborhood object with all current field values.  ## Use Cases  - Updating neighborhood information through admin interfaces - Correcting geographic boundaries or coordinates - Modifying neighborhood status and classifications - Updating demographic and economic data - Bulk neighborhood data management operations
     * Update a specific neighborhood by neighborhoodId
     */
    v4NeighborhoodsControllerUpdateNeighborhoodV4(requestParameters: V4NeighborhoodsControllerUpdateNeighborhoodV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NeighborhoodsUpdateNeighborhoodResponseDto>;
}
//# sourceMappingURL=NeighborhoodsAPIV4Api.d.ts.map