@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
220 lines (219 loc) • 29.9 kB
JavaScript
/* tslint:disable */
/* eslint-disable */
/**
* 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 { V4NeighborhoodsGetNeighborhoodColumnsResponseDtoFromJSON, V4NeighborhoodsGetNeighborhoodResponseDtoFromJSON, V4NeighborhoodsGetNeighborhoodsInViewResponseDtoFromJSON, V4NeighborhoodsGetNeighborhoodsResponseDtoFromJSON, V4NeighborhoodsUpdateNeighborhoodBodyDtoToJSON, V4NeighborhoodsUpdateNeighborhoodResponseDtoFromJSON, } from '../models/index';
/**
*
*/
export class NeighborhoodsAPIV4Api extends runtime.BaseAPI {
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodColumnsV4Raw(requestParameters, initOverrides) {
if (requestParameters['columns'] == null) {
throw new runtime.RequiredError('columns', 'Required parameter "columns" was null or undefined when calling v4NeighborhoodsControllerGetNeighborhoodColumnsV4().');
}
if (requestParameters['neighborhoodId'] == null) {
throw new runtime.RequiredError('neighborhoodId', 'Required parameter "neighborhoodId" was null or undefined when calling v4NeighborhoodsControllerGetNeighborhoodColumnsV4().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/neighborhoods/{neighborhoodId}/{columns}`;
urlPath = urlPath.replace(`{${"columns"}}`, encodeURIComponent(String(requestParameters['columns'])));
urlPath = urlPath.replace(`{${"neighborhoodId"}}`, encodeURIComponent(String(requestParameters['neighborhoodId'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4NeighborhoodsGetNeighborhoodColumnsResponseDtoFromJSON(jsonValue));
}
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodColumnsV4(requestParameters, initOverrides) {
const response = await this.v4NeighborhoodsControllerGetNeighborhoodColumnsV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodV4Raw(requestParameters, initOverrides) {
if (requestParameters['neighborhoodId'] == null) {
throw new runtime.RequiredError('neighborhoodId', 'Required parameter "neighborhoodId" was null or undefined when calling v4NeighborhoodsControllerGetNeighborhoodV4().');
}
const queryParameters = {};
if (requestParameters['viewId'] != null) {
queryParameters['viewId'] = requestParameters['viewId'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/neighborhoods/{neighborhoodId}`;
urlPath = urlPath.replace(`{${"neighborhoodId"}}`, encodeURIComponent(String(requestParameters['neighborhoodId'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4NeighborhoodsGetNeighborhoodResponseDtoFromJSON(jsonValue));
}
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodV4(requestParameters, initOverrides) {
const response = await this.v4NeighborhoodsControllerGetNeighborhoodV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodsInViewV4Raw(requestParameters, initOverrides) {
if (requestParameters['viewId'] == null) {
throw new runtime.RequiredError('viewId', 'Required parameter "viewId" was null or undefined when calling v4NeighborhoodsControllerGetNeighborhoodsInViewV4().');
}
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['countOnly'] != null) {
queryParameters['countOnly'] = requestParameters['countOnly'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/neighborhoods/viewId/{viewId}`;
urlPath = urlPath.replace(`{${"viewId"}}`, encodeURIComponent(String(requestParameters['viewId'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4NeighborhoodsGetNeighborhoodsInViewResponseDtoFromJSON(jsonValue));
}
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodsInViewV4(requestParameters, initOverrides) {
const response = await this.v4NeighborhoodsControllerGetNeighborhoodsInViewV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodsV4Raw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['viewId'] != null) {
queryParameters['viewId'] = requestParameters['viewId'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['countOnly'] != null) {
queryParameters['countOnly'] = requestParameters['countOnly'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/neighborhoods`;
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4NeighborhoodsGetNeighborhoodsResponseDtoFromJSON(jsonValue));
}
/**
* # 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
*/
async v4NeighborhoodsControllerGetNeighborhoodsV4(requestParameters = {}, initOverrides) {
const response = await this.v4NeighborhoodsControllerGetNeighborhoodsV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* # 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
*/
async v4NeighborhoodsControllerUpdateNeighborhoodV4Raw(requestParameters, initOverrides) {
if (requestParameters['neighborhoodId'] == null) {
throw new runtime.RequiredError('neighborhoodId', 'Required parameter "neighborhoodId" was null or undefined when calling v4NeighborhoodsControllerUpdateNeighborhoodV4().');
}
if (requestParameters['v4NeighborhoodsUpdateNeighborhoodBodyDto'] == null) {
throw new runtime.RequiredError('v4NeighborhoodsUpdateNeighborhoodBodyDto', 'Required parameter "v4NeighborhoodsUpdateNeighborhoodBodyDto" was null or undefined when calling v4NeighborhoodsControllerUpdateNeighborhoodV4().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/neighborhoods/{neighborhoodId}`;
urlPath = urlPath.replace(`{${"neighborhoodId"}}`, encodeURIComponent(String(requestParameters['neighborhoodId'])));
const response = await this.request({
path: urlPath,
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: V4NeighborhoodsUpdateNeighborhoodBodyDtoToJSON(requestParameters['v4NeighborhoodsUpdateNeighborhoodBodyDto']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4NeighborhoodsUpdateNeighborhoodResponseDtoFromJSON(jsonValue));
}
/**
* # 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
*/
async v4NeighborhoodsControllerUpdateNeighborhoodV4(requestParameters, initOverrides) {
const response = await this.v4NeighborhoodsControllerUpdateNeighborhoodV4Raw(requestParameters, initOverrides);
return await response.value();
}
}