@tapline/client 0.2.9 → 0.2.11

package/dist/services/imovelweb/client.d.ts

@@ -0,0 +1,21 @@
+import type { BaseClient } from '../../base.js';
+import type { GetListingParams, GetPublisherParams, ImovelwebListingDetail, ImovelwebListingPublishers, ImovelwebListingsMap, ImovelwebListingsPage, ImovelwebLocations, ImovelwebPublisher, ImovelwebSimilarListings, ListListingPublishersParams, ListListingsParams, ListLocationsParams, ListSimilarListingsParams, MapListingsParams } from './types.js';
+export declare class ImovelwebClient {
+    private readonly base;
+    constructor(base: BaseClient);
+    /** Search imovelweb.com.br, Brazil's QuintoAndar-owned listings portal: homes and commercial property for sale, rent, short stays, auction and new developments, 30 per page. Each listing carries its price per operation, condo fee, rooms and areas, address with its state, city and district, coordinates, photos in every size, the publisher (type, CRECI licence and, when published, its main phone) and its WhatsApp number when the advertiser shows one. A development also carries its stage, delivery date, price and size ranges and unit groups in `development`. Fields imovelweb sends that this API does not decode stay in each record's `raw`, under imovelweb's names; a code imovelweb adds that this API has no name for yet decodes to null. About a fifth of listings hide their map position (`location.latitude` null); the detail route usually still has coordinates. Rent and season listings give the rental period only in their text, and imovelweb sends no IPTU on search results. `applied_filters` is imovelweb's own account of the filters it applied, in this API's parameter names: compare it with the request to spot a filter imovelweb dropped. Search a publisher's portfolio with `publisher_id`. Pages stop at page 1,000 (30,000 listings); narrow the filters to reach the rest. Priced per page, not per listing. Costs 2 credits. */
+    listListings(params: ListListingsParams): Promise<ImovelwebListingsPage>;
+    /** Map markers for a search: the 100 most relevant listings with id, title, first listed operation and price (a listing offered for both sale and rent can show its sale price on a rent search) and coordinates, the count of matching listings imovelweb can place on the map (`total`, lower than the search total), the `viewport`, and, when you filter by one location, its `area` with level, centre and GeoJSON outline. Takes the filters of `/listings`; the markers cannot be paged or re-sorted. imovelweb's map ignores `publisher_id`, so `applied_filters` leaves it out. imovelweb's map fails on many filters across the whole country or a state; those answer 400 with the reason (not charged): narrow to a city or neighbourhood or use `/listings`. `max_age=launching_soon` fails wherever the map runs, so it answers 422 before any call. Costs 1 credit. */
+    mapListings(params: MapListingsParams): Promise<ImovelwebListingsMap>;
+    /** One listing's full page: the complete description as plain text (line breaks kept, imovelweb's markup removed), every photo and floor plan in every size, every amenity with the area it belongs to, prices per operation, condo fee, the IPTU the page shows (`iptu`, no period given), coordinates, publication date, imovelweb's view counter when it shows one, the publisher with CRECI licence and the first digits of its phone (`publisher.partial_phone`; the full numbers are on `/publishers/{publisher_id}`), and a development's stage, ranges and units. `/listings/{posting_id}/publishers` lists the other agencies advertising the same property. Fields imovelweb sends that this API does not decode stay in `raw`, under imovelweb's names; a code imovelweb adds that this API has no name for yet decodes to null. A listing id imovelweb does not know answers 404. Costs 2 credits. */
+    getListing(params: GetListingParams): Promise<ImovelwebListingDetail>;
+    /** Every publisher advertising the same property, when imovelweb groups duplicate listings (search results flag them in `duplicate_group_id`): each publisher's own listing id and URL, name, logo and ad tier, but no publisher id or price; fetch each `listing_id` from `/listings/{posting_id}` for those. A listing nobody else advertises answers an empty list, and so does an id imovelweb does not know; both are charged. Costs 1 credit. */
+    listListingPublishers(params: ListListingPublishersParams): Promise<ImovelwebListingPublishers>;
+    /** Listings imovelweb shows as similar to this one (same area, type and price band), from imovelweb's compact card: its operation, property type and price arrive as display text and come back decoded, with rooms and areas, address and photos; fetch `/listings/{posting_id}` for the full record. A development or a listing imovelweb pairs with nothing answers an empty list. imovelweb does not check the id: one it does not know answers a couple of generic listings, charged like any other answer. Costs 1 credit. */
+    listSimilarListings(params: ListSimilarListingsParams): Promise<ImovelwebSimilarListings>;
+    /** Location autocomplete: states, cities and neighbourhoods matching the text, at most 10, each with its `level` and the `id` that `location_id` on `/listings` takes. A query with no match answers an empty list. Costs 1 credit. */
+    listLocations(params: ListLocationsParams): Promise<ImovelwebLocations>;
+    /** An agency's or developer's profile: name, its phone text as the publisher writes it (`phone_text`) and parsed into +55 numbers (`phone_numbers`), office address, year joined, live and listed listing counts, logo, and the ratings buyers gave it (`ratings` is null when imovelweb keeps no statistics for the publisher; an unrated one has a null `review_count`, `average` and `recommend_percent`, and no questions). List its listings with `/listings?publisher_id=`. Owners selling directly (`publisher.type` `owner` on a search listing) have no profile page, so their ids answer the same 404 as an id imovelweb does not know; the listing's `whatsapp` is their contact. Costs 2 credits. */
+    getPublisher(params: GetPublisherParams): Promise<ImovelwebPublisher>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/services/imovelweb/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/services/imovelweb/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE9V,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,0zCAA0zC;IACpzC,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI9E,s1BAAs1B;IACh1B,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI3E,k3BAAk3B;IAC52B,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAK3E,ubAAub;IACjb,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAKrG,ogBAAogB;IAC9f,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK/F,uOAAuO;IACjO,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI7E,irBAAirB;IAC3qB,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAI5E"}

package/dist/services/imovelweb/client.js

@@ -0,0 +1,40 @@
+// Generated by generate-client from spec/openapi.json. Do not edit.
+export class ImovelwebClient {
+    base;
+    constructor(base) {
+        this.base = base;
+    }
+    /** Search imovelweb.com.br, Brazil's QuintoAndar-owned listings portal: homes and commercial property for sale, rent, short stays, auction and new developments, 30 per page. Each listing carries its price per operation, condo fee, rooms and areas, address with its state, city and district, coordinates, photos in every size, the publisher (type, CRECI licence and, when published, its main phone) and its WhatsApp number when the advertiser shows one. A development also carries its stage, delivery date, price and size ranges and unit groups in `development`. Fields imovelweb sends that this API does not decode stay in each record's `raw`, under imovelweb's names; a code imovelweb adds that this API has no name for yet decodes to null. About a fifth of listings hide their map position (`location.latitude` null); the detail route usually still has coordinates. Rent and season listings give the rental period only in their text, and imovelweb sends no IPTU on search results. `applied_filters` is imovelweb's own account of the filters it applied, in this API's parameter names: compare it with the request to spot a filter imovelweb dropped. Search a publisher's portfolio with `publisher_id`. Pages stop at page 1,000 (30,000 listings); narrow the filters to reach the rest. Priced per page, not per listing. Costs 2 credits. */
+    async listListings(params) {
+        return this.base.get('/v1/imovelweb/listings', { ...params });
+    }
+    /** Map markers for a search: the 100 most relevant listings with id, title, first listed operation and price (a listing offered for both sale and rent can show its sale price on a rent search) and coordinates, the count of matching listings imovelweb can place on the map (`total`, lower than the search total), the `viewport`, and, when you filter by one location, its `area` with level, centre and GeoJSON outline. Takes the filters of `/listings`; the markers cannot be paged or re-sorted. imovelweb's map ignores `publisher_id`, so `applied_filters` leaves it out. imovelweb's map fails on many filters across the whole country or a state; those answer 400 with the reason (not charged): narrow to a city or neighbourhood or use `/listings`. `max_age=launching_soon` fails wherever the map runs, so it answers 422 before any call. Costs 1 credit. */
+    async mapListings(params) {
+        return this.base.get('/v1/imovelweb/listings/map', { ...params });
+    }
+    /** One listing's full page: the complete description as plain text (line breaks kept, imovelweb's markup removed), every photo and floor plan in every size, every amenity with the area it belongs to, prices per operation, condo fee, the IPTU the page shows (`iptu`, no period given), coordinates, publication date, imovelweb's view counter when it shows one, the publisher with CRECI licence and the first digits of its phone (`publisher.partial_phone`; the full numbers are on `/publishers/{publisher_id}`), and a development's stage, ranges and units. `/listings/{posting_id}/publishers` lists the other agencies advertising the same property. Fields imovelweb sends that this API does not decode stay in `raw`, under imovelweb's names; a code imovelweb adds that this API has no name for yet decodes to null. A listing id imovelweb does not know answers 404. Costs 2 credits. */
+    async getListing(params) {
+        const { posting_id } = params;
+        return this.base.get(`/v1/imovelweb/listings/${encodeURIComponent(posting_id)}`);
+    }
+    /** Every publisher advertising the same property, when imovelweb groups duplicate listings (search results flag them in `duplicate_group_id`): each publisher's own listing id and URL, name, logo and ad tier, but no publisher id or price; fetch each `listing_id` from `/listings/{posting_id}` for those. A listing nobody else advertises answers an empty list, and so does an id imovelweb does not know; both are charged. Costs 1 credit. */
+    async listListingPublishers(params) {
+        const { posting_id } = params;
+        return this.base.get(`/v1/imovelweb/listings/${encodeURIComponent(posting_id)}/publishers`);
+    }
+    /** Listings imovelweb shows as similar to this one (same area, type and price band), from imovelweb's compact card: its operation, property type and price arrive as display text and come back decoded, with rooms and areas, address and photos; fetch `/listings/{posting_id}` for the full record. A development or a listing imovelweb pairs with nothing answers an empty list. imovelweb does not check the id: one it does not know answers a couple of generic listings, charged like any other answer. Costs 1 credit. */
+    async listSimilarListings(params) {
+        const { posting_id, ...query } = params;
+        return this.base.get(`/v1/imovelweb/listings/${encodeURIComponent(posting_id)}/similar`, query);
+    }
+    /** Location autocomplete: states, cities and neighbourhoods matching the text, at most 10, each with its `level` and the `id` that `location_id` on `/listings` takes. A query with no match answers an empty list. Costs 1 credit. */
+    async listLocations(params) {
+        return this.base.get('/v1/imovelweb/locations', { ...params });
+    }
+    /** An agency's or developer's profile: name, its phone text as the publisher writes it (`phone_text`) and parsed into +55 numbers (`phone_numbers`), office address, year joined, live and listed listing counts, logo, and the ratings buyers gave it (`ratings` is null when imovelweb keeps no statistics for the publisher; an unrated one has a null `review_count`, `average` and `recommend_percent`, and no questions). List its listings with `/listings?publisher_id=`. Owners selling directly (`publisher.type` `owner` on a search listing) have no profile page, so their ids answer the same 404 as an id imovelweb does not know; the listing's `whatsapp` is their contact. Costs 2 credits. */
+    async getPublisher(params) {
+        const { publisher_id } = params;
+        return this.base.get(`/v1/imovelweb/publishers/${encodeURIComponent(publisher_id)}`);
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/services/imovelweb/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/services/imovelweb/client.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAKpE,MAAM,OAAO,eAAe;IACG;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,0zCAA0zC;IAC1zC,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwB,wBAAwB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACvF,CAAC;IAED,s1BAAs1B;IACt1B,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAuB,4BAA4B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,k3BAAk3B;IACl3B,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAyB,0BAA0B,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,ubAAub;IACvb,KAAK,CAAC,qBAAqB,CAAC,MAAmC;QAC7D,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA6B,0BAA0B,kBAAkB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAC1H,CAAC;IAED,ogBAAogB;IACpgB,KAAK,CAAC,mBAAmB,CAAC,MAAiC;QACzD,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA2B,0BAA0B,kBAAkB,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC5H,CAAC;IAED,uOAAuO;IACvO,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,yBAAyB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,irBAAirB;IACjrB,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,4BAA4B,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF"}

package/dist/services/imovelweb/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export { ImovelwebClient } from './client.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/imovelweb/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/imovelweb/index.ts"],"names":[],"mappings":"AAEA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}

package/dist/services/imovelweb/index.js

@@ -0,0 +1,4 @@
+// Generated by generate-client from spec/openapi.json. Do not edit.
+export * from './types.js';
+export { ImovelwebClient } from './client.js';
+//# sourceMappingURL=index.js.map

package/dist/services/imovelweb/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/imovelweb/index.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}