@roxyapi/sdk 1.2.23 → 1.2.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +25 -14
- package/README.md +16 -16
- package/dist/factory.cjs +4 -4
- package/dist/factory.js +4 -4
- package/dist/sdk.gen.d.ts +3 -3
- package/dist/types.gen.d.ts +3 -3
- package/dist/version.d.ts +1 -1
- package/package.json +1 -1
- package/src/sdk.gen.ts +3 -3
- package/src/types.gen.ts +3 -3
- package/src/version.ts +1 -1
package/AGENTS.md
CHANGED
|
@@ -41,22 +41,32 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
41
41
|
<!-- BEGIN:DOMAINS -->
|
|
42
42
|
| Namespace | Endpoints | What it covers |
|
|
43
43
|
|-----------|-----------|----------------|
|
|
44
|
-
| `roxy.astrology` | 22 | Western astrology
|
|
45
|
-
| `roxy.vedicAstrology` | 42 | Vedic
|
|
46
|
-
| `roxy.numerology` | 16 |
|
|
47
|
-
| `roxy.tarot` | 10 |
|
|
48
|
-
| `roxy.biorhythm` | 6 |
|
|
49
|
-
| `roxy.iching` | 9 | I
|
|
50
|
-
| `roxy.crystals` | 12 |
|
|
51
|
-
| `roxy.dreams` | 5 | Dream
|
|
52
|
-
| `roxy.angelNumbers` | 4 |
|
|
53
|
-
| `roxy.location` | 3 | City geocoding for
|
|
54
|
-
| `roxy.usage` | 1 | API usage
|
|
55
|
-
| `roxy.languages` | 1 |
|
|
44
|
+
| `roxy.astrology` | 22 | Production-ready Western astrology API + remote MCP for AI agents and developers |
|
|
45
|
+
| `roxy.vedicAstrology` | 42 | Production-grade Vedic (Jyotish) and KP astrology API + remote MCP for AI agents and developers |
|
|
46
|
+
| `roxy.numerology` | 16 | Production-ready Pythagorean numerology API + hosted MCP for AI agents and developers |
|
|
47
|
+
| `roxy.tarot` | 10 | Production-ready tarot card reading API + hosted MCP for AI agents and developers |
|
|
48
|
+
| `roxy.biorhythm` | 6 | The most complete biorhythm API + remote MCP for AI agents and developers |
|
|
49
|
+
| `roxy.iching` | 9 | I-Ching oracle API + hosted MCP for AI agents and developers |
|
|
50
|
+
| `roxy.crystals` | 12 | Production-ready crystal healing API + hosted MCP for AI agents and developers |
|
|
51
|
+
| `roxy.dreams` | 5 | Dream interpretation API + hosted MCP for AI agents and developers |
|
|
52
|
+
| `roxy.angelNumbers` | 4 | Production-ready angel numbers API + hosted MCP for AI agents and developers |
|
|
53
|
+
| `roxy.location` | 3 | City search and geocoding API + hosted MCP for AI agents and astrology apps |
|
|
54
|
+
| `roxy.usage` | 1 | Monitor your API usage, check rate limits, and track request consumption |
|
|
55
|
+
| `roxy.languages` | 1 | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
|
|
56
56
|
<!-- END:DOMAINS -->
|
|
57
57
|
|
|
58
58
|
**Total:** 130 endpoints across 10 product domains plus usage and languages. Counts auto-sync from `specs/openapi.json` at release time.
|
|
59
59
|
|
|
60
|
+
## Quality guidelines for agents
|
|
61
|
+
|
|
62
|
+
Five rules to follow when writing any call with this SDK. Get these right and the generated types do the rest.
|
|
63
|
+
|
|
64
|
+
- **One options object, hey-api wrapped.** Every method takes a single object with `path`, `query`, and `body` keys. Path params go in `path`, query params in `query`, request body in `body`. Never flat named args. Right: `roxy.astrology.getDailyHoroscope({ path: { sign: 'aries' } })`. Wrong: `roxy.astrology.getDailyHoroscope({ sign: 'aries' })`.
|
|
65
|
+
- **Always `await`. Always destructure `{ data, error, response }`.** All methods are async. `data` is the typed success response (undefined on error). `error` is the typed API error (`{ error: string, code: string }`, undefined on success). `response` is the raw `fetch` Response. Switch on `error.code`, not on `error.error`.
|
|
66
|
+
- **Method names match the OpenAPI `operationId` verbatim.** When in doubt, autocomplete `roxy.{domain}.` in your editor or `grep 'public ' node_modules/@roxyapi/sdk/dist/factory.d.ts`. Never invent a method from the URL path or a guess.
|
|
67
|
+
- **Response field names come from the spec's response schema.** Field access is typed dot syntax (`data.cities[0].timezone`). TypeScript will catch any invented field at compile time via the generated types - if `tsc` complains, the field does not exist.
|
|
68
|
+
- **Do not hand-roll requests.** No raw `fetch`, no axios. The SDK injects auth, base URL, retries, and typed responses. Use `createRoxy(key)` for the common case, or `new Roxy({ client })` with `createClient` from `@roxyapi/sdk/client` when you need a custom fetch or interceptors.
|
|
69
|
+
|
|
60
70
|
## Critical patterns
|
|
61
71
|
|
|
62
72
|
### Two-step pattern for coordinate-dependent endpoints
|
|
@@ -192,13 +202,14 @@ These are the fields AI agents most often get wrong. Copy the format column exac
|
|
|
192
202
|
| `latitude` | Decimal degrees (number) | `28.6139` (Delhi), `-33.8688` (Sydney), `40.7128` (NYC) | `"28°36'N"`, `"28 36 50"`, strings |
|
|
193
203
|
| `longitude` | Decimal degrees (number) | `77.209` (Delhi), `-74.006` (NYC), `139.6917` (Tokyo) | Same as latitude - no DMS strings |
|
|
194
204
|
| `sign` (horoscope path) | Lowercase zodiac name | `aries`, `taurus`, `gemini`, ... `pisces` | `"Aries"`, `"♈"`, `"1"`, `"ARIES"` (case-insensitive but prefer lowercase) |
|
|
205
|
+
| `chakra` (crystals path) | Title-case English name from the fixed enum | `"Root"`, `"Sacral"`, `"Solar Plexus"`, `"Heart"`, `"Throat"`, `"Third Eye"`, `"Crown"` | `"heart"`, `"third-eye"`, `"solar plexus"` - route is case-insensitive at runtime, but the generated TS enum is title-case; lowercase fails `tsc --strict`. |
|
|
195
206
|
| `fullName` (numerology) | Birth-certificate name | `"John William Smith"`, `"Priya Rajesh Sharma"` | Nickname, married name, partial name - affects all letter-based calcs |
|
|
196
207
|
| `seed` | Any string (deterministic) | `"user-42"`, `"session-abc-123"`, email hash | Numbers, objects - must be string |
|
|
197
208
|
| `number` (angel numbers path) | String | `"1111"`, `"777"`, `"1234"` | `1111` (int) fails path validation |
|
|
198
209
|
| `id` (nakshatra / dream / tarot) | Slug | `"ashwini"`, `"flying"`, `"the-fool"`, `"three-of-cups"` | Display names, uppercase, spaces |
|
|
199
210
|
| `houseSystem` | Enum | `"placidus"` (default), `"whole-sign"`, `"equal"`, `"koch"` | `"Placidus"`, `"whole_sign"`, `"WS"` |
|
|
200
211
|
| `ayanamsa` (KP) | Enum | `"kp-newcomb"` (default), `"kp-old"`, `"lahiri"`, `"custom"` | `"KP"`, `"New Comb"`, `"Lahiri"` |
|
|
201
|
-
| `nodeType` | Enum | `"
|
|
212
|
+
| `nodeType` (KP) | Enum | `"mean"` (default, traditional Vedic), `"true"` (osculating with perturbation corrections) | `"true-node"`, `"mean-node"`, `"True Node"` |
|
|
202
213
|
| `count` (tarot draw) | Integer 1 to 78 | `3`, `10`, `78` | `0`, `79`, strings, floats |
|
|
203
214
|
| `mahadasha` (path) | Planet name | `"Ketu"`, `"Venus"`, `"Sun"`, `"Moon"`, `"Mars"`, `"Rahu"`, `"Jupiter"`, `"Saturn"`, `"Mercury"` | `"KETU"` (works, case-insensitive), `"ke"`, `"Ke-tu"` |
|
|
204
215
|
| `person1` / `person2` | Object with full birth data | `{ date, time, latitude, longitude, timezone }` (Western) or `{ date, time, latitude, longitude }` (Vedic) | Separate top-level fields, missing time, partial object |
|
|
@@ -229,7 +240,7 @@ LLMs hallucinate confidently in this category. These are the specific traps you
|
|
|
229
240
|
|
|
230
241
|
- **Ayanamsa is server-side in Vedic.** LLMs default to tropical / Western math. Vedic endpoints apply sidereal Lahiri ayanamsa server-side. KP endpoints accept `ayanamsa` of `kp-newcomb` (default), `kp-old`, `lahiri`, or `custom`. Do not try to "correct" server output by subtracting ayanamsa in client code.
|
|
231
242
|
- **Tithi count is 30, not 2.** 15 Shukla (waxing) plus 15 Krishna (waning). Older LLM training data conflates Purnima and Amavasya as single tithis. Our panchang response carries a `paksha` field (`"Shukla"` or `"Krishna"`) plus a tithi number, so there are 30 distinct tithis in a lunar month.
|
|
232
|
-
- **Rahu and Ketu are shadow points, not planets.** They do not appear in a real ephemeris. Endpoints accept `nodeType` of `
|
|
243
|
+
- **Rahu and Ketu are shadow points, not planets.** They do not appear in a real ephemeris. Endpoints accept `nodeType` of `"mean"` (smooth mean node, traditional Vedic default) or `"true"` (osculating node with perturbation corrections) to select which calculation to use.
|
|
233
244
|
- **Nakshatra count is 27.** Abhijit is sometimes treated as a 28th in some schools, but this API uses the standard 27. `roxy.vedicAstrology.listNakshatras()` returns an array of length 27.
|
|
234
245
|
- **Retrograde is per-planet, not global.** Natal chart planets and Vedic `meta` include `isRetrograde: boolean` per planet. KP planet lists use `retrograde`. Never generate "Mercury retrograde globally" UI copy, check the specific planet in the response.
|
|
235
246
|
- **Tarot reversals are a product choice.** `allowReversals: false` on a tarot draw means no reversed cards in that draw, period. It is not cosmically meaningful, it is a config flag.
|
package/README.md
CHANGED
|
@@ -85,18 +85,18 @@ const { latitude, longitude, timezone } = data.cities[0];
|
|
|
85
85
|
<!-- BEGIN:DOMAINS -->
|
|
86
86
|
| Namespace | Endpoints | What it covers |
|
|
87
87
|
|-----------|-----------|----------------|
|
|
88
|
-
| `roxy.astrology` | 22 | Western astrology
|
|
89
|
-
| `roxy.vedicAstrology` | 42 | Vedic
|
|
90
|
-
| `roxy.numerology` | 16 |
|
|
91
|
-
| `roxy.tarot` | 10 |
|
|
92
|
-
| `roxy.biorhythm` | 6 |
|
|
93
|
-
| `roxy.iching` | 9 | I
|
|
94
|
-
| `roxy.crystals` | 12 |
|
|
95
|
-
| `roxy.dreams` | 5 | Dream
|
|
96
|
-
| `roxy.angelNumbers` | 4 |
|
|
97
|
-
| `roxy.location` | 3 | City and
|
|
98
|
-
| `roxy.usage` | 1 | API usage
|
|
99
|
-
| `roxy.languages` | 1 | List
|
|
88
|
+
| `roxy.astrology` | 22 | Production-ready Western astrology API + remote MCP for AI agents and developers |
|
|
89
|
+
| `roxy.vedicAstrology` | 42 | Production-grade Vedic (Jyotish) and KP astrology API + remote MCP for AI agents and developers |
|
|
90
|
+
| `roxy.numerology` | 16 | Production-ready Pythagorean numerology API + hosted MCP for AI agents and developers |
|
|
91
|
+
| `roxy.tarot` | 10 | Production-ready tarot card reading API + hosted MCP for AI agents and developers |
|
|
92
|
+
| `roxy.biorhythm` | 6 | The most complete biorhythm API + remote MCP for AI agents and developers |
|
|
93
|
+
| `roxy.iching` | 9 | I-Ching oracle API + hosted MCP for AI agents and developers |
|
|
94
|
+
| `roxy.crystals` | 12 | Production-ready crystal healing API + hosted MCP for AI agents and developers |
|
|
95
|
+
| `roxy.dreams` | 5 | Dream interpretation API + hosted MCP for AI agents and developers |
|
|
96
|
+
| `roxy.angelNumbers` | 4 | Production-ready angel numbers API + hosted MCP for AI agents and developers |
|
|
97
|
+
| `roxy.location` | 3 | City search and geocoding API + hosted MCP for AI agents and astrology apps |
|
|
98
|
+
| `roxy.usage` | 1 | Monitor your API usage, check rate limits, and track request consumption |
|
|
99
|
+
| `roxy.languages` | 1 | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
|
|
100
100
|
<!-- END:DOMAINS -->
|
|
101
101
|
|
|
102
102
|
## Most-used endpoints
|
|
@@ -124,7 +124,7 @@ const { data: synastry } = await roxy.astrology.calculateSynastry({
|
|
|
124
124
|
person2: { date: '1992-07-22', time: '09:00:00', latitude: 19.07, longitude: 72.87, timezone: 5.5 },
|
|
125
125
|
},
|
|
126
126
|
});
|
|
127
|
-
// synastry.compatibilityScore, synastry.interAspects, synastry.strengths
|
|
127
|
+
// synastry.compatibilityScore, synastry.interAspects, synastry.analysis.strengths
|
|
128
128
|
|
|
129
129
|
// Moon phase. Viral for wellness, cycle-tracking, and meditation apps.
|
|
130
130
|
const { data: moon } = await roxy.astrology.getCurrentMoonPhase({});
|
|
@@ -198,7 +198,7 @@ High search volume, evergreen. The tarot card database is the highest per-endpoi
|
|
|
198
198
|
```typescript
|
|
199
199
|
// Daily card. Stickiest tarot feature. Seed per user for deterministic once-per-day behavior.
|
|
200
200
|
const { data: card } = await roxy.tarot.getDailyCard({ body: { seed: 'user-42' } });
|
|
201
|
-
// card.card.name, card.card.imageUrl, card.
|
|
201
|
+
// card.card.name, card.card.imageUrl, card.dailyMessage
|
|
202
202
|
|
|
203
203
|
// Celtic Cross. Professional-reader spread. Premium-tier, ten positions.
|
|
204
204
|
const { data: cc } = await roxy.tarot.castCelticCross({
|
|
@@ -252,10 +252,10 @@ Crystal retail and metaphysical shops use these to build "crystals for [sign]" a
|
|
|
252
252
|
```typescript
|
|
253
253
|
// By zodiac. Highest-search crystal query pattern.
|
|
254
254
|
const { data: bySign } = await roxy.crystals.getCrystalsByZodiac({ path: { sign: 'scorpio' } });
|
|
255
|
-
// bySign.crystals is a list of id, name,
|
|
255
|
+
// bySign.crystals is a list of { id, name, imageUrl, colors }. Use /crystals/{id} for full properties.
|
|
256
256
|
|
|
257
257
|
// By chakra. Second-highest crystal query pattern.
|
|
258
|
-
const { data: byChakra } = await roxy.crystals.getCrystalsByChakra({ path: { chakra: '
|
|
258
|
+
const { data: byChakra } = await roxy.crystals.getCrystalsByChakra({ path: { chakra: 'Heart' } });
|
|
259
259
|
|
|
260
260
|
// Birthstone. Evergreen gift and jewelry SEO.
|
|
261
261
|
const { data: birthstone } = await roxy.crystals.getBirthstones({ path: { month: 4 } });
|
package/dist/factory.cjs
CHANGED
|
@@ -2721,7 +2721,7 @@ var Location = class extends HeyApiClient {
|
|
|
2721
2721
|
/**
|
|
2722
2722
|
* Search cities worldwide - Geocoding autocomplete with coordinates and timezone
|
|
2723
2723
|
*
|
|
2724
|
-
* City autocomplete and geocoding search across
|
|
2724
|
+
* City autocomplete and geocoding search across 23,000+ locations in 240+ countries, including deep coverage of Indian tier-2 and tier-3 cities. Returns geographic coordinates (latitude, longitude), IANA timezone, and DST-aware UTC offset for each match. Built for birth chart location pickers, horoscope apps, event scheduling, and any feature requiring place-to-coordinates resolution. Partial name matching with intelligent ranking: exact prefix matches first, then sorted by population for relevance. Common alternate names like Bombay, Calcutta, Madras, and Banaras transparently resolve to their canonical entries.
|
|
2725
2725
|
*/
|
|
2726
2726
|
searchCities(options) {
|
|
2727
2727
|
return (options.client ?? this.client).get({
|
|
@@ -2731,9 +2731,9 @@ var Location = class extends HeyApiClient {
|
|
|
2731
2731
|
});
|
|
2732
2732
|
}
|
|
2733
2733
|
/**
|
|
2734
|
-
* List all
|
|
2734
|
+
* List all countries - ISO codes and city coverage
|
|
2735
2735
|
*
|
|
2736
|
-
* Returns
|
|
2736
|
+
* Returns every country with ISO 3166-1 alpha-2 and alpha-3 codes, plus the number of searchable cities per country. Use this endpoint to build country dropdown menus, regional filters, or to check city coverage before querying. Sorted alphabetically by country name. Covers Europe, Americas, Asia, Middle East, Africa, and Oceania.
|
|
2737
2737
|
*/
|
|
2738
2738
|
listCountries(options) {
|
|
2739
2739
|
return (options?.client ?? this.client).get({
|
|
@@ -2840,7 +2840,7 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
2840
2840
|
};
|
|
2841
2841
|
|
|
2842
2842
|
// src/version.ts
|
|
2843
|
-
var VERSION = "1.2.
|
|
2843
|
+
var VERSION = "1.2.25";
|
|
2844
2844
|
|
|
2845
2845
|
// src/factory.ts
|
|
2846
2846
|
function createRoxy(auth) {
|
package/dist/factory.js
CHANGED
|
@@ -1885,7 +1885,7 @@ var Location = class extends HeyApiClient {
|
|
|
1885
1885
|
/**
|
|
1886
1886
|
* Search cities worldwide - Geocoding autocomplete with coordinates and timezone
|
|
1887
1887
|
*
|
|
1888
|
-
* City autocomplete and geocoding search across
|
|
1888
|
+
* City autocomplete and geocoding search across 23,000+ locations in 240+ countries, including deep coverage of Indian tier-2 and tier-3 cities. Returns geographic coordinates (latitude, longitude), IANA timezone, and DST-aware UTC offset for each match. Built for birth chart location pickers, horoscope apps, event scheduling, and any feature requiring place-to-coordinates resolution. Partial name matching with intelligent ranking: exact prefix matches first, then sorted by population for relevance. Common alternate names like Bombay, Calcutta, Madras, and Banaras transparently resolve to their canonical entries.
|
|
1889
1889
|
*/
|
|
1890
1890
|
searchCities(options) {
|
|
1891
1891
|
return (options.client ?? this.client).get({
|
|
@@ -1895,9 +1895,9 @@ var Location = class extends HeyApiClient {
|
|
|
1895
1895
|
});
|
|
1896
1896
|
}
|
|
1897
1897
|
/**
|
|
1898
|
-
* List all
|
|
1898
|
+
* List all countries - ISO codes and city coverage
|
|
1899
1899
|
*
|
|
1900
|
-
* Returns
|
|
1900
|
+
* Returns every country with ISO 3166-1 alpha-2 and alpha-3 codes, plus the number of searchable cities per country. Use this endpoint to build country dropdown menus, regional filters, or to check city coverage before querying. Sorted alphabetically by country name. Covers Europe, Americas, Asia, Middle East, Africa, and Oceania.
|
|
1901
1901
|
*/
|
|
1902
1902
|
listCountries(options) {
|
|
1903
1903
|
return (options?.client ?? this.client).get({
|
|
@@ -2004,7 +2004,7 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
2004
2004
|
};
|
|
2005
2005
|
|
|
2006
2006
|
// src/version.ts
|
|
2007
|
-
var VERSION = "1.2.
|
|
2007
|
+
var VERSION = "1.2.25";
|
|
2008
2008
|
|
|
2009
2009
|
// src/factory.ts
|
|
2010
2010
|
function createRoxy(auth) {
|
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -803,13 +803,13 @@ export declare class Location extends HeyApiClient {
|
|
|
803
803
|
/**
|
|
804
804
|
* Search cities worldwide - Geocoding autocomplete with coordinates and timezone
|
|
805
805
|
*
|
|
806
|
-
* City autocomplete and geocoding search across
|
|
806
|
+
* City autocomplete and geocoding search across 23,000+ locations in 240+ countries, including deep coverage of Indian tier-2 and tier-3 cities. Returns geographic coordinates (latitude, longitude), IANA timezone, and DST-aware UTC offset for each match. Built for birth chart location pickers, horoscope apps, event scheduling, and any feature requiring place-to-coordinates resolution. Partial name matching with intelligent ranking: exact prefix matches first, then sorted by population for relevance. Common alternate names like Bombay, Calcutta, Madras, and Banaras transparently resolve to their canonical entries.
|
|
807
807
|
*/
|
|
808
808
|
searchCities<ThrowOnError extends boolean = false>(options: Options<GetLocationSearchData, ThrowOnError>): import("./client").RequestResult<GetLocationSearchResponses, GetLocationSearchErrors, ThrowOnError, "fields">;
|
|
809
809
|
/**
|
|
810
|
-
* List all
|
|
810
|
+
* List all countries - ISO codes and city coverage
|
|
811
811
|
*
|
|
812
|
-
* Returns
|
|
812
|
+
* Returns every country with ISO 3166-1 alpha-2 and alpha-3 codes, plus the number of searchable cities per country. Use this endpoint to build country dropdown menus, regional filters, or to check city coverage before querying. Sorted alphabetically by country name. Covers Europe, Americas, Asia, Middle East, Africa, and Oceania.
|
|
813
813
|
*/
|
|
814
814
|
listCountries<ThrowOnError extends boolean = false>(options?: Options<GetLocationCountriesData, ThrowOnError>): import("./client").RequestResult<GetLocationCountriesResponses, GetLocationCountriesErrors, ThrowOnError, "fields">;
|
|
815
815
|
/**
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -27210,7 +27210,7 @@ export type GetLocationCountriesData = {
|
|
|
27210
27210
|
path?: never;
|
|
27211
27211
|
query?: {
|
|
27212
27212
|
/**
|
|
27213
|
-
* Maximum items to return per page. Range: 1-
|
|
27213
|
+
* Maximum items to return per page. Range: 1-250, default 50.
|
|
27214
27214
|
*/
|
|
27215
27215
|
limit?: number;
|
|
27216
27216
|
/**
|
|
@@ -27324,7 +27324,7 @@ export type GetLocationCountriesErrors = {
|
|
|
27324
27324
|
export type GetLocationCountriesError = GetLocationCountriesErrors[keyof GetLocationCountriesErrors];
|
|
27325
27325
|
export type GetLocationCountriesResponses = {
|
|
27326
27326
|
/**
|
|
27327
|
-
* Alphabetically sorted list of all
|
|
27327
|
+
* Alphabetically sorted list of all countries with ISO codes and city counts
|
|
27328
27328
|
*/
|
|
27329
27329
|
200: {
|
|
27330
27330
|
/**
|
|
@@ -27373,7 +27373,7 @@ export type GetLocationCountriesByIso2Data = {
|
|
|
27373
27373
|
};
|
|
27374
27374
|
query?: {
|
|
27375
27375
|
/**
|
|
27376
|
-
* Maximum items to return per page. Range: 1-
|
|
27376
|
+
* Maximum items to return per page. Range: 1-100, default 20.
|
|
27377
27377
|
*/
|
|
27378
27378
|
limit?: number;
|
|
27379
27379
|
/**
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "1.2.
|
|
1
|
+
export declare const VERSION = "1.2.25";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/package.json
CHANGED
package/src/sdk.gen.ts
CHANGED
|
@@ -2030,7 +2030,7 @@ export class Location extends HeyApiClient {
|
|
|
2030
2030
|
/**
|
|
2031
2031
|
* Search cities worldwide - Geocoding autocomplete with coordinates and timezone
|
|
2032
2032
|
*
|
|
2033
|
-
* City autocomplete and geocoding search across
|
|
2033
|
+
* City autocomplete and geocoding search across 23,000+ locations in 240+ countries, including deep coverage of Indian tier-2 and tier-3 cities. Returns geographic coordinates (latitude, longitude), IANA timezone, and DST-aware UTC offset for each match. Built for birth chart location pickers, horoscope apps, event scheduling, and any feature requiring place-to-coordinates resolution. Partial name matching with intelligent ranking: exact prefix matches first, then sorted by population for relevance. Common alternate names like Bombay, Calcutta, Madras, and Banaras transparently resolve to their canonical entries.
|
|
2034
2034
|
*/
|
|
2035
2035
|
public searchCities<ThrowOnError extends boolean = false>(options: Options<GetLocationSearchData, ThrowOnError>) {
|
|
2036
2036
|
return (options.client ?? this.client).get<GetLocationSearchResponses, GetLocationSearchErrors, ThrowOnError>({
|
|
@@ -2041,9 +2041,9 @@ export class Location extends HeyApiClient {
|
|
|
2041
2041
|
}
|
|
2042
2042
|
|
|
2043
2043
|
/**
|
|
2044
|
-
* List all
|
|
2044
|
+
* List all countries - ISO codes and city coverage
|
|
2045
2045
|
*
|
|
2046
|
-
* Returns
|
|
2046
|
+
* Returns every country with ISO 3166-1 alpha-2 and alpha-3 codes, plus the number of searchable cities per country. Use this endpoint to build country dropdown menus, regional filters, or to check city coverage before querying. Sorted alphabetically by country name. Covers Europe, Americas, Asia, Middle East, Africa, and Oceania.
|
|
2047
2047
|
*/
|
|
2048
2048
|
public listCountries<ThrowOnError extends boolean = false>(options?: Options<GetLocationCountriesData, ThrowOnError>) {
|
|
2049
2049
|
return (options?.client ?? this.client).get<GetLocationCountriesResponses, GetLocationCountriesErrors, ThrowOnError>({
|
package/src/types.gen.ts
CHANGED
|
@@ -27907,7 +27907,7 @@ export type GetLocationCountriesData = {
|
|
|
27907
27907
|
path?: never;
|
|
27908
27908
|
query?: {
|
|
27909
27909
|
/**
|
|
27910
|
-
* Maximum items to return per page. Range: 1-
|
|
27910
|
+
* Maximum items to return per page. Range: 1-250, default 50.
|
|
27911
27911
|
*/
|
|
27912
27912
|
limit?: number;
|
|
27913
27913
|
/**
|
|
@@ -28024,7 +28024,7 @@ export type GetLocationCountriesError = GetLocationCountriesErrors[keyof GetLoca
|
|
|
28024
28024
|
|
|
28025
28025
|
export type GetLocationCountriesResponses = {
|
|
28026
28026
|
/**
|
|
28027
|
-
* Alphabetically sorted list of all
|
|
28027
|
+
* Alphabetically sorted list of all countries with ISO codes and city counts
|
|
28028
28028
|
*/
|
|
28029
28029
|
200: {
|
|
28030
28030
|
/**
|
|
@@ -28075,7 +28075,7 @@ export type GetLocationCountriesByIso2Data = {
|
|
|
28075
28075
|
};
|
|
28076
28076
|
query?: {
|
|
28077
28077
|
/**
|
|
28078
|
-
* Maximum items to return per page. Range: 1-
|
|
28078
|
+
* Maximum items to return per page. Range: 1-100, default 20.
|
|
28079
28079
|
*/
|
|
28080
28080
|
limit?: number;
|
|
28081
28081
|
/**
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '1.2.
|
|
1
|
+
export const VERSION = '1.2.25';
|