@roxyapi/sdk 1.0.0

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.
Files changed (60) hide show
  1. package/README.md +118 -0
  2. package/dist/chunk-2UA7D7RW.js +1021 -0
  3. package/dist/client/client.gen.d.ts +3 -0
  4. package/dist/client/client.gen.d.ts.map +1 -0
  5. package/dist/client/index.cjs +1054 -0
  6. package/dist/client/index.d.ts +9 -0
  7. package/dist/client/index.d.ts.map +1 -0
  8. package/dist/client/index.js +20 -0
  9. package/dist/client/types.gen.d.ts +118 -0
  10. package/dist/client/types.gen.d.ts.map +1 -0
  11. package/dist/client/utils.gen.d.ts +34 -0
  12. package/dist/client/utils.gen.d.ts.map +1 -0
  13. package/dist/client.gen.d.ts +13 -0
  14. package/dist/client.gen.d.ts.map +1 -0
  15. package/dist/core/auth.gen.d.ts +19 -0
  16. package/dist/core/auth.gen.d.ts.map +1 -0
  17. package/dist/core/bodySerializer.gen.d.ts +26 -0
  18. package/dist/core/bodySerializer.gen.d.ts.map +1 -0
  19. package/dist/core/params.gen.d.ts +44 -0
  20. package/dist/core/params.gen.d.ts.map +1 -0
  21. package/dist/core/pathSerializer.gen.d.ts +34 -0
  22. package/dist/core/pathSerializer.gen.d.ts.map +1 -0
  23. package/dist/core/queryKeySerializer.gen.d.ts +19 -0
  24. package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
  25. package/dist/core/serverSentEvents.gen.d.ts +72 -0
  26. package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
  27. package/dist/core/types.gen.d.ts +79 -0
  28. package/dist/core/types.gen.d.ts.map +1 -0
  29. package/dist/core/utils.gen.d.ts +20 -0
  30. package/dist/core/utils.gen.d.ts.map +1 -0
  31. package/dist/factory.cjs +2703 -0
  32. package/dist/factory.d.ts +17 -0
  33. package/dist/factory.d.ts.map +1 -0
  34. package/dist/factory.js +1868 -0
  35. package/dist/index.cjs +1054 -0
  36. package/dist/index.d.ts +3 -0
  37. package/dist/index.d.ts.map +1 -0
  38. package/dist/index.js +1020 -0
  39. package/dist/sdk.gen.d.ts +808 -0
  40. package/dist/sdk.gen.d.ts.map +1 -0
  41. package/dist/types.gen.d.ts +12810 -0
  42. package/dist/types.gen.d.ts.map +1 -0
  43. package/package.json +66 -0
  44. package/src/client/client.gen.ts +290 -0
  45. package/src/client/index.ts +25 -0
  46. package/src/client/types.gen.ts +214 -0
  47. package/src/client/utils.gen.ts +316 -0
  48. package/src/client.gen.ts +16 -0
  49. package/src/core/auth.gen.ts +41 -0
  50. package/src/core/bodySerializer.gen.ts +82 -0
  51. package/src/core/params.gen.ts +169 -0
  52. package/src/core/pathSerializer.gen.ts +171 -0
  53. package/src/core/queryKeySerializer.gen.ts +117 -0
  54. package/src/core/serverSentEvents.gen.ts +243 -0
  55. package/src/core/types.gen.ts +104 -0
  56. package/src/core/utils.gen.ts +140 -0
  57. package/src/factory.ts +31 -0
  58. package/src/index.ts +4 -0
  59. package/src/sdk.gen.ts +1995 -0
  60. package/src/types.gen.ts +13274 -0
package/src/sdk.gen.ts ADDED
@@ -0,0 +1,1995 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+
3
+ import type { Client, Options as Options2, TDataShape } from './client';
4
+ import { client } from './client.gen';
5
+ import type { GetAngelNumbersDailyData, GetAngelNumbersDailyResponses, GetAngelNumbersLookupData, GetAngelNumbersLookupResponses, GetAngelNumbersNumbersByNumberData, GetAngelNumbersNumbersByNumberErrors, GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersData, GetAngelNumbersNumbersResponses, GetAstrologyHoroscopeBySignDailyData, GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignMonthlyData, GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignWeeklyData, GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyHoroscopeDailyData, GetAstrologyHoroscopeDailyResponses, GetAstrologyMoonPhaseCalendarByYearByMonthData, GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCurrentData, GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseUpcomingData, GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyPlanetMeaningsByIdentifierData, GetAstrologyPlanetMeaningsByIdentifierErrors, GetAstrologyPlanetMeaningsByIdentifierResponses, GetAstrologyPlanetMeaningsData, GetAstrologyPlanetMeaningsResponses, GetAstrologySignsByIdentifierData, GetAstrologySignsByIdentifierErrors, GetAstrologySignsByIdentifierResponses, GetAstrologySignsData, GetAstrologySignsResponses, GetCrystalsBirthstoneByMonthData, GetCrystalsBirthstoneByMonthResponses, GetCrystalsBySlugData, GetCrystalsBySlugErrors, GetCrystalsBySlugResponses, GetCrystalsChakraByChakraData, GetCrystalsChakraByChakraResponses, GetCrystalsColorsData, GetCrystalsColorsResponses, GetCrystalsDailyData, GetCrystalsDailyResponses, GetCrystalsData, GetCrystalsElementByElementData, GetCrystalsElementByElementResponses, GetCrystalsPairingsBySlugData, GetCrystalsPairingsBySlugErrors, GetCrystalsPairingsBySlugResponses, GetCrystalsPlanetsData, GetCrystalsPlanetsResponses, GetCrystalsRandomData, GetCrystalsRandomResponses, GetCrystalsResponses, GetCrystalsSearchData, GetCrystalsSearchResponses, GetCrystalsZodiacBySignData, GetCrystalsZodiacBySignResponses, GetDreamsSymbolsByIdData, GetDreamsSymbolsByIdErrors, GetDreamsSymbolsByIdResponses, GetDreamsSymbolsData, GetDreamsSymbolsLettersData, GetDreamsSymbolsLettersResponses, GetDreamsSymbolsRandomData, GetDreamsSymbolsRandomResponses, GetDreamsSymbolsResponses, GetIchingCastData, GetIchingCastResponses, GetIchingHexagramsByNumberData, GetIchingHexagramsByNumberErrors, GetIchingHexagramsByNumberResponses, GetIchingHexagramsData, GetIchingHexagramsLookupData, GetIchingHexagramsLookupErrors, GetIchingHexagramsLookupResponses, GetIchingHexagramsRandomData, GetIchingHexagramsRandomErrors, GetIchingHexagramsRandomResponses, GetIchingHexagramsResponses, GetIchingTrigramsByIdentifierData, GetIchingTrigramsByIdentifierErrors, GetIchingTrigramsByIdentifierResponses, GetIchingTrigramsData, GetIchingTrigramsResponses, GetLocationCountriesByIso2Data, GetLocationCountriesByIso2Responses, GetLocationCountriesData, GetLocationCountriesResponses, GetLocationSearchData, GetLocationSearchResponses, GetNumerologyMeaningsByNumberData, GetNumerologyMeaningsByNumberErrors, GetNumerologyMeaningsByNumberResponses, GetTarotCardsByIdData, GetTarotCardsByIdErrors, GetTarotCardsByIdResponses, GetTarotCardsData, GetTarotCardsResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetVedicAstrologyKpAyanamsaData, GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyNakshatrasByIdData, GetVedicAstrologyNakshatrasByIdErrors, GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasData, GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyRashisByIdData, GetVedicAstrologyRashisByIdErrors, GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisData, GetVedicAstrologyRashisResponses, GetVedicAstrologyYogaByIdData, GetVedicAstrologyYogaByIdErrors, GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaData, GetVedicAstrologyYogaResponses, PostAstrologyAspectsData, PostAstrologyAspectsResponses, PostAstrologyCompatibilityScoreData, PostAstrologyCompatibilityScoreResponses, PostAstrologyCompositeChartData, PostAstrologyCompositeChartResponses, PostAstrologyHousesData, PostAstrologyHousesResponses, PostAstrologyLunarReturnData, PostAstrologyLunarReturnResponses, PostAstrologyNatalChartData, PostAstrologyNatalChartResponses, PostAstrologyPlanetaryReturnsData, PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetsData, PostAstrologyPlanetsResponses, PostAstrologySolarReturnData, PostAstrologySolarReturnResponses, PostAstrologySynastryData, PostAstrologySynastryResponses, PostAstrologyTransitAspectsData, PostAstrologyTransitAspectsResponses, PostAstrologyTransitsData, PostAstrologyTransitsResponses, PostDreamsDailyData, PostDreamsDailyResponses, PostIchingDailyCastData, PostIchingDailyCastResponses, PostIchingDailyData, PostIchingDailyErrors, PostIchingDailyResponses, PostNumerologyBirthDayData, PostNumerologyBirthDayResponses, PostNumerologyChartData, PostNumerologyChartResponses, PostNumerologyCompatibilityData, PostNumerologyCompatibilityResponses, PostNumerologyDailyData, PostNumerologyDailyResponses, PostNumerologyExpressionData, PostNumerologyExpressionResponses, PostNumerologyKarmicDebtData, PostNumerologyKarmicDebtResponses, PostNumerologyKarmicLessonsData, PostNumerologyKarmicLessonsResponses, PostNumerologyLifePathData, PostNumerologyLifePathResponses, PostNumerologyMaturityData, PostNumerologyMaturityResponses, PostNumerologyPersonalityData, PostNumerologyPersonalityResponses, PostNumerologyPersonalYearData, PostNumerologyPersonalYearResponses, PostNumerologySoulUrgeData, PostNumerologySoulUrgeResponses, PostTarotDailyData, PostTarotDailyErrors, PostTarotDailyResponses, PostTarotDrawData, PostTarotDrawResponses, PostTarotSpreadsCareerData, PostTarotSpreadsCareerResponses, PostTarotSpreadsCelticCrossData, PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCustomData, PostTarotSpreadsCustomResponses, PostTarotSpreadsLoveData, PostTarotSpreadsLoveResponses, PostTarotSpreadsThreeCardData, PostTarotSpreadsThreeCardResponses, PostTarotYesNoData, PostTarotYesNoErrors, PostTarotYesNoResponses, PostVedicAstrologyAshtakavargaData, PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAspectsData, PostVedicAstrologyAspectsLunarData, PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsMonthlyData, PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsResponses, PostVedicAstrologyBirthChartData, PostVedicAstrologyBirthChartResponses, PostVedicAstrologyCompatibilityData, PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyDashaCurrentData, PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaMajorData, PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaSubByMahadashaData, PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDivisionalChartData, PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDoshaKalsarpaData, PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaManglikData, PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaSadhesatiData, PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyEclipticCrossingsData, PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyKpChartData, PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpCuspsData, PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpPlanetsData, PostVedicAstrologyKpPlanetsIntervalData, PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpRasiChangesData, PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRulingPlanetsData, PostVedicAstrologyKpRulingPlanetsIntervalData, PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpSublordChangesData, PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyNavamsaData, PostVedicAstrologyNavamsaResponses, PostVedicAstrologyPanchangBasicData, PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangChoghadiyaData, PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangDetailedData, PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangHoraData, PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyParallelsData, PostVedicAstrologyParallelsMonthlyData, PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsResponses, PostVedicAstrologyPlanetaryPositionsData, PostVedicAstrologyPlanetaryPositionsMonthlyData, PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyShadbalaData, PostVedicAstrologyShadbalaResponses, PostVedicAstrologyTransitData, PostVedicAstrologyTransitMonthlyData, PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitResponses, PostVedicAstrologyUpagrahaData, PostVedicAstrologyUpagrahaResponses } from './types.gen';
6
+
7
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
8
+ /**
9
+ * You can provide a client instance returned by `createClient()` instead of
10
+ * individual options. This might be also useful if you want to implement a
11
+ * custom client.
12
+ */
13
+ client?: Client;
14
+ /**
15
+ * You can pass arbitrary values through the `meta` object. This can be
16
+ * used to access values that aren't defined as part of the SDK function.
17
+ */
18
+ meta?: Record<string, unknown>;
19
+ };
20
+
21
+ class HeyApiClient {
22
+ protected client: Client;
23
+
24
+ constructor(args?: {
25
+ client?: Client;
26
+ }) {
27
+ this.client = args?.client ?? client;
28
+ }
29
+ }
30
+
31
+ class HeyApiRegistry<T> {
32
+ private readonly defaultKey = 'default';
33
+
34
+ private readonly instances: Map<string, T> = new Map();
35
+
36
+ get(key?: string): T {
37
+ const instance = this.instances.get(key ?? this.defaultKey);
38
+ if (!instance) {
39
+ throw new Error(`No SDK client found. Create one with "new Roxy()" to fix this error.`);
40
+ }
41
+ return instance;
42
+ }
43
+
44
+ set(value: T, key?: string): void {
45
+ this.instances.set(key ?? this.defaultKey, value);
46
+ }
47
+ }
48
+
49
+ export class AngelNumbers extends HeyApiClient {
50
+ /**
51
+ * List All Angel Numbers
52
+ *
53
+ * Retrieve the complete database of angel numbers with summary information. Returns all 43 angel numbers covering root digits (0-9), master numbers (11, 22, 33), double digits (44-99), triple repeating (111-999), quad repeating (1111-9999), mirror patterns (1212), and sequential numbers (1234). Supports optional type filtering. Perfect for building angel number explorer apps, reference guides, and spiritual databases.
54
+ */
55
+ public listAngelNumbers<ThrowOnError extends boolean = false>(options?: Options<GetAngelNumbersNumbersData, ThrowOnError>) {
56
+ return (options?.client ?? this.client).get<GetAngelNumbersNumbersResponses, unknown, ThrowOnError>({
57
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
58
+ url: '/angel-numbers/numbers',
59
+ ...options
60
+ });
61
+ }
62
+
63
+ /**
64
+ * Get Angel Number Meaning
65
+ *
66
+ * Get the complete, authoritative meaning and interpretation for a specific angel number. Returns detailed spiritual, love, career, and twin flame interpretations along with keywords, affirmation, and actionable steps. Covers 43 angel numbers including 111, 222, 333, 444, 555, 666, 777, 888, 999, 1111, 1212, 1234, and more. Authoritative interpretations covering all major angel number patterns.
67
+ */
68
+ public getAngelNumber<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersNumbersByNumberData, ThrowOnError>) {
69
+ return (options.client ?? this.client).get<GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersByNumberErrors, ThrowOnError>({
70
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
71
+ url: '/angel-numbers/numbers/{number}',
72
+ ...options
73
+ });
74
+ }
75
+
76
+ /**
77
+ * Analyze Any Number Sequence
78
+ *
79
+ * Smart angel number analysis that works for ANY number sequence, not just known angel numbers. Automatically classifies the pattern type (repeating, sequential, mirror, master, root), calculates the numerology digit root, checks the database for a known meaning, and provides the foundational digit root interpretation as a fallback. Perfect for synchronicity tracking apps where users enter arbitrary number sequences they encounter.
80
+ */
81
+ public analyzeNumberSequence<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersLookupData, ThrowOnError>) {
82
+ return (options.client ?? this.client).get<GetAngelNumbersLookupResponses, unknown, ThrowOnError>({
83
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
84
+ url: '/angel-numbers/lookup',
85
+ ...options
86
+ });
87
+ }
88
+
89
+ /**
90
+ * Daily Angel Number
91
+ *
92
+ * Get the angel number of the day with full meaning and interpretation. Returns a deterministic angel number based on the current date (or a provided seed date), ensuring all users see the same number for any given day. Includes complete spiritual, love, career, and twin flame interpretations. Perfect for daily guidance features, push notifications, content generation, and angel number widget integrations.
93
+ */
94
+ public getDailyAngelNumber<ThrowOnError extends boolean = false>(options?: Options<GetAngelNumbersDailyData, ThrowOnError>) {
95
+ return (options?.client ?? this.client).get<GetAngelNumbersDailyResponses, unknown, ThrowOnError>({
96
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
97
+ url: '/angel-numbers/daily',
98
+ ...options
99
+ });
100
+ }
101
+ }
102
+
103
+ export class Astrology extends HeyApiClient {
104
+ /**
105
+ * Get all zodiac signs - Complete zodiac signs list with dates and elements
106
+ *
107
+ * Returns all 12 tropical zodiac signs (Aries, Taurus, Gemini, Cancer, Leo, Virgo, Libra, Scorpio, Sagittarius, Capricorn, Aquarius, Pisces) with essential information: name, symbol, element (fire, earth, air, water), date ranges, and short descriptions. Perfect for zodiac sign lists, horoscope widgets, birth chart calculators, astrology apps, star sign selectors, and zodiac reference tools. Use GET /signs/{identifier} for complete zodiac sign profiles with personality traits, compatibility, and detailed characteristics.
108
+ */
109
+ public listZodiacSigns<ThrowOnError extends boolean = false>(options?: Options<GetAstrologySignsData, ThrowOnError>) {
110
+ return (options?.client ?? this.client).get<GetAstrologySignsResponses, unknown, ThrowOnError>({
111
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
112
+ url: '/astrology/signs',
113
+ ...options
114
+ });
115
+ }
116
+
117
+ /**
118
+ * Get zodiac sign details - Complete astrology sign profile with personality traits
119
+ *
120
+ * Retrieve comprehensive zodiac sign information for any astrological sign using lowercase ID (e.g., "aries") or case-insensitive name (e.g., "Aries", "ARIES"). Returns complete astrology profile including: element (fire, earth, air, water), modality (cardinal, fixed, mutable), ruling planet, birth date ranges, personality traits (positive, negative, keywords), zodiac sign descriptions, famous people with this sign, key strengths and qualities, sign motto, greatest gifts, challenges, and secret weapon. Perfect for horoscope readings, zodiac compatibility checks, birth chart interpretations, astrology blogs, star sign personality analysis, and zodiac meaning databases.
121
+ */
122
+ public getZodiacSign<ThrowOnError extends boolean = false>(options: Options<GetAstrologySignsByIdentifierData, ThrowOnError>) {
123
+ return (options.client ?? this.client).get<GetAstrologySignsByIdentifierResponses, GetAstrologySignsByIdentifierErrors, ThrowOnError>({
124
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
125
+ url: '/astrology/signs/{identifier}',
126
+ ...options
127
+ });
128
+ }
129
+
130
+ /**
131
+ * Get all planet meanings - Complete astrology planet interpretations list
132
+ *
133
+ * Returns all 10 astrological planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto) with essential meanings: name, symbol, tagline, category (personal/social/generational), ruling sign, and short descriptions. Perfect for astrology reference apps, planet meaning widgets, birth chart interpretation tools, astrology learning platforms, planetary keywords reference, and zodiac planet guides. Use GET /planet-meanings/{identifier} for complete planet profiles with detailed interpretations, keywords, temperature, and dignities (rulership/detriment/exultation/fall).
134
+ */
135
+ public listPlanetMeanings<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyPlanetMeaningsData, ThrowOnError>) {
136
+ return (options?.client ?? this.client).get<GetAstrologyPlanetMeaningsResponses, unknown, ThrowOnError>({
137
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
138
+ url: '/astrology/planet-meanings',
139
+ ...options
140
+ });
141
+ }
142
+
143
+ /**
144
+ * Get planet meaning details - Complete astrology planet interpretation
145
+ *
146
+ * Retrieve comprehensive planet interpretation for any astrological planet using lowercase ID (e.g., "sun", "moon") or case-insensitive name (e.g., "Sun", "MOON"). Returns complete astrology meaning including: symbol, tagline, category (personal/social/generational), temperature, orbital period, retrograde status, dignities (rulership/detriment/exultation/fall), positive and negative keywords, and short/long descriptions. Perfect for birth chart readings, planet meaning lookups, astrology education, natal chart interpretation, transit meanings, planetary symbolism reference, and keyword-based interpretations.
147
+ */
148
+ public getPlanetMeaning<ThrowOnError extends boolean = false>(options: Options<GetAstrologyPlanetMeaningsByIdentifierData, ThrowOnError>) {
149
+ return (options.client ?? this.client).get<GetAstrologyPlanetMeaningsByIdentifierResponses, GetAstrologyPlanetMeaningsByIdentifierErrors, ThrowOnError>({
150
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
151
+ url: '/astrology/planet-meanings/{identifier}',
152
+ ...options
153
+ });
154
+ }
155
+
156
+ /**
157
+ * Generate natal chart - Birth chart calculator API with houses and aspects
158
+ *
159
+ * Calculate complete Western astrology natal chart (birth chart) with tropical zodiac. Returns all 10 planetary positions (Sun through Pluto), 12 house cusps with customizable house systems (Placidus, Whole Sign, Equal, Koch), major and minor aspects, Ascendant, Midheaven, dominant elements and modalities. Perfect for astrology apps, birth chart generators, horoscope websites, and astrological consultation tools. NASA JPL-validated astronomical accuracy.
160
+ */
161
+ public generateNatalChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyNatalChartData, ThrowOnError>) {
162
+ return (options?.client ?? this.client).post<PostAstrologyNatalChartResponses, unknown, ThrowOnError>({
163
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
164
+ url: '/astrology/natal-chart',
165
+ ...options,
166
+ headers: {
167
+ 'Content-Type': 'application/json',
168
+ ...options?.headers
169
+ }
170
+ });
171
+ }
172
+
173
+ /**
174
+ * Get planetary positions - Ephemeris calculator for all planets
175
+ *
176
+ * Calculate accurate tropical zodiac positions for all 10 planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto) for any date, time, and location. Returns longitude, latitude, zodiac sign, degree within sign, daily motion speed, and retrograde status. Perfect for transit tracking, ephemeris tables, astrology apps, and planetary position widgets. NASA JPL-validated accuracy.
177
+ */
178
+ public getPlanetaryPositions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetsData, ThrowOnError>) {
179
+ return (options?.client ?? this.client).post<PostAstrologyPlanetsResponses, unknown, ThrowOnError>({
180
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
181
+ url: '/astrology/planets',
182
+ ...options,
183
+ headers: {
184
+ 'Content-Type': 'application/json',
185
+ ...options?.headers
186
+ }
187
+ });
188
+ }
189
+
190
+ /**
191
+ * Get current moon phase - Lunar phase calculator with zodiac sign
192
+ *
193
+ * Get current moon phase with illumination percentage, lunar age (days since new moon), zodiac sign, and distance from Earth. Returns phase name (New Moon, Waxing Crescent Moon, First Quarter Moon, Waxing Gibbous Moon, Full Moon, Waning Gibbous Moon, Last Quarter Moon, Waning Crescent Moon) plus exact lunar position. Perfect for moon tracking apps, lunar calendars, astrology widgets, and gardening by moon phase tools.
194
+ */
195
+ public getCurrentMoonPhase<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseCurrentData, ThrowOnError>) {
196
+ return (options?.client ?? this.client).get<GetAstrologyMoonPhaseCurrentResponses, unknown, ThrowOnError>({
197
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
198
+ url: '/astrology/moon-phase/current',
199
+ ...options
200
+ });
201
+ }
202
+
203
+ /**
204
+ * Get upcoming moon phases - Next new moon, full moon, quarters
205
+ *
206
+ * Get upcoming moon phase transitions (New Moon, First Quarter, Full Moon, Last Quarter) for the next weeks/months. Returns dates and phase names for each lunar quarter. Perfect for lunar event calendars, moon phase widgets, and astrology planning tools.
207
+ */
208
+ public getUpcomingMoonPhases<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseUpcomingData, ThrowOnError>) {
209
+ return (options?.client ?? this.client).get<GetAstrologyMoonPhaseUpcomingResponses, unknown, ThrowOnError>({
210
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
211
+ url: '/astrology/moon-phase/upcoming',
212
+ ...options
213
+ });
214
+ }
215
+
216
+ /**
217
+ * Get lunar calendar - Moon phases for entire month
218
+ *
219
+ * Get complete lunar calendar showing moon phase and illumination for every day of a specific month. Perfect for creating moon phase calendars, lunar planners, and astrology event schedules.
220
+ */
221
+ public getMoonCalendar<ThrowOnError extends boolean = false>(options: Options<GetAstrologyMoonPhaseCalendarByYearByMonthData, ThrowOnError>) {
222
+ return (options.client ?? this.client).get<GetAstrologyMoonPhaseCalendarByYearByMonthResponses, unknown, ThrowOnError>({
223
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
224
+ url: '/astrology/moon-phase/calendar/{year}/{month}',
225
+ ...options
226
+ });
227
+ }
228
+
229
+ /**
230
+ * Calculate synastry - Relationship compatibility analysis API
231
+ *
232
+ * Calculate complete synastry (relationship compatibility) between two natal charts using Western tropical astrology. Analyzes inter-chart aspects between all planets to determine romantic, friendship, and karmic compatibility. Returns compatibility score (0-100), detailed inter-aspects with strength ratings, harmonious vs challenging aspect counts, and relationship dynamics analysis. Perfect for dating apps, matrimonial sites, relationship counseling tools, and astrology compatibility features. Based on professional astrological techniques.
233
+ */
234
+ public calculateSynastry<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySynastryData, ThrowOnError>) {
235
+ return (options?.client ?? this.client).post<PostAstrologySynastryResponses, unknown, ThrowOnError>({
236
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
237
+ url: '/astrology/synastry',
238
+ ...options,
239
+ headers: {
240
+ 'Content-Type': 'application/json',
241
+ ...options?.headers
242
+ }
243
+ });
244
+ }
245
+
246
+ /**
247
+ * Calculate house cusps - House system calculator with comparison
248
+ *
249
+ * Calculate astrological house cusps using Placidus, Whole Sign, Equal, or Koch house systems. Returns all 12 house cusps with zodiac signs, degrees, Ascendant, and Midheaven. Use "all" parameter to compare all 4 house systems side-by-side. Perfect for astrology charts, house cusp tables, and educational tools showing house system differences. Includes accurate Ascendant and MC calculations.
250
+ */
251
+ public calculateHouses<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyHousesData, ThrowOnError>) {
252
+ return (options?.client ?? this.client).post<PostAstrologyHousesResponses, unknown, ThrowOnError>({
253
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
254
+ url: '/astrology/houses',
255
+ ...options,
256
+ headers: {
257
+ 'Content-Type': 'application/json',
258
+ ...options?.headers
259
+ }
260
+ });
261
+ }
262
+
263
+ /**
264
+ * Calculate planetary aspects - Aspect finder for any date and time
265
+ *
266
+ * Calculate all major and minor aspects between planets for any date and time. Finds conjunctions (0°), oppositions (180°), trines (120°), squares (90°), sextiles (60°), and minor aspects. Returns aspect type, exact angle, orb, applying/separating status, and strength (0-100). Filter by specific planets or aspect types. Perfect for aspect tables, transit analysis, and aspect pattern detection. Uses standard Western astrology orbs.
267
+ */
268
+ public calculateAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectsData, ThrowOnError>) {
269
+ return (options?.client ?? this.client).post<PostAstrologyAspectsResponses, unknown, ThrowOnError>({
270
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
271
+ url: '/astrology/aspects',
272
+ ...options,
273
+ headers: {
274
+ 'Content-Type': 'application/json',
275
+ ...options?.headers
276
+ }
277
+ });
278
+ }
279
+
280
+ /**
281
+ * Calculate planetary transits - Current transits with natal chart comparison
282
+ *
283
+ * Calculate current or future planetary transits (positions of all planets now). Optionally compare transits to natal chart to find transit-to-natal aspects. Returns all 10 planet positions with signs, degrees, and speeds. When natal chart provided, includes transit aspects (transiting Sun conjunct natal Mars, etc.) with orbs and applying/separating status. Perfect for daily transit forecasts, aspect alerts, and personalized transit reports.
284
+ */
285
+ public calculateTransits<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitsData, ThrowOnError>) {
286
+ return (options?.client ?? this.client).post<PostAstrologyTransitsResponses, unknown, ThrowOnError>({
287
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
288
+ url: '/astrology/transits',
289
+ ...options,
290
+ headers: {
291
+ 'Content-Type': 'application/json',
292
+ ...options?.headers
293
+ }
294
+ });
295
+ }
296
+
297
+ /**
298
+ * Transit Aspects - Detailed transit-to-natal aspect analysis with interpretations
299
+ *
300
+ * Calculate all transit-to-natal aspects with detailed interpretations, strength ratings, and timing guidance. Compares current (or future) planetary positions against your natal chart to identify active transits. Returns aspect type, orb, applying/separating status, narrative interpretation, impact rating, and practical guidance for each transit. Supports planet and aspect-type filtering. More detailed than the /transits endpoint — includes AI-friendly interpretation fields. Transit aspects API, transit-to-natal analysis, predictive astrology, personalized transit forecast.
301
+ */
302
+ public calculateTransitAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitAspectsData, ThrowOnError>) {
303
+ return (options?.client ?? this.client).post<PostAstrologyTransitAspectsResponses, unknown, ThrowOnError>({
304
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
305
+ url: '/astrology/transit-aspects',
306
+ ...options,
307
+ headers: {
308
+ 'Content-Type': 'application/json',
309
+ ...options?.headers
310
+ }
311
+ });
312
+ }
313
+
314
+ /**
315
+ * Solar Return Chart - Annual birthday forecast with relocated chart
316
+ *
317
+ * Generate a solar return chart for any year — the foundational technique for annual astrological forecasting. The chart is cast for the exact moment the transiting Sun returns to its natal ecliptic longitude (your astrological birthday). Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Location-sensitive: relocating your solar return chart to a different city changes the houses and Ascendant. Solar return chart API, annual horoscope forecast, birthday chart calculator, yearly astrology prediction, relocated solar return.
318
+ */
319
+ public generateSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarReturnData, ThrowOnError>) {
320
+ return (options?.client ?? this.client).post<PostAstrologySolarReturnResponses, unknown, ThrowOnError>({
321
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
322
+ url: '/astrology/solar-return',
323
+ ...options,
324
+ headers: {
325
+ 'Content-Type': 'application/json',
326
+ ...options?.headers
327
+ }
328
+ });
329
+ }
330
+
331
+ /**
332
+ * Lunar Return Chart - Monthly emotional forecast with Moon cycle chart
333
+ *
334
+ * Generate a lunar return chart for any month — cast for the exact moment the transiting Moon returns to its natal ecliptic longitude. The Moon completes one sidereal orbit every ~27.3 days, making this the primary technique for monthly astrological forecasting. Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Reveals emotional patterns, domestic focus, and intuitive themes for the coming month. Lunar return chart API, monthly horoscope forecast, Moon cycle chart, emotional astrology prediction.
335
+ */
336
+ public generateLunarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLunarReturnData, ThrowOnError>) {
337
+ return (options?.client ?? this.client).post<PostAstrologyLunarReturnResponses, unknown, ThrowOnError>({
338
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
339
+ url: '/astrology/lunar-return',
340
+ ...options,
341
+ headers: {
342
+ 'Content-Type': 'application/json',
343
+ ...options?.headers
344
+ }
345
+ });
346
+ }
347
+
348
+ /**
349
+ * Composite Chart - Midpoint relationship chart with interpretations
350
+ *
351
+ * Generate a composite chart by calculating midpoints between two natal charts. The composite chart represents the relationship as a single entity, showing its core identity, emotional bond, communication style, and growth direction. Returns composite planetary positions, house cusps, Ascendant, Midheaven, aspects, and relationship interpretation. Composite chart API, midpoint chart calculator, relationship astrology, couple chart analysis.
352
+ */
353
+ public generateCompositeChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompositeChartData, ThrowOnError>) {
354
+ return (options?.client ?? this.client).post<PostAstrologyCompositeChartResponses, unknown, ThrowOnError>({
355
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
356
+ url: '/astrology/composite-chart',
357
+ ...options,
358
+ headers: {
359
+ 'Content-Type': 'application/json',
360
+ ...options?.headers
361
+ }
362
+ });
363
+ }
364
+
365
+ /**
366
+ * Compatibility Score - Relationship compatibility analysis with category breakdown
367
+ *
368
+ * Calculate a detailed compatibility score between two birth charts using Western synastry (inter-chart aspects). Returns overall score (0-100) plus category breakdowns for romantic, emotional, intellectual, physical, and spiritual compatibility. Each category analyzes specific planetary pairs: Venus-Mars for romance, Moon-Moon for emotions, Mercury-Mercury for intellect. Includes relationship strengths, challenges, and narrative interpretation. Compatibility score API, love match calculator, relationship astrology, synastry score.
369
+ */
370
+ public calculateCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompatibilityScoreData, ThrowOnError>) {
371
+ return (options?.client ?? this.client).post<PostAstrologyCompatibilityScoreResponses, unknown, ThrowOnError>({
372
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
373
+ url: '/astrology/compatibility-score',
374
+ ...options,
375
+ headers: {
376
+ 'Content-Type': 'application/json',
377
+ ...options?.headers
378
+ }
379
+ });
380
+ }
381
+
382
+ /**
383
+ * Daily horoscope by zodiac sign - Transit-based forecast
384
+ *
385
+ * Get the daily horoscope for any zodiac sign. Forecast is generated from real-time planetary transits through the sign, covering love, career, health, finance, and general outlook. Returns lucky number, lucky color, and compatible signs. Daily horoscope API, zodiac forecast, sun sign horoscope, astrology prediction.
386
+ */
387
+ public getDailyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignDailyData, ThrowOnError>) {
388
+ return (options.client ?? this.client).get<GetAstrologyHoroscopeBySignDailyResponses, unknown, ThrowOnError>({
389
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
390
+ url: '/astrology/horoscope/{sign}/daily',
391
+ ...options
392
+ });
393
+ }
394
+
395
+ /**
396
+ * All zodiac signs daily horoscope - Batch forecast for all 12 signs
397
+ *
398
+ * Retrieve daily horoscope forecasts for all 12 zodiac signs in a single request. More efficient than making 12 individual sign requests. Each sign includes love, career, health, finance, lucky number, lucky color, and compatible signs. Bulk horoscope API, all signs daily forecast, zodiac horoscope feed.
399
+ */
400
+ public getAllDailyHoroscopes<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyHoroscopeDailyData, ThrowOnError>) {
401
+ return (options?.client ?? this.client).get<GetAstrologyHoroscopeDailyResponses, unknown, ThrowOnError>({
402
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
403
+ url: '/astrology/horoscope/daily',
404
+ ...options
405
+ });
406
+ }
407
+
408
+ /**
409
+ * Weekly horoscope by zodiac sign - 7-day transit forecast
410
+ *
411
+ * Get weekly horoscope for any zodiac sign. Forecast covers a full 7-day period based on planetary transits through the sign, with love, career, health, finance guidance plus lucky days, lucky numbers, and compatible signs. Weekly horoscope API, zodiac weekly forecast, astrology weekly prediction.
412
+ */
413
+ public getWeeklyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignWeeklyData, ThrowOnError>) {
414
+ return (options.client ?? this.client).get<GetAstrologyHoroscopeBySignWeeklyResponses, unknown, ThrowOnError>({
415
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
416
+ url: '/astrology/horoscope/{sign}/weekly',
417
+ ...options
418
+ });
419
+ }
420
+
421
+ /**
422
+ * Monthly horoscope by zodiac sign - 30-day transit forecast
423
+ *
424
+ * Get monthly horoscope for any zodiac sign with week-by-week breakdown and key dates. Based on planetary transits through the sign, covering love, career, health, and finance for the entire month. Includes important astrological dates and lucky numbers. Monthly horoscope API, zodiac monthly forecast, astrology monthly prediction.
425
+ */
426
+ public getMonthlyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignMonthlyData, ThrowOnError>) {
427
+ return (options.client ?? this.client).get<GetAstrologyHoroscopeBySignMonthlyResponses, unknown, ThrowOnError>({
428
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
429
+ url: '/astrology/horoscope/{sign}/monthly',
430
+ ...options
431
+ });
432
+ }
433
+
434
+ /**
435
+ * Planetary Return Chart - Saturn return, Jupiter return, and inner planet cycles
436
+ *
437
+ * Generate a planetary return chart for Mercury, Venus, Mars, Jupiter, or Saturn. A planetary return occurs when a transiting planet conjuncts its natal longitude, marking the beginning of a new cycle. Saturn return (~29 years) is the most significant life milestone in Western astrology. Jupiter return (~12 years) signals expansion and growth phases. Mars return (~2 years) resets energy and drive. Returns full tropical zodiac chart with all planetary positions, house cusps, and aspects. Planetary return chart API, Saturn return calculator, Jupiter return chart, Mars return forecast.
438
+ */
439
+ public generatePlanetaryReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetaryReturnsData, ThrowOnError>) {
440
+ return (options?.client ?? this.client).post<PostAstrologyPlanetaryReturnsResponses, unknown, ThrowOnError>({
441
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
442
+ url: '/astrology/planetary-returns',
443
+ ...options,
444
+ headers: {
445
+ 'Content-Type': 'application/json',
446
+ ...options?.headers
447
+ }
448
+ });
449
+ }
450
+ }
451
+
452
+ export class VedicAstrology extends HeyApiClient {
453
+ /**
454
+ * Get birth chart (D1 Rashi chart) - Kundli Calculator API
455
+ *
456
+ * Calculate complete Vedic birth chart (Janam Kundli, natal chart) with all 9 planetary positions (Sun through Ketu) plus Ascendant (Lagna). Kundli calculator API for astrology apps, matrimonial sites. Returns accurate graha positions grouped by zodiac signs (rashis) with nakshatra details and pada. Perfect for kundli generation, horoscope matching, and Vedic astrology software integration.
457
+ */
458
+ public generateBirthChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBirthChartData, ThrowOnError>) {
459
+ return (options?.client ?? this.client).post<PostVedicAstrologyBirthChartResponses, unknown, ThrowOnError>({
460
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
461
+ url: '/vedic-astrology/birth-chart',
462
+ ...options,
463
+ headers: {
464
+ 'Content-Type': 'application/json',
465
+ ...options?.headers
466
+ }
467
+ });
468
+ }
469
+
470
+ /**
471
+ * Get Navamsa chart (D9) - Marriage Compatibility Calculator
472
+ *
473
+ * Calculate Navamsa (D9 divisional chart) for marriage compatibility analysis, spouse prediction, and spiritual life assessment. Navamsa calculator API reveals planetary strength in married life. Each planetary position is divided into 9 parts for accurate marriage astrology. Detects Vargottama planets (exalted status). Essential for matrimonial matching, relationship prediction, and marital harmony analysis in Vedic astrology.
474
+ */
475
+ public generateNavamsa<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyNavamsaData, ThrowOnError>) {
476
+ return (options?.client ?? this.client).post<PostVedicAstrologyNavamsaResponses, unknown, ThrowOnError>({
477
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
478
+ url: '/vedic-astrology/navamsa',
479
+ ...options,
480
+ headers: {
481
+ 'Content-Type': 'application/json',
482
+ ...options?.headers
483
+ }
484
+ });
485
+ }
486
+
487
+ /**
488
+ * Get divisional chart (Varga) - D2 to D60 Calculator
489
+ *
490
+ * Calculate any Vedic divisional chart (Varga) from D2 Hora to D60 Shashtiamsa. Divisional charts divide each zodiac sign into smaller segments to reveal detailed insights about specific life areas: wealth (D2), siblings (D3), property (D4), children (D7), marriage (D9), career (D10), parents (D12), vehicles (D16), spirituality (D20), education (D24), strength (D27), misfortunes (D30), merit (D40), character (D45), and past life karma (D60). Based on Brihat Parashara Hora Shastra (BPHS) Shodasha Varga system. Detects Vargottama planets (same sign in D1 and selected chart).
491
+ */
492
+ public generateDivisionalChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDivisionalChartData, ThrowOnError>) {
493
+ return (options?.client ?? this.client).post<PostVedicAstrologyDivisionalChartResponses, unknown, ThrowOnError>({
494
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
495
+ url: '/vedic-astrology/divisional-chart',
496
+ ...options,
497
+ headers: {
498
+ 'Content-Type': 'application/json',
499
+ ...options?.headers
500
+ }
501
+ });
502
+ }
503
+
504
+ /**
505
+ * Calculate compatibility score - Gun Milan API (Ashtakoot Matching)
506
+ *
507
+ * Calculate detailed Ashtakoot compatibility (Gun Milan) for kundli matching between two people. Returns accurate 36-point Guna Milan scale with breakdown across all 8 kootas (Varna, Vashya, Tara, Yoni, Graha Maitri, Gana, Bhakoot, Nadi), Nadi and Bhakoot dosha detection with classical cancellation analysis per Muhurta Martanda and BPHS rules, and marriage recommendation. Perfect for kundli matching for marriage, matrimonial platforms, horoscope compatibility, and Vedic matchmaking services.
508
+ */
509
+ public calculateGunMilan<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCompatibilityData, ThrowOnError>) {
510
+ return (options?.client ?? this.client).post<PostVedicAstrologyCompatibilityResponses, unknown, ThrowOnError>({
511
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
512
+ url: '/vedic-astrology/compatibility',
513
+ ...options,
514
+ headers: {
515
+ 'Content-Type': 'application/json',
516
+ ...options?.headers
517
+ }
518
+ });
519
+ }
520
+
521
+ /**
522
+ * Get planetary positions - Graha Positions API
523
+ *
524
+ * Get simplified planetary positions (graha positions) for all 9 planets (Sun through Ketu) plus Ascendant (Lagna). Real-time planet transit calculator for Vedic astrology. Navagraha positions API with nakshatra, pada, and rashi details. Includes house number placement using Whole Sign house system from Lagna. Faster response for basic planetary data without full chart structure. Perfect for planetary alignment tracking, daily transit updates, and astrology widgets.
525
+ */
526
+ public getPlanetPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsData, ThrowOnError>) {
527
+ return (options?.client ?? this.client).post<PostVedicAstrologyPlanetaryPositionsResponses, unknown, ThrowOnError>({
528
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
529
+ url: '/vedic-astrology/planetary-positions',
530
+ ...options,
531
+ headers: {
532
+ 'Content-Type': 'application/json',
533
+ ...options?.headers
534
+ }
535
+ });
536
+ }
537
+
538
+ /**
539
+ * Monthly Ephemeris - Daily sidereal planetary positions for a month
540
+ *
541
+ * Get daily sidereal ecliptic positions for all 9 Vedic planets (Navagraha) for an entire month. Returns longitude, zodiac sign, degree within sign, and retrograde status for each planet on each day. Calculated at noon UTC. Essential for ephemeris generation, transit tracking, and planetary movement visualization. Monthly planetary ephemeris API, sidereal position table, daily graha gochara positions, ecliptic longitude calculator.
542
+ */
543
+ public getMonthlyEphemeris<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsMonthlyData, ThrowOnError>) {
544
+ return (options?.client ?? this.client).post<PostVedicAstrologyPlanetaryPositionsMonthlyResponses, unknown, ThrowOnError>({
545
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
546
+ url: '/vedic-astrology/planetary-positions/monthly',
547
+ ...options,
548
+ headers: {
549
+ 'Content-Type': 'application/json',
550
+ ...options?.headers
551
+ }
552
+ });
553
+ }
554
+
555
+ /**
556
+ * Get current Mahadasha, Antardasha, Pratyantardasha - Dasha Calculator API
557
+ *
558
+ * Calculate current Vimshottari Dasha periods (Mahadasha, Antardasha, Pratyantardasha) with remaining time. Accurate dasha calculator API for life phase prediction and planetary period analysis. Returns dasha timeline with start/end dates for each period. Essential for understanding current planetary influences, dasha transitions, and timing events in Vedic astrology. 120-year dasha system based on moon nakshatra at birth.
559
+ */
560
+ public getCurrentDasha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaCurrentData, ThrowOnError>) {
561
+ return (options?.client ?? this.client).post<PostVedicAstrologyDashaCurrentResponses, unknown, ThrowOnError>({
562
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
563
+ url: '/vedic-astrology/dasha/current',
564
+ ...options,
565
+ headers: {
566
+ 'Content-Type': 'application/json',
567
+ ...options?.headers
568
+ }
569
+ });
570
+ }
571
+
572
+ /**
573
+ * Get all 9 Mahadasha periods (120-year cycle)
574
+ *
575
+ * Returns complete Vimshottari Dasha cycle starting from birth. Shows all major planetary periods from birth through 120 years.
576
+ */
577
+ public getMajorDashas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaMajorData, ThrowOnError>) {
578
+ return (options?.client ?? this.client).post<PostVedicAstrologyDashaMajorResponses, unknown, ThrowOnError>({
579
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
580
+ url: '/vedic-astrology/dasha/major',
581
+ ...options,
582
+ headers: {
583
+ 'Content-Type': 'application/json',
584
+ ...options?.headers
585
+ }
586
+ });
587
+ }
588
+
589
+ /**
590
+ * Get all Antardashas (sub-periods) for a specific Mahadasha
591
+ *
592
+ * Returns 9 Antardasha sub-periods within a Mahadasha. Each Mahadasha is divided into 9 proportional sub-periods.
593
+ */
594
+ public getSubDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaData, ThrowOnError>) {
595
+ return (options.client ?? this.client).post<PostVedicAstrologyDashaSubByMahadashaResponses, unknown, ThrowOnError>({
596
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
597
+ url: '/vedic-astrology/dasha/sub/{mahadasha}',
598
+ ...options,
599
+ headers: {
600
+ 'Content-Type': 'application/json',
601
+ ...options.headers
602
+ }
603
+ });
604
+ }
605
+
606
+ /**
607
+ * Get basic Panchang - Tithi Nakshatra Yoga Karana Calculator
608
+ *
609
+ * Calculate Panchang elements (Hindu calendar) for any date: Tithi (lunar day), Nakshatra (lunar mansion), Yoga, and Karana. Daily panchang API for determining auspicious timings (muhurta), festival dates, and planetary influences. Tithi calculator with Shukla/Krishna paksha. Accurate nakshatra today with ruling planet. Essential for Hindu calendar integration, muhurta selection, and Vedic timekeeping in astrology apps.
610
+ */
611
+ public getBasicPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangBasicData, ThrowOnError>) {
612
+ return (options?.client ?? this.client).post<PostVedicAstrologyPanchangBasicResponses, unknown, ThrowOnError>({
613
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
614
+ url: '/vedic-astrology/panchang/basic',
615
+ ...options,
616
+ headers: {
617
+ 'Content-Type': 'application/json',
618
+ ...options?.headers
619
+ }
620
+ });
621
+ }
622
+
623
+ /**
624
+ * Get detailed Panchang with Rahu Kaal, Yamaganda, Gulika
625
+ *
626
+ * Complete daily panchang with all five limbs (Tithi, Nakshatra, Yoga, Karana, Vara) plus sunrise, sunset, moonrise, moonset times. Includes inauspicious periods (Rahu Kaal, Yamaganda, Gulika Kaal) and auspicious windows (Abhijit Muhurta, Brahma Muhurta). Current planetary hora with start/end times. Essential for muhurta selection, daily horoscope apps, Hindu calendar integration, and electional astrology. Accurate calculations based on observer location.
627
+ */
628
+ public getDetailedPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangDetailedData, ThrowOnError>) {
629
+ return (options?.client ?? this.client).post<PostVedicAstrologyPanchangDetailedResponses, unknown, ThrowOnError>({
630
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
631
+ url: '/vedic-astrology/panchang/detailed',
632
+ ...options,
633
+ headers: {
634
+ 'Content-Type': 'application/json',
635
+ ...options?.headers
636
+ }
637
+ });
638
+ }
639
+
640
+ /**
641
+ * Get Choghadiya - 8 Muhurta divisions of day and night
642
+ *
643
+ * Calculate Choghadiya (Chaughadia) muhurta timings for any date and location. Divides day (sunrise to sunset) and night (sunset to next sunrise) into 8 equal auspicious/inauspicious periods. Each period ruled by a planet: Udveg (Sun, bad), Amrit (Moon, good), Rog (Mars, bad), Labh (Mercury, good), Shubh (Jupiter, good), Char (Venus, good), Kaal (Saturn, bad). Essential for muhurta selection, daily planning, and traditional Hindu timekeeping. Choghadiya calculator API, daily muhurat timings, auspicious time finder.
644
+ */
645
+ public getChoghadiya<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangChoghadiyaData, ThrowOnError>) {
646
+ return (options?.client ?? this.client).post<PostVedicAstrologyPanchangChoghadiyaResponses, unknown, ThrowOnError>({
647
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
648
+ url: '/vedic-astrology/panchang/choghadiya',
649
+ ...options,
650
+ headers: {
651
+ 'Content-Type': 'application/json',
652
+ ...options?.headers
653
+ }
654
+ });
655
+ }
656
+
657
+ /**
658
+ * Get Hora - 24 Planetary Hours (12 day + 12 night)
659
+ *
660
+ * Calculate all 24 Hora (planetary hour) periods for any date and location. Day is divided into 12 equal horas from sunrise to sunset, night into 12 equal horas from sunset to next sunrise. Each hora is ruled by a planet in the Chaldean sequence starting from the day lord. Hora timings API, planetary hours calculator, Vedic hora chart, electional astrology timing.
661
+ */
662
+ public getHora<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangHoraData, ThrowOnError>) {
663
+ return (options?.client ?? this.client).post<PostVedicAstrologyPanchangHoraResponses, unknown, ThrowOnError>({
664
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
665
+ url: '/vedic-astrology/panchang/hora',
666
+ ...options,
667
+ headers: {
668
+ 'Content-Type': 'application/json',
669
+ ...options?.headers
670
+ }
671
+ });
672
+ }
673
+
674
+ /**
675
+ * Check Manglik Dosha - Mangal Dosha Calculator API
676
+ *
677
+ * Detect Manglik dosha (Kuja dosha, Mars dosha) based on Mars position in inauspicious houses (1, 2, 4, 7, 8, 12) from Lagna. Accurate mangal dosha calculator for matrimonial compatibility checks in Vedic astrology. Returns severity levels (Mild/Moderate/Severe) and cancellation factors. Essential for kundli matching for marriage, manglik compatibility, and marriage astrology in matrimonial sites. Includes exceptions that reduce manglik dosha effects.
678
+ */
679
+ public checkManglikDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaManglikData, ThrowOnError>) {
680
+ return (options?.client ?? this.client).post<PostVedicAstrologyDoshaManglikResponses, unknown, ThrowOnError>({
681
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
682
+ url: '/vedic-astrology/dosha/manglik',
683
+ ...options,
684
+ headers: {
685
+ 'Content-Type': 'application/json',
686
+ ...options?.headers
687
+ }
688
+ });
689
+ }
690
+
691
+ /**
692
+ * Check Kalsarpa Dosha - Kalsarpa Yoga Calculator API
693
+ *
694
+ * Detect Kalsarpa dosha (Kalsarpa yoga) when all 7 planets are hemmed between Rahu-Ketu axis. Accurate kalsarpa dosha calculator identifying 12 types (Ananta, Kulik, Vasuki, Shankhapala, Padma, Mahapadma, Takshak, Karkotak, Shankhachud, Ghatak, Vishdhar, Sheshnag). Returns severity and effects based on Rahu house position. Essential for Vedic astrology dosha analysis, birth chart evaluation, and matrimonial compatibility. Considered significant dosha affecting life obstacles and spiritual growth.
695
+ */
696
+ public checkKalsarpaDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaKalsarpaData, ThrowOnError>) {
697
+ return (options?.client ?? this.client).post<PostVedicAstrologyDoshaKalsarpaResponses, unknown, ThrowOnError>({
698
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
699
+ url: '/vedic-astrology/dosha/kalsarpa',
700
+ ...options,
701
+ headers: {
702
+ 'Content-Type': 'application/json',
703
+ ...options?.headers
704
+ }
705
+ });
706
+ }
707
+
708
+ /**
709
+ * Check Sadhesati - Sade Sati Calculator API (Saturn Transit)
710
+ *
711
+ * Calculate Sadhesati (Sade Sati) periods when Saturn transits 12th, 1st, and 2nd houses from natal Moon. Accurate sade sati calculator with current status and phase identification (Rising/Peak/Setting). Shani sadhesati 7.5 year period tracker. Returns Saturn transit dates and effects on life. Essential for Saturn transit analysis, sadhesati remedies timing, and understanding challenging Saturn periods in Vedic astrology. Important for timing major life decisions.
712
+ */
713
+ public checkSadhesati<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaSadhesatiData, ThrowOnError>) {
714
+ return (options?.client ?? this.client).post<PostVedicAstrologyDoshaSadhesatiResponses, unknown, ThrowOnError>({
715
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
716
+ url: '/vedic-astrology/dosha/sadhesati',
717
+ ...options,
718
+ headers: {
719
+ 'Content-Type': 'application/json',
720
+ ...options?.headers
721
+ }
722
+ });
723
+ }
724
+
725
+ /**
726
+ * List all planetary yogas - 300+ Vedic Yoga Combinations
727
+ *
728
+ * Returns list of all 300+ planetary yogas (astrological combinations) with basic information (id and name only). Use this to discover available yogas, then call GET /yogas/:id for detailed information. Perfect for building yoga browser interfaces, search functionality, and progressive data loading in astrology apps.
729
+ */
730
+ public listYogas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyYogaData, ThrowOnError>) {
731
+ return (options?.client ?? this.client).get<GetVedicAstrologyYogaResponses, unknown, ThrowOnError>({
732
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
733
+ url: '/vedic-astrology/yoga',
734
+ ...options
735
+ });
736
+ }
737
+
738
+ /**
739
+ * Get yoga details by ID - Detailed Yoga Information API
740
+ *
741
+ * Returns complete details for a specific yoga including formation conditions, results/effects, and quality (Positive/Negative/Both). Use GET /yogas first to get the list of IDs. Provides in-depth information about each planetary combination. Perfect for yoga detail pages, educational content, and astrological interpretation in horoscope apps.
742
+ */
743
+ public getYoga<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyYogaByIdData, ThrowOnError>) {
744
+ return (options.client ?? this.client).get<GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaByIdErrors, ThrowOnError>({
745
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
746
+ url: '/vedic-astrology/yoga/{id}',
747
+ ...options
748
+ });
749
+ }
750
+
751
+ /**
752
+ * Get KP-Newcomb ayanamsa - Dynamic daily calculation
753
+ *
754
+ * Get real-time KP-Newcomb ayanamsa value calculated using Newcomb precession theory - no preset tables. Returns precise ayanamsa for any date based on IAU modern precession standards. Essential for accurate KP chart calculations and research. Formula: A = 16.90709×(Year/10000) - 0.757371×(Year/1000)² - 6.92416, B = (Month-1 + Date/30)×1.1574074/1000. KP Newcomb ayanamsa API, dynamic ayanamsa calculator, Krishnamurti ayanamsa today, current KP ayanamsa
755
+ */
756
+ public getKpAyanamsa<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyKpAyanamsaData, ThrowOnError>) {
757
+ return (options?.client ?? this.client).get<GetVedicAstrologyKpAyanamsaResponses, unknown, ThrowOnError>({
758
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
759
+ url: '/vedic-astrology/kp/ayanamsa',
760
+ ...options
761
+ });
762
+ }
763
+
764
+ /**
765
+ * Get KP planetary positions with sub-lords
766
+ *
767
+ * Get planetary positions with detailed KP star-lord and sub-lord calculations for precise event timing and significator analysis. Returns all 9 planets (Sun through Ketu) with nakshatra, star-lord, sub-lord, and KP horary numbers (1-249). Essential for KP astrology software, significator analysis, and event prediction. KP planet positions API, star lord sub lord calculator, KP significator API, Krishnamurti Paddhati planets
768
+ */
769
+ public getKpPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsData, ThrowOnError>) {
770
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpPlanetsResponses, unknown, ThrowOnError>({
771
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
772
+ url: '/vedic-astrology/kp/planets',
773
+ ...options,
774
+ headers: {
775
+ 'Content-Type': 'application/json',
776
+ ...options?.headers
777
+ }
778
+ });
779
+ }
780
+
781
+ /**
782
+ * Get KP Placidus house cusps with sub-lords
783
+ *
784
+ * Calculate unequal Placidus house cusps with ruling sign-lord, nakshatra-lord, and sub-lord for each cusp. Dynamic KP-Newcomb or custom ayanamsa support. Used in KP horary astrology, cusp sub-lord analysis, and birth chart rectification. Returns all 12 house cusps with KP sub-division details. SEO: Placidus house cusps API, KP cusp calculator, house cusps star sub lord, KP horary cusps
785
+ */
786
+ public getKpCusps<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpCuspsData, ThrowOnError>) {
787
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpCuspsResponses, unknown, ThrowOnError>({
788
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
789
+ url: '/vedic-astrology/kp/cusps',
790
+ ...options,
791
+ headers: {
792
+ 'Content-Type': 'application/json',
793
+ ...options?.headers
794
+ }
795
+ });
796
+ }
797
+
798
+ /**
799
+ * Generate complete KP birth chart
800
+ *
801
+ * Generate authentic Krishnamurti Paddhati birth charts with Placidus house cusps, star-lord and sub-lord calculations. Supports custom ayanamsa and dynamic KP-Newcomb ayanamsa calculation. Returns complete chart with all 9 planets (Sun through Ketu), Ascendant, 12 Placidus house cusps, nakshatra details, star-lords, sub-lords, and KP horary numbers (1-249). Perfect for KP astrology software, horary prediction apps, and event timing analysis. SEO: KP astrology chart API, Placidus house cusps planets, Krishnamurti Paddhati chart generator, KP birth chart calculator
802
+ */
803
+ public generateKpChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpChartData, ThrowOnError>) {
804
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpChartResponses, unknown, ThrowOnError>({
805
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
806
+ url: '/vedic-astrology/kp/chart',
807
+ ...options,
808
+ headers: {
809
+ 'Content-Type': 'application/json',
810
+ ...options?.headers
811
+ }
812
+ });
813
+ }
814
+
815
+ /**
816
+ * Get KP ruling planets with optional significators
817
+ *
818
+ * Calculate the 5 ruling planets at any moment using Krishnamurti Paddhati horary astrology. Returns Day Lord, Moon Sign/Star/Sub Lord, Lagna Sign/Star/Sub Lord. Optionally provide birth data (birthDate, birthTime) to include significators showing which houses each ruling planet signifies in the birth chart - essential for KP prediction.
819
+ */
820
+ public getKpRulingPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsData, ThrowOnError>) {
821
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpRulingPlanetsResponses, unknown, ThrowOnError>({
822
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
823
+ url: '/vedic-astrology/kp/ruling-planets',
824
+ ...options,
825
+ headers: {
826
+ 'Content-Type': 'application/json',
827
+ ...options?.headers
828
+ }
829
+ });
830
+ }
831
+
832
+ /**
833
+ * Get KP ruling planets with significators at intervals
834
+ *
835
+ * Calculate ruling planets and their KP significators at regular time intervals using Krishnamurti Paddhati prashna (horary) astrology. For each interval, a full Placidus house chart is erected and significators are computed using the 4-level KP hierarchy: Level 1 (strongest) planets in star of house occupant, Level 2 occupants, Level 3 planets in star of house owner, Level 4 house owner. Returns Day Lord (sunrise-based Hindu Vara), Moon Sign/Star/Sub/Sub-Sub Lords, Lagna Sign/Star/Sub/Sub-Sub Lords, unique ruling planets set, and per-ruling-planet house significations. No birth data needed, significators come from each moments sky chart. Use for birth time rectification, muhurta selection, and KP horary number analysis.
836
+ */
837
+ public getKpRulingInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsIntervalData, ThrowOnError>) {
838
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpRulingPlanetsIntervalResponses, unknown, ThrowOnError>({
839
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
840
+ url: '/vedic-astrology/kp/ruling-planets-interval',
841
+ ...options,
842
+ headers: {
843
+ 'Content-Type': 'application/json',
844
+ ...options?.headers
845
+ }
846
+ });
847
+ }
848
+
849
+ /**
850
+ * Find KP sublord changes
851
+ *
852
+ * Track when planets cross KP sublord boundaries (1-249 divisions) for precise Krishnamurti Paddhati event timing. Returns exact timestamps when a planet transitions between sublords, essential for prashna kundali analysis and dasha predictions. Use this to find favorable windows when benefic sublords are active. Supports Sun, Moon, Mars, Mercury, Jupiter, Venus, and Saturn tracking over any date range.
853
+ */
854
+ public getKpSublordChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpSublordChangesData, ThrowOnError>) {
855
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpSublordChangesResponses, unknown, ThrowOnError>({
856
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
857
+ url: '/vedic-astrology/kp/sublord-changes',
858
+ ...options,
859
+ headers: {
860
+ 'Content-Type': 'application/json',
861
+ ...options?.headers
862
+ }
863
+ });
864
+ }
865
+
866
+ /**
867
+ * Find KP rasi ingress times
868
+ *
869
+ * Track when planets enter new zodiac signs (rasi) with precise ingress timestamps. Essential for Vedic astrology transit analysis, muhurta selection, and predictive horoscope readings. Returns exact times when planets cross sign boundaries (0, 30, 60 degrees etc). Use for tracking Sun sankranti dates, Moon sign changes for panchang, or outer planet transits for yearly predictions.
870
+ */
871
+ public getKpRasiChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRasiChangesData, ThrowOnError>) {
872
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpRasiChangesResponses, unknown, ThrowOnError>({
873
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
874
+ url: '/vedic-astrology/kp/rasi-changes',
875
+ ...options,
876
+ headers: {
877
+ 'Content-Type': 'application/json',
878
+ ...options?.headers
879
+ }
880
+ });
881
+ }
882
+
883
+ /**
884
+ * Get KP planets at time intervals
885
+ *
886
+ * Calculate positions of all 9 planets (Sun through Saturn, Rahu, Ketu) at regular time intervals with full KP hierarchy: sign lord, star lord, sublord, and sub-sublord. Returns longitude, zodiac sign, nakshatra, sublord, sub-sublord, and KP number (1-249) for each planet at each timestamp. Ideal for tracking planetary motion, finding optimal muhurta windows, analyzing transit patterns, and building KP ephemeris tables. Maximum range of 7 days with 15-minute to 24-hour intervals.
887
+ */
888
+ public getKpPlanetsInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsIntervalData, ThrowOnError>) {
889
+ return (options?.client ?? this.client).post<PostVedicAstrologyKpPlanetsIntervalResponses, unknown, ThrowOnError>({
890
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
891
+ url: '/vedic-astrology/kp/planets-interval',
892
+ ...options,
893
+ headers: {
894
+ 'Content-Type': 'application/json',
895
+ ...options?.headers
896
+ }
897
+ });
898
+ }
899
+
900
+ /**
901
+ * Get planetary aspects (Drishti) - Mutual aspects between all planets
902
+ *
903
+ * Calculate all planetary aspects (Drishti) for a given time. Returns full aspects (7th house for all planets) and special aspects (Mars 4th/8th, Jupiter 5th/9th, Saturn 3rd/10th). Includes aspect table grouped by planet, mutual aspects, and individual aspect details with orb calculation. Essential for birth chart analysis, compatibility checking, and transit predictions. Planetary aspects API, drishti calculator, vedic astrology aspects, graha drishti.
904
+ */
905
+ public calculateDrishti<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsData, ThrowOnError>) {
906
+ return (options?.client ?? this.client).post<PostVedicAstrologyAspectsResponses, unknown, ThrowOnError>({
907
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
908
+ url: '/vedic-astrology/aspects',
909
+ ...options,
910
+ headers: {
911
+ 'Content-Type': 'application/json',
912
+ ...options?.headers
913
+ }
914
+ });
915
+ }
916
+
917
+ /**
918
+ * Monthly Planetary Aspects - Major and minor aspect events for a month
919
+ *
920
+ * Calculate all planetary aspect events (excluding Moon) for a given month. Detects 22 aspect types. 5 major (conjunction, opposition, trine, square, sextile) and 17 minor (vigintile, semi-sextile, undecile, semi-quintile, novile, semi-square, septile, quintile, binovile, centile, biseptile, tredecile, sesqui-square, bi-quintile, quincunx, triseptile, quadranovile). Returns exact date and time of closest approach using ternary search refinement. Uses degree-based aspect methodology on sidereal positions (Lahiri ayanamsa). For Moon-specific aspects, use the /aspects/lunar endpoint. Essential for transit timing, muhurta selection, and monthly astrological forecasting. Monthly planetary aspects API, graha drishti calendar, mutual aspect ephemeris, minor aspects.
921
+ */
922
+ public getMonthlyAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsMonthlyData, ThrowOnError>) {
923
+ return (options?.client ?? this.client).post<PostVedicAstrologyAspectsMonthlyResponses, unknown, ThrowOnError>({
924
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
925
+ url: '/vedic-astrology/aspects/monthly',
926
+ ...options,
927
+ headers: {
928
+ 'Content-Type': 'application/json',
929
+ ...options?.headers
930
+ }
931
+ });
932
+ }
933
+
934
+ /**
935
+ * Monthly Lunar Aspects - Moon aspect events with all planets for a month
936
+ *
937
+ * Track all lunar aspect events for a given month including major and minor aspects. The Moon traverses approximately 13 degrees per day, forming 22 aspect types with each planet. 5 major (conjunction, opposition, trine, square, sextile) and 17 minor (vigintile, semi-sextile, undecile, semi-quintile, novile, semi-square, septile, quintile, binovile, centile, biseptile, tredecile, sesqui-square, bi-quintile, quincunx, triseptile, quadranovile). Returns exact date and time of each Moon aspect event with ternary search refinement to the minute. Essential for muhurta selection, daily panchang analysis, and chandra gochar predictions. Monthly lunar aspects API, Moon transit calendar, chandra drishti ephemeris, minor lunar aspects.
938
+ */
939
+ public getLunarAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsLunarData, ThrowOnError>) {
940
+ return (options?.client ?? this.client).post<PostVedicAstrologyAspectsLunarResponses, unknown, ThrowOnError>({
941
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
942
+ url: '/vedic-astrology/aspects/lunar',
943
+ ...options,
944
+ headers: {
945
+ 'Content-Type': 'application/json',
946
+ ...options?.headers
947
+ }
948
+ });
949
+ }
950
+
951
+ /**
952
+ * Transit Analysis - Compare current planets to natal chart (Gochar)
953
+ *
954
+ * Analyze planetary transits (Gochar) over natal chart positions. Returns transiting planets with their natal house positions, aspects to natal planets, and highlights key transits from slow-moving planets (Jupiter, Saturn, Rahu, Ketu). Essential for timing predictions, event forecasting, and understanding current planetary influences. Transit analysis API, gochar calculator, vedic transit predictions.
955
+ */
956
+ public calculateTransit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitData, ThrowOnError>) {
957
+ return (options?.client ?? this.client).post<PostVedicAstrologyTransitResponses, unknown, ThrowOnError>({
958
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
959
+ url: '/vedic-astrology/transit',
960
+ ...options,
961
+ headers: {
962
+ 'Content-Type': 'application/json',
963
+ ...options?.headers
964
+ }
965
+ });
966
+ }
967
+
968
+ /**
969
+ * Monthly Transit - Planetary sign changes for an entire month
970
+ *
971
+ * Get all planetary sign (rashi) changes for a given month. Shows when each planet transitions from one zodiac sign to another. Covers all 9 Vedic planets: Sun, Moon, Mars, Mercury, Jupiter, Venus, Saturn, Rahu, Ketu. Includes starting positions at the beginning of the month. Essential for transit prediction, monthly horoscope generation, and muhurta planning. Monthly planetary transit API, gochar calendar, rashi parivartan dates.
972
+ */
973
+ public getMonthlyTransits<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitMonthlyData, ThrowOnError>) {
974
+ return (options?.client ?? this.client).post<PostVedicAstrologyTransitMonthlyResponses, unknown, ThrowOnError>({
975
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
976
+ url: '/vedic-astrology/transit/monthly',
977
+ ...options,
978
+ headers: {
979
+ 'Content-Type': 'application/json',
980
+ ...options?.headers
981
+ }
982
+ });
983
+ }
984
+
985
+ /**
986
+ * Declination Parallels - Planets at same or opposite declination
987
+ *
988
+ * Calculate planetary declinations and find parallels (same declination) and contraparallels (opposite declination). Parallels are considered equivalent to conjunctions in strength, contraparallels to oppositions. Returns declination for each planet and all parallel/contraparallel aspects. Declination parallels API, planetary declination calculator, contraparallel aspects.
989
+ */
990
+ public calculateParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsData, ThrowOnError>) {
991
+ return (options?.client ?? this.client).post<PostVedicAstrologyParallelsResponses, unknown, ThrowOnError>({
992
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
993
+ url: '/vedic-astrology/parallels',
994
+ ...options,
995
+ headers: {
996
+ 'Content-Type': 'application/json',
997
+ ...options?.headers
998
+ }
999
+ });
1000
+ }
1001
+
1002
+ /**
1003
+ * Monthly Declination Parallels - Parallel and contraparallel events for a month
1004
+ *
1005
+ * Find all declination parallel and contraparallel events between the 7 visible planets for a given month. Parallels occur when two planets share the same celestial declination (equivalent to conjunction in strength). Contraparallels occur at opposite declinations (equivalent to opposition). Scanned daily at noon UTC. Essential for advanced transit analysis and hidden aspect discovery. Monthly declination parallels API, planetary parallel ephemeris, contraparallel event calendar.
1006
+ */
1007
+ public getMonthlyParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsMonthlyData, ThrowOnError>) {
1008
+ return (options?.client ?? this.client).post<PostVedicAstrologyParallelsMonthlyResponses, unknown, ThrowOnError>({
1009
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1010
+ url: '/vedic-astrology/parallels/monthly',
1011
+ ...options,
1012
+ headers: {
1013
+ 'Content-Type': 'application/json',
1014
+ ...options?.headers
1015
+ }
1016
+ });
1017
+ }
1018
+
1019
+ /**
1020
+ * Ecliptic Crossings - When planets cross the ecliptic plane
1021
+ *
1022
+ * Find all ecliptic plane crossings for visible planets during a given year. An ecliptic crossing occurs when a planetary celestial latitude passes through 0 degrees, crossing from one side of the ecliptic to the other. Ascending crossings (south to north) correspond to the ascending node, descending crossings (north to south) to the descending node. Moon crosses ~2 times per month, outer planets cross less frequently. Returns exact date, time, direction, sidereal longitude, and zodiac sign. Ecliptic crossing API, planetary node crossing, ascending descending node ephemeris.
1023
+ */
1024
+ public getEclipticCrossings<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyEclipticCrossingsData, ThrowOnError>) {
1025
+ return (options?.client ?? this.client).post<PostVedicAstrologyEclipticCrossingsResponses, unknown, ThrowOnError>({
1026
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1027
+ url: '/vedic-astrology/ecliptic-crossings',
1028
+ ...options,
1029
+ headers: {
1030
+ 'Content-Type': 'application/json',
1031
+ ...options?.headers
1032
+ }
1033
+ });
1034
+ }
1035
+
1036
+ /**
1037
+ * List all 12 Rashis - Vedic Zodiac Signs Reference
1038
+ *
1039
+ * Get the complete list of 12 rashis (zodiac signs) in Vedic astrology. Returns Sanskrit names, Western equivalents, sidereal date ranges, symbols, governing Adityas, and personality characteristics for each rashi. Reference data for Mesha through Meen. Essential for zodiac sign lookup tables, astrology apps, and rashi-based UI components.
1040
+ */
1041
+ public listRashis<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyRashisData, ThrowOnError>) {
1042
+ return (options?.client ?? this.client).get<GetVedicAstrologyRashisResponses, unknown, ThrowOnError>({
1043
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1044
+ url: '/vedic-astrology/rashis',
1045
+ ...options
1046
+ });
1047
+ }
1048
+
1049
+ /**
1050
+ * Get Rashi by ID - Vedic Zodiac Sign Detail
1051
+ *
1052
+ * Get detailed information for a single rashi (zodiac sign) by its Vedic ID slug. Returns Sanskrit name, Western equivalent, sidereal date range, symbol, governing Aditya, and personality characteristics.
1053
+ */
1054
+ public getRashi<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyRashisByIdData, ThrowOnError>) {
1055
+ return (options.client ?? this.client).get<GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisByIdErrors, ThrowOnError>({
1056
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1057
+ url: '/vedic-astrology/rashis/{id}',
1058
+ ...options
1059
+ });
1060
+ }
1061
+
1062
+ /**
1063
+ * List all 27 Nakshatras - Lunar Mansions Reference
1064
+ *
1065
+ * Get the complete list of 27 nakshatras (lunar mansions) in Vedic astrology. Returns names, zodiac ranges, ruling planets, presiding deities, symbols, personality characteristics, and traditional remedies (mantras, gemstones, rituals) for each nakshatra from Ashwini to Revati. Essential for nakshatra lookup tables, dasha period calculations, muhurta selection, and astrology app reference data.
1066
+ */
1067
+ public listNakshatras<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyNakshatrasData, ThrowOnError>) {
1068
+ return (options?.client ?? this.client).get<GetVedicAstrologyNakshatrasResponses, unknown, ThrowOnError>({
1069
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1070
+ url: '/vedic-astrology/nakshatras',
1071
+ ...options
1072
+ });
1073
+ }
1074
+
1075
+ /**
1076
+ * Get Nakshatra by ID - Lunar Mansion Detail
1077
+ *
1078
+ * Get detailed information for a single nakshatra (lunar mansion) by its ID slug. Returns name, zodiac range, ruling planet, presiding deity, symbol, personality characteristics, and traditional remedies including mantras, gemstones, and rituals.
1079
+ */
1080
+ public getNakshatra<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyNakshatrasByIdData, ThrowOnError>) {
1081
+ return (options.client ?? this.client).get<GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasByIdErrors, ThrowOnError>({
1082
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1083
+ url: '/vedic-astrology/nakshatras/{id}',
1084
+ ...options
1085
+ });
1086
+ }
1087
+
1088
+ /**
1089
+ * Get upagraha (sub-planet) positions - Upagraha Calculator API
1090
+ *
1091
+ * Calculate all 11 Vedic upagraha (sub-planet) positions per Brihat Parashara Hora Shastra (BPHS). Returns 6 time-based upagrahas (Gulika, Mandi, Kala, Mrityu, Ardhaprahara, Yamaghantaka) derived from the 8-part day/night division, plus 5 Sun-longitude-based upagrahas (Dhuma, Vyatipata, Parivesha, Indra Chapa, Upaketu). Essential for complete kundli analysis, dosha assessment, and advanced chart interpretation. Upagraha calculator API, Gulika Mandi position, sub-planet Vedic astrology.
1092
+ */
1093
+ public getUpagrahaPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyUpagrahaData, ThrowOnError>) {
1094
+ return (options?.client ?? this.client).post<PostVedicAstrologyUpagrahaResponses, unknown, ThrowOnError>({
1095
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1096
+ url: '/vedic-astrology/upagraha',
1097
+ ...options,
1098
+ headers: {
1099
+ 'Content-Type': 'application/json',
1100
+ ...options?.headers
1101
+ }
1102
+ });
1103
+ }
1104
+
1105
+ /**
1106
+ * Get Ashtakavarga (planetary strength) analysis - Ashtakavarga Calculator API
1107
+ *
1108
+ * Calculate complete Ashtakavarga analysis per Brihat Parashara Hora Shastra (BPHS). Returns Bhinnashtakavarga (BAV), Sarvashtakavarga (SAV, total 337), Reduced Ashtakavarga (Trikona + Ekadipati Shodhana per Ch. 67-68), and Shodhya Pinda planetary strength (Rashi Pinda + Graha Pinda per Ch. 69). Essential for transit prediction timing, house strength analysis, dasha result evaluation, and planetary strength comparison. Ashtakavarga calculator API, bindu rekha points, Shodhya Pinda, Vedic astrology.
1109
+ */
1110
+ public calculateAshtakavarga<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAshtakavargaData, ThrowOnError>) {
1111
+ return (options?.client ?? this.client).post<PostVedicAstrologyAshtakavargaResponses, unknown, ThrowOnError>({
1112
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1113
+ url: '/vedic-astrology/ashtakavarga',
1114
+ ...options,
1115
+ headers: {
1116
+ 'Content-Type': 'application/json',
1117
+ ...options?.headers
1118
+ }
1119
+ });
1120
+ }
1121
+
1122
+ /**
1123
+ * Get Shadbala (six-fold planetary strength) analysis - Shadbala Calculator API
1124
+ *
1125
+ * Calculate complete Shadbala (six-fold planetary strength) per Brihat Parashara Hora Shastra (BPHS) and BV Raman Graha and Bhava Balas. Returns all 6 strength components (Sthana Bala, Dig Bala, Kala Bala, Chesta Bala, Naisargika Bala, Drik Bala) plus Ishta Phala, Kashta Phala, strength ratio, and relative ranking for all 7 classical planets. Essential for evaluating planetary strength in Vedic birth chart analysis, dasha prediction, transit interpretation, and yoga assessment. Shadbala calculator API, planetary strength Vedic astrology, graha bala, Ishta Kashta Phala.
1126
+ */
1127
+ public calculateShadbala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyShadbalaData, ThrowOnError>) {
1128
+ return (options?.client ?? this.client).post<PostVedicAstrologyShadbalaResponses, unknown, ThrowOnError>({
1129
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1130
+ url: '/vedic-astrology/shadbala',
1131
+ ...options,
1132
+ headers: {
1133
+ 'Content-Type': 'application/json',
1134
+ ...options?.headers
1135
+ }
1136
+ });
1137
+ }
1138
+ }
1139
+
1140
+ export class Tarot extends HeyApiClient {
1141
+ /**
1142
+ * List all 78 tarot cards
1143
+ *
1144
+ * Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards: 22 Major Arcana (numbered 0-21, representing life lessons, spiritual themes, and karmic influences like The Fool, Death, The Tower) plus 56 Minor Arcana (4 suits × 14 cards each for daily situations and practical matters). Filter by arcana type (major for spiritual guidance, minor for everyday concerns), suit (cups for emotions and relationships, wands for creativity and passion, swords for intellect and conflict, pentacles for material wealth and finances), or card number (Ace=1 for new beginnings, 2-10 for progression, Page=11 for messages, Knight=12 for action, Queen=13 for mastery, King=14 for authority). Returns lightweight basic card data - use GET /cards/:id for full upright and reversed interpretations with keywords. Perfect for building tarot reference libraries, card databases, learning applications, or browsing the complete traditional deck used by professional tarot readers worldwide.
1145
+ */
1146
+ public listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>) {
1147
+ return (options?.client ?? this.client).get<GetTarotCardsResponses, unknown, ThrowOnError>({
1148
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1149
+ url: '/tarot/cards',
1150
+ ...options
1151
+ });
1152
+ }
1153
+
1154
+ /**
1155
+ * Get detailed tarot card information
1156
+ *
1157
+ * Retrieve comprehensive details for a specific tarot card from the traditional Rider-Waite-Smith deck including complete upright meanings (card drawn normally) and reversed meanings (inverted/upside down interpretations for nuanced guidance). Each card provides keywords for quick reference, full interpretations (400+ words each for upright and reversed orientations), and guidance across life domains: love and relationships, career and professional growth, finances and material success, health and wellbeing, spirituality and personal development. Major Arcana cards (0-21) reveal deep spiritual lessons and life-changing themes. Minor Arcana cards (Ace through King in Cups, Wands, Swords, Pentacles) address practical daily situations and specific challenges. Use card ID in kebab-case format: Major Arcana like "fool", "magician", "death", "tower", or Minor Arcana like "ace-of-cups", "seven-of-wands", "queen-of-swords", "king-of-pentacles". Essential for detailed tarot study, reading interpretations, divination apps, fortune-telling platforms, spiritual guidance tools, and professional tarot learning applications.
1158
+ */
1159
+ public getCard<ThrowOnError extends boolean = false>(options: Options<GetTarotCardsByIdData, ThrowOnError>) {
1160
+ return (options.client ?? this.client).get<GetTarotCardsByIdResponses, GetTarotCardsByIdErrors, ThrowOnError>({
1161
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1162
+ url: '/tarot/cards/{id}',
1163
+ ...options
1164
+ });
1165
+ }
1166
+
1167
+ /**
1168
+ * Draw random tarot cards with reproducible results
1169
+ *
1170
+ * Draw 1-78 tarot cards from the complete Rider-Waite-Smith deck with seeded reproducibility for consistent personalized readings. Provide an optional seed string (like "user123-2025-12-27" or "readingId") to ensure the same seed always returns identical cards in the exact same order - essential for daily tarot features, personalized user experiences, shareable readings, or reproducible testing. Omit seed for true random draws each time. Control card reversals (upright vs reversed/inverted orientations - reversed cards provide alternative meanings when drawn upside down) and duplicates (traditional deck draws each of 78 cards once, or oracle-style allows repeating same card). Each drawn card includes position number, reversal state (boolean), keywords for quick interpretation, full meaning text (400+ words), authentic Rider-Waite imagery, and card metadata. Perfect for custom spread builders, random card generators, automated tarot reading platforms, daily card features, meditation apps, journaling prompts, divination tools, and any application requiring reproducible or random tarot draws from the industry-standard 78-card deck (22 Major Arcana spiritual lessons + 56 Minor Arcana practical guidance across 4 suits).
1171
+ */
1172
+ public drawCards<ThrowOnError extends boolean = false>(options: Options<PostTarotDrawData, ThrowOnError>) {
1173
+ return (options.client ?? this.client).post<PostTarotDrawResponses, unknown, ThrowOnError>({
1174
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1175
+ url: '/tarot/draw',
1176
+ ...options,
1177
+ headers: {
1178
+ 'Content-Type': 'application/json',
1179
+ ...options.headers
1180
+ }
1181
+ });
1182
+ }
1183
+
1184
+ /**
1185
+ * Get daily tarot card reading
1186
+ *
1187
+ * Receive a single tarot card for daily guidance and reflection. This endpoint uses seeded randomness to ensure the same seed gets the same card on the same day - perfect for "Card of the Day" features. Provide a seed (userId, email hash, session token) for reproducible consistency, or omit for anonymous daily draws. Returns card with keywords, full meaning, and a daily message summary. Great for tarot apps, wellness platforms, morning ritual apps, and journaling tools.
1188
+ */
1189
+ public getDailyCard<ThrowOnError extends boolean = false>(options?: Options<PostTarotDailyData, ThrowOnError>) {
1190
+ return (options?.client ?? this.client).post<PostTarotDailyResponses, PostTarotDailyErrors, ThrowOnError>({
1191
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1192
+ url: '/tarot/daily',
1193
+ ...options,
1194
+ headers: {
1195
+ 'Content-Type': 'application/json',
1196
+ ...options?.headers
1197
+ }
1198
+ });
1199
+ }
1200
+
1201
+ /**
1202
+ * Get yes/no answer to your question
1203
+ *
1204
+ * Ask a specific question and receive a yes, no, or maybe answer based on a single tarot card draw. Upright cards indicate "Yes" with positive energy, reversed cards indicate "No" with caution, and certain inherently ambiguous cards (The Hanged Man, Wheel of Fortune, Temperance, Two of Swords, Four of Swords) return "Maybe" regardless of orientation since their energy signals pause, reflection, or shifting circumstances. Major Arcana cards give strong definitive answers, Minor Arcana cards give qualified nuanced answers. Returns the answer, strength level, drawn card details, and a contextual interpretation explaining why. Perfect for decision-making apps, quick guidance tools, fortune-telling chatbots, and interactive tarot experiences. Optionally provide a seed for reproducible answers.
1205
+ */
1206
+ public castYesNo<ThrowOnError extends boolean = false>(options: Options<PostTarotYesNoData, ThrowOnError>) {
1207
+ return (options.client ?? this.client).post<PostTarotYesNoResponses, PostTarotYesNoErrors, ThrowOnError>({
1208
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1209
+ url: '/tarot/yes-no',
1210
+ ...options,
1211
+ headers: {
1212
+ 'Content-Type': 'application/json',
1213
+ ...options.headers
1214
+ }
1215
+ });
1216
+ }
1217
+
1218
+ /**
1219
+ * Three-Card Spread: Past, Present, Future
1220
+ *
1221
+ * Perform the classic three-card tarot spread revealing Past (what led to this situation), Present (current energy and circumstances), and Future (likely outcome if current path continues). The most popular beginner-friendly spread, perfect for quick insights, daily guidance, or exploring specific questions. Each position includes a drawn card with reversal state, keywords, full meaning, and position-specific interpretation. Returns a summary connecting all three cards. Ideal for tarot reading apps, decision-making tools, and personal growth platforms. Optionally provide a seed for reproducible readings.
1222
+ */
1223
+ public castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>) {
1224
+ return (options.client ?? this.client).post<PostTarotSpreadsThreeCardResponses, unknown, ThrowOnError>({
1225
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1226
+ url: '/tarot/spreads/three-card',
1227
+ ...options,
1228
+ headers: {
1229
+ 'Content-Type': 'application/json',
1230
+ ...options.headers
1231
+ }
1232
+ });
1233
+ }
1234
+
1235
+ /**
1236
+ * Celtic Cross Spread (10 cards)
1237
+ *
1238
+ * Perform the legendary Celtic Cross spread - the most comprehensive and detailed tarot reading available, used by professional tarot readers worldwide for over a century. This 10-card layout reveals the complete picture of any situation through distinct positions: Present Situation (what is happening now), Challenge (obstacles crossing your path), Distant Past (root causes), Recent Past (recent influences), Best Outcome (potential positive result), Near Future (what is approaching in weeks ahead), Your Approach (your attitude and self-perception), External Influences (environment and other people impact), Hopes and Fears (your desires and anxieties), and Final Outcome (where everything is headed). Perfect for life-changing decisions, complex relationship questions, career transitions, spiritual guidance, and deep self-discovery. Ideal for professional tarot apps, life coaching platforms, spiritual wellness websites, and divination tools requiring authoritative comprehensive readings. Each card position provides layered insight combining traditional tarot wisdom with modern psychological interpretation for actionable guidance.
1239
+ */
1240
+ public castCelticCross<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCelticCrossData, ThrowOnError>) {
1241
+ return (options.client ?? this.client).post<PostTarotSpreadsCelticCrossResponses, unknown, ThrowOnError>({
1242
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1243
+ url: '/tarot/spreads/celtic-cross',
1244
+ ...options,
1245
+ headers: {
1246
+ 'Content-Type': 'application/json',
1247
+ ...options.headers
1248
+ }
1249
+ });
1250
+ }
1251
+
1252
+ /**
1253
+ * Love Spread (5 cards)
1254
+ *
1255
+ * Perform a specialized 5-card relationship tarot spread analyzing romantic connections, emotional dynamics, and partnership potential. This love-focused reading examines five crucial relationship aspects: You (your current emotional state, needs, and what you bring to the relationship), Partner/Other (their emotional perspective, desires, and energy), Relationship Dynamic (the current energy and connection between you both), Challenge (obstacles needing attention, healing, or communication), and Outcome (where this romantic connection is naturally heading). Perfect for dating apps, relationship counseling platforms, matchmaking services, wellness apps, and romantic guidance tools. Provides deep insight into new relationships, existing partnerships, potential connections, breakup recovery, or self-love journeys. Ideal for understanding compatibility, resolving conflicts, strengthening bonds, or deciding whether to pursue or continue a relationship. Each position reveals emotional truths combining traditional tarot relationship wisdom with modern relationship psychology. Use for individual readings or couples readings to gain perspective on romantic situations from singleness to marriage.
1256
+ */
1257
+ public castLoveSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsLoveData, ThrowOnError>) {
1258
+ return (options.client ?? this.client).post<PostTarotSpreadsLoveResponses, unknown, ThrowOnError>({
1259
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1260
+ url: '/tarot/spreads/love',
1261
+ ...options,
1262
+ headers: {
1263
+ 'Content-Type': 'application/json',
1264
+ ...options.headers
1265
+ }
1266
+ });
1267
+ }
1268
+
1269
+ /**
1270
+ * Career Spread (7 cards)
1271
+ *
1272
+ * Perform a comprehensive 7-card career tarot spread using SWOT analysis framework (Strengths, Weaknesses, Opportunities, Threats) for professional guidance, business decisions, and vocational clarity. This career-focused reading examines seven strategic business aspects: Current Situation (your present professional position and workplace energy), Strengths (your professional assets, talents, and competitive advantages), Weaknesses (areas needing development, skill gaps, or limiting beliefs), Opportunities (potential growth paths, new ventures, or doors opening), Threats (obstacles, competition, or external challenges), Advice (actionable guidance for navigating your career path), and Outcome (where your professional journey is heading if you follow the guidance). Perfect for career coaching platforms, professional development apps, business consulting tools, job search websites, entrepreneurship platforms, and executive coaching services. Use for career transitions, job offers evaluation, promotion decisions, starting a business, workplace conflicts, finding your calling, or strategic career planning. Combines traditional tarot wisdom with modern SWOT business analysis for practical professional insight. Ideal for employees, entrepreneurs, freelancers, career changers, and anyone seeking vocational direction.
1273
+ */
1274
+ public castCareerSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCareerData, ThrowOnError>) {
1275
+ return (options.client ?? this.client).post<PostTarotSpreadsCareerResponses, unknown, ThrowOnError>({
1276
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1277
+ url: '/tarot/spreads/career',
1278
+ ...options,
1279
+ headers: {
1280
+ 'Content-Type': 'application/json',
1281
+ ...options.headers
1282
+ }
1283
+ });
1284
+ }
1285
+
1286
+ /**
1287
+ * Custom Spread Builder
1288
+ *
1289
+ * Build and perform your own custom tarot spread with personalized positions and interpretations (1-10 cards). This flexible endpoint lets you create unique spread layouts for any purpose - define your own position names, meanings, and card count to match your specific needs or therapeutic framework. Perfect for therapists using tarot in counseling, coaches creating signature spreads, app developers building custom reading features, spiritual practitioners with proprietary methods, or anyone wanting to design specialized layouts beyond traditional spreads. Create spreads for specific themes like chakra readings (7 cards), lunar phases (8 cards), elements (4 cards), goals setting (any count), shadow work, inner child healing, decision matrices, or creative problem-solving. Each position requires a name and interpretation - you define what each card position represents in your reading. The API draws the exact number of cards you specify and maps them to your custom positions. No pre-generated summary provided - you interpret the reading based on your framework. Ideal for innovative tarot apps, therapeutic tools, personal development platforms, spiritual coaching services, or experimental divination methods. Maximum 10 positions to maintain reading clarity and practical interpretation time.
1290
+ */
1291
+ public castCustomSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCustomData, ThrowOnError>) {
1292
+ return (options.client ?? this.client).post<PostTarotSpreadsCustomResponses, unknown, ThrowOnError>({
1293
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1294
+ url: '/tarot/spreads/custom',
1295
+ ...options,
1296
+ headers: {
1297
+ 'Content-Type': 'application/json',
1298
+ ...options.headers
1299
+ }
1300
+ });
1301
+ }
1302
+ }
1303
+
1304
+ export class Numerology extends HeyApiClient {
1305
+ /**
1306
+ * Calculate Life Path number - Most important numerology calculation
1307
+ *
1308
+ * Calculate your Life Path number from your birth date using Pythagorean numerology. This is the most significant number in your numerology chart, revealing your life purpose, natural talents, and destiny path. Automatically detects Master Numbers (11, 22, 33) and Karmic Debt numbers (13, 14, 16, 19). Returns comprehensive interpretation including personality traits, strengths, challenges, career guidance, relationship compatibility, and spiritual insights. Perfect for numerology apps, birth chart calculators, life purpose discovery tools, personal development platforms, and astrology services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
1309
+ */
1310
+ public calculateLifePath<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyLifePathData, ThrowOnError>) {
1311
+ return (options?.client ?? this.client).post<PostNumerologyLifePathResponses, unknown, ThrowOnError>({
1312
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1313
+ url: '/numerology/life-path',
1314
+ ...options,
1315
+ headers: {
1316
+ 'Content-Type': 'application/json',
1317
+ ...options?.headers
1318
+ }
1319
+ });
1320
+ }
1321
+
1322
+ /**
1323
+ * Calculate Expression number - Natural talents and life goals
1324
+ *
1325
+ * Calculate your Expression (Destiny) number from your full birth name using Pythagorean numerology. This number reveals your natural talents, abilities, and life goals. It shows what you came here to do and what tools you have to accomplish your life purpose. Returns comprehensive interpretation including personality traits, career paths, relationship dynamics, and spiritual insights. Automatically detects Master Numbers (11, 22, 33). Perfect for name numerology apps, career guidance tools, personal development platforms, and talent assessment services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
1326
+ */
1327
+ public calculateExpression<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyExpressionData, ThrowOnError>) {
1328
+ return (options?.client ?? this.client).post<PostNumerologyExpressionResponses, unknown, ThrowOnError>({
1329
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1330
+ url: '/numerology/expression',
1331
+ ...options,
1332
+ headers: {
1333
+ 'Content-Type': 'application/json',
1334
+ ...options?.headers
1335
+ }
1336
+ });
1337
+ }
1338
+
1339
+ /**
1340
+ * Calculate Soul Urge number - Inner motivations and desires
1341
+ *
1342
+ * Calculate your Soul Urge (Heart Desire) number from the vowels in your birth name using Pythagorean numerology. This number reveals your innermost desires, motivations, and what your soul truly wants to experience. It shows what drives you from within, your emotional needs, and what brings you fulfillment. Returns comprehensive interpretation including personality traits, emotional needs, relationship desires, and spiritual longings. Automatically detects Master Numbers (11, 22, 33). Perfect for self-discovery apps, emotional intelligence tools, relationship counseling platforms, and personal development services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
1343
+ */
1344
+ public calculateSoulUrge<ThrowOnError extends boolean = false>(options?: Options<PostNumerologySoulUrgeData, ThrowOnError>) {
1345
+ return (options?.client ?? this.client).post<PostNumerologySoulUrgeResponses, unknown, ThrowOnError>({
1346
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1347
+ url: '/numerology/soul-urge',
1348
+ ...options,
1349
+ headers: {
1350
+ 'Content-Type': 'application/json',
1351
+ ...options?.headers
1352
+ }
1353
+ });
1354
+ }
1355
+
1356
+ /**
1357
+ * Calculate Personality number - How others perceive you
1358
+ *
1359
+ * Calculate your Personality number from the consonants in your birth name using Pythagorean numerology. This number reveals how others perceive you, your outer personality, and first impressions you make. It represents the mask you show the world and your social persona. Returns comprehensive interpretation including public image, social dynamics, professional presence, and relationship first impressions. Automatically detects Master Numbers (11, 22, 33). Perfect for personal branding apps, social skills training, professional development platforms, and communication coaching services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
1360
+ */
1361
+ public calculatePersonality<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalityData, ThrowOnError>) {
1362
+ return (options?.client ?? this.client).post<PostNumerologyPersonalityResponses, unknown, ThrowOnError>({
1363
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1364
+ url: '/numerology/personality',
1365
+ ...options,
1366
+ headers: {
1367
+ 'Content-Type': 'application/json',
1368
+ ...options?.headers
1369
+ }
1370
+ });
1371
+ }
1372
+
1373
+ /**
1374
+ * Calculate Birth Day number - Special talents from day of birth
1375
+ *
1376
+ * Calculate your Birth Day number from the day you were born (1-31) using Pythagorean numerology. This number reveals special talents and abilities you possess from birth. It shows natural gifts that can help you achieve your life purpose. Returns comprehensive interpretation including innate talents, natural abilities, career advantages, and how to leverage your special gifts. Automatically detects Master Numbers (11, 22) and reduces double-digit days. Perfect for talent discovery apps, career counseling platforms, personal development services, and skill assessment tools. Get detailed 300-500 word meanings for all numbers 1-9, 11, and 22.
1377
+ */
1378
+ public calculateBirthDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBirthDayData, ThrowOnError>) {
1379
+ return (options?.client ?? this.client).post<PostNumerologyBirthDayResponses, unknown, ThrowOnError>({
1380
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1381
+ url: '/numerology/birth-day',
1382
+ ...options,
1383
+ headers: {
1384
+ 'Content-Type': 'application/json',
1385
+ ...options?.headers
1386
+ }
1387
+ });
1388
+ }
1389
+
1390
+ /**
1391
+ * Calculate Maturity number - Who you become in later life
1392
+ *
1393
+ * Calculate your Maturity (Realization) number by adding Life Path and Expression numbers using Pythagorean numerology. This number reveals who you become in the second half of life, typically manifesting after age 35-40. It shows the ultimate goal of personal development and mature self-expression. Returns comprehensive interpretation including life transformation, mature personality, later-life purpose, and wisdom development. Automatically detects Master Numbers (11, 22, 33). Perfect for life coaching apps, midlife guidance platforms, personal development services, and aging wisdom tools. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
1394
+ */
1395
+ public calculateMaturity<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyMaturityData, ThrowOnError>) {
1396
+ return (options?.client ?? this.client).post<PostNumerologyMaturityResponses, unknown, ThrowOnError>({
1397
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1398
+ url: '/numerology/maturity',
1399
+ ...options,
1400
+ headers: {
1401
+ 'Content-Type': 'application/json',
1402
+ ...options?.headers
1403
+ }
1404
+ });
1405
+ }
1406
+
1407
+ /**
1408
+ * Analyze Karmic Lessons - Life lessons from missing numbers
1409
+ *
1410
+ * Analyze your Karmic Lessons from your birth name using Pythagorean numerology. Karmic lessons are indicated by numbers missing from your name (numbers 1-9 that do not appear). These represent challenges you came to learn and skills you need to develop in this lifetime. Returns comprehensive analysis including missing numbers, specific lessons for each, challenges to overcome, and practical guidance for development. Perfect for spiritual growth apps, personal development platforms, life coaching services, and self-improvement tools. Get detailed lesson descriptions, development strategies, and practical exercises for each missing number.
1411
+ */
1412
+ public analyzeKarmicLessons<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicLessonsData, ThrowOnError>) {
1413
+ return (options?.client ?? this.client).post<PostNumerologyKarmicLessonsResponses, unknown, ThrowOnError>({
1414
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1415
+ url: '/numerology/karmic-lessons',
1416
+ ...options,
1417
+ headers: {
1418
+ 'Content-Type': 'application/json',
1419
+ ...options?.headers
1420
+ }
1421
+ });
1422
+ }
1423
+
1424
+ /**
1425
+ * Detect Karmic Debt numbers - Past life challenges (13, 14, 16, 19)
1426
+ *
1427
+ * Check for Karmic Debt numbers (13, 14, 16, 19) in Life Path, Expression, Soul Urge, or Personality calculations using Pythagorean numerology. Karmic debt indicates challenges carried from past lives that must be resolved in this lifetime. These numbers appear during reduction and represent specific lessons and tests. Returns comprehensive analysis including debt descriptions, challenges to overcome, and resolution guidance. Perfect for spiritual growth apps, karmic astrology platforms, past life exploration services, and personal transformation tools. Get detailed meanings for all four karmic debt numbers with practical resolution strategies.
1428
+ */
1429
+ public checkKarmicDebt<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicDebtData, ThrowOnError>) {
1430
+ return (options?.client ?? this.client).post<PostNumerologyKarmicDebtResponses, unknown, ThrowOnError>({
1431
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1432
+ url: '/numerology/karmic-debt',
1433
+ ...options,
1434
+ headers: {
1435
+ 'Content-Type': 'application/json',
1436
+ ...options?.headers
1437
+ }
1438
+ });
1439
+ }
1440
+
1441
+ /**
1442
+ * Calculate Personal Year - Annual cycle and forecast for current year
1443
+ *
1444
+ * Calculate your Personal Year number from your birth month, day, and current year using Pythagorean numerology. Personal Year runs in 9-year cycles (1-9) and reveals the theme, opportunities, and challenges for the current year. Each year has a specific energy and lessons. Returns comprehensive annual forecast including year theme, opportunities, challenges, and actionable advice. Perfect for yearly planning apps, life coaching platforms, astrology services, and personal development tools. Get detailed forecasts for all 9 Personal Year cycles with practical guidance.
1445
+ */
1446
+ public calculatePersonalYear<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalYearData, ThrowOnError>) {
1447
+ return (options?.client ?? this.client).post<PostNumerologyPersonalYearResponses, unknown, ThrowOnError>({
1448
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1449
+ url: '/numerology/personal-year',
1450
+ ...options,
1451
+ headers: {
1452
+ 'Content-Type': 'application/json',
1453
+ ...options?.headers
1454
+ }
1455
+ });
1456
+ }
1457
+
1458
+ /**
1459
+ * Calculate Compatibility - Relationship dynamics between two people
1460
+ *
1461
+ * Calculate numerology compatibility between two people using their Life Path, Expression, and Soul Urge numbers based on Pythagorean numerology. Provides comprehensive relationship analysis with overall compatibility score (0-100), individual aspect compatibility (Life Path 50% weight, Expression 30%, Soul Urge 20%), relationship strengths, challenges, and practical advice. Uses detailed compatibility matrix for all number combinations. Perfect for dating apps, relationship counseling platforms, matchmaking services, and compatibility tools. Get actionable insights for improving relationship dynamics.
1462
+ */
1463
+ public calculateNumCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyCompatibilityData, ThrowOnError>) {
1464
+ return (options?.client ?? this.client).post<PostNumerologyCompatibilityResponses, unknown, ThrowOnError>({
1465
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1466
+ url: '/numerology/compatibility',
1467
+ ...options,
1468
+ headers: {
1469
+ 'Content-Type': 'application/json',
1470
+ ...options?.headers
1471
+ }
1472
+ });
1473
+ }
1474
+
1475
+ /**
1476
+ * Generate Complete Numerology Chart - Full profile analysis
1477
+ *
1478
+ * Generate a comprehensive numerology chart combining all major calculations: Life Path, Expression, Soul Urge, Personality, Birth Day, Maturity, Karmic Lessons, Karmic Debt, and Personal Year. This single endpoint provides everything needed for a full numerology reading. Returns detailed interpretations for all numbers, karmic analysis, yearly forecast, and holistic summary. Perfect for numerology apps, complete reading services, birth chart generators, and comprehensive analysis tools. Save multiple API calls by getting the full chart in one request. Ideal for generating PDF reports or detailed user profiles.
1479
+ */
1480
+ public generateNumerologyChart<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChartData, ThrowOnError>) {
1481
+ return (options?.client ?? this.client).post<PostNumerologyChartResponses, unknown, ThrowOnError>({
1482
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1483
+ url: '/numerology/chart',
1484
+ ...options,
1485
+ headers: {
1486
+ 'Content-Type': 'application/json',
1487
+ ...options?.headers
1488
+ }
1489
+ });
1490
+ }
1491
+
1492
+ /**
1493
+ * Get Number Meaning - Interpretation for any number 1-9, 11, 22, 33
1494
+ *
1495
+ * Get the complete meaning and interpretation for any numerology number (1-9, 11, 22, 33) using Pythagorean numerology. Returns comprehensive description including archetype title, keywords, personality traits, strengths, weaknesses, career guidance, relationship dynamics, and spiritual insights. Master numbers (11, 22, 33) include amplified meanings with their reduced base number. Perfect for numerology reference tools, educational apps, quick lookups, and building custom numerology calculators. Get detailed 300-500 word expert-written meanings for all 12 valid numerology numbers.
1496
+ */
1497
+ public getNumberMeaning<ThrowOnError extends boolean = false>(options: Options<GetNumerologyMeaningsByNumberData, ThrowOnError>) {
1498
+ return (options.client ?? this.client).get<GetNumerologyMeaningsByNumberResponses, GetNumerologyMeaningsByNumberErrors, ThrowOnError>({
1499
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1500
+ url: '/numerology/meanings/{number}',
1501
+ ...options
1502
+ });
1503
+ }
1504
+
1505
+ /**
1506
+ * Get daily numerology number - Number of the Day with interpretation
1507
+ *
1508
+ * Receive a daily numerology number (1-9, 11, 22, 33) for guidance and reflection. Uses seeded randomness so the same seed gets the same number on the same date, perfect for "Number of the Day" features in numerology apps, wellness platforms, and daily guidance tools. Returns the number with full interpretation including archetype, keywords, strengths, challenges, career, relationships, and spiritual insights. Ideal for daily push notifications, morning briefings, and personalized numerology experiences.
1509
+ */
1510
+ public getDailyNumber<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDailyData, ThrowOnError>) {
1511
+ return (options?.client ?? this.client).post<PostNumerologyDailyResponses, unknown, ThrowOnError>({
1512
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1513
+ url: '/numerology/daily',
1514
+ ...options,
1515
+ headers: {
1516
+ 'Content-Type': 'application/json',
1517
+ ...options?.headers
1518
+ }
1519
+ });
1520
+ }
1521
+ }
1522
+
1523
+ export class Dreams extends HeyApiClient {
1524
+ /**
1525
+ * List and search dream symbols
1526
+ *
1527
+ * Browse and search our complete dream interpretation dictionary containing 2,000+ dream symbols with psychological meanings. Find dream meanings for animals (snake dreams, spider dreams, dog dreams), common scenarios (falling dreams, flying dreams, being chased, drowning), people (dreams about mother, father, baby, ex), objects (car, house, water, fire), emotions (fear, anxiety, love), body parts (teeth falling out, hair, eyes), colors, numbers, and abstract concepts. Filter by starting letter for A-Z navigation or search by keyword to find what your dreams mean.
1528
+ */
1529
+ public searchDreamSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsData, ThrowOnError>) {
1530
+ return (options?.client ?? this.client).get<GetDreamsSymbolsResponses, unknown, ThrowOnError>({
1531
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1532
+ url: '/dreams/symbols',
1533
+ ...options
1534
+ });
1535
+ }
1536
+
1537
+ /**
1538
+ * Get random dream symbols
1539
+ *
1540
+ * Discover random dream symbols and their interpretations for daily dream insights and exploration. Each request returns different symbols from the 2,000+ dream meaning database - perfect for dream of the day features, dream journaling prompts, meditation on subconscious themes, or exploring what different dreams mean. Get one or multiple random dream interpretations with full psychological meanings.
1541
+ */
1542
+ public getRandomSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsRandomData, ThrowOnError>) {
1543
+ return (options?.client ?? this.client).get<GetDreamsSymbolsRandomResponses, unknown, ThrowOnError>({
1544
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1545
+ url: '/dreams/symbols/random',
1546
+ ...options
1547
+ });
1548
+ }
1549
+
1550
+ /**
1551
+ * Get symbol counts by letter
1552
+ *
1553
+ * Get the count of dream symbols available for each letter A-Z. Build alphabetical dream dictionary navigation to help users browse dream interpretations by letter - from abandonment dreams to zodiac dreams. See how many dream meanings exist for each starting letter.
1554
+ */
1555
+ public getSymbolLetterCounts<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsLettersData, ThrowOnError>) {
1556
+ return (options?.client ?? this.client).get<GetDreamsSymbolsLettersResponses, unknown, ThrowOnError>({
1557
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1558
+ url: '/dreams/symbols/letters',
1559
+ ...options
1560
+ });
1561
+ }
1562
+
1563
+ /**
1564
+ * Get dream symbol details
1565
+ *
1566
+ * Get the complete dream interpretation for a specific symbol. Understand what your dream means with detailed psychological analysis covering subconscious symbolism, emotional significance, and connections to your waking life. Covers all major dream themes: snake dreams (hidden fears, transformation), falling dreams (loss of control, anxiety), water dreams (emotions, cleansing), death dreams (endings, transformation), teeth falling out (self-image, communication anxiety), being chased (avoidance, confronting fears), flying dreams (freedom, ambition), and thousands more dream meanings.
1567
+ */
1568
+ public getDreamSymbol<ThrowOnError extends boolean = false>(options: Options<GetDreamsSymbolsByIdData, ThrowOnError>) {
1569
+ return (options.client ?? this.client).get<GetDreamsSymbolsByIdResponses, GetDreamsSymbolsByIdErrors, ThrowOnError>({
1570
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1571
+ url: '/dreams/symbols/{id}',
1572
+ ...options
1573
+ });
1574
+ }
1575
+
1576
+ /**
1577
+ * Get daily dream symbol
1578
+ *
1579
+ * Receive a single dream symbol for daily reflection and subconscious exploration. Uses seeded randomness so the same seed gets the same symbol on the same day, perfect for "Dream Symbol of the Day" features. Provide a seed (userId, email hash, session token) for reproducible consistency, or omit for date-based daily symbols. Returns the symbol with full psychological interpretation. Great for dream journal apps, wellness platforms, morning ritual apps, and meditation tools.
1580
+ */
1581
+ public getDailyDreamSymbol<ThrowOnError extends boolean = false>(options?: Options<PostDreamsDailyData, ThrowOnError>) {
1582
+ return (options?.client ?? this.client).post<PostDreamsDailyResponses, unknown, ThrowOnError>({
1583
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1584
+ url: '/dreams/daily',
1585
+ ...options,
1586
+ headers: {
1587
+ 'Content-Type': 'application/json',
1588
+ ...options?.headers
1589
+ }
1590
+ });
1591
+ }
1592
+ }
1593
+
1594
+ export class Iching extends HeyApiClient {
1595
+ /**
1596
+ * Get daily I-Ching hexagram
1597
+ *
1598
+ * Receive a daily I-Ching hexagram for guidance and reflection. This endpoint uses seeded randomness to ensure the same seed gets the same hexagram on the same day - perfect for "Hexagram of the Day" features in oracle apps, meditation platforms, and daily wisdom tools. Returns the hexagram with judgment, image, and interpretations for love, career, decisions, and practical advice based on ancient Chinese wisdom from the Book of Changes.
1599
+ */
1600
+ public getDailyHexagram<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyData, ThrowOnError>) {
1601
+ return (options?.client ?? this.client).post<PostIchingDailyResponses, PostIchingDailyErrors, ThrowOnError>({
1602
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1603
+ url: '/iching/daily',
1604
+ ...options,
1605
+ headers: {
1606
+ 'Content-Type': 'application/json',
1607
+ ...options?.headers
1608
+ }
1609
+ });
1610
+ }
1611
+
1612
+ /**
1613
+ * Cast daily I-Ching reading with changing lines
1614
+ *
1615
+ * Cast a complete daily I-Ching reading using the traditional three-coin method with seeded randomness. Unlike the simple daily hexagram, this provides the full casting experience with line values (6-9), changing line positions, and the resulting hexagram if transformation occurs. Same seed + same date = same casting result. Perfect for I-Ching divination apps requiring authentic oracle experience with daily consistency.
1616
+ */
1617
+ public castDailyReading<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyCastData, ThrowOnError>) {
1618
+ return (options?.client ?? this.client).post<PostIchingDailyCastResponses, unknown, ThrowOnError>({
1619
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1620
+ url: '/iching/daily/cast',
1621
+ ...options,
1622
+ headers: {
1623
+ 'Content-Type': 'application/json',
1624
+ ...options?.headers
1625
+ }
1626
+ });
1627
+ }
1628
+
1629
+ /**
1630
+ * List all 64 hexagrams
1631
+ *
1632
+ * Browse all 64 I-Ching hexagrams from the Book of Changes with their Chinese names, English translations, and trigram compositions. The hexagrams are ordered by the traditional King Wen sequence used in I-Ching divination for 3,000 years. Each hexagram represents a unique life situation combining two trigrams (Heaven, Earth, Thunder, Wind, Water, Fire, Mountain, Lake) into profound wisdom for decision-making and self-understanding.
1633
+ */
1634
+ public listHexagrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsData, ThrowOnError>) {
1635
+ return (options?.client ?? this.client).get<GetIchingHexagramsResponses, unknown, ThrowOnError>({
1636
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1637
+ url: '/iching/hexagrams',
1638
+ ...options
1639
+ });
1640
+ }
1641
+
1642
+ /**
1643
+ * Get a random hexagram
1644
+ *
1645
+ * Receive a random I-Ching hexagram with full interpretation. Perfect for daily oracle features, meditation prompts, or exploring the Book of Changes. Returns complete hexagram data including judgment, image, interpretations for love/career/decisions, and all six changing line meanings.
1646
+ */
1647
+ public getRandomHexagram<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsRandomData, ThrowOnError>) {
1648
+ return (options?.client ?? this.client).get<GetIchingHexagramsRandomResponses, GetIchingHexagramsRandomErrors, ThrowOnError>({
1649
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1650
+ url: '/iching/hexagrams/random',
1651
+ ...options
1652
+ });
1653
+ }
1654
+
1655
+ /**
1656
+ * Lookup hexagram by line pattern
1657
+ *
1658
+ * Find an I-Ching hexagram by its binary line pattern. Provide 6 digits (0 or 1) representing broken (yin) and solid (yang) lines from bottom to top. Use this for custom divination interfaces where users input their own line configurations, or to find hexagrams matching specific trigram combinations. Example: "111111" returns Hexagram 1 (The Creative), "000000" returns Hexagram 2 (The Receptive).
1659
+ */
1660
+ public lookupHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsLookupData, ThrowOnError>) {
1661
+ return (options.client ?? this.client).get<GetIchingHexagramsLookupResponses, GetIchingHexagramsLookupErrors, ThrowOnError>({
1662
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1663
+ url: '/iching/hexagrams/lookup',
1664
+ ...options
1665
+ });
1666
+ }
1667
+
1668
+ /**
1669
+ * Get hexagram by number
1670
+ *
1671
+ * Retrieve complete I-Ching hexagram details by King Wen sequence number (1-64). Returns the full hexagram with Chinese name, English translation, judgment text, image text, modern interpretations for general situations, love, career, and decision-making, plus all six changing line meanings. Use this to display detailed hexagram information after casting or for educational reference.
1672
+ */
1673
+ public getHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsByNumberData, ThrowOnError>) {
1674
+ return (options.client ?? this.client).get<GetIchingHexagramsByNumberResponses, GetIchingHexagramsByNumberErrors, ThrowOnError>({
1675
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1676
+ url: '/iching/hexagrams/{number}',
1677
+ ...options
1678
+ });
1679
+ }
1680
+
1681
+ /**
1682
+ * Cast an I-Ching reading
1683
+ *
1684
+ * Generate an authentic I-Ching reading using the traditional three-coin casting method. Each of the six lines is determined by virtually tossing three coins, producing values 6-9 where 6 (old yin) and 9 (old yang) are changing lines. Returns the primary hexagram with full interpretation, the line values showing which lines are changing, and if any lines change, the resulting hexagram that the primary transforms into. Optionally provide a seed for reproducible castings. Perfect for divination apps, oracle features, and decision-making tools.
1685
+ */
1686
+ public castReading<ThrowOnError extends boolean = false>(options?: Options<GetIchingCastData, ThrowOnError>) {
1687
+ return (options?.client ?? this.client).get<GetIchingCastResponses, unknown, ThrowOnError>({
1688
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1689
+ url: '/iching/cast',
1690
+ ...options
1691
+ });
1692
+ }
1693
+
1694
+ /**
1695
+ * List all 8 trigrams
1696
+ *
1697
+ * Retrieve all 8 I-Ching trigrams (bagua) - the fundamental building blocks of hexagrams. Each trigram consists of three lines and represents a primal force of nature: Heaven (Qian), Earth (Kun), Thunder (Zhen), Wind (Xun), Water (Kan), Fire (Li), Mountain (Gen), and Lake (Dui). Understanding trigrams is essential for interpreting hexagram meanings, as each hexagram combines an upper and lower trigram.
1698
+ */
1699
+ public listTrigrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingTrigramsData, ThrowOnError>) {
1700
+ return (options?.client ?? this.client).get<GetIchingTrigramsResponses, unknown, ThrowOnError>({
1701
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1702
+ url: '/iching/trigrams',
1703
+ ...options
1704
+ });
1705
+ }
1706
+
1707
+ /**
1708
+ * Get trigram by number or name
1709
+ *
1710
+ * Retrieve a specific I-Ching trigram by its number (1-8) or English name (Heaven, Earth, Thunder, Wind, Water, Fire, Mountain, Lake). Returns complete trigram information including Chinese name, pinyin, element associations, core attributes, and symbolic meaning. Use this to understand the component trigrams of any hexagram.
1711
+ */
1712
+ public getTrigram<ThrowOnError extends boolean = false>(options: Options<GetIchingTrigramsByIdentifierData, ThrowOnError>) {
1713
+ return (options.client ?? this.client).get<GetIchingTrigramsByIdentifierResponses, GetIchingTrigramsByIdentifierErrors, ThrowOnError>({
1714
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1715
+ url: '/iching/trigrams/{identifier}',
1716
+ ...options
1717
+ });
1718
+ }
1719
+ }
1720
+
1721
+ export class Crystals extends HeyApiClient {
1722
+ /**
1723
+ * Crystals by Zodiac Sign
1724
+ *
1725
+ * Get healing crystals and gemstones associated with a specific zodiac sign. Returns summary data for each crystal. Use the /crystals/:slug detail endpoint for full healing properties. Supports all 12 zodiac signs from Aries through Pisces. Perfect for personalized crystal recommendations based on astrological birth chart data.
1726
+ */
1727
+ public getCrystalsByZodiac<ThrowOnError extends boolean = false>(options: Options<GetCrystalsZodiacBySignData, ThrowOnError>) {
1728
+ return (options.client ?? this.client).get<GetCrystalsZodiacBySignResponses, unknown, ThrowOnError>({
1729
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1730
+ url: '/crystals/zodiac/{sign}',
1731
+ ...options
1732
+ });
1733
+ }
1734
+
1735
+ /**
1736
+ * Crystals by Chakra
1737
+ *
1738
+ * Get healing crystals and gemstones that resonate with a specific chakra energy center. Returns summary data for each crystal. Use the /crystals/:slug detail endpoint for full healing properties. Supports all 7 primary chakras: Root, Sacral, Solar Plexus, Heart, Throat, Third Eye, and Crown. Essential for crystal grid building, chakra balancing, and energy healing applications.
1739
+ */
1740
+ public getCrystalsByChakra<ThrowOnError extends boolean = false>(options: Options<GetCrystalsChakraByChakraData, ThrowOnError>) {
1741
+ return (options.client ?? this.client).get<GetCrystalsChakraByChakraResponses, unknown, ThrowOnError>({
1742
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1743
+ url: '/crystals/chakra/{chakra}',
1744
+ ...options
1745
+ });
1746
+ }
1747
+
1748
+ /**
1749
+ * Crystals by Element
1750
+ *
1751
+ * Get healing crystals and gemstones associated with a specific natural element. Returns summary data for each crystal. Use the /crystals/:slug detail endpoint for full healing properties. Supports five elements: Earth, Water, Fire, Air, and Storm. Essential for elemental crystal selection, nature-based healing, and element-themed crystal grid applications.
1752
+ */
1753
+ public getCrystalsByElement<ThrowOnError extends boolean = false>(options: Options<GetCrystalsElementByElementData, ThrowOnError>) {
1754
+ return (options.client ?? this.client).get<GetCrystalsElementByElementResponses, unknown, ThrowOnError>({
1755
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1756
+ url: '/crystals/element/{element}',
1757
+ ...options
1758
+ });
1759
+ }
1760
+
1761
+ /**
1762
+ * Birthstone Crystals by Month
1763
+ *
1764
+ * Get the traditional birthstone crystals for a given birth month. Returns summary data for each crystal. Use the /crystals/:slug detail endpoint for full healing properties. Based on GIA-authoritative birthstone assignments. Perfect for birthday gift recommendations, personalized crystal suggestions, and birthstone jewelry applications.
1765
+ */
1766
+ public getBirthstones<ThrowOnError extends boolean = false>(options: Options<GetCrystalsBirthstoneByMonthData, ThrowOnError>) {
1767
+ return (options.client ?? this.client).get<GetCrystalsBirthstoneByMonthResponses, unknown, ThrowOnError>({
1768
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1769
+ url: '/crystals/birthstone/{month}',
1770
+ ...options
1771
+ });
1772
+ }
1773
+
1774
+ /**
1775
+ * Search Crystals
1776
+ *
1777
+ * Search for healing crystals by keyword or name. Matches against crystal names, healing keywords, descriptions, and spiritual/emotional/physical meaning fields. Returns summary data for each crystal. Use the /crystals/:slug detail endpoint for full healing properties. Useful for building crystal search bars, keyword-based recommendation features, and healing property lookups.
1778
+ */
1779
+ public searchCrystals<ThrowOnError extends boolean = false>(options: Options<GetCrystalsSearchData, ThrowOnError>) {
1780
+ return (options.client ?? this.client).get<GetCrystalsSearchResponses, unknown, ThrowOnError>({
1781
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1782
+ url: '/crystals/search',
1783
+ ...options
1784
+ });
1785
+ }
1786
+
1787
+ /**
1788
+ * Crystal Pairings
1789
+ *
1790
+ * Get crystals that pair well with a given crystal for enhanced healing combinations. Returns the source crystal along with its recommended companion stones and their properties. Essential for crystal grid building, healing combination recommendations, and crystal shop cross-sell features.
1791
+ */
1792
+ public getCrystalPairings<ThrowOnError extends boolean = false>(options: Options<GetCrystalsPairingsBySlugData, ThrowOnError>) {
1793
+ return (options.client ?? this.client).get<GetCrystalsPairingsBySlugResponses, GetCrystalsPairingsBySlugErrors, ThrowOnError>({
1794
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1795
+ url: '/crystals/pairings/{slug}',
1796
+ ...options
1797
+ });
1798
+ }
1799
+
1800
+ /**
1801
+ * Daily Crystal
1802
+ *
1803
+ * Get the crystal of the day as a discovery teaser. Returns a deterministic crystal based on the current date (or a provided seed date), ensuring all users see the same crystal for any given day. Use the /crystals/:slug detail endpoint for complete spiritual, emotional, and physical healing properties. Perfect for daily guidance features, push notifications, wellness app widgets, and crystal journal integrations.
1804
+ */
1805
+ public getDailyCrystal<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsDailyData, ThrowOnError>) {
1806
+ return (options?.client ?? this.client).get<GetCrystalsDailyResponses, unknown, ThrowOnError>({
1807
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1808
+ url: '/crystals/daily',
1809
+ ...options
1810
+ });
1811
+ }
1812
+
1813
+ /**
1814
+ * Random Crystal
1815
+ *
1816
+ * Get a randomly selected healing crystal as a discovery teaser. Returns a different crystal on each request (non-deterministic). Use the /crystals/:slug detail endpoint for complete spiritual, emotional, and physical healing properties. Perfect for crystal discovery features, surprise crystal picks, crystal roulette games, and exploration widgets. For a deterministic daily crystal that is the same for all users on a given date, use the /daily endpoint instead.
1817
+ */
1818
+ public getRandomCrystal<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsRandomData, ThrowOnError>) {
1819
+ return (options?.client ?? this.client).get<GetCrystalsRandomResponses, unknown, ThrowOnError>({
1820
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1821
+ url: '/crystals/random',
1822
+ ...options
1823
+ });
1824
+ }
1825
+
1826
+ /**
1827
+ * List Crystal Colors
1828
+ *
1829
+ * List all unique crystal colors available in the database. Use these values with the color filter on GET /crystals to find crystals by color. Essential reference endpoint for building color-based crystal browsing, visual crystal pickers, and filtering UI.
1830
+ */
1831
+ public listCrystalColors<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsColorsData, ThrowOnError>) {
1832
+ return (options?.client ?? this.client).get<GetCrystalsColorsResponses, unknown, ThrowOnError>({
1833
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1834
+ url: '/crystals/colors',
1835
+ ...options
1836
+ });
1837
+ }
1838
+
1839
+ /**
1840
+ * List Crystal Planets
1841
+ *
1842
+ * List all unique planetary associations available in the database. Use these values with the planet filter on GET /crystals to find crystals by ruling planet. Essential reference endpoint for astrology app builders who want to recommend crystals based on planetary placements in a birth chart.
1843
+ */
1844
+ public listCrystalPlanets<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsPlanetsData, ThrowOnError>) {
1845
+ return (options?.client ?? this.client).get<GetCrystalsPlanetsResponses, unknown, ThrowOnError>({
1846
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1847
+ url: '/crystals/planets',
1848
+ ...options
1849
+ });
1850
+ }
1851
+
1852
+ /**
1853
+ * List All Crystals
1854
+ *
1855
+ * Retrieve healing crystals and gemstones with pagination. Supports optional filtering by chakra, zodiac sign, element, color, or planet. Returns minimal summary fields per crystal. Use the detail endpoint for full healing properties. Perfect for building crystal explorer apps, healing stone guides, and personalized crystal recommendation engines.
1856
+ */
1857
+ public listCrystals<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsData, ThrowOnError>) {
1858
+ return (options?.client ?? this.client).get<GetCrystalsResponses, unknown, ThrowOnError>({
1859
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1860
+ url: '/crystals',
1861
+ ...options
1862
+ });
1863
+ }
1864
+
1865
+ /**
1866
+ * Get Crystal Healing Properties
1867
+ *
1868
+ * Get complete healing properties and metaphysical data for a specific crystal or gemstone. Returns spiritual, emotional, and physical healing interpretations along with chakra associations, zodiac connections, elemental properties, and crystal pairing recommendations. Authoritative interpretations covering all major healing crystals.
1869
+ */
1870
+ public getCrystal<ThrowOnError extends boolean = false>(options: Options<GetCrystalsBySlugData, ThrowOnError>) {
1871
+ return (options.client ?? this.client).get<GetCrystalsBySlugResponses, GetCrystalsBySlugErrors, ThrowOnError>({
1872
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1873
+ url: '/crystals/{slug}',
1874
+ ...options
1875
+ });
1876
+ }
1877
+ }
1878
+
1879
+ export class Location extends HeyApiClient {
1880
+ /**
1881
+ * Search cities worldwide - Geocoding autocomplete with coordinates and timezone
1882
+ *
1883
+ * City autocomplete and geocoding search across 7,000+ locations in 227 countries. 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. Covers all major cities in Europe, Americas, Asia, Africa, and Oceania.
1884
+ */
1885
+ public searchCities<ThrowOnError extends boolean = false>(options: Options<GetLocationSearchData, ThrowOnError>) {
1886
+ return (options.client ?? this.client).get<GetLocationSearchResponses, unknown, ThrowOnError>({
1887
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1888
+ url: '/location/search',
1889
+ ...options
1890
+ });
1891
+ }
1892
+
1893
+ /**
1894
+ * List all 227 countries - ISO codes and city coverage
1895
+ *
1896
+ * Returns all 227 countries 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.
1897
+ */
1898
+ public listCountries<ThrowOnError extends boolean = false>(options?: Options<GetLocationCountriesData, ThrowOnError>) {
1899
+ return (options?.client ?? this.client).get<GetLocationCountriesResponses, unknown, ThrowOnError>({
1900
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1901
+ url: '/location/countries',
1902
+ ...options
1903
+ });
1904
+ }
1905
+
1906
+ /**
1907
+ * Get cities in a country - Geocoding directory sorted by population
1908
+ *
1909
+ * Returns all cities for a specific country, identified by ISO 3166-1 alpha-2 code (e.g. DE for Germany, FR for France, GB for United Kingdom, US for United States). Each city includes geographic coordinates, IANA timezone, and DST-aware UTC offset for direct use in astrology birth chart, horoscope, transit, and panchang calculations. Cities sorted by population with the largest metropolitan areas first.
1910
+ */
1911
+ public getCitiesByCountry<ThrowOnError extends boolean = false>(options: Options<GetLocationCountriesByIso2Data, ThrowOnError>) {
1912
+ return (options.client ?? this.client).get<GetLocationCountriesByIso2Responses, unknown, ThrowOnError>({
1913
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1914
+ url: '/location/countries/{iso2}',
1915
+ ...options
1916
+ });
1917
+ }
1918
+ }
1919
+
1920
+ export class Usage extends HeyApiClient {
1921
+ /**
1922
+ * Get API usage statistics
1923
+ *
1924
+ * Returns current usage and plan limits for your subscription.
1925
+ */
1926
+ public getUsageStats<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) {
1927
+ return (options?.client ?? this.client).get<GetUsageResponses, GetUsageErrors, ThrowOnError>({
1928
+ security: [{ name: 'X-API-Key', type: 'apiKey' }],
1929
+ url: '/usage',
1930
+ ...options
1931
+ });
1932
+ }
1933
+ }
1934
+
1935
+ export class Roxy extends HeyApiClient {
1936
+ public static readonly __registry = new HeyApiRegistry<Roxy>();
1937
+
1938
+ constructor(args?: {
1939
+ client?: Client;
1940
+ key?: string;
1941
+ }) {
1942
+ super(args);
1943
+ Roxy.__registry.set(this, args?.key);
1944
+ }
1945
+
1946
+ private _angelNumbers?: AngelNumbers;
1947
+ get angelNumbers(): AngelNumbers {
1948
+ return this._angelNumbers ??= new AngelNumbers({ client: this.client });
1949
+ }
1950
+
1951
+ private _astrology?: Astrology;
1952
+ get astrology(): Astrology {
1953
+ return this._astrology ??= new Astrology({ client: this.client });
1954
+ }
1955
+
1956
+ private _vedicAstrology?: VedicAstrology;
1957
+ get vedicAstrology(): VedicAstrology {
1958
+ return this._vedicAstrology ??= new VedicAstrology({ client: this.client });
1959
+ }
1960
+
1961
+ private _tarot?: Tarot;
1962
+ get tarot(): Tarot {
1963
+ return this._tarot ??= new Tarot({ client: this.client });
1964
+ }
1965
+
1966
+ private _numerology?: Numerology;
1967
+ get numerology(): Numerology {
1968
+ return this._numerology ??= new Numerology({ client: this.client });
1969
+ }
1970
+
1971
+ private _dreams?: Dreams;
1972
+ get dreams(): Dreams {
1973
+ return this._dreams ??= new Dreams({ client: this.client });
1974
+ }
1975
+
1976
+ private _iching?: Iching;
1977
+ get iching(): Iching {
1978
+ return this._iching ??= new Iching({ client: this.client });
1979
+ }
1980
+
1981
+ private _crystals?: Crystals;
1982
+ get crystals(): Crystals {
1983
+ return this._crystals ??= new Crystals({ client: this.client });
1984
+ }
1985
+
1986
+ private _location?: Location;
1987
+ get location(): Location {
1988
+ return this._location ??= new Location({ client: this.client });
1989
+ }
1990
+
1991
+ private _usage?: Usage;
1992
+ get usage(): Usage {
1993
+ return this._usage ??= new Usage({ client: this.client });
1994
+ }
1995
+ }