Class MarketPropertyTypeIdContext

Context class for Market API endpoints that require a "propertyTypeId"

Index

Constructors

Methods

properties rentals

Constructors

constructor

new MarketPropertyTypeIdContext(
requester: Requester,
contextId: string | number,
): MarketPropertyTypeIdContext
Parameters
- requester: Requester
- contextId: string | number
Returns MarketPropertyTypeIdContext
- Defined in src/generated/endpoints/market.ts:236

Methods

properties

properties(
    params?: {
        limit?: number;
        offset?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
    },
): Promise<
    PaginatedResponse<MarketPropertiesResponse> & MarketPropertiesResponse,
>
Get properties market listings
Parameters
- Optionalparams: {
      limit?: number;
      offset?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<MarketPropertiesResponse> & MarketPropertiesResponse>
- Defined in src/generated/endpoints/market.ts:245

rentals

rentals(
    params?: {
        limit?: number;
        offset?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string | number;
    },
): Promise<PaginatedResponse<MarketRentalsResponse> & MarketRentalsResponse>
Get properties rental listings
Parameters
- Optionalparams: {
      limit?: number;
      offset?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string | number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<MarketRentalsResponse> & MarketRentalsResponse>
- Defined in src/generated/endpoints/market.ts:267