@roxyapi/sdk 1.2.56 → 1.2.58
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-HCC4GID6.js → chunk-25Y6CPVU.js} +19 -11
- package/dist/client/index.cjs +19 -11
- package/dist/client/index.d.ts +2 -0
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/utils.gen.d.ts +1 -1
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client.gen.d.ts +2 -2
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.d.ts +7 -0
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/params.gen.d.ts +2 -2
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/types.gen.d.ts +5 -0
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/factory.cjs +36 -4
- package/dist/factory.js +37 -5
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +191 -179
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1280 -140
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +60 -1
- package/package.json +4 -4
- package/src/client/index.ts +2 -0
- package/src/client/utils.gen.ts +2 -2
- package/src/client.gen.ts +2 -2
- package/src/core/auth.gen.ts +7 -0
- package/src/core/params.gen.ts +21 -12
- package/src/core/pathSerializer.gen.ts +6 -6
- package/src/core/queryKeySerializer.gen.ts +1 -1
- package/src/core/types.gen.ts +6 -0
- package/src/core/utils.gen.ts +4 -4
- package/src/index.ts +1 -1
- package/src/sdk.gen.ts +214 -180
- package/src/types.gen.ts +1779 -625
- package/src/version.ts +1 -1
package/src/sdk.gen.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
|
|
3
|
-
import type { Client, Options as Options2, TDataShape } from './client';
|
|
3
|
+
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
4
4
|
import { client } from './client.gen';
|
|
5
|
-
import type { GetAngelNumbersLookupData, GetAngelNumbersLookupErrors, GetAngelNumbersLookupResponses, GetAngelNumbersNumbersByNumberData, GetAngelNumbersNumbersByNumberErrors, GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersData, GetAngelNumbersNumbersErrors, GetAngelNumbersNumbersResponses, GetAstrologyHoroscopeBySignDailyData, GetAstrologyHoroscopeBySignDailyErrors, GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignMonthlyData, GetAstrologyHoroscopeBySignMonthlyErrors, GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignWeeklyData, GetAstrologyHoroscopeBySignWeeklyErrors, GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyMoonPhaseCalendarByYearByMonthData, GetAstrologyMoonPhaseCalendarByYearByMonthErrors, GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCurrentData, GetAstrologyMoonPhaseCurrentErrors, GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseUpcomingData, GetAstrologyMoonPhaseUpcomingErrors, GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyPlanetMeaningsByIdData, GetAstrologyPlanetMeaningsByIdErrors, GetAstrologyPlanetMeaningsByIdResponses, GetAstrologyPlanetMeaningsData, GetAstrologyPlanetMeaningsErrors, GetAstrologyPlanetMeaningsResponses, GetAstrologySignsByIdData, GetAstrologySignsByIdErrors, GetAstrologySignsByIdResponses, GetAstrologySignsData, GetAstrologySignsErrors, GetAstrologySignsResponses, GetCrystalsBirthstoneByMonthData, GetCrystalsBirthstoneByMonthErrors, GetCrystalsBirthstoneByMonthResponses, GetCrystalsByIdData, GetCrystalsByIdErrors, GetCrystalsByIdResponses, GetCrystalsChakraByChakraData, GetCrystalsChakraByChakraErrors, GetCrystalsChakraByChakraResponses, GetCrystalsColorsData, GetCrystalsColorsErrors, GetCrystalsColorsResponses, GetCrystalsData, GetCrystalsElementByElementData, GetCrystalsElementByElementErrors, GetCrystalsElementByElementResponses, GetCrystalsErrors, GetCrystalsPairingsByIdData, GetCrystalsPairingsByIdErrors, GetCrystalsPairingsByIdResponses, GetCrystalsPlanetsData, GetCrystalsPlanetsErrors, GetCrystalsPlanetsResponses, GetCrystalsRandomData, GetCrystalsRandomErrors, GetCrystalsRandomResponses, GetCrystalsResponses, GetCrystalsSearchData, GetCrystalsSearchErrors, GetCrystalsSearchResponses, GetCrystalsZodiacBySignData, GetCrystalsZodiacBySignErrors, GetCrystalsZodiacBySignResponses, GetDreamsSymbolsByIdData, GetDreamsSymbolsByIdErrors, GetDreamsSymbolsByIdResponses, GetDreamsSymbolsData, GetDreamsSymbolsErrors, GetDreamsSymbolsLettersData, GetDreamsSymbolsLettersErrors, GetDreamsSymbolsLettersResponses, GetDreamsSymbolsRandomData, GetDreamsSymbolsRandomErrors, GetDreamsSymbolsRandomResponses, GetDreamsSymbolsResponses, GetHumanDesignCentersByIdData, GetHumanDesignCentersByIdErrors, GetHumanDesignCentersByIdResponses, GetHumanDesignGatesByNumberData, GetHumanDesignGatesByNumberErrors, GetHumanDesignGatesByNumberResponses, GetIchingCastData, GetIchingCastErrors, GetIchingCastResponses, GetIchingHexagramsByNumberData, GetIchingHexagramsByNumberErrors, GetIchingHexagramsByNumberResponses, GetIchingHexagramsData, GetIchingHexagramsErrors, GetIchingHexagramsLookupData, GetIchingHexagramsLookupErrors, GetIchingHexagramsLookupResponses, GetIchingHexagramsRandomData, GetIchingHexagramsRandomErrors, GetIchingHexagramsRandomResponses, GetIchingHexagramsResponses, GetIchingTrigramsByIdData, GetIchingTrigramsByIdErrors, GetIchingTrigramsByIdResponses, GetIchingTrigramsData, GetIchingTrigramsErrors, GetIchingTrigramsResponses, GetLanguagesData, GetLanguagesErrors, GetLanguagesResponses, GetLocationCountriesByIso2Data, GetLocationCountriesByIso2Errors, GetLocationCountriesByIso2Responses, GetLocationCountriesData, GetLocationCountriesErrors, GetLocationCountriesResponses, GetLocationSearchData, GetLocationSearchErrors, GetLocationSearchResponses, GetNumerologyCompoundNumberByNumberData, GetNumerologyCompoundNumberByNumberErrors, GetNumerologyCompoundNumberByNumberResponses, GetNumerologyMeaningsByNumberData, GetNumerologyMeaningsByNumberErrors, GetNumerologyMeaningsByNumberResponses, GetTarotCardsByIdData, GetTarotCardsByIdErrors, GetTarotCardsByIdResponses, GetTarotCardsData, GetTarotCardsErrors, GetTarotCardsResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetVedicAstrologyAvasthasByIdData, GetVedicAstrologyAvasthasByIdErrors, GetVedicAstrologyAvasthasByIdResponses, GetVedicAstrologyAvasthasData, GetVedicAstrologyAvasthasErrors, GetVedicAstrologyAvasthasResponses, GetVedicAstrologyKpAyanamsaData, GetVedicAstrologyKpAyanamsaErrors, GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyNakshatrasByIdData, GetVedicAstrologyNakshatrasByIdErrors, GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasData, GetVedicAstrologyNakshatrasErrors, GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyRashisByIdData, GetVedicAstrologyRashisByIdErrors, GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisData, GetVedicAstrologyRashisErrors, GetVedicAstrologyRashisResponses, GetVedicAstrologyYogaByIdData, GetVedicAstrologyYogaByIdErrors, GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaData, GetVedicAstrologyYogaErrors, GetVedicAstrologyYogaResponses, PostAngelNumbersDailyData, PostAngelNumbersDailyErrors, PostAngelNumbersDailyResponses, PostAstrologyArabicLotsData, PostAstrologyArabicLotsErrors, PostAstrologyArabicLotsResponses, PostAstrologyAspectPatternsData, PostAstrologyAspectPatternsErrors, PostAstrologyAspectPatternsResponses, PostAstrologyAspectsData, PostAstrologyAspectsErrors, PostAstrologyAspectsResponses, PostAstrologyAsteroidsData, PostAstrologyAsteroidsErrors, PostAstrologyAsteroidsResponses, PostAstrologyAstrocartographyData, PostAstrologyAstrocartographyErrors, PostAstrologyAstrocartographyResponses, PostAstrologyCompatibilityScoreData, PostAstrologyCompatibilityScoreErrors, PostAstrologyCompatibilityScoreResponses, PostAstrologyCompositeChartData, PostAstrologyCompositeChartErrors, PostAstrologyCompositeChartResponses, PostAstrologyFixedStarsData, PostAstrologyFixedStarsErrors, PostAstrologyFixedStarsResponses, PostAstrologyHousesData, PostAstrologyHousesErrors, PostAstrologyHousesResponses, PostAstrologyLilithData, PostAstrologyLilithErrors, PostAstrologyLilithResponses, PostAstrologyLocalSpaceData, PostAstrologyLocalSpaceErrors, PostAstrologyLocalSpaceResponses, PostAstrologyLunarReturnData, PostAstrologyLunarReturnErrors, PostAstrologyLunarReturnResponses, PostAstrologyNatalChartData, PostAstrologyNatalChartErrors, PostAstrologyNatalChartResponses, PostAstrologyPlanetaryReturnsData, PostAstrologyPlanetaryReturnsErrors, PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetsData, PostAstrologyPlanetsErrors, PostAstrologyPlanetsResponses, PostAstrologyProfectionsData, PostAstrologyProfectionsErrors, PostAstrologyProfectionsResponses, PostAstrologyProgressionsData, PostAstrologyProgressionsErrors, PostAstrologyProgressionsResponses, PostAstrologyRelocationChartData, PostAstrologyRelocationChartErrors, PostAstrologyRelocationChartResponses, PostAstrologySolarArcData, PostAstrologySolarArcErrors, PostAstrologySolarArcResponses, PostAstrologySolarReturnData, PostAstrologySolarReturnErrors, PostAstrologySolarReturnResponses, PostAstrologySynastryData, PostAstrologySynastryErrors, PostAstrologySynastryResponses, PostAstrologyTransitAspectsData, PostAstrologyTransitAspectsErrors, PostAstrologyTransitAspectsResponses, PostAstrologyTransitsData, PostAstrologyTransitsErrors, PostAstrologyTransitsResponses, PostBiorhythmCompatibilityData, PostBiorhythmCompatibilityErrors, PostBiorhythmCompatibilityResponses, PostBiorhythmCriticalDaysData, PostBiorhythmCriticalDaysErrors, PostBiorhythmCriticalDaysResponses, PostBiorhythmDailyData, PostBiorhythmDailyErrors, PostBiorhythmDailyResponses, PostBiorhythmForecastData, PostBiorhythmForecastErrors, PostBiorhythmForecastResponses, PostBiorhythmPhasesData, PostBiorhythmPhasesErrors, PostBiorhythmPhasesResponses, PostBiorhythmReadingData, PostBiorhythmReadingErrors, PostBiorhythmReadingResponses, PostCrystalsDailyData, PostCrystalsDailyErrors, PostCrystalsDailyResponses, PostDreamsDailyData, PostDreamsDailyErrors, PostDreamsDailyResponses, PostForecastDigestData, PostForecastDigestErrors, PostForecastDigestResponses, PostForecastSignificantDatesData, PostForecastSignificantDatesErrors, PostForecastSignificantDatesResponses, PostForecastSolarReturnData, PostForecastSolarReturnErrors, PostForecastSolarReturnResponses, PostForecastTimelineData, PostForecastTimelineErrors, PostForecastTimelineResponses, PostForecastTransitsData, PostForecastTransitsErrors, PostForecastTransitsResponses, PostHumanDesignBodygraphData, PostHumanDesignBodygraphErrors, PostHumanDesignBodygraphResponses, PostHumanDesignCentersData, PostHumanDesignCentersErrors, PostHumanDesignCentersResponses, PostHumanDesignChannelsData, PostHumanDesignChannelsErrors, PostHumanDesignChannelsResponses, PostHumanDesignConnectionData, PostHumanDesignConnectionErrors, PostHumanDesignConnectionResponses, PostHumanDesignGatesData, PostHumanDesignGatesErrors, PostHumanDesignGatesResponses, PostHumanDesignPentaData, PostHumanDesignPentaErrors, PostHumanDesignPentaResponses, PostHumanDesignProfileData, PostHumanDesignProfileErrors, PostHumanDesignProfileResponses, PostHumanDesignTransitData, PostHumanDesignTransitErrors, PostHumanDesignTransitResponses, PostHumanDesignTypeData, PostHumanDesignTypeErrors, PostHumanDesignTypeResponses, PostHumanDesignVariablesData, PostHumanDesignVariablesErrors, PostHumanDesignVariablesResponses, PostIchingDailyCastData, PostIchingDailyCastErrors, PostIchingDailyCastResponses, PostIchingDailyData, PostIchingDailyErrors, PostIchingDailyResponses, PostNumerologyBirthDayData, PostNumerologyBirthDayErrors, PostNumerologyBirthDayResponses, PostNumerologyBridgeData, PostNumerologyBridgeErrors, PostNumerologyBridgeResponses, PostNumerologyBusinessNameData, PostNumerologyBusinessNameErrors, PostNumerologyBusinessNameResponses, PostNumerologyChaldeanData, PostNumerologyChaldeanErrors, PostNumerologyChaldeanResponses, PostNumerologyChartData, PostNumerologyChartErrors, PostNumerologyChartResponses, PostNumerologyCompatibilityData, PostNumerologyCompatibilityErrors, PostNumerologyCompatibilityResponses, PostNumerologyDailyData, PostNumerologyDailyErrors, PostNumerologyDailyResponses, PostNumerologyDualData, PostNumerologyDualErrors, PostNumerologyDualResponses, PostNumerologyExpressionData, PostNumerologyExpressionErrors, PostNumerologyExpressionResponses, PostNumerologyKarmicDebtData, PostNumerologyKarmicDebtErrors, PostNumerologyKarmicDebtResponses, PostNumerologyKarmicLessonsData, PostNumerologyKarmicLessonsErrors, PostNumerologyKarmicLessonsResponses, PostNumerologyLifePathData, PostNumerologyLifePathErrors, PostNumerologyLifePathResponses, PostNumerologyMaturityData, PostNumerologyMaturityErrors, PostNumerologyMaturityResponses, PostNumerologyPersonalDayData, PostNumerologyPersonalDayErrors, PostNumerologyPersonalDayResponses, PostNumerologyPersonalityData, PostNumerologyPersonalityErrors, PostNumerologyPersonalityResponses, PostNumerologyPersonalMonthData, PostNumerologyPersonalMonthErrors, PostNumerologyPersonalMonthResponses, PostNumerologyPersonalYearData, PostNumerologyPersonalYearErrors, PostNumerologyPersonalYearResponses, PostNumerologySoulUrgeData, PostNumerologySoulUrgeErrors, PostNumerologySoulUrgeResponses, PostTarotDailyData, PostTarotDailyErrors, PostTarotDailyResponses, PostTarotDrawData, PostTarotDrawErrors, PostTarotDrawResponses, PostTarotSpreadsCareerData, PostTarotSpreadsCareerErrors, PostTarotSpreadsCareerResponses, PostTarotSpreadsCelticCrossData, PostTarotSpreadsCelticCrossErrors, PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCustomData, PostTarotSpreadsCustomErrors, PostTarotSpreadsCustomResponses, PostTarotSpreadsLoveData, PostTarotSpreadsLoveErrors, PostTarotSpreadsLoveResponses, PostTarotSpreadsThreeCardData, PostTarotSpreadsThreeCardErrors, PostTarotSpreadsThreeCardResponses, PostTarotYesNoData, PostTarotYesNoErrors, PostTarotYesNoResponses, PostVedicAstrologyArudhaData, PostVedicAstrologyArudhaErrors, PostVedicAstrologyArudhaResponses, PostVedicAstrologyAshtakavargaData, PostVedicAstrologyAshtakavargaErrors, PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAspectsData, PostVedicAstrologyAspectsErrors, PostVedicAstrologyAspectsLunarData, PostVedicAstrologyAspectsLunarErrors, PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsMonthlyData, PostVedicAstrologyAspectsMonthlyErrors, PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsResponses, PostVedicAstrologyBhavaBalaData, PostVedicAstrologyBhavaBalaErrors, PostVedicAstrologyBhavaBalaResponses, PostVedicAstrologyBhavChalitData, PostVedicAstrologyBhavChalitErrors, PostVedicAstrologyBhavChalitResponses, PostVedicAstrologyBirthChartData, PostVedicAstrologyBirthChartErrors, PostVedicAstrologyBirthChartResponses, PostVedicAstrologyCharaKarakasData, PostVedicAstrologyCharaKarakasErrors, PostVedicAstrologyCharaKarakasResponses, PostVedicAstrologyCompatibilityData, PostVedicAstrologyCompatibilityErrors, PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyDashaCurrentData, PostVedicAstrologyDashaCurrentErrors, PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaMajorData, PostVedicAstrologyDashaMajorErrors, PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaResponses, PostVedicAstrologyDashaSubByMahadashaData, PostVedicAstrologyDashaSubByMahadashaErrors, PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDivisionalChartData, PostVedicAstrologyDivisionalChartErrors, PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDoshaKalsarpaData, PostVedicAstrologyDoshaKalsarpaErrors, PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaManglikData, PostVedicAstrologyDoshaManglikErrors, PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaSadhesatiData, PostVedicAstrologyDoshaSadhesatiErrors, PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyEclipticCrossingsData, PostVedicAstrologyEclipticCrossingsErrors, PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyKpChartData, PostVedicAstrologyKpChartErrors, PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpCuspsData, PostVedicAstrologyKpCuspsErrors, PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpPlanetsData, PostVedicAstrologyKpPlanetsErrors, PostVedicAstrologyKpPlanetsIntervalData, PostVedicAstrologyKpPlanetsIntervalErrors, PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpRasiChangesData, PostVedicAstrologyKpRasiChangesErrors, PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRulingPlanetsData, PostVedicAstrologyKpRulingPlanetsErrors, PostVedicAstrologyKpRulingPlanetsIntervalData, PostVedicAstrologyKpRulingPlanetsIntervalErrors, PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpSublordChangesData, PostVedicAstrologyKpSublordChangesErrors, PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyNavamsaData, PostVedicAstrologyNavamsaErrors, PostVedicAstrologyNavamsaResponses, PostVedicAstrologyPanchangBasicData, PostVedicAstrologyPanchangBasicErrors, PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangChoghadiyaData, PostVedicAstrologyPanchangChoghadiyaErrors, PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangDetailedData, PostVedicAstrologyPanchangDetailedErrors, PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangHoraData, PostVedicAstrologyPanchangHoraErrors, PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyParallelsData, PostVedicAstrologyParallelsErrors, PostVedicAstrologyParallelsMonthlyData, PostVedicAstrologyParallelsMonthlyErrors, PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsResponses, PostVedicAstrologyPlanetaryPositionsData, PostVedicAstrologyPlanetaryPositionsErrors, PostVedicAstrologyPlanetaryPositionsMonthlyData, PostVedicAstrologyPlanetaryPositionsMonthlyErrors, PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyShadbalaData, PostVedicAstrologyShadbalaErrors, PostVedicAstrologyShadbalaResponses, PostVedicAstrologyTransitData, PostVedicAstrologyTransitErrors, PostVedicAstrologyTransitMonthlyData, PostVedicAstrologyTransitMonthlyErrors, PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitResponses, PostVedicAstrologyUpagrahaData, PostVedicAstrologyUpagrahaErrors, PostVedicAstrologyUpagrahaResponses, PostVedicAstrologyYogaDetectData, PostVedicAstrologyYogaDetectErrors, PostVedicAstrologyYogaDetectResponses } from './types.gen';
|
|
5
|
+
import type { GetAngelNumbersLookupData, GetAngelNumbersLookupErrors, GetAngelNumbersLookupResponses, GetAngelNumbersNumbersByNumberData, GetAngelNumbersNumbersByNumberErrors, GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersData, GetAngelNumbersNumbersErrors, GetAngelNumbersNumbersResponses, GetAstrologyHoroscopeBySignDailyData, GetAstrologyHoroscopeBySignDailyErrors, GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignMonthlyData, GetAstrologyHoroscopeBySignMonthlyErrors, GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignWeeklyData, GetAstrologyHoroscopeBySignWeeklyErrors, GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyMoonPhaseCalendarByYearByMonthData, GetAstrologyMoonPhaseCalendarByYearByMonthErrors, GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCurrentData, GetAstrologyMoonPhaseCurrentErrors, GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseUpcomingData, GetAstrologyMoonPhaseUpcomingErrors, GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyPlanetMeaningsByIdData, GetAstrologyPlanetMeaningsByIdErrors, GetAstrologyPlanetMeaningsByIdResponses, GetAstrologyPlanetMeaningsData, GetAstrologyPlanetMeaningsErrors, GetAstrologyPlanetMeaningsResponses, GetAstrologySignsByIdData, GetAstrologySignsByIdErrors, GetAstrologySignsByIdResponses, GetAstrologySignsData, GetAstrologySignsErrors, GetAstrologySignsResponses, GetCrystalsBirthstoneByMonthData, GetCrystalsBirthstoneByMonthErrors, GetCrystalsBirthstoneByMonthResponses, GetCrystalsByIdData, GetCrystalsByIdErrors, GetCrystalsByIdResponses, GetCrystalsChakraByChakraData, GetCrystalsChakraByChakraErrors, GetCrystalsChakraByChakraResponses, GetCrystalsColorsData, GetCrystalsColorsErrors, GetCrystalsColorsResponses, GetCrystalsData, GetCrystalsElementByElementData, GetCrystalsElementByElementErrors, GetCrystalsElementByElementResponses, GetCrystalsErrors, GetCrystalsPairingsByIdData, GetCrystalsPairingsByIdErrors, GetCrystalsPairingsByIdResponses, GetCrystalsPlanetsData, GetCrystalsPlanetsErrors, GetCrystalsPlanetsResponses, GetCrystalsRandomData, GetCrystalsRandomErrors, GetCrystalsRandomResponses, GetCrystalsResponses, GetCrystalsSearchData, GetCrystalsSearchErrors, GetCrystalsSearchResponses, GetCrystalsZodiacBySignData, GetCrystalsZodiacBySignErrors, GetCrystalsZodiacBySignResponses, GetDreamsSymbolsByIdData, GetDreamsSymbolsByIdErrors, GetDreamsSymbolsByIdResponses, GetDreamsSymbolsData, GetDreamsSymbolsErrors, GetDreamsSymbolsLettersData, GetDreamsSymbolsLettersErrors, GetDreamsSymbolsLettersResponses, GetDreamsSymbolsRandomData, GetDreamsSymbolsRandomErrors, GetDreamsSymbolsRandomResponses, GetDreamsSymbolsResponses, GetHumanDesignCentersByIdData, GetHumanDesignCentersByIdErrors, GetHumanDesignCentersByIdResponses, GetHumanDesignGatesByNumberData, GetHumanDesignGatesByNumberErrors, GetHumanDesignGatesByNumberResponses, GetIchingCastData, GetIchingCastErrors, GetIchingCastResponses, GetIchingHexagramsByNumberData, GetIchingHexagramsByNumberErrors, GetIchingHexagramsByNumberResponses, GetIchingHexagramsData, GetIchingHexagramsErrors, GetIchingHexagramsLookupData, GetIchingHexagramsLookupErrors, GetIchingHexagramsLookupResponses, GetIchingHexagramsRandomData, GetIchingHexagramsRandomErrors, GetIchingHexagramsRandomResponses, GetIchingHexagramsResponses, GetIchingTrigramsByIdData, GetIchingTrigramsByIdErrors, GetIchingTrigramsByIdResponses, GetIchingTrigramsData, GetIchingTrigramsErrors, GetIchingTrigramsResponses, GetLanguagesData, GetLanguagesErrors, GetLanguagesResponses, GetLocationCountriesByIso2Data, GetLocationCountriesByIso2Errors, GetLocationCountriesByIso2Responses, GetLocationCountriesData, GetLocationCountriesErrors, GetLocationCountriesResponses, GetLocationSearchData, GetLocationSearchErrors, GetLocationSearchResponses, GetNumerologyCompoundNumberByNumberData, GetNumerologyCompoundNumberByNumberErrors, GetNumerologyCompoundNumberByNumberResponses, GetNumerologyMeaningsByNumberData, GetNumerologyMeaningsByNumberErrors, GetNumerologyMeaningsByNumberResponses, GetTarotCardsByIdData, GetTarotCardsByIdErrors, GetTarotCardsByIdResponses, GetTarotCardsData, GetTarotCardsErrors, GetTarotCardsResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetVedicAstrologyAvasthasByIdData, GetVedicAstrologyAvasthasByIdErrors, GetVedicAstrologyAvasthasByIdResponses, GetVedicAstrologyAvasthasData, GetVedicAstrologyAvasthasErrors, GetVedicAstrologyAvasthasResponses, GetVedicAstrologyKpAyanamsaData, GetVedicAstrologyKpAyanamsaErrors, GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyNakshatrasByIdData, GetVedicAstrologyNakshatrasByIdErrors, GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasData, GetVedicAstrologyNakshatrasErrors, GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyRashisByIdData, GetVedicAstrologyRashisByIdErrors, GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisData, GetVedicAstrologyRashisErrors, GetVedicAstrologyRashisResponses, GetVedicAstrologyYogaByIdData, GetVedicAstrologyYogaByIdErrors, GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaData, GetVedicAstrologyYogaErrors, GetVedicAstrologyYogaResponses, PostAngelNumbersDailyData, PostAngelNumbersDailyErrors, PostAngelNumbersDailyResponses, PostAstrologyArabicLotsData, PostAstrologyArabicLotsErrors, PostAstrologyArabicLotsResponses, PostAstrologyAspectPatternsData, PostAstrologyAspectPatternsErrors, PostAstrologyAspectPatternsResponses, PostAstrologyAspectsData, PostAstrologyAspectsErrors, PostAstrologyAspectsResponses, PostAstrologyAsteroidsData, PostAstrologyAsteroidsErrors, PostAstrologyAsteroidsResponses, PostAstrologyAstrocartographyData, PostAstrologyAstrocartographyErrors, PostAstrologyAstrocartographyResponses, PostAstrologyCompatibilityScoreData, PostAstrologyCompatibilityScoreErrors, PostAstrologyCompatibilityScoreResponses, PostAstrologyCompositeChartData, PostAstrologyCompositeChartErrors, PostAstrologyCompositeChartResponses, PostAstrologyFixedStarsData, PostAstrologyFixedStarsErrors, PostAstrologyFixedStarsResponses, PostAstrologyHousesData, PostAstrologyHousesErrors, PostAstrologyHousesResponses, PostAstrologyLilithData, PostAstrologyLilithErrors, PostAstrologyLilithResponses, PostAstrologyLocalSpaceData, PostAstrologyLocalSpaceErrors, PostAstrologyLocalSpaceResponses, PostAstrologyLunarReturnData, PostAstrologyLunarReturnErrors, PostAstrologyLunarReturnResponses, PostAstrologyNatalChartData, PostAstrologyNatalChartErrors, PostAstrologyNatalChartResponses, PostAstrologyPlanetaryReturnsData, PostAstrologyPlanetaryReturnsErrors, PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetsData, PostAstrologyPlanetsErrors, PostAstrologyPlanetsResponses, PostAstrologyProfectionsData, PostAstrologyProfectionsErrors, PostAstrologyProfectionsResponses, PostAstrologyProgressionsData, PostAstrologyProgressionsErrors, PostAstrologyProgressionsResponses, PostAstrologyRelocationChartData, PostAstrologyRelocationChartErrors, PostAstrologyRelocationChartResponses, PostAstrologySolarArcData, PostAstrologySolarArcErrors, PostAstrologySolarArcResponses, PostAstrologySolarReturnData, PostAstrologySolarReturnErrors, PostAstrologySolarReturnResponses, PostAstrologySynastryData, PostAstrologySynastryErrors, PostAstrologySynastryResponses, PostAstrologyTransitAspectsData, PostAstrologyTransitAspectsErrors, PostAstrologyTransitAspectsResponses, PostAstrologyTransitsData, PostAstrologyTransitsErrors, PostAstrologyTransitsResponses, PostBiorhythmCompatibilityData, PostBiorhythmCompatibilityErrors, PostBiorhythmCompatibilityResponses, PostBiorhythmCriticalDaysData, PostBiorhythmCriticalDaysErrors, PostBiorhythmCriticalDaysResponses, PostBiorhythmDailyData, PostBiorhythmDailyErrors, PostBiorhythmDailyResponses, PostBiorhythmForecastData, PostBiorhythmForecastErrors, PostBiorhythmForecastResponses, PostBiorhythmPhasesData, PostBiorhythmPhasesErrors, PostBiorhythmPhasesResponses, PostBiorhythmReadingData, PostBiorhythmReadingErrors, PostBiorhythmReadingResponses, PostCrystalsDailyData, PostCrystalsDailyErrors, PostCrystalsDailyResponses, PostDreamsDailyData, PostDreamsDailyErrors, PostDreamsDailyResponses, PostForecastDigestData, PostForecastDigestErrors, PostForecastDigestResponses, PostForecastSignificantDatesData, PostForecastSignificantDatesErrors, PostForecastSignificantDatesResponses, PostForecastSolarReturnData, PostForecastSolarReturnErrors, PostForecastSolarReturnResponses, PostForecastTimelineData, PostForecastTimelineErrors, PostForecastTimelineResponses, PostForecastTransitsData, PostForecastTransitsErrors, PostForecastTransitsResponses, PostHumanDesignBodygraphData, PostHumanDesignBodygraphErrors, PostHumanDesignBodygraphResponses, PostHumanDesignCentersData, PostHumanDesignCentersErrors, PostHumanDesignCentersResponses, PostHumanDesignChannelsData, PostHumanDesignChannelsErrors, PostHumanDesignChannelsResponses, PostHumanDesignConnectionData, PostHumanDesignConnectionErrors, PostHumanDesignConnectionResponses, PostHumanDesignGatesData, PostHumanDesignGatesErrors, PostHumanDesignGatesResponses, PostHumanDesignPentaData, PostHumanDesignPentaErrors, PostHumanDesignPentaResponses, PostHumanDesignProfileData, PostHumanDesignProfileErrors, PostHumanDesignProfileResponses, PostHumanDesignTransitData, PostHumanDesignTransitErrors, PostHumanDesignTransitResponses, PostHumanDesignTypeData, PostHumanDesignTypeErrors, PostHumanDesignTypeResponses, PostHumanDesignVariablesData, PostHumanDesignVariablesErrors, PostHumanDesignVariablesResponses, PostIchingDailyCastData, PostIchingDailyCastErrors, PostIchingDailyCastResponses, PostIchingDailyData, PostIchingDailyErrors, PostIchingDailyResponses, PostNumerologyBirthDayData, PostNumerologyBirthDayErrors, PostNumerologyBirthDayResponses, PostNumerologyBridgeData, PostNumerologyBridgeErrors, PostNumerologyBridgeResponses, PostNumerologyBusinessNameData, PostNumerologyBusinessNameErrors, PostNumerologyBusinessNameResponses, PostNumerologyChaldeanData, PostNumerologyChaldeanErrors, PostNumerologyChaldeanResponses, PostNumerologyChartData, PostNumerologyChartErrors, PostNumerologyChartResponses, PostNumerologyCompatibilityData, PostNumerologyCompatibilityErrors, PostNumerologyCompatibilityResponses, PostNumerologyDailyData, PostNumerologyDailyErrors, PostNumerologyDailyResponses, PostNumerologyDualData, PostNumerologyDualErrors, PostNumerologyDualResponses, PostNumerologyExpressionData, PostNumerologyExpressionErrors, PostNumerologyExpressionResponses, PostNumerologyKarmicDebtData, PostNumerologyKarmicDebtErrors, PostNumerologyKarmicDebtResponses, PostNumerologyKarmicLessonsData, PostNumerologyKarmicLessonsErrors, PostNumerologyKarmicLessonsResponses, PostNumerologyLifePathData, PostNumerologyLifePathErrors, PostNumerologyLifePathResponses, PostNumerologyMaturityData, PostNumerologyMaturityErrors, PostNumerologyMaturityResponses, PostNumerologyPersonalDayData, PostNumerologyPersonalDayErrors, PostNumerologyPersonalDayResponses, PostNumerologyPersonalityData, PostNumerologyPersonalityErrors, PostNumerologyPersonalityResponses, PostNumerologyPersonalMonthData, PostNumerologyPersonalMonthErrors, PostNumerologyPersonalMonthResponses, PostNumerologyPersonalYearData, PostNumerologyPersonalYearErrors, PostNumerologyPersonalYearResponses, PostNumerologySoulUrgeData, PostNumerologySoulUrgeErrors, PostNumerologySoulUrgeResponses, PostTarotDailyData, PostTarotDailyErrors, PostTarotDailyResponses, PostTarotDrawData, PostTarotDrawErrors, PostTarotDrawResponses, PostTarotSpreadsCareerData, PostTarotSpreadsCareerErrors, PostTarotSpreadsCareerResponses, PostTarotSpreadsCelticCrossData, PostTarotSpreadsCelticCrossErrors, PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCustomData, PostTarotSpreadsCustomErrors, PostTarotSpreadsCustomResponses, PostTarotSpreadsLoveData, PostTarotSpreadsLoveErrors, PostTarotSpreadsLoveResponses, PostTarotSpreadsThreeCardData, PostTarotSpreadsThreeCardErrors, PostTarotSpreadsThreeCardResponses, PostTarotYesNoData, PostTarotYesNoErrors, PostTarotYesNoResponses, PostVedicAstrologyArudhaData, PostVedicAstrologyArudhaErrors, PostVedicAstrologyArudhaResponses, PostVedicAstrologyAshtakavargaData, PostVedicAstrologyAshtakavargaErrors, PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAspectsData, PostVedicAstrologyAspectsErrors, PostVedicAstrologyAspectsLunarData, PostVedicAstrologyAspectsLunarErrors, PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsMonthlyData, PostVedicAstrologyAspectsMonthlyErrors, PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsResponses, PostVedicAstrologyBhavaBalaData, PostVedicAstrologyBhavaBalaErrors, PostVedicAstrologyBhavaBalaResponses, PostVedicAstrologyBhavChalitData, PostVedicAstrologyBhavChalitErrors, PostVedicAstrologyBhavChalitResponses, PostVedicAstrologyBirthChartData, PostVedicAstrologyBirthChartErrors, PostVedicAstrologyBirthChartResponses, PostVedicAstrologyCharaKarakasData, PostVedicAstrologyCharaKarakasErrors, PostVedicAstrologyCharaKarakasResponses, PostVedicAstrologyCompatibilityData, PostVedicAstrologyCompatibilityErrors, PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyDashaCurrentData, PostVedicAstrologyDashaCurrentErrors, PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaMajorData, PostVedicAstrologyDashaMajorErrors, PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaResponses, PostVedicAstrologyDashaSubByMahadashaData, PostVedicAstrologyDashaSubByMahadashaErrors, PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDivisionalChartData, PostVedicAstrologyDivisionalChartErrors, PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDoshaKalsarpaData, PostVedicAstrologyDoshaKalsarpaErrors, PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaManglikData, PostVedicAstrologyDoshaManglikErrors, PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaSadhesatiData, PostVedicAstrologyDoshaSadhesatiErrors, PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyEclipticCrossingsData, PostVedicAstrologyEclipticCrossingsErrors, PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyHeliacalData, PostVedicAstrologyHeliacalErrors, PostVedicAstrologyHeliacalResponses, PostVedicAstrologyKpChartData, PostVedicAstrologyKpChartErrors, PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpCuspsData, PostVedicAstrologyKpCuspsErrors, PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpHoraryData, PostVedicAstrologyKpHoraryErrors, PostVedicAstrologyKpHoraryResponses, PostVedicAstrologyKpPlanetsData, PostVedicAstrologyKpPlanetsErrors, PostVedicAstrologyKpPlanetsIntervalData, PostVedicAstrologyKpPlanetsIntervalErrors, PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpRasiChangesData, PostVedicAstrologyKpRasiChangesErrors, PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRulingPlanetsData, PostVedicAstrologyKpRulingPlanetsErrors, PostVedicAstrologyKpRulingPlanetsIntervalData, PostVedicAstrologyKpRulingPlanetsIntervalErrors, PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpSublordChangesData, PostVedicAstrologyKpSublordChangesErrors, PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyNavamsaData, PostVedicAstrologyNavamsaErrors, PostVedicAstrologyNavamsaResponses, PostVedicAstrologyPanchangBasicData, PostVedicAstrologyPanchangBasicErrors, PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangChoghadiyaData, PostVedicAstrologyPanchangChoghadiyaErrors, PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangDetailedData, PostVedicAstrologyPanchangDetailedErrors, PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangHoraData, PostVedicAstrologyPanchangHoraErrors, PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyParallelsData, PostVedicAstrologyParallelsErrors, PostVedicAstrologyParallelsMonthlyData, PostVedicAstrologyParallelsMonthlyErrors, PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsResponses, PostVedicAstrologyPlanetaryPositionsData, PostVedicAstrologyPlanetaryPositionsErrors, PostVedicAstrologyPlanetaryPositionsMonthlyData, PostVedicAstrologyPlanetaryPositionsMonthlyErrors, PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyShadbalaData, PostVedicAstrologyShadbalaErrors, PostVedicAstrologyShadbalaResponses, PostVedicAstrologyTransitData, PostVedicAstrologyTransitErrors, PostVedicAstrologyTransitMonthlyData, PostVedicAstrologyTransitMonthlyErrors, PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitResponses, PostVedicAstrologyUpagrahaData, PostVedicAstrologyUpagrahaErrors, PostVedicAstrologyUpagrahaResponses, PostVedicAstrologyYogaDetectData, PostVedicAstrologyYogaDetectErrors, PostVedicAstrologyYogaDetectResponses } from './types.gen';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
8
8
|
/**
|
|
@@ -15,7 +15,7 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
15
15
|
* You can pass arbitrary values through the `meta` object. This can be
|
|
16
16
|
* used to access values that aren't defined as part of the SDK function.
|
|
17
17
|
*/
|
|
18
|
-
meta?: Record<string, unknown
|
|
18
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
19
19
|
};
|
|
20
20
|
|
|
21
21
|
class HeyApiClient {
|
|
@@ -52,7 +52,7 @@ export class Astrology extends HeyApiClient {
|
|
|
52
52
|
*
|
|
53
53
|
* 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/{id} for complete zodiac sign profiles with personality traits, compatibility, and detailed characteristics.
|
|
54
54
|
*/
|
|
55
|
-
public listZodiacSigns<ThrowOnError extends boolean = false>(options?: Options<GetAstrologySignsData, ThrowOnError>) {
|
|
55
|
+
public listZodiacSigns<ThrowOnError extends boolean = false>(options?: Options<GetAstrologySignsData, ThrowOnError>): RequestResult<GetAstrologySignsResponses, GetAstrologySignsErrors, ThrowOnError> {
|
|
56
56
|
return (options?.client ?? this.client).get<GetAstrologySignsResponses, GetAstrologySignsErrors, ThrowOnError>({
|
|
57
57
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
58
58
|
url: '/astrology/signs',
|
|
@@ -65,7 +65,7 @@ export class Astrology extends HeyApiClient {
|
|
|
65
65
|
*
|
|
66
66
|
* 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.
|
|
67
67
|
*/
|
|
68
|
-
public getZodiacSign<ThrowOnError extends boolean = false>(options: Options<GetAstrologySignsByIdData, ThrowOnError>) {
|
|
68
|
+
public getZodiacSign<ThrowOnError extends boolean = false>(options: Options<GetAstrologySignsByIdData, ThrowOnError>): RequestResult<GetAstrologySignsByIdResponses, GetAstrologySignsByIdErrors, ThrowOnError> {
|
|
69
69
|
return (options.client ?? this.client).get<GetAstrologySignsByIdResponses, GetAstrologySignsByIdErrors, ThrowOnError>({
|
|
70
70
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
71
71
|
url: '/astrology/signs/{id}',
|
|
@@ -78,7 +78,7 @@ export class Astrology extends HeyApiClient {
|
|
|
78
78
|
*
|
|
79
79
|
* Returns all 14 astrological bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) 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/{id} for complete profiles with detailed interpretations, keywords, temperature, and dignities (rulership/detriment/exaltation/fall).
|
|
80
80
|
*/
|
|
81
|
-
public listPlanetMeanings<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyPlanetMeaningsData, ThrowOnError>) {
|
|
81
|
+
public listPlanetMeanings<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyPlanetMeaningsData, ThrowOnError>): RequestResult<GetAstrologyPlanetMeaningsResponses, GetAstrologyPlanetMeaningsErrors, ThrowOnError> {
|
|
82
82
|
return (options?.client ?? this.client).get<GetAstrologyPlanetMeaningsResponses, GetAstrologyPlanetMeaningsErrors, ThrowOnError>({
|
|
83
83
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
84
84
|
url: '/astrology/planet-meanings',
|
|
@@ -91,7 +91,7 @@ export class Astrology extends HeyApiClient {
|
|
|
91
91
|
*
|
|
92
92
|
* 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/exaltation/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.
|
|
93
93
|
*/
|
|
94
|
-
public getPlanetMeaning<ThrowOnError extends boolean = false>(options: Options<GetAstrologyPlanetMeaningsByIdData, ThrowOnError>) {
|
|
94
|
+
public getPlanetMeaning<ThrowOnError extends boolean = false>(options: Options<GetAstrologyPlanetMeaningsByIdData, ThrowOnError>): RequestResult<GetAstrologyPlanetMeaningsByIdResponses, GetAstrologyPlanetMeaningsByIdErrors, ThrowOnError> {
|
|
95
95
|
return (options.client ?? this.client).get<GetAstrologyPlanetMeaningsByIdResponses, GetAstrologyPlanetMeaningsByIdErrors, ThrowOnError>({
|
|
96
96
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
97
97
|
url: '/astrology/planet-meanings/{id}',
|
|
@@ -104,7 +104,7 @@ export class Astrology extends HeyApiClient {
|
|
|
104
104
|
*
|
|
105
105
|
* Calculate complete Western astrology natal chart (birth chart) with tropical zodiac. Returns all 14 celestial bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith), 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. Verified against NASA JPL Horizons.
|
|
106
106
|
*/
|
|
107
|
-
public generateNatalChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyNatalChartData, ThrowOnError>) {
|
|
107
|
+
public generateNatalChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyNatalChartData, ThrowOnError>): RequestResult<PostAstrologyNatalChartResponses, PostAstrologyNatalChartErrors, ThrowOnError> {
|
|
108
108
|
return (options?.client ?? this.client).post<PostAstrologyNatalChartResponses, PostAstrologyNatalChartErrors, ThrowOnError>({
|
|
109
109
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
110
110
|
url: '/astrology/natal-chart',
|
|
@@ -121,7 +121,7 @@ export class Astrology extends HeyApiClient {
|
|
|
121
121
|
*
|
|
122
122
|
* Calculate accurate tropical zodiac positions for all 14 celestial bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) 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. Verified against NASA JPL Horizons.
|
|
123
123
|
*/
|
|
124
|
-
public getPlanetaryPositions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetsData, ThrowOnError>) {
|
|
124
|
+
public getPlanetaryPositions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetsData, ThrowOnError>): RequestResult<PostAstrologyPlanetsResponses, PostAstrologyPlanetsErrors, ThrowOnError> {
|
|
125
125
|
return (options?.client ?? this.client).post<PostAstrologyPlanetsResponses, PostAstrologyPlanetsErrors, ThrowOnError>({
|
|
126
126
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
127
127
|
url: '/astrology/planets',
|
|
@@ -138,7 +138,7 @@ export class Astrology extends HeyApiClient {
|
|
|
138
138
|
*
|
|
139
139
|
* 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.
|
|
140
140
|
*/
|
|
141
|
-
public getCurrentMoonPhase<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseCurrentData, ThrowOnError>) {
|
|
141
|
+
public getCurrentMoonPhase<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseCurrentData, ThrowOnError>): RequestResult<GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseCurrentErrors, ThrowOnError> {
|
|
142
142
|
return (options?.client ?? this.client).get<GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseCurrentErrors, ThrowOnError>({
|
|
143
143
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
144
144
|
url: '/astrology/moon-phase/current',
|
|
@@ -151,7 +151,7 @@ export class Astrology extends HeyApiClient {
|
|
|
151
151
|
*
|
|
152
152
|
* 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.
|
|
153
153
|
*/
|
|
154
|
-
public getUpcomingMoonPhases<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseUpcomingData, ThrowOnError>) {
|
|
154
|
+
public getUpcomingMoonPhases<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseUpcomingData, ThrowOnError>): RequestResult<GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyMoonPhaseUpcomingErrors, ThrowOnError> {
|
|
155
155
|
return (options?.client ?? this.client).get<GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyMoonPhaseUpcomingErrors, ThrowOnError>({
|
|
156
156
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
157
157
|
url: '/astrology/moon-phase/upcoming',
|
|
@@ -164,7 +164,7 @@ export class Astrology extends HeyApiClient {
|
|
|
164
164
|
*
|
|
165
165
|
* 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.
|
|
166
166
|
*/
|
|
167
|
-
public getMoonCalendar<ThrowOnError extends boolean = false>(options: Options<GetAstrologyMoonPhaseCalendarByYearByMonthData, ThrowOnError>) {
|
|
167
|
+
public getMoonCalendar<ThrowOnError extends boolean = false>(options: Options<GetAstrologyMoonPhaseCalendarByYearByMonthData, ThrowOnError>): RequestResult<GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCalendarByYearByMonthErrors, ThrowOnError> {
|
|
168
168
|
return (options.client ?? this.client).get<GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCalendarByYearByMonthErrors, ThrowOnError>({
|
|
169
169
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
170
170
|
url: '/astrology/moon-phase/calendar/{year}/{month}',
|
|
@@ -177,7 +177,7 @@ export class Astrology extends HeyApiClient {
|
|
|
177
177
|
*
|
|
178
178
|
* 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.
|
|
179
179
|
*/
|
|
180
|
-
public calculateSynastry<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySynastryData, ThrowOnError>) {
|
|
180
|
+
public calculateSynastry<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySynastryData, ThrowOnError>): RequestResult<PostAstrologySynastryResponses, PostAstrologySynastryErrors, ThrowOnError> {
|
|
181
181
|
return (options?.client ?? this.client).post<PostAstrologySynastryResponses, PostAstrologySynastryErrors, ThrowOnError>({
|
|
182
182
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
183
183
|
url: '/astrology/synastry',
|
|
@@ -194,7 +194,7 @@ export class Astrology extends HeyApiClient {
|
|
|
194
194
|
*
|
|
195
195
|
* 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.
|
|
196
196
|
*/
|
|
197
|
-
public calculateHouses<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyHousesData, ThrowOnError>) {
|
|
197
|
+
public calculateHouses<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyHousesData, ThrowOnError>): RequestResult<PostAstrologyHousesResponses, PostAstrologyHousesErrors, ThrowOnError> {
|
|
198
198
|
return (options?.client ?? this.client).post<PostAstrologyHousesResponses, PostAstrologyHousesErrors, ThrowOnError>({
|
|
199
199
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
200
200
|
url: '/astrology/houses',
|
|
@@ -211,7 +211,7 @@ export class Astrology extends HeyApiClient {
|
|
|
211
211
|
*
|
|
212
212
|
* 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.
|
|
213
213
|
*/
|
|
214
|
-
public calculateAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectsData, ThrowOnError>) {
|
|
214
|
+
public calculateAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectsData, ThrowOnError>): RequestResult<PostAstrologyAspectsResponses, PostAstrologyAspectsErrors, ThrowOnError> {
|
|
215
215
|
return (options?.client ?? this.client).post<PostAstrologyAspectsResponses, PostAstrologyAspectsErrors, ThrowOnError>({
|
|
216
216
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
217
217
|
url: '/astrology/aspects',
|
|
@@ -228,7 +228,7 @@ export class Astrology extends HeyApiClient {
|
|
|
228
228
|
*
|
|
229
229
|
* Identify classical Western astrology multi-planet configurations in a birth chart. Returns Grand Trines (with element), Kites (with apex), T-Squares (with apex and modality), Grand Crosses (with modality), Yods (Finger of Fate, with apex), Mystic Rectangles, and Stelliums. Each pattern carries a tightness score (0-100), dissociate flag for out-of-sign configurations, and a one-line interpretation suitable for chart reports. Disambiguation is built in: a Grand Cross suppresses its contained T-Squares, a Kite suppresses its underlying Grand Trine. Useful for personalized natal report engines, astrology chatbots, AI agents that interpret chart geometry, and editorial chart-pattern callouts.
|
|
230
230
|
*/
|
|
231
|
-
public detectAspectPatterns<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectPatternsData, ThrowOnError>) {
|
|
231
|
+
public detectAspectPatterns<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectPatternsData, ThrowOnError>): RequestResult<PostAstrologyAspectPatternsResponses, PostAstrologyAspectPatternsErrors, ThrowOnError> {
|
|
232
232
|
return (options?.client ?? this.client).post<PostAstrologyAspectPatternsResponses, PostAstrologyAspectPatternsErrors, ThrowOnError>({
|
|
233
233
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
234
234
|
url: '/astrology/aspect-patterns',
|
|
@@ -245,7 +245,7 @@ export class Astrology extends HeyApiClient {
|
|
|
245
245
|
*
|
|
246
246
|
* Calculate current or future planetary transits (positions of all bodies now). Optionally compare transits to natal chart to find transit-to-natal aspects. Returns all 14 celestial bodies (the 10 classical planets, the lunar nodes, Chiron, and Black Moon Lilith) 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.
|
|
247
247
|
*/
|
|
248
|
-
public calculateTransits<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitsData, ThrowOnError>) {
|
|
248
|
+
public calculateTransits<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitsData, ThrowOnError>): RequestResult<PostAstrologyTransitsResponses, PostAstrologyTransitsErrors, ThrowOnError> {
|
|
249
249
|
return (options?.client ?? this.client).post<PostAstrologyTransitsResponses, PostAstrologyTransitsErrors, ThrowOnError>({
|
|
250
250
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
251
251
|
url: '/astrology/transits',
|
|
@@ -262,7 +262,7 @@ export class Astrology extends HeyApiClient {
|
|
|
262
262
|
*
|
|
263
263
|
* 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.
|
|
264
264
|
*/
|
|
265
|
-
public calculateTransitAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitAspectsData, ThrowOnError>) {
|
|
265
|
+
public calculateTransitAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitAspectsData, ThrowOnError>): RequestResult<PostAstrologyTransitAspectsResponses, PostAstrologyTransitAspectsErrors, ThrowOnError> {
|
|
266
266
|
return (options?.client ?? this.client).post<PostAstrologyTransitAspectsResponses, PostAstrologyTransitAspectsErrors, ThrowOnError>({
|
|
267
267
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
268
268
|
url: '/astrology/transit-aspects',
|
|
@@ -279,7 +279,7 @@ export class Astrology extends HeyApiClient {
|
|
|
279
279
|
*
|
|
280
280
|
* 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.
|
|
281
281
|
*/
|
|
282
|
-
public generateSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarReturnData, ThrowOnError>) {
|
|
282
|
+
public generateSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarReturnData, ThrowOnError>): RequestResult<PostAstrologySolarReturnResponses, PostAstrologySolarReturnErrors, ThrowOnError> {
|
|
283
283
|
return (options?.client ?? this.client).post<PostAstrologySolarReturnResponses, PostAstrologySolarReturnErrors, ThrowOnError>({
|
|
284
284
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
285
285
|
url: '/astrology/solar-return',
|
|
@@ -296,7 +296,7 @@ export class Astrology extends HeyApiClient {
|
|
|
296
296
|
*
|
|
297
297
|
* 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.
|
|
298
298
|
*/
|
|
299
|
-
public generateLunarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLunarReturnData, ThrowOnError>) {
|
|
299
|
+
public generateLunarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLunarReturnData, ThrowOnError>): RequestResult<PostAstrologyLunarReturnResponses, PostAstrologyLunarReturnErrors, ThrowOnError> {
|
|
300
300
|
return (options?.client ?? this.client).post<PostAstrologyLunarReturnResponses, PostAstrologyLunarReturnErrors, ThrowOnError>({
|
|
301
301
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
302
302
|
url: '/astrology/lunar-return',
|
|
@@ -313,7 +313,7 @@ export class Astrology extends HeyApiClient {
|
|
|
313
313
|
*
|
|
314
314
|
* 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.
|
|
315
315
|
*/
|
|
316
|
-
public generateCompositeChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompositeChartData, ThrowOnError>) {
|
|
316
|
+
public generateCompositeChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompositeChartData, ThrowOnError>): RequestResult<PostAstrologyCompositeChartResponses, PostAstrologyCompositeChartErrors, ThrowOnError> {
|
|
317
317
|
return (options?.client ?? this.client).post<PostAstrologyCompositeChartResponses, PostAstrologyCompositeChartErrors, ThrowOnError>({
|
|
318
318
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
319
319
|
url: '/astrology/composite-chart',
|
|
@@ -330,7 +330,7 @@ export class Astrology extends HeyApiClient {
|
|
|
330
330
|
*
|
|
331
331
|
* 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 Sun, Moon, Venus, and Mars sign compatibility narratives, element balance analysis, relationship archetype classification, and the most significant inter-chart aspects with relationship-specific interpretations.
|
|
332
332
|
*/
|
|
333
|
-
public calculateCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompatibilityScoreData, ThrowOnError>) {
|
|
333
|
+
public calculateCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompatibilityScoreData, ThrowOnError>): RequestResult<PostAstrologyCompatibilityScoreResponses, PostAstrologyCompatibilityScoreErrors, ThrowOnError> {
|
|
334
334
|
return (options?.client ?? this.client).post<PostAstrologyCompatibilityScoreResponses, PostAstrologyCompatibilityScoreErrors, ThrowOnError>({
|
|
335
335
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
336
336
|
url: '/astrology/compatibility-score',
|
|
@@ -347,7 +347,7 @@ export class Astrology extends HeyApiClient {
|
|
|
347
347
|
*
|
|
348
348
|
* Get the daily horoscope for any zodiac sign. Forecast is generated from real-time planetary transits using whole-sign house positions, so every sign receives unique content. Returns love, career, health, finance, overview with active transits, Moon sign, Moon phase, energy rating, lucky number, lucky color, and compatible signs. Content is fixed for a given date and rolls over at midnight, by default UTC. Pass date for editorial scheduling, or timezone to roll over on a local clock. Daily horoscope API, zodiac forecast, sun sign horoscope, astrology prediction.
|
|
349
349
|
*/
|
|
350
|
-
public getDailyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignDailyData, ThrowOnError>) {
|
|
350
|
+
public getDailyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignDailyData, ThrowOnError>): RequestResult<GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignDailyErrors, ThrowOnError> {
|
|
351
351
|
return (options.client ?? this.client).get<GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignDailyErrors, ThrowOnError>({
|
|
352
352
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
353
353
|
url: '/astrology/horoscope/{sign}/daily',
|
|
@@ -360,7 +360,7 @@ export class Astrology extends HeyApiClient {
|
|
|
360
360
|
*
|
|
361
361
|
* Get weekly horoscope for any zodiac sign. Forecast covers a full Monday to Sunday period based on planetary transits with house-based content unique to each sign, with love, career, health, finance guidance plus lucky days, lucky numbers, and compatible signs. Pass any date inside a week to retrieve that week, or timezone to roll over on a local clock. Weekly horoscope API, zodiac weekly forecast, astrology weekly prediction.
|
|
362
362
|
*/
|
|
363
|
-
public getWeeklyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignWeeklyData, ThrowOnError>) {
|
|
363
|
+
public getWeeklyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignWeeklyData, ThrowOnError>): RequestResult<GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyHoroscopeBySignWeeklyErrors, ThrowOnError> {
|
|
364
364
|
return (options.client ?? this.client).get<GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyHoroscopeBySignWeeklyErrors, ThrowOnError>({
|
|
365
365
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
366
366
|
url: '/astrology/horoscope/{sign}/weekly',
|
|
@@ -373,7 +373,7 @@ export class Astrology extends HeyApiClient {
|
|
|
373
373
|
*
|
|
374
374
|
* Get monthly horoscope for any zodiac sign with sign-specific week-by-week breakdown and real lunar phase key dates. Based on planetary transits with house activations unique to each sign, covering love, career, health, and finance for the entire month. Key dates include actual New Moon, Full Moon, and retrograde dates from ephemeris calculations. Pass any date inside a month to retrieve that month, or timezone to roll over on a local clock. Monthly horoscope API, zodiac monthly forecast, astrology monthly prediction.
|
|
375
375
|
*/
|
|
376
|
-
public getMonthlyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignMonthlyData, ThrowOnError>) {
|
|
376
|
+
public getMonthlyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignMonthlyData, ThrowOnError>): RequestResult<GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignMonthlyErrors, ThrowOnError> {
|
|
377
377
|
return (options.client ?? this.client).get<GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignMonthlyErrors, ThrowOnError>({
|
|
378
378
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
379
379
|
url: '/astrology/horoscope/{sign}/monthly',
|
|
@@ -386,7 +386,7 @@ export class Astrology extends HeyApiClient {
|
|
|
386
386
|
*
|
|
387
387
|
* 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.
|
|
388
388
|
*/
|
|
389
|
-
public generatePlanetaryReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetaryReturnsData, ThrowOnError>) {
|
|
389
|
+
public generatePlanetaryReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetaryReturnsData, ThrowOnError>): RequestResult<PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetaryReturnsErrors, ThrowOnError> {
|
|
390
390
|
return (options?.client ?? this.client).post<PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetaryReturnsErrors, ThrowOnError>({
|
|
391
391
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
392
392
|
url: '/astrology/planetary-returns',
|
|
@@ -403,7 +403,7 @@ export class Astrology extends HeyApiClient {
|
|
|
403
403
|
*
|
|
404
404
|
* Generate an astrocartography map of Midheaven, Imum Coeli, Ascendant, and Descendant planetary lines for any birth moment. Each line marks where a planet turns angular across the world, the core of relocation astrology and astro mapping. Returns right ascension, declination, the two meridian line longitudes, and sampled rising and setting curves ready to plot, with a short interpretation per line.
|
|
405
405
|
*/
|
|
406
|
-
public generateAstrocartography<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAstrocartographyData, ThrowOnError>) {
|
|
406
|
+
public generateAstrocartography<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAstrocartographyData, ThrowOnError>): RequestResult<PostAstrologyAstrocartographyResponses, PostAstrologyAstrocartographyErrors, ThrowOnError> {
|
|
407
407
|
return (options?.client ?? this.client).post<PostAstrologyAstrocartographyResponses, PostAstrologyAstrocartographyErrors, ThrowOnError>({
|
|
408
408
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
409
409
|
url: '/astrology/astrocartography',
|
|
@@ -420,7 +420,7 @@ export class Astrology extends HeyApiClient {
|
|
|
420
420
|
*
|
|
421
421
|
* Calculate a relocation chart (relocated birth chart) for a new place on Earth. The birth moment stays the same, so every planet keeps its natal sign and degree, while the Ascendant, Midheaven, Vertex, and all twelve house cusps are recomputed for the new latitude and longitude. Returns the relocated houses and angles, the planets that change house, the angular planets activated at the new place, and the distance and compass direction from the birthplace. Built for relocation astrology readings, astrocartography style move planning, and travel charts. Verified against NASA JPL Horizons.
|
|
422
422
|
*/
|
|
423
|
-
public generateRelocationChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyRelocationChartData, ThrowOnError>) {
|
|
423
|
+
public generateRelocationChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyRelocationChartData, ThrowOnError>): RequestResult<PostAstrologyRelocationChartResponses, PostAstrologyRelocationChartErrors, ThrowOnError> {
|
|
424
424
|
return (options?.client ?? this.client).post<PostAstrologyRelocationChartResponses, PostAstrologyRelocationChartErrors, ThrowOnError>({
|
|
425
425
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
426
426
|
url: '/astrology/relocation-chart',
|
|
@@ -437,7 +437,7 @@ export class Astrology extends HeyApiClient {
|
|
|
437
437
|
*
|
|
438
438
|
* Generate a local space astrology map that projects the natal planets onto the local horizon as compass directions and great-circle lines radiating from the birthplace. Returns each body azimuth (degrees clockwise from true north), altitude, 16-point compass direction, whether it sits above the horizon, and the latitude and longitude waypoints of its directional line. Ideal for relocation planning, directional astrology, and travel-direction maps.
|
|
439
439
|
*/
|
|
440
|
-
public generateLocalSpace<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLocalSpaceData, ThrowOnError>) {
|
|
440
|
+
public generateLocalSpace<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLocalSpaceData, ThrowOnError>): RequestResult<PostAstrologyLocalSpaceResponses, PostAstrologyLocalSpaceErrors, ThrowOnError> {
|
|
441
441
|
return (options?.client ?? this.client).post<PostAstrologyLocalSpaceResponses, PostAstrologyLocalSpaceErrors, ThrowOnError>({
|
|
442
442
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
443
443
|
url: '/astrology/local-space',
|
|
@@ -454,7 +454,7 @@ export class Astrology extends HeyApiClient {
|
|
|
454
454
|
*
|
|
455
455
|
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment, including the four Royal stars and the fifteen Behenian stars, then detect conjunctions to the natal planets, Ascendant, and Midheaven. Each star returns its precessed ecliptic longitude, zodiac sign, visual magnitude, and traditional planetary nature, with a plain language interpretation for every conjunction inside the chosen orb. A focused tool for natal reports that weigh Regulus, Spica, Aldebaran, Antares, and Algol against the chart.
|
|
456
456
|
*/
|
|
457
|
-
public generateFixedStars<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyFixedStarsData, ThrowOnError>) {
|
|
457
|
+
public generateFixedStars<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyFixedStarsData, ThrowOnError>): RequestResult<PostAstrologyFixedStarsResponses, PostAstrologyFixedStarsErrors, ThrowOnError> {
|
|
458
458
|
return (options?.client ?? this.client).post<PostAstrologyFixedStarsResponses, PostAstrologyFixedStarsErrors, ThrowOnError>({
|
|
459
459
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
460
460
|
url: '/astrology/fixed-stars',
|
|
@@ -471,7 +471,7 @@ export class Astrology extends HeyApiClient {
|
|
|
471
471
|
*
|
|
472
472
|
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment: Part of Fortune, Part of Spirit, Eros, Necessity, Courage, Victory, and Nemesis. Each lot is a sensitive point projected by arc from the Ascendant, with the day or night formula applied automatically from the chart sect. Returns the zodiac sign, degree, exact longitude, the arc used, and a plain language interpretation per lot, for Hellenistic and traditional astrology apps. Built on accurate tropical chart positions, no astronomy expertise needed.
|
|
473
473
|
*/
|
|
474
|
-
public calculateArabicLots<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyArabicLotsData, ThrowOnError>) {
|
|
474
|
+
public calculateArabicLots<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyArabicLotsData, ThrowOnError>): RequestResult<PostAstrologyArabicLotsResponses, PostAstrologyArabicLotsErrors, ThrowOnError> {
|
|
475
475
|
return (options?.client ?? this.client).post<PostAstrologyArabicLotsResponses, PostAstrologyArabicLotsErrors, ThrowOnError>({
|
|
476
476
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
477
477
|
url: '/astrology/arabic-lots',
|
|
@@ -488,7 +488,7 @@ export class Astrology extends HeyApiClient {
|
|
|
488
488
|
*
|
|
489
489
|
* Calculate the natal positions of the four classical asteroid goddesses, Ceres, Pallas, Juno, and Vesta, for any birth moment. Each asteroid returns its tropical zodiac sign, degree, house placement, daily speed, retrograde status, and a plain language interpretation of its meaning in the chart. Chiron is available through the natal chart endpoint, so this endpoint stays focused on the four asteroid goddesses for natal reports and relationship astrology.
|
|
490
490
|
*/
|
|
491
|
-
public generateAsteroids<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAsteroidsData, ThrowOnError>) {
|
|
491
|
+
public generateAsteroids<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAsteroidsData, ThrowOnError>): RequestResult<PostAstrologyAsteroidsResponses, PostAstrologyAsteroidsErrors, ThrowOnError> {
|
|
492
492
|
return (options?.client ?? this.client).post<PostAstrologyAsteroidsResponses, PostAstrologyAsteroidsErrors, ThrowOnError>({
|
|
493
493
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
494
494
|
url: '/astrology/asteroids',
|
|
@@ -505,7 +505,7 @@ export class Astrology extends HeyApiClient {
|
|
|
505
505
|
*
|
|
506
506
|
* Calculate Black Moon Lilith for any birth chart, both the mean lunar apogee, the steady and most widely used point, and the true or osculating apogee, the exact position that can shift sign and turn retrograde. Returns the zodiac sign, degree, house, ecliptic longitude and latitude, daily speed, retrograde flag, and a plain language interpretation for each variant. Built for natal astrology apps and AI agents exploring the wild, suppressed, and reclaimed self that Lilith represents.
|
|
507
507
|
*/
|
|
508
|
-
public generateLilith<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLilithData, ThrowOnError>) {
|
|
508
|
+
public generateLilith<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLilithData, ThrowOnError>): RequestResult<PostAstrologyLilithResponses, PostAstrologyLilithErrors, ThrowOnError> {
|
|
509
509
|
return (options?.client ?? this.client).post<PostAstrologyLilithResponses, PostAstrologyLilithErrors, ThrowOnError>({
|
|
510
510
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
511
511
|
url: '/astrology/lilith',
|
|
@@ -522,7 +522,7 @@ export class Astrology extends HeyApiClient {
|
|
|
522
522
|
*
|
|
523
523
|
* Generate the secondary progressed chart for any date using the day-for-a-year key, where each day of ephemeris motion after birth stands in for one year of life. Returns every progressed body with its sign, degree, whole-sign house, motion, and retrograde state, plus the progressed Ascendant and Midheaven via the Naibod arc. The progressed Sun and progressed Moon are the headline timing markers for inner growth and emotional chapters. Secondary progressions API, progressed chart calculator, progressed Sun and Moon, progressed Ascendant and Midheaven.
|
|
524
524
|
*/
|
|
525
|
-
public generateProgressions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProgressionsData, ThrowOnError>) {
|
|
525
|
+
public generateProgressions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProgressionsData, ThrowOnError>): RequestResult<PostAstrologyProgressionsResponses, PostAstrologyProgressionsErrors, ThrowOnError> {
|
|
526
526
|
return (options?.client ?? this.client).post<PostAstrologyProgressionsResponses, PostAstrologyProgressionsErrors, ThrowOnError>({
|
|
527
527
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
528
528
|
url: '/astrology/progressions',
|
|
@@ -539,7 +539,7 @@ export class Astrology extends HeyApiClient {
|
|
|
539
539
|
*
|
|
540
540
|
* Calculate a solar arc directed chart for any birth moment and target date. The solar arc is the secondary-progressed Sun longitude minus the natal Sun longitude, about one degree for each year of life, and every natal point including the Ascendant and Midheaven is advanced forward by that same arc. Returns the solar arc, each directed point with its natal and directed longitude, zodiac sign, degree, and a plain language interpretation, for predictive astrology apps timing major life events. Built on accurate tropical chart positions, no astronomy expertise needed.
|
|
541
541
|
*/
|
|
542
|
-
public generateSolarArc<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarArcData, ThrowOnError>) {
|
|
542
|
+
public generateSolarArc<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarArcData, ThrowOnError>): RequestResult<PostAstrologySolarArcResponses, PostAstrologySolarArcErrors, ThrowOnError> {
|
|
543
543
|
return (options?.client ?? this.client).post<PostAstrologySolarArcResponses, PostAstrologySolarArcErrors, ThrowOnError>({
|
|
544
544
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
545
545
|
url: '/astrology/solar-arc',
|
|
@@ -556,7 +556,7 @@ export class Astrology extends HeyApiClient {
|
|
|
556
556
|
*
|
|
557
557
|
* Calculate the annual profection and lord of the year for any birth chart and target date using the Hellenistic time lord technique. Each completed year of life advances the rising sign by one whole sign house, activating a new profected house, profected sign, and ruling planet that sets the tone of the year. Returns the age, profected house and sign, the lord of the year with its natal sign and house placement, and a plain language interpretation for traditional and Hellenistic astrology apps.
|
|
558
558
|
*/
|
|
559
|
-
public generateProfections<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProfectionsData, ThrowOnError>) {
|
|
559
|
+
public generateProfections<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProfectionsData, ThrowOnError>): RequestResult<PostAstrologyProfectionsResponses, PostAstrologyProfectionsErrors, ThrowOnError> {
|
|
560
560
|
return (options?.client ?? this.client).post<PostAstrologyProfectionsResponses, PostAstrologyProfectionsErrors, ThrowOnError>({
|
|
561
561
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
562
562
|
url: '/astrology/profections',
|
|
@@ -575,7 +575,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
575
575
|
*
|
|
576
576
|
* 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.
|
|
577
577
|
*/
|
|
578
|
-
public generateBirthChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBirthChartData, ThrowOnError>) {
|
|
578
|
+
public generateBirthChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBirthChartData, ThrowOnError>): RequestResult<PostVedicAstrologyBirthChartResponses, PostVedicAstrologyBirthChartErrors, ThrowOnError> {
|
|
579
579
|
return (options?.client ?? this.client).post<PostVedicAstrologyBirthChartResponses, PostVedicAstrologyBirthChartErrors, ThrowOnError>({
|
|
580
580
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
581
581
|
url: '/vedic-astrology/birth-chart',
|
|
@@ -592,7 +592,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
592
592
|
*
|
|
593
593
|
* 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.
|
|
594
594
|
*/
|
|
595
|
-
public generateNavamsa<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyNavamsaData, ThrowOnError>) {
|
|
595
|
+
public generateNavamsa<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyNavamsaData, ThrowOnError>): RequestResult<PostVedicAstrologyNavamsaResponses, PostVedicAstrologyNavamsaErrors, ThrowOnError> {
|
|
596
596
|
return (options?.client ?? this.client).post<PostVedicAstrologyNavamsaResponses, PostVedicAstrologyNavamsaErrors, ThrowOnError>({
|
|
597
597
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
598
598
|
url: '/vedic-astrology/navamsa',
|
|
@@ -609,7 +609,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
609
609
|
*
|
|
610
610
|
* 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).
|
|
611
611
|
*/
|
|
612
|
-
public generateDivisionalChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDivisionalChartData, ThrowOnError>) {
|
|
612
|
+
public generateDivisionalChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDivisionalChartData, ThrowOnError>): RequestResult<PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDivisionalChartErrors, ThrowOnError> {
|
|
613
613
|
return (options?.client ?? this.client).post<PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDivisionalChartErrors, ThrowOnError>({
|
|
614
614
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
615
615
|
url: '/vedic-astrology/divisional-chart',
|
|
@@ -626,7 +626,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
626
626
|
*
|
|
627
627
|
* 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.
|
|
628
628
|
*/
|
|
629
|
-
public calculateGunMilan<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCompatibilityData, ThrowOnError>) {
|
|
629
|
+
public calculateGunMilan<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCompatibilityData, ThrowOnError>): RequestResult<PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyCompatibilityErrors, ThrowOnError> {
|
|
630
630
|
return (options?.client ?? this.client).post<PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyCompatibilityErrors, ThrowOnError>({
|
|
631
631
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
632
632
|
url: '/vedic-astrology/compatibility',
|
|
@@ -643,7 +643,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
643
643
|
*
|
|
644
644
|
* 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.
|
|
645
645
|
*/
|
|
646
|
-
public getPlanetPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsData, ThrowOnError>) {
|
|
646
|
+
public getPlanetPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsData, ThrowOnError>): RequestResult<PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyPlanetaryPositionsErrors, ThrowOnError> {
|
|
647
647
|
return (options?.client ?? this.client).post<PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyPlanetaryPositionsErrors, ThrowOnError>({
|
|
648
648
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
649
649
|
url: '/vedic-astrology/planetary-positions',
|
|
@@ -660,7 +660,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
660
660
|
*
|
|
661
661
|
* 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.
|
|
662
662
|
*/
|
|
663
|
-
public getMonthlyEphemeris<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsMonthlyData, ThrowOnError>) {
|
|
663
|
+
public getMonthlyEphemeris<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsMonthlyErrors, ThrowOnError> {
|
|
664
664
|
return (options?.client ?? this.client).post<PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsMonthlyErrors, ThrowOnError>({
|
|
665
665
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
666
666
|
url: '/vedic-astrology/planetary-positions/monthly',
|
|
@@ -677,7 +677,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
677
677
|
*
|
|
678
678
|
* Calculate all five running Vimshottari Dasha levels (Mahadasha, Antardasha, Pratyantardasha, Sookshma, Prana) with remaining time in each. Accurate dasha calculator API for life phase prediction and planetary period analysis. Returns the dasha timeline with start/end dates for every level, ready for a current DBA readout down to hour-level timing. Set significators true to add the KP star lord, sub lord, signified houses and strength grade of each running lord, plus the houses they have in common. Essential for understanding current planetary influences, dasha transitions, and timing events in Vedic astrology. 120-year dasha system based on moon nakshatra at birth, with selectable Lahiri or KP ayanamsa.
|
|
679
679
|
*/
|
|
680
|
-
public getCurrentDasha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaCurrentData, ThrowOnError>) {
|
|
680
|
+
public getCurrentDasha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaCurrentData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaCurrentErrors, ThrowOnError> {
|
|
681
681
|
return (options?.client ?? this.client).post<PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaCurrentErrors, ThrowOnError>({
|
|
682
682
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
683
683
|
url: '/vedic-astrology/dasha/current',
|
|
@@ -694,7 +694,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
694
694
|
*
|
|
695
695
|
* Returns complete Vimshottari Dasha cycle starting from birth. Shows all major planetary periods from birth through 120 years.
|
|
696
696
|
*/
|
|
697
|
-
public getMajorDashas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaMajorData, ThrowOnError>) {
|
|
697
|
+
public getMajorDashas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaMajorData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaMajorErrors, ThrowOnError> {
|
|
698
698
|
return (options?.client ?? this.client).post<PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaMajorErrors, ThrowOnError>({
|
|
699
699
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
700
700
|
url: '/vedic-astrology/dasha/major',
|
|
@@ -711,7 +711,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
711
711
|
*
|
|
712
712
|
* Returns 9 Antardasha sub-periods within a Mahadasha. Each Mahadasha is divided into 9 proportional sub-periods.
|
|
713
713
|
*/
|
|
714
|
-
public getSubDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaData, ThrowOnError>) {
|
|
714
|
+
public getSubDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDashaSubByMahadashaErrors, ThrowOnError> {
|
|
715
715
|
return (options.client ?? this.client).post<PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDashaSubByMahadashaErrors, ThrowOnError>({
|
|
716
716
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
717
717
|
url: '/vedic-astrology/dasha/sub/{mahadasha}',
|
|
@@ -728,7 +728,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
728
728
|
*
|
|
729
729
|
* Pratyantardasha calculator API. Returns the 9 Pratyantardasha (antara) periods inside a chosen Antardasha, the third level of the Vimshottari dasha hierarchy. Use it to drill from a Mahadasha into month level timing for event prediction, muhurta selection, and dasha timeline UIs. Each period is proportional to the Vimshottari years of its lord.
|
|
730
730
|
*/
|
|
731
|
-
public getPratyantardashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaData, ThrowOnError>) {
|
|
731
|
+
public getPratyantardashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaByAntardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaErrors, ThrowOnError> {
|
|
732
732
|
return (options.client ?? this.client).post<PostVedicAstrologyDashaSubByMahadashaByAntardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaErrors, ThrowOnError>({
|
|
733
733
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
734
734
|
url: '/vedic-astrology/dasha/sub/{mahadasha}/{antardasha}',
|
|
@@ -745,7 +745,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
745
745
|
*
|
|
746
746
|
* Sookshma dasha API. Returns the 9 Sookshma periods inside a chosen Pratyantardasha, the fourth and finest level of the Vimshottari dasha hierarchy. Completes a full vimshottari drill down from the 120-year cycle to day level timing, typically 3 to 30 days per period. Built for dasha drill down tables, current DBA readouts, and precise event timing in Vedic astrology software.
|
|
747
747
|
*/
|
|
748
|
-
public getSookshmaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, ThrowOnError>) {
|
|
748
|
+
public getSookshmaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaErrors, ThrowOnError> {
|
|
749
749
|
return (options.client ?? this.client).post<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaErrors, ThrowOnError>({
|
|
750
750
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
751
751
|
url: '/vedic-astrology/dasha/sub/{mahadasha}/{antardasha}/{pratyantardasha}',
|
|
@@ -762,7 +762,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
762
762
|
*
|
|
763
763
|
* Prana dasha API. Returns the 9 Prana periods inside a chosen Sookshma dasha, the fifth and finest level of the Vimshottari dasha hierarchy. Completes the full vimshottari drill down from the 120-year cycle to hour level timing, typically 20 minutes to 4 days per period depending on the parent Mahadasha. Built for five column dasha drill down tables, muhurta selection, and pinpointing the trigger moment inside an event window already found at the Sookshma level.
|
|
764
764
|
*/
|
|
765
|
-
public getPranaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, ThrowOnError>) {
|
|
765
|
+
public getPranaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaErrors, ThrowOnError> {
|
|
766
766
|
return (options.client ?? this.client).post<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaErrors, ThrowOnError>({
|
|
767
767
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
768
768
|
url: '/vedic-astrology/dasha/sub/{mahadasha}/{antardasha}/{pratyantardasha}/{sookshma}',
|
|
@@ -779,7 +779,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
779
779
|
*
|
|
780
780
|
* 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.
|
|
781
781
|
*/
|
|
782
|
-
public getBasicPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangBasicData, ThrowOnError>) {
|
|
782
|
+
public getBasicPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangBasicData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangBasicErrors, ThrowOnError> {
|
|
783
783
|
return (options?.client ?? this.client).post<PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangBasicErrors, ThrowOnError>({
|
|
784
784
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
785
785
|
url: '/vedic-astrology/panchang/basic',
|
|
@@ -796,7 +796,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
796
796
|
*
|
|
797
797
|
* 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.
|
|
798
798
|
*/
|
|
799
|
-
public getDetailedPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangDetailedData, ThrowOnError>) {
|
|
799
|
+
public getDetailedPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangDetailedData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangDetailedErrors, ThrowOnError> {
|
|
800
800
|
return (options?.client ?? this.client).post<PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangDetailedErrors, ThrowOnError>({
|
|
801
801
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
802
802
|
url: '/vedic-astrology/panchang/detailed',
|
|
@@ -813,7 +813,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
813
813
|
*
|
|
814
814
|
* 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.
|
|
815
815
|
*/
|
|
816
|
-
public getChoghadiya<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangChoghadiyaData, ThrowOnError>) {
|
|
816
|
+
public getChoghadiya<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangChoghadiyaData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangChoghadiyaErrors, ThrowOnError> {
|
|
817
817
|
return (options?.client ?? this.client).post<PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangChoghadiyaErrors, ThrowOnError>({
|
|
818
818
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
819
819
|
url: '/vedic-astrology/panchang/choghadiya',
|
|
@@ -830,7 +830,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
830
830
|
*
|
|
831
831
|
* 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.
|
|
832
832
|
*/
|
|
833
|
-
public getHora<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangHoraData, ThrowOnError>) {
|
|
833
|
+
public getHora<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangHoraData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyPanchangHoraErrors, ThrowOnError> {
|
|
834
834
|
return (options?.client ?? this.client).post<PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyPanchangHoraErrors, ThrowOnError>({
|
|
835
835
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
836
836
|
url: '/vedic-astrology/panchang/hora',
|
|
@@ -847,7 +847,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
847
847
|
*
|
|
848
848
|
* 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.
|
|
849
849
|
*/
|
|
850
|
-
public checkManglikDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaManglikData, ThrowOnError>) {
|
|
850
|
+
public checkManglikDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaManglikData, ThrowOnError>): RequestResult<PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaManglikErrors, ThrowOnError> {
|
|
851
851
|
return (options?.client ?? this.client).post<PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaManglikErrors, ThrowOnError>({
|
|
852
852
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
853
853
|
url: '/vedic-astrology/dosha/manglik',
|
|
@@ -864,7 +864,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
864
864
|
*
|
|
865
865
|
* 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.
|
|
866
866
|
*/
|
|
867
|
-
public checkKalsarpaDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaKalsarpaData, ThrowOnError>) {
|
|
867
|
+
public checkKalsarpaDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaKalsarpaData, ThrowOnError>): RequestResult<PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaKalsarpaErrors, ThrowOnError> {
|
|
868
868
|
return (options?.client ?? this.client).post<PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaKalsarpaErrors, ThrowOnError>({
|
|
869
869
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
870
870
|
url: '/vedic-astrology/dosha/kalsarpa',
|
|
@@ -881,7 +881,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
881
881
|
*
|
|
882
882
|
* 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.
|
|
883
883
|
*/
|
|
884
|
-
public checkSadhesati<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaSadhesatiData, ThrowOnError>) {
|
|
884
|
+
public checkSadhesati<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaSadhesatiData, ThrowOnError>): RequestResult<PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyDoshaSadhesatiErrors, ThrowOnError> {
|
|
885
885
|
return (options?.client ?? this.client).post<PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyDoshaSadhesatiErrors, ThrowOnError>({
|
|
886
886
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
887
887
|
url: '/vedic-astrology/dosha/sadhesati',
|
|
@@ -894,11 +894,11 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
894
894
|
}
|
|
895
895
|
|
|
896
896
|
/**
|
|
897
|
-
* List all planetary yogas -
|
|
897
|
+
* List all planetary yogas - 301 entry Vedic Yoga Glossary
|
|
898
898
|
*
|
|
899
|
-
* Browse the
|
|
899
|
+
* Browse the 301-entry Vedic planetary-yoga glossary. Returns id and name for every cataloged yoga (Raja, Dhana, Pancha Mahapurusha, Nabhasa, Chandra-Mangala, and more). This is a dictionary lookup, not chart-driven detection: it does not inspect a birth chart. Use GET /yoga/{id} for the full glossary entry, or POST /yoga/detect to run all 44 detection rules against a specific kundli. Ideal for yoga-browser UIs, search, and progressive data loading.
|
|
900
900
|
*/
|
|
901
|
-
public listYogas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyYogaData, ThrowOnError>) {
|
|
901
|
+
public listYogas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyYogaData, ThrowOnError>): RequestResult<GetVedicAstrologyYogaResponses, GetVedicAstrologyYogaErrors, ThrowOnError> {
|
|
902
902
|
return (options?.client ?? this.client).get<GetVedicAstrologyYogaResponses, GetVedicAstrologyYogaErrors, ThrowOnError>({
|
|
903
903
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
904
904
|
url: '/vedic-astrology/yoga',
|
|
@@ -909,9 +909,9 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
909
909
|
/**
|
|
910
910
|
* Get yoga details by ID - Vedic Yoga Glossary Entry
|
|
911
911
|
*
|
|
912
|
-
* Look up the dictionary entry for a specific named yoga from the
|
|
912
|
+
* Look up the dictionary entry for a specific named yoga from the 301-entry Vedic planetary-yoga glossary. Returns formation conditions, life results, and quality classification (Positive/Negative/Both). This is a glossary lookup against the static catalog; it does NOT analyze a birth chart. For chart-driven present/absent verdicts on the 44 detection-grade yogas (Gajakesari, the Pancha Mahapurusha set, and all 32 Nabhasa distribution yogas) call POST /yoga/detect with birth data.
|
|
913
913
|
*/
|
|
914
|
-
public getYoga<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyYogaByIdData, ThrowOnError>) {
|
|
914
|
+
public getYoga<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyYogaByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaByIdErrors, ThrowOnError> {
|
|
915
915
|
return (options.client ?? this.client).get<GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaByIdErrors, ThrowOnError>({
|
|
916
916
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
917
917
|
url: '/vedic-astrology/yoga/{id}',
|
|
@@ -924,7 +924,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
924
924
|
*
|
|
925
925
|
* Chart-driven detection of 44 classical Vedic yogas. Twelve conjunction and dignity yogas: Gajakesari (parashara three-rule definition), Sunapha, Anapha, Dhurdhura, Kemadruma, Chandra Mangala, Budha-Aditya, and the five Pancha Mahapurusha yogas (Ruchaka, Bhadra, Hamsa, Malavya, Sasa). Plus all 32 Nabhasa distribution yogas, which describe how the seven visible grahas are spread across the whole chart rather than any single conjunction, across four families: Asraya (Rajju, Musala, Nala), Dala (Mala, Sarpa), Akriti (Gada, Shakata, Vihaga, Shringataka, Hala, Vajra, Yava, Kamala, Vapi, Yupa, Shara, Shakti, Danda, Nauka, Kuta, Chhatra, Dhanusha, Ardhachandra, Chakra, Samudra) and Sankhya (Gola, Yuga, Shoola, Kedara, Pasa, Damini, Veena). Each yoga is returned with an `id`, `name`, a `present` boolean, a `quality` (Positive, Negative, or Both, i.e. auspicious, inauspicious, or context-dependent), and a classical-text `evidence` string naming the rule that triggered or failed (kendra position, dignity, malefic drishti, lordship, retrograde state, sign modality, bhava distribution). Nabhasa results also apply the four classical precedence norms, so a yoga that matched its own rule but was outranked by a stronger family is returned as absent with evidence naming the norm that silenced it, letting you explain a verdict rather than only report it. There is no separate major/minor flag; `quality` is the auspiciousness axis. Unlike GET /yoga and GET /yoga/{id} which are dictionary lookups, this endpoint computes the kundli from birth data and runs the detection rules. Sources: BPHS ch. 35 and ch. 75, Mantreswara Phaladeepika ch. 6, B.V. Raman Three Hundred Important Combinations.
|
|
926
926
|
*/
|
|
927
|
-
public detectYogas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyYogaDetectData, ThrowOnError>) {
|
|
927
|
+
public detectYogas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyYogaDetectData, ThrowOnError>): RequestResult<PostVedicAstrologyYogaDetectResponses, PostVedicAstrologyYogaDetectErrors, ThrowOnError> {
|
|
928
928
|
return (options?.client ?? this.client).post<PostVedicAstrologyYogaDetectResponses, PostVedicAstrologyYogaDetectErrors, ThrowOnError>({
|
|
929
929
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
930
930
|
url: '/vedic-astrology/yoga/detect',
|
|
@@ -941,7 +941,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
941
941
|
*
|
|
942
942
|
* Get the KP-Newcomb (Krishnamurti) ayanamsa for any instant, computed continuously from Newcomb precession theory rather than looked up in a preset table, so it tracks the exact moment you ask for instead of the calendar year. Supply date alone for midnight UTC, or add time and timezone to pin a birth moment exactly. This is the precession offset subtracted from a tropical longitude to obtain the sidereal one, and it is what makes a KP chart reproduce the reference software your practitioners already use. Returns the same value every KP endpoint applies internally. KP Newcomb ayanamsa API, dynamic ayanamsa calculator, Krishnamurti ayanamsa today, current KP ayanamsa
|
|
943
943
|
*/
|
|
944
|
-
public getKpAyanamsa<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyKpAyanamsaData, ThrowOnError>) {
|
|
944
|
+
public getKpAyanamsa<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyKpAyanamsaData, ThrowOnError>): RequestResult<GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyKpAyanamsaErrors, ThrowOnError> {
|
|
945
945
|
return (options?.client ?? this.client).get<GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyKpAyanamsaErrors, ThrowOnError>({
|
|
946
946
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
947
947
|
url: '/vedic-astrology/kp/ayanamsa',
|
|
@@ -954,7 +954,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
954
954
|
*
|
|
955
955
|
* 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
|
|
956
956
|
*/
|
|
957
|
-
public getKpPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsData, ThrowOnError>) {
|
|
957
|
+
public getKpPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsData, ThrowOnError>): RequestResult<PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpPlanetsErrors, ThrowOnError> {
|
|
958
958
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpPlanetsErrors, ThrowOnError>({
|
|
959
959
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
960
960
|
url: '/vedic-astrology/kp/planets',
|
|
@@ -971,7 +971,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
971
971
|
*
|
|
972
972
|
* 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
|
|
973
973
|
*/
|
|
974
|
-
public getKpCusps<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpCuspsData, ThrowOnError>) {
|
|
974
|
+
public getKpCusps<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpCuspsData, ThrowOnError>): RequestResult<PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpCuspsErrors, ThrowOnError> {
|
|
975
975
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpCuspsErrors, ThrowOnError>({
|
|
976
976
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
977
977
|
url: '/vedic-astrology/kp/cusps',
|
|
@@ -988,7 +988,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
988
988
|
*
|
|
989
989
|
* 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
|
|
990
990
|
*/
|
|
991
|
-
public generateKpChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpChartData, ThrowOnError>) {
|
|
991
|
+
public generateKpChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpChartData, ThrowOnError>): RequestResult<PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpChartErrors, ThrowOnError> {
|
|
992
992
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpChartErrors, ThrowOnError>({
|
|
993
993
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
994
994
|
url: '/vedic-astrology/kp/chart',
|
|
@@ -1005,7 +1005,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1005
1005
|
*
|
|
1006
1006
|
* 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.
|
|
1007
1007
|
*/
|
|
1008
|
-
public getKpRulingPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsData, ThrowOnError>) {
|
|
1008
|
+
public getKpRulingPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsData, ThrowOnError>): RequestResult<PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpRulingPlanetsErrors, ThrowOnError> {
|
|
1009
1009
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpRulingPlanetsErrors, ThrowOnError>({
|
|
1010
1010
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1011
1011
|
url: '/vedic-astrology/kp/ruling-planets',
|
|
@@ -1022,7 +1022,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1022
1022
|
*
|
|
1023
1023
|
* 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.
|
|
1024
1024
|
*/
|
|
1025
|
-
public getKpRulingInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsIntervalData, ThrowOnError>) {
|
|
1025
|
+
public getKpRulingInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsIntervalData, ThrowOnError>): RequestResult<PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsIntervalErrors, ThrowOnError> {
|
|
1026
1026
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsIntervalErrors, ThrowOnError>({
|
|
1027
1027
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1028
1028
|
url: '/vedic-astrology/kp/ruling-planets-interval',
|
|
@@ -1039,7 +1039,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1039
1039
|
*
|
|
1040
1040
|
* 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.
|
|
1041
1041
|
*/
|
|
1042
|
-
public getKpSublordChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpSublordChangesData, ThrowOnError>) {
|
|
1042
|
+
public getKpSublordChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpSublordChangesData, ThrowOnError>): RequestResult<PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyKpSublordChangesErrors, ThrowOnError> {
|
|
1043
1043
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyKpSublordChangesErrors, ThrowOnError>({
|
|
1044
1044
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1045
1045
|
url: '/vedic-astrology/kp/sublord-changes',
|
|
@@ -1056,7 +1056,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1056
1056
|
*
|
|
1057
1057
|
* 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.
|
|
1058
1058
|
*/
|
|
1059
|
-
public getKpRasiChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRasiChangesData, ThrowOnError>) {
|
|
1059
|
+
public getKpRasiChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRasiChangesData, ThrowOnError>): RequestResult<PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRasiChangesErrors, ThrowOnError> {
|
|
1060
1060
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRasiChangesErrors, ThrowOnError>({
|
|
1061
1061
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1062
1062
|
url: '/vedic-astrology/kp/rasi-changes',
|
|
@@ -1073,7 +1073,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1073
1073
|
*
|
|
1074
1074
|
* 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.
|
|
1075
1075
|
*/
|
|
1076
|
-
public getKpPlanetsInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsIntervalData, ThrowOnError>) {
|
|
1076
|
+
public getKpPlanetsInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsIntervalData, ThrowOnError>): RequestResult<PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsIntervalErrors, ThrowOnError> {
|
|
1077
1077
|
return (options?.client ?? this.client).post<PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsIntervalErrors, ThrowOnError>({
|
|
1078
1078
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1079
1079
|
url: '/vedic-astrology/kp/planets-interval',
|
|
@@ -1085,12 +1085,29 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1085
1085
|
});
|
|
1086
1086
|
}
|
|
1087
1087
|
|
|
1088
|
+
/**
|
|
1089
|
+
* Cast a KP horary (Prashna) chart from a number 1-249 - KP Horary API
|
|
1090
|
+
*
|
|
1091
|
+
* Cast a Krishnamurti Paddhati horary chart, also called Prashna, from a number between 1 and 249 given by the querent plus the moment and place the question is judged. NO BIRTH DETAILS ARE NEEDED, which is what makes horary the KP answer when birth time is unknown or unreliable. The number maps to one of the 249 KP sub divisions and sets the Ascendant; the twelve Placidus cusps follow from that Ascendant at the given latitude, and every planetary position comes from the real sky at the moment of the question. Returns the Ascendant with its sub lord, all twelve cusps with star lord and sub lord, the nine grahas placed against those cusps, the five ruling planets for validating the chart, and four-level significators for judging which houses each graha supports. KP horary API, Prashna kundali calculator, 249 horary number chart, Krishnamurti Paddhati horary, cusp sub lord question answering.
|
|
1092
|
+
*/
|
|
1093
|
+
public castKpHoraryChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpHoraryData, ThrowOnError>): RequestResult<PostVedicAstrologyKpHoraryResponses, PostVedicAstrologyKpHoraryErrors, ThrowOnError> {
|
|
1094
|
+
return (options?.client ?? this.client).post<PostVedicAstrologyKpHoraryResponses, PostVedicAstrologyKpHoraryErrors, ThrowOnError>({
|
|
1095
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1096
|
+
url: '/vedic-astrology/kp/horary',
|
|
1097
|
+
...options,
|
|
1098
|
+
headers: {
|
|
1099
|
+
'Content-Type': 'application/json',
|
|
1100
|
+
...options?.headers
|
|
1101
|
+
}
|
|
1102
|
+
});
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1088
1105
|
/**
|
|
1089
1106
|
* Get planetary aspects (Drishti) - Mutual aspects between all planets
|
|
1090
1107
|
*
|
|
1091
1108
|
* 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.
|
|
1092
1109
|
*/
|
|
1093
|
-
public calculateDrishti<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsData, ThrowOnError>) {
|
|
1110
|
+
public calculateDrishti<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsData, ThrowOnError>): RequestResult<PostVedicAstrologyAspectsResponses, PostVedicAstrologyAspectsErrors, ThrowOnError> {
|
|
1094
1111
|
return (options?.client ?? this.client).post<PostVedicAstrologyAspectsResponses, PostVedicAstrologyAspectsErrors, ThrowOnError>({
|
|
1095
1112
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1096
1113
|
url: '/vedic-astrology/aspects',
|
|
@@ -1107,7 +1124,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1107
1124
|
*
|
|
1108
1125
|
* 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.
|
|
1109
1126
|
*/
|
|
1110
|
-
public getMonthlyAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsMonthlyData, ThrowOnError>) {
|
|
1127
|
+
public getMonthlyAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsMonthlyErrors, ThrowOnError> {
|
|
1111
1128
|
return (options?.client ?? this.client).post<PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsMonthlyErrors, ThrowOnError>({
|
|
1112
1129
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1113
1130
|
url: '/vedic-astrology/aspects/monthly',
|
|
@@ -1124,7 +1141,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1124
1141
|
*
|
|
1125
1142
|
* 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.
|
|
1126
1143
|
*/
|
|
1127
|
-
public getLunarAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsLunarData, ThrowOnError>) {
|
|
1144
|
+
public getLunarAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsLunarData, ThrowOnError>): RequestResult<PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsLunarErrors, ThrowOnError> {
|
|
1128
1145
|
return (options?.client ?? this.client).post<PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsLunarErrors, ThrowOnError>({
|
|
1129
1146
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1130
1147
|
url: '/vedic-astrology/aspects/lunar',
|
|
@@ -1141,7 +1158,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1141
1158
|
*
|
|
1142
1159
|
* 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.
|
|
1143
1160
|
*/
|
|
1144
|
-
public calculateTransit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitData, ThrowOnError>) {
|
|
1161
|
+
public calculateTransit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitData, ThrowOnError>): RequestResult<PostVedicAstrologyTransitResponses, PostVedicAstrologyTransitErrors, ThrowOnError> {
|
|
1145
1162
|
return (options?.client ?? this.client).post<PostVedicAstrologyTransitResponses, PostVedicAstrologyTransitErrors, ThrowOnError>({
|
|
1146
1163
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1147
1164
|
url: '/vedic-astrology/transit',
|
|
@@ -1158,7 +1175,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1158
1175
|
*
|
|
1159
1176
|
* 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.
|
|
1160
1177
|
*/
|
|
1161
|
-
public getMonthlyTransits<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitMonthlyData, ThrowOnError>) {
|
|
1178
|
+
public getMonthlyTransits<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitMonthlyErrors, ThrowOnError> {
|
|
1162
1179
|
return (options?.client ?? this.client).post<PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitMonthlyErrors, ThrowOnError>({
|
|
1163
1180
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1164
1181
|
url: '/vedic-astrology/transit/monthly',
|
|
@@ -1175,7 +1192,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1175
1192
|
*
|
|
1176
1193
|
* 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.
|
|
1177
1194
|
*/
|
|
1178
|
-
public calculateParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsData, ThrowOnError>) {
|
|
1195
|
+
public calculateParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsData, ThrowOnError>): RequestResult<PostVedicAstrologyParallelsResponses, PostVedicAstrologyParallelsErrors, ThrowOnError> {
|
|
1179
1196
|
return (options?.client ?? this.client).post<PostVedicAstrologyParallelsResponses, PostVedicAstrologyParallelsErrors, ThrowOnError>({
|
|
1180
1197
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1181
1198
|
url: '/vedic-astrology/parallels',
|
|
@@ -1192,7 +1209,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1192
1209
|
*
|
|
1193
1210
|
* 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.
|
|
1194
1211
|
*/
|
|
1195
|
-
public getMonthlyParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsMonthlyData, ThrowOnError>) {
|
|
1212
|
+
public getMonthlyParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsMonthlyErrors, ThrowOnError> {
|
|
1196
1213
|
return (options?.client ?? this.client).post<PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsMonthlyErrors, ThrowOnError>({
|
|
1197
1214
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1198
1215
|
url: '/vedic-astrology/parallels/monthly',
|
|
@@ -1209,7 +1226,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1209
1226
|
*
|
|
1210
1227
|
* 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.
|
|
1211
1228
|
*/
|
|
1212
|
-
public getEclipticCrossings<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyEclipticCrossingsData, ThrowOnError>) {
|
|
1229
|
+
public getEclipticCrossings<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyEclipticCrossingsData, ThrowOnError>): RequestResult<PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyEclipticCrossingsErrors, ThrowOnError> {
|
|
1213
1230
|
return (options?.client ?? this.client).post<PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyEclipticCrossingsErrors, ThrowOnError>({
|
|
1214
1231
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1215
1232
|
url: '/vedic-astrology/ecliptic-crossings',
|
|
@@ -1226,7 +1243,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1226
1243
|
*
|
|
1227
1244
|
* 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.
|
|
1228
1245
|
*/
|
|
1229
|
-
public listRashis<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyRashisData, ThrowOnError>) {
|
|
1246
|
+
public listRashis<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyRashisData, ThrowOnError>): RequestResult<GetVedicAstrologyRashisResponses, GetVedicAstrologyRashisErrors, ThrowOnError> {
|
|
1230
1247
|
return (options?.client ?? this.client).get<GetVedicAstrologyRashisResponses, GetVedicAstrologyRashisErrors, ThrowOnError>({
|
|
1231
1248
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1232
1249
|
url: '/vedic-astrology/rashis',
|
|
@@ -1239,7 +1256,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1239
1256
|
*
|
|
1240
1257
|
* 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.
|
|
1241
1258
|
*/
|
|
1242
|
-
public getRashi<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyRashisByIdData, ThrowOnError>) {
|
|
1259
|
+
public getRashi<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyRashisByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisByIdErrors, ThrowOnError> {
|
|
1243
1260
|
return (options.client ?? this.client).get<GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisByIdErrors, ThrowOnError>({
|
|
1244
1261
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1245
1262
|
url: '/vedic-astrology/rashis/{id}',
|
|
@@ -1252,7 +1269,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1252
1269
|
*
|
|
1253
1270
|
* 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.
|
|
1254
1271
|
*/
|
|
1255
|
-
public listNakshatras<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyNakshatrasData, ThrowOnError>) {
|
|
1272
|
+
public listNakshatras<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyNakshatrasData, ThrowOnError>): RequestResult<GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyNakshatrasErrors, ThrowOnError> {
|
|
1256
1273
|
return (options?.client ?? this.client).get<GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyNakshatrasErrors, ThrowOnError>({
|
|
1257
1274
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1258
1275
|
url: '/vedic-astrology/nakshatras',
|
|
@@ -1265,7 +1282,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1265
1282
|
*
|
|
1266
1283
|
* 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.
|
|
1267
1284
|
*/
|
|
1268
|
-
public getNakshatra<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyNakshatrasByIdData, ThrowOnError>) {
|
|
1285
|
+
public getNakshatra<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyNakshatrasByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasByIdErrors, ThrowOnError> {
|
|
1269
1286
|
return (options.client ?? this.client).get<GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasByIdErrors, ThrowOnError>({
|
|
1270
1287
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1271
1288
|
url: '/vedic-astrology/nakshatras/{id}',
|
|
@@ -1278,7 +1295,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1278
1295
|
*
|
|
1279
1296
|
* 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.
|
|
1280
1297
|
*/
|
|
1281
|
-
public getUpagrahaPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyUpagrahaData, ThrowOnError>) {
|
|
1298
|
+
public getUpagrahaPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyUpagrahaData, ThrowOnError>): RequestResult<PostVedicAstrologyUpagrahaResponses, PostVedicAstrologyUpagrahaErrors, ThrowOnError> {
|
|
1282
1299
|
return (options?.client ?? this.client).post<PostVedicAstrologyUpagrahaResponses, PostVedicAstrologyUpagrahaErrors, ThrowOnError>({
|
|
1283
1300
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1284
1301
|
url: '/vedic-astrology/upagraha',
|
|
@@ -1295,7 +1312,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1295
1312
|
*
|
|
1296
1313
|
* 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.
|
|
1297
1314
|
*/
|
|
1298
|
-
public calculateAshtakavarga<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAshtakavargaData, ThrowOnError>) {
|
|
1315
|
+
public calculateAshtakavarga<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAshtakavargaData, ThrowOnError>): RequestResult<PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAshtakavargaErrors, ThrowOnError> {
|
|
1299
1316
|
return (options?.client ?? this.client).post<PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAshtakavargaErrors, ThrowOnError>({
|
|
1300
1317
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1301
1318
|
url: '/vedic-astrology/ashtakavarga',
|
|
@@ -1312,7 +1329,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1312
1329
|
*
|
|
1313
1330
|
* 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.
|
|
1314
1331
|
*/
|
|
1315
|
-
public calculateShadbala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyShadbalaData, ThrowOnError>) {
|
|
1332
|
+
public calculateShadbala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyShadbalaData, ThrowOnError>): RequestResult<PostVedicAstrologyShadbalaResponses, PostVedicAstrologyShadbalaErrors, ThrowOnError> {
|
|
1316
1333
|
return (options?.client ?? this.client).post<PostVedicAstrologyShadbalaResponses, PostVedicAstrologyShadbalaErrors, ThrowOnError>({
|
|
1317
1334
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1318
1335
|
url: '/vedic-astrology/shadbala',
|
|
@@ -1329,7 +1346,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1329
1346
|
*
|
|
1330
1347
|
* Reference list of every avastha (planetary state) across the three classical systems: the five Baladi age states, the three Jagradadi waking states, and the nine Deeptadi dispositional states. Each carries a short label and what the state means for the results the graha can deliver. Use it to turn the bare state names a birth chart returns into readable output, filtered by system if you only need one. Avastha meaning API, Baladi avastha, Jagradadi, Deeptadi, planetary state Vedic astrology.
|
|
1331
1348
|
*/
|
|
1332
|
-
public listAvasthas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyAvasthasData, ThrowOnError>) {
|
|
1349
|
+
public listAvasthas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyAvasthasData, ThrowOnError>): RequestResult<GetVedicAstrologyAvasthasResponses, GetVedicAstrologyAvasthasErrors, ThrowOnError> {
|
|
1333
1350
|
return (options?.client ?? this.client).get<GetVedicAstrologyAvasthasResponses, GetVedicAstrologyAvasthasErrors, ThrowOnError>({
|
|
1334
1351
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1335
1352
|
url: '/vedic-astrology/avasthas',
|
|
@@ -1342,7 +1359,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1342
1359
|
*
|
|
1343
1360
|
* Look up a single avastha state by its slug, which is the lowercased state name a birth chart returns in `awastha`, `jagradadi` or `deeptadi`. Returns the system it belongs to, a short label, and what the state means for the results the graha delivers.
|
|
1344
1361
|
*/
|
|
1345
|
-
public getAvastha<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyAvasthasByIdData, ThrowOnError>) {
|
|
1362
|
+
public getAvastha<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyAvasthasByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyAvasthasByIdResponses, GetVedicAstrologyAvasthasByIdErrors, ThrowOnError> {
|
|
1346
1363
|
return (options.client ?? this.client).get<GetVedicAstrologyAvasthasByIdResponses, GetVedicAstrologyAvasthasByIdErrors, ThrowOnError>({
|
|
1347
1364
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1348
1365
|
url: '/vedic-astrology/avasthas/{id}',
|
|
@@ -1355,7 +1372,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1355
1372
|
*
|
|
1356
1373
|
* Calculate the Arudha Lagna (AL) and all twelve Arudha padas of Jaimini astrology from birth details. An Arudha pada is the perceived or projected form of a bhava, so where the Lagna shows what a person is, the Arudha Lagna shows the image and status the world attaches to them. Returns each pada with the bhava lord and the count that produced it, the sign it lands in, its house from the Lagna, and a flag showing whether the classical exception moved it. Includes the Upapada (UL) read for marriage. Arudha Lagna calculator API, Jaimini pada, Upapada Lagna, Vedic astrology public image.
|
|
1357
1374
|
*/
|
|
1358
|
-
public calculateArudhaPadas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyArudhaData, ThrowOnError>) {
|
|
1375
|
+
public calculateArudhaPadas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyArudhaData, ThrowOnError>): RequestResult<PostVedicAstrologyArudhaResponses, PostVedicAstrologyArudhaErrors, ThrowOnError> {
|
|
1359
1376
|
return (options?.client ?? this.client).post<PostVedicAstrologyArudhaResponses, PostVedicAstrologyArudhaErrors, ThrowOnError>({
|
|
1360
1377
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1361
1378
|
url: '/vedic-astrology/arudha',
|
|
@@ -1372,7 +1389,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1372
1389
|
*
|
|
1373
1390
|
* Calculate the Chara Karakas of Jaimini astrology from birth details: the movable significators assigned by ranking each graha on how far it has advanced into its sign. The highest becomes the Atmakaraka, the soul significator and the strongest influence in the chart, and the rest take the Amatya, Bhratri, Matri, Pitri, Putra, Gnati and Dara offices in descending order. Supports both the eight-karaka scheme, where Rahu is included with its degree reversed, and the seven-karaka scheme that excludes the nodes, because the two can name a different Atmakaraka for the same chart. Atmakaraka calculator API, Darakaraka, Jaimini chara karaka, Vedic astrology soul significator.
|
|
1374
1391
|
*/
|
|
1375
|
-
public calculateCharaKarakas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCharaKarakasData, ThrowOnError>) {
|
|
1392
|
+
public calculateCharaKarakas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCharaKarakasData, ThrowOnError>): RequestResult<PostVedicAstrologyCharaKarakasResponses, PostVedicAstrologyCharaKarakasErrors, ThrowOnError> {
|
|
1376
1393
|
return (options?.client ?? this.client).post<PostVedicAstrologyCharaKarakasResponses, PostVedicAstrologyCharaKarakasErrors, ThrowOnError>({
|
|
1377
1394
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1378
1395
|
url: '/vedic-astrology/chara-karakas',
|
|
@@ -1389,7 +1406,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1389
1406
|
*
|
|
1390
1407
|
* Calculate Bhava Bala (house strength) for all twelve bhavas per Brihat Parashara Hora Shastra (BPHS) and BV Raman Graha and Bhava Balas. Returns the three classical components (Bhavadhipati Bala from the house lord Shadbala, Bhava Digbala from the rashi class and direction, Bhava Drishti Bala from aspects on the bhava madhya) plus totals in virupas and rupas and a strength ranking. Bhavas are built on unequal Sripati mid-cusps, so a house near a sign boundary is measured where it actually falls. Shadbala measures which graha is strong, Bhava Bala measures which life area is strong, and reading both together is how a practitioner separates a strong planet in a weak house from a weak planet in a strong one. Bhava Bala calculator API, house strength Vedic astrology, bhava bala virupas, Bhavadhipati Bala, Bhava Digbala, Sripati bhava madhya.
|
|
1391
1408
|
*/
|
|
1392
|
-
public calculateBhavaBala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBhavaBalaData, ThrowOnError>) {
|
|
1409
|
+
public calculateBhavaBala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBhavaBalaData, ThrowOnError>): RequestResult<PostVedicAstrologyBhavaBalaResponses, PostVedicAstrologyBhavaBalaErrors, ThrowOnError> {
|
|
1393
1410
|
return (options?.client ?? this.client).post<PostVedicAstrologyBhavaBalaResponses, PostVedicAstrologyBhavaBalaErrors, ThrowOnError>({
|
|
1394
1411
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1395
1412
|
url: '/vedic-astrology/bhava-bala',
|
|
@@ -1406,7 +1423,7 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1406
1423
|
*
|
|
1407
1424
|
* Calculate the Bhav Chalit chart, also written Bhava Chalit or Chalit Kundli, placing every graha by unequal Sripati bhava cusps instead of by whole sign. The Rashi (D1) chart treats a whole sign as a house, so a graha a degree from a sign boundary is shown in a house it does not actually occupy; the Chalit chart resolves that by measuring from the bhava sandhis, which is why practitioners check it before reading house results, house lordship strength or transit effects. Returns the twelve bhava boundaries with their madhyas and spans, every graha in both frames, and a moved flag on the placements that differ. Bhav Chalit API, Chalit Kundli calculator, bhava chalit chart, Sripati house cusps, cusp based house chart Vedic astrology.
|
|
1408
1425
|
*/
|
|
1409
|
-
public calculateBhavChalit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBhavChalitData, ThrowOnError>) {
|
|
1426
|
+
public calculateBhavChalit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBhavChalitData, ThrowOnError>): RequestResult<PostVedicAstrologyBhavChalitResponses, PostVedicAstrologyBhavChalitErrors, ThrowOnError> {
|
|
1410
1427
|
return (options?.client ?? this.client).post<PostVedicAstrologyBhavChalitResponses, PostVedicAstrologyBhavChalitErrors, ThrowOnError>({
|
|
1411
1428
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1412
1429
|
url: '/vedic-astrology/bhav-chalit',
|
|
@@ -1417,6 +1434,23 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1417
1434
|
}
|
|
1418
1435
|
});
|
|
1419
1436
|
}
|
|
1437
|
+
|
|
1438
|
+
/**
|
|
1439
|
+
* Heliacal rising and setting (udaya and asta) - Graha Asta Calculator API
|
|
1440
|
+
*
|
|
1441
|
+
* Calculate heliacal rising (udaya) and setting (asta) of the six visible grahas for any date and place, by the Surya Siddhanta rule. Returns whether each graha currently clears the solar glare, its separation from the Sun in classical degrees of time, and the dates its visibility last changed and next changes. This is the calculation behind Guru Asta and Shukra Asta, the periods classical muhurta withholds marriage and other auspicious ceremonies. Unlike a birth chart combustion flag it is location aware, because the angle the ecliptic makes with the local horizon decides how long a graha lingers after the Sun. Graha asta API, Guru Asta Shukra Asta dates, heliacal rising calculator, planetary combustion muhurta.
|
|
1442
|
+
*/
|
|
1443
|
+
public getHeliacalVisibility<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyHeliacalData, ThrowOnError>): RequestResult<PostVedicAstrologyHeliacalResponses, PostVedicAstrologyHeliacalErrors, ThrowOnError> {
|
|
1444
|
+
return (options?.client ?? this.client).post<PostVedicAstrologyHeliacalResponses, PostVedicAstrologyHeliacalErrors, ThrowOnError>({
|
|
1445
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1446
|
+
url: '/vedic-astrology/heliacal',
|
|
1447
|
+
...options,
|
|
1448
|
+
headers: {
|
|
1449
|
+
'Content-Type': 'application/json',
|
|
1450
|
+
...options?.headers
|
|
1451
|
+
}
|
|
1452
|
+
});
|
|
1453
|
+
}
|
|
1420
1454
|
}
|
|
1421
1455
|
|
|
1422
1456
|
export class Forecast extends HeyApiClient {
|
|
@@ -1425,7 +1459,7 @@ export class Forecast extends HeyApiClient {
|
|
|
1425
1459
|
*
|
|
1426
1460
|
* Build one time-ordered forecast for a single birth subject by merging upcoming events across three domains: western transit-to-natal aspects, sign ingresses, retrograde stations, eclipses, and new and full moons; biorhythm critical days; and vedic Vimshottari mahadasha, antardasha, and pratyantardasha boundaries. The window is clamped to 90 days and events are capped and scored by significance. Built for what-is-coming dashboards, daily and weekly forecast feeds, and timing tools.
|
|
1427
1461
|
*/
|
|
1428
|
-
public generateTimeline<ThrowOnError extends boolean = false>(options?: Options<PostForecastTimelineData, ThrowOnError>) {
|
|
1462
|
+
public generateTimeline<ThrowOnError extends boolean = false>(options?: Options<PostForecastTimelineData, ThrowOnError>): RequestResult<PostForecastTimelineResponses, PostForecastTimelineErrors, ThrowOnError> {
|
|
1429
1463
|
return (options?.client ?? this.client).post<PostForecastTimelineResponses, PostForecastTimelineErrors, ThrowOnError>({
|
|
1430
1464
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1431
1465
|
url: '/forecast/timeline',
|
|
@@ -1442,7 +1476,7 @@ export class Forecast extends HeyApiClient {
|
|
|
1442
1476
|
*
|
|
1443
1477
|
* Forecast the western astrology events for a single birth chart over a window up to 90 days: every transit-to-natal major aspect refined to its exact instant, every transiting planet sign ingress, every retrograde or direct station, every solar and lunar eclipse, and every New and Full Moon. Returns a time-ordered, significance-scored timeline. Built for astrology forecast feeds, transit alerts, and timing tools.
|
|
1444
1478
|
*/
|
|
1445
|
-
public forecastTransits<ThrowOnError extends boolean = false>(options?: Options<PostForecastTransitsData, ThrowOnError>) {
|
|
1479
|
+
public forecastTransits<ThrowOnError extends boolean = false>(options?: Options<PostForecastTransitsData, ThrowOnError>): RequestResult<PostForecastTransitsResponses, PostForecastTransitsErrors, ThrowOnError> {
|
|
1446
1480
|
return (options?.client ?? this.client).post<PostForecastTransitsResponses, PostForecastTransitsErrors, ThrowOnError>({
|
|
1447
1481
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1448
1482
|
url: '/forecast/transits',
|
|
@@ -1459,7 +1493,7 @@ export class Forecast extends HeyApiClient {
|
|
|
1459
1493
|
*
|
|
1460
1494
|
* Return only the high-significance dates from the merged cross-domain forecast for a single birth subject: the rare outer-planet exact transit aspects, slow-planet sign ingresses, retrograde stations, and Vimshottari mahadasha and antardasha changes that mark genuine turning points. Defaults to a significance floor of 70 so the response is a short list of the most meaningful upcoming dates. Built for what-is-coming highlights, timing alerts, and at-a-glance forecast strips.
|
|
1461
1495
|
*/
|
|
1462
|
-
public findSignificantDates<ThrowOnError extends boolean = false>(options?: Options<PostForecastSignificantDatesData, ThrowOnError>) {
|
|
1496
|
+
public findSignificantDates<ThrowOnError extends boolean = false>(options?: Options<PostForecastSignificantDatesData, ThrowOnError>): RequestResult<PostForecastSignificantDatesResponses, PostForecastSignificantDatesErrors, ThrowOnError> {
|
|
1463
1497
|
return (options?.client ?? this.client).post<PostForecastSignificantDatesResponses, PostForecastSignificantDatesErrors, ThrowOnError>({
|
|
1464
1498
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1465
1499
|
url: '/forecast/significant-dates',
|
|
@@ -1476,7 +1510,7 @@ export class Forecast extends HeyApiClient {
|
|
|
1476
1510
|
*
|
|
1477
1511
|
* Roll the cross-domain forecast for a single birth subject into four pre-summarized windows: the next 24 hours, 7 days, 30 days, and 90 days from the start date. Each window returns its event count, a per-domain count breakdown, a per-type count breakdown, and the top highest-significance events. Built for a glanceable what-is-coming strip so a caller can render the upcoming highlights without scanning the full event list.
|
|
1478
1512
|
*/
|
|
1479
|
-
public generateDigest<ThrowOnError extends boolean = false>(options?: Options<PostForecastDigestData, ThrowOnError>) {
|
|
1513
|
+
public generateDigest<ThrowOnError extends boolean = false>(options?: Options<PostForecastDigestData, ThrowOnError>): RequestResult<PostForecastDigestResponses, PostForecastDigestErrors, ThrowOnError> {
|
|
1480
1514
|
return (options?.client ?? this.client).post<PostForecastDigestResponses, PostForecastDigestErrors, ThrowOnError>({
|
|
1481
1515
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1482
1516
|
url: '/forecast/digest',
|
|
@@ -1493,7 +1527,7 @@ export class Forecast extends HeyApiClient {
|
|
|
1493
1527
|
*
|
|
1494
1528
|
* Cast the solar return chart for one subject and year: the chart erected for the exact moment the transiting Sun returns to its natal ecliptic longitude, the foundational technique for annual astrological forecasting. Returns the full tropical chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Location-sensitive: pass the birthplace to anchor the chart to natal geography, or the current city for a relocated solar return where the houses and Ascendant shift to where you are on your birthday. Built for year-ahead forecast tools, birthday charts, and annual horoscope features.
|
|
1495
1529
|
*/
|
|
1496
|
-
public forecastSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostForecastSolarReturnData, ThrowOnError>) {
|
|
1530
|
+
public forecastSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostForecastSolarReturnData, ThrowOnError>): RequestResult<PostForecastSolarReturnResponses, PostForecastSolarReturnErrors, ThrowOnError> {
|
|
1497
1531
|
return (options?.client ?? this.client).post<PostForecastSolarReturnResponses, PostForecastSolarReturnErrors, ThrowOnError>({
|
|
1498
1532
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1499
1533
|
url: '/forecast/solar-return',
|
|
@@ -1512,7 +1546,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1512
1546
|
*
|
|
1513
1547
|
* Generate a complete Human Design bodygraph from a birth date, time, and timezone. Returns the energy type, strategy, inner authority, signature, not-self theme, profile, definition, incarnation cross, all nine centers with defined state and active gates, the defined channels, and all 26 planetary activations across the Personality and Design sides. The single endpoint for a full chart in one call, built for Human Design apps, readings, and coaching tools.
|
|
1514
1548
|
*/
|
|
1515
|
-
public generateBodygraph<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignBodygraphData, ThrowOnError>) {
|
|
1549
|
+
public generateBodygraph<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignBodygraphData, ThrowOnError>): RequestResult<PostHumanDesignBodygraphResponses, PostHumanDesignBodygraphErrors, ThrowOnError> {
|
|
1516
1550
|
return (options?.client ?? this.client).post<PostHumanDesignBodygraphResponses, PostHumanDesignBodygraphErrors, ThrowOnError>({
|
|
1517
1551
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1518
1552
|
url: '/human-design/bodygraph',
|
|
@@ -1529,7 +1563,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1529
1563
|
*
|
|
1530
1564
|
* Calculate a Human Design connection chart by overlaying two bodygraphs. For each of the 36 channels the dynamic between the two people is classified as electromagnetic, dominance, compromise, or companionship, the four mechanics of how two designs meet. Also returns the nine centers as defined or open in the combined bodygraph with which person defines each, the combined definition, and a count of each dynamic. Built for relationship, dating, and coaching tools.
|
|
1531
1565
|
*/
|
|
1532
|
-
public calculateConnection<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignConnectionData, ThrowOnError>) {
|
|
1566
|
+
public calculateConnection<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignConnectionData, ThrowOnError>): RequestResult<PostHumanDesignConnectionResponses, PostHumanDesignConnectionErrors, ThrowOnError> {
|
|
1533
1567
|
return (options?.client ?? this.client).post<PostHumanDesignConnectionResponses, PostHumanDesignConnectionErrors, ThrowOnError>({
|
|
1534
1568
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1535
1569
|
url: '/human-design/connection',
|
|
@@ -1546,7 +1580,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1546
1580
|
*
|
|
1547
1581
|
* Calculate the Human Design Penta (BG5, Base Group 5) for a small group of three to five people. The Penta is a trans-auric form built from a fixed set of six channels running only between the Sacral, the G Center, and the Throat. It reports which of the twelve Penta gates are filled and by whom, which of the six channels are defined Strengths, the upper leadership channels versus the lower generative channels, the 2/14 material core, and the functional gaps where no member supplies a role. Built for team, family, and group analysis tools. Below three people no Penta forms and above five a second Penta emerges, so the group size must be three to five.
|
|
1548
1582
|
*/
|
|
1549
|
-
public calculatePenta<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignPentaData, ThrowOnError>) {
|
|
1583
|
+
public calculatePenta<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignPentaData, ThrowOnError>): RequestResult<PostHumanDesignPentaResponses, PostHumanDesignPentaErrors, ThrowOnError> {
|
|
1550
1584
|
return (options?.client ?? this.client).post<PostHumanDesignPentaResponses, PostHumanDesignPentaErrors, ThrowOnError>({
|
|
1551
1585
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1552
1586
|
url: '/human-design/penta',
|
|
@@ -1563,7 +1597,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1563
1597
|
*
|
|
1564
1598
|
* Overlay the current or any given planetary positions on a natal Human Design bodygraph to see which channels the transit temporarily completes. Returns the 13 transiting body activations with gate and line, the channels the transit completes beyond the natal definition split into personal channels where the transit supplies the partner gate of a natal gate and educational channels where the transit supplies both gates, the natally open centers those channels temporarily define, and a short factual summary. A transit is a single moment, so there is no Design side. When date and time are omitted the overlay is computed for now in UTC. Built for daily Human Design apps, transit widgets, and notification tools.
|
|
1565
1599
|
*/
|
|
1566
|
-
public generateTransit<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTransitData, ThrowOnError>) {
|
|
1600
|
+
public generateTransit<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTransitData, ThrowOnError>): RequestResult<PostHumanDesignTransitResponses, PostHumanDesignTransitErrors, ThrowOnError> {
|
|
1567
1601
|
return (options?.client ?? this.client).post<PostHumanDesignTransitResponses, PostHumanDesignTransitErrors, ThrowOnError>({
|
|
1568
1602
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1569
1603
|
url: '/human-design/transit',
|
|
@@ -1580,7 +1614,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1580
1614
|
*
|
|
1581
1615
|
* Calculate the core Human Design identity from a birth moment: the energy type, the aura strategy, the inner authority, the signature and not-self themes, and the profile. The fast lookup for type-and-authority features without the full bodygraph payload. Verified against NASA JPL Horizons positions.
|
|
1582
1616
|
*/
|
|
1583
|
-
public calculateType<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTypeData, ThrowOnError>) {
|
|
1617
|
+
public calculateType<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTypeData, ThrowOnError>): RequestResult<PostHumanDesignTypeResponses, PostHumanDesignTypeErrors, ThrowOnError> {
|
|
1584
1618
|
return (options?.client ?? this.client).post<PostHumanDesignTypeResponses, PostHumanDesignTypeErrors, ThrowOnError>({
|
|
1585
1619
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1586
1620
|
url: '/human-design/type',
|
|
@@ -1597,7 +1631,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1597
1631
|
*
|
|
1598
1632
|
* Calculate the 26 gate activations for a birth moment, split into the 13 conscious Personality activations at birth and the 13 unconscious Design activations 88 degrees of solar arc earlier. Each activation reports the planet, gate, line, gate keynote, and the matching I-Ching hexagram. Built for activation columns and detailed chart views.
|
|
1599
1633
|
*/
|
|
1600
|
-
public calculateGates<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignGatesData, ThrowOnError>) {
|
|
1634
|
+
public calculateGates<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignGatesData, ThrowOnError>): RequestResult<PostHumanDesignGatesResponses, PostHumanDesignGatesErrors, ThrowOnError> {
|
|
1601
1635
|
return (options?.client ?? this.client).post<PostHumanDesignGatesResponses, PostHumanDesignGatesErrors, ThrowOnError>({
|
|
1602
1636
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1603
1637
|
url: '/human-design/gates',
|
|
@@ -1614,7 +1648,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1614
1648
|
*
|
|
1615
1649
|
* Look up the static reference data for a Human Design gate by its number from 1 to 64: the gate keynote name, the center it sits in, the matching I-Ching hexagram, and the gates that form a channel with it. A pure reference endpoint with no birth data required.
|
|
1616
1650
|
*/
|
|
1617
|
-
public getGate<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignGatesByNumberData, ThrowOnError>) {
|
|
1651
|
+
public getGate<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignGatesByNumberData, ThrowOnError>): RequestResult<GetHumanDesignGatesByNumberResponses, GetHumanDesignGatesByNumberErrors, ThrowOnError> {
|
|
1618
1652
|
return (options.client ?? this.client).get<GetHumanDesignGatesByNumberResponses, GetHumanDesignGatesByNumberErrors, ThrowOnError>({
|
|
1619
1653
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1620
1654
|
url: '/human-design/gates/{number}',
|
|
@@ -1627,7 +1661,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1627
1661
|
*
|
|
1628
1662
|
* Calculate the defined channels for a birth moment. A channel is defined when both of its gates are activated, and it wires together the two centers it connects. Returns each defined channel with its gates, name, circuit family, and connected centers, plus the full set of centers those channels define. Built for bodygraph rendering and definition analysis.
|
|
1629
1663
|
*/
|
|
1630
|
-
public calculateChannels<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignChannelsData, ThrowOnError>) {
|
|
1664
|
+
public calculateChannels<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignChannelsData, ThrowOnError>): RequestResult<PostHumanDesignChannelsResponses, PostHumanDesignChannelsErrors, ThrowOnError> {
|
|
1631
1665
|
return (options?.client ?? this.client).post<PostHumanDesignChannelsResponses, PostHumanDesignChannelsErrors, ThrowOnError>({
|
|
1632
1666
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1633
1667
|
url: '/human-design/channels',
|
|
@@ -1644,7 +1678,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1644
1678
|
*
|
|
1645
1679
|
* Calculate the state of all nine Human Design centers for a birth moment: whether each is defined or open, whether it is a motor or an awareness center, its theme, and the active gates it holds. The data layer behind a rendered bodygraph where defined centers are colored and open centers are white.
|
|
1646
1680
|
*/
|
|
1647
|
-
public calculateCenters<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignCentersData, ThrowOnError>) {
|
|
1681
|
+
public calculateCenters<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignCentersData, ThrowOnError>): RequestResult<PostHumanDesignCentersResponses, PostHumanDesignCentersErrors, ThrowOnError> {
|
|
1648
1682
|
return (options?.client ?? this.client).post<PostHumanDesignCentersResponses, PostHumanDesignCentersErrors, ThrowOnError>({
|
|
1649
1683
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1650
1684
|
url: '/human-design/centers',
|
|
@@ -1661,7 +1695,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1661
1695
|
*
|
|
1662
1696
|
* Look up the static reference data for one of the nine Human Design centers by its id: the display name, whether it is a motor or awareness center, and what it means both defined and undefined. A pure reference endpoint with no birth data required.
|
|
1663
1697
|
*/
|
|
1664
|
-
public getCenter<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignCentersByIdData, ThrowOnError>) {
|
|
1698
|
+
public getCenter<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignCentersByIdData, ThrowOnError>): RequestResult<GetHumanDesignCentersByIdResponses, GetHumanDesignCentersByIdErrors, ThrowOnError> {
|
|
1665
1699
|
return (options.client ?? this.client).get<GetHumanDesignCentersByIdResponses, GetHumanDesignCentersByIdErrors, ThrowOnError>({
|
|
1666
1700
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1667
1701
|
url: '/human-design/centers/{id}',
|
|
@@ -1674,7 +1708,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1674
1708
|
*
|
|
1675
1709
|
* Calculate the Human Design profile for a birth moment: the conscious Personality Sun line over the unconscious Design Sun line, with the keynote for each. The profile is the geometry of the life role, for example 5/1 the Heretic Investigator. Verified against NASA JPL Horizons positions.
|
|
1676
1710
|
*/
|
|
1677
|
-
public calculateProfile<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignProfileData, ThrowOnError>) {
|
|
1711
|
+
public calculateProfile<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignProfileData, ThrowOnError>): RequestResult<PostHumanDesignProfileResponses, PostHumanDesignProfileErrors, ThrowOnError> {
|
|
1678
1712
|
return (options?.client ?? this.client).post<PostHumanDesignProfileResponses, PostHumanDesignProfileErrors, ThrowOnError>({
|
|
1679
1713
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1680
1714
|
url: '/human-design/profile',
|
|
@@ -1691,7 +1725,7 @@ export class HumanDesign extends HeyApiClient {
|
|
|
1691
1725
|
*
|
|
1692
1726
|
* Calculate the four Human Design Variable arrows for a birth moment: Determination and Environment on the design side, Perspective and Motivation on the personality side. Each arrow returns its Color, Tone, and Base numbers from the hexagram-line substructure, the left or right direction set by the Tone, and the sourced Color and direction labels. This is the advanced Rave Variables and Primary Health System layer beneath Type, Strategy, Authority, and Profile. Color, Tone, and Base shift with tiny differences in birth time, so each arrow carries a confidence flag that turns false near a Color or Tone boundary, and a precise birth time is essential. Built for Human Design apps offering PHS, diet, environment, and Rave Psychology readings.
|
|
1693
1727
|
*/
|
|
1694
|
-
public calculateVariables<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignVariablesData, ThrowOnError>) {
|
|
1728
|
+
public calculateVariables<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignVariablesData, ThrowOnError>): RequestResult<PostHumanDesignVariablesResponses, PostHumanDesignVariablesErrors, ThrowOnError> {
|
|
1695
1729
|
return (options?.client ?? this.client).post<PostHumanDesignVariablesResponses, PostHumanDesignVariablesErrors, ThrowOnError>({
|
|
1696
1730
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1697
1731
|
url: '/human-design/variables',
|
|
@@ -1710,7 +1744,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1710
1744
|
*
|
|
1711
1745
|
* 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.
|
|
1712
1746
|
*/
|
|
1713
|
-
public calculateLifePath<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyLifePathData, ThrowOnError>) {
|
|
1747
|
+
public calculateLifePath<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyLifePathData, ThrowOnError>): RequestResult<PostNumerologyLifePathResponses, PostNumerologyLifePathErrors, ThrowOnError> {
|
|
1714
1748
|
return (options?.client ?? this.client).post<PostNumerologyLifePathResponses, PostNumerologyLifePathErrors, ThrowOnError>({
|
|
1715
1749
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1716
1750
|
url: '/numerology/life-path',
|
|
@@ -1727,7 +1761,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1727
1761
|
*
|
|
1728
1762
|
* 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.
|
|
1729
1763
|
*/
|
|
1730
|
-
public calculateExpression<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyExpressionData, ThrowOnError>) {
|
|
1764
|
+
public calculateExpression<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyExpressionData, ThrowOnError>): RequestResult<PostNumerologyExpressionResponses, PostNumerologyExpressionErrors, ThrowOnError> {
|
|
1731
1765
|
return (options?.client ?? this.client).post<PostNumerologyExpressionResponses, PostNumerologyExpressionErrors, ThrowOnError>({
|
|
1732
1766
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1733
1767
|
url: '/numerology/expression',
|
|
@@ -1744,7 +1778,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1744
1778
|
*
|
|
1745
1779
|
* Calculate three Bridge Numbers that reveal the adjustments needed to create harmony between different aspects of your numerology profile. Bridge Numbers are the absolute difference between pairs of core numbers: Life Path and Expression, Expression and Personality, Expression and Soul Urge. A Bridge of 0 means the two aspects are already aligned. Higher bridges (1 to 8) indicate greater tension and provide specific guidance on what changes to make. Bridge Numbers are essential for personal development, coaching applications, self-improvement platforms, and AI-powered personality analysis tools. Requires both a full birth name and birth date to calculate all four core numbers (Life Path, Expression, Soul Urge, Personality) internally before deriving the bridges.
|
|
1746
1780
|
*/
|
|
1747
|
-
public calculateBridgeNumbers<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBridgeData, ThrowOnError>) {
|
|
1781
|
+
public calculateBridgeNumbers<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBridgeData, ThrowOnError>): RequestResult<PostNumerologyBridgeResponses, PostNumerologyBridgeErrors, ThrowOnError> {
|
|
1748
1782
|
return (options?.client ?? this.client).post<PostNumerologyBridgeResponses, PostNumerologyBridgeErrors, ThrowOnError>({
|
|
1749
1783
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1750
1784
|
url: '/numerology/bridge',
|
|
@@ -1761,7 +1795,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1761
1795
|
*
|
|
1762
1796
|
* 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.
|
|
1763
1797
|
*/
|
|
1764
|
-
public calculateSoulUrge<ThrowOnError extends boolean = false>(options?: Options<PostNumerologySoulUrgeData, ThrowOnError>) {
|
|
1798
|
+
public calculateSoulUrge<ThrowOnError extends boolean = false>(options?: Options<PostNumerologySoulUrgeData, ThrowOnError>): RequestResult<PostNumerologySoulUrgeResponses, PostNumerologySoulUrgeErrors, ThrowOnError> {
|
|
1765
1799
|
return (options?.client ?? this.client).post<PostNumerologySoulUrgeResponses, PostNumerologySoulUrgeErrors, ThrowOnError>({
|
|
1766
1800
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1767
1801
|
url: '/numerology/soul-urge',
|
|
@@ -1778,7 +1812,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1778
1812
|
*
|
|
1779
1813
|
* 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.
|
|
1780
1814
|
*/
|
|
1781
|
-
public calculatePersonality<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalityData, ThrowOnError>) {
|
|
1815
|
+
public calculatePersonality<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalityData, ThrowOnError>): RequestResult<PostNumerologyPersonalityResponses, PostNumerologyPersonalityErrors, ThrowOnError> {
|
|
1782
1816
|
return (options?.client ?? this.client).post<PostNumerologyPersonalityResponses, PostNumerologyPersonalityErrors, ThrowOnError>({
|
|
1783
1817
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1784
1818
|
url: '/numerology/personality',
|
|
@@ -1795,7 +1829,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1795
1829
|
*
|
|
1796
1830
|
* 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.
|
|
1797
1831
|
*/
|
|
1798
|
-
public calculateBirthDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBirthDayData, ThrowOnError>) {
|
|
1832
|
+
public calculateBirthDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBirthDayData, ThrowOnError>): RequestResult<PostNumerologyBirthDayResponses, PostNumerologyBirthDayErrors, ThrowOnError> {
|
|
1799
1833
|
return (options?.client ?? this.client).post<PostNumerologyBirthDayResponses, PostNumerologyBirthDayErrors, ThrowOnError>({
|
|
1800
1834
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1801
1835
|
url: '/numerology/birth-day',
|
|
@@ -1812,7 +1846,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1812
1846
|
*
|
|
1813
1847
|
* 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.
|
|
1814
1848
|
*/
|
|
1815
|
-
public calculateMaturity<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyMaturityData, ThrowOnError>) {
|
|
1849
|
+
public calculateMaturity<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyMaturityData, ThrowOnError>): RequestResult<PostNumerologyMaturityResponses, PostNumerologyMaturityErrors, ThrowOnError> {
|
|
1816
1850
|
return (options?.client ?? this.client).post<PostNumerologyMaturityResponses, PostNumerologyMaturityErrors, ThrowOnError>({
|
|
1817
1851
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1818
1852
|
url: '/numerology/maturity',
|
|
@@ -1829,7 +1863,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1829
1863
|
*
|
|
1830
1864
|
* 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.
|
|
1831
1865
|
*/
|
|
1832
|
-
public analyzeKarmicLessons<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicLessonsData, ThrowOnError>) {
|
|
1866
|
+
public analyzeKarmicLessons<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicLessonsData, ThrowOnError>): RequestResult<PostNumerologyKarmicLessonsResponses, PostNumerologyKarmicLessonsErrors, ThrowOnError> {
|
|
1833
1867
|
return (options?.client ?? this.client).post<PostNumerologyKarmicLessonsResponses, PostNumerologyKarmicLessonsErrors, ThrowOnError>({
|
|
1834
1868
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1835
1869
|
url: '/numerology/karmic-lessons',
|
|
@@ -1846,7 +1880,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1846
1880
|
*
|
|
1847
1881
|
* 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.
|
|
1848
1882
|
*/
|
|
1849
|
-
public checkKarmicDebt<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicDebtData, ThrowOnError>) {
|
|
1883
|
+
public checkKarmicDebt<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicDebtData, ThrowOnError>): RequestResult<PostNumerologyKarmicDebtResponses, PostNumerologyKarmicDebtErrors, ThrowOnError> {
|
|
1850
1884
|
return (options?.client ?? this.client).post<PostNumerologyKarmicDebtResponses, PostNumerologyKarmicDebtErrors, ThrowOnError>({
|
|
1851
1885
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1852
1886
|
url: '/numerology/karmic-debt',
|
|
@@ -1863,7 +1897,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1863
1897
|
*
|
|
1864
1898
|
* Calculate your Personal Day number from birth month, day, and a target date. Personal Day is the most granular cycle in Pythagorean numerology, revealing the specific energy and theme for a single calendar day personalized to you. Unlike generic daily numbers, this is based on YOUR birth data combined with the calendar date. Returns the daily theme, actionable guidance, and parent month and year context. Perfect for daily push notifications, morning briefings, calendar widget integrations, daily content generation, and life coaching tools.
|
|
1865
1899
|
*/
|
|
1866
|
-
public calculatePersonalDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalDayData, ThrowOnError>) {
|
|
1900
|
+
public calculatePersonalDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalDayData, ThrowOnError>): RequestResult<PostNumerologyPersonalDayResponses, PostNumerologyPersonalDayErrors, ThrowOnError> {
|
|
1867
1901
|
return (options?.client ?? this.client).post<PostNumerologyPersonalDayResponses, PostNumerologyPersonalDayErrors, ThrowOnError>({
|
|
1868
1902
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1869
1903
|
url: '/numerology/personal-day',
|
|
@@ -1880,7 +1914,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1880
1914
|
*
|
|
1881
1915
|
* Calculate your Personal Month number from birth month, day, and a target year and month. Personal Month reveals the specific theme and energy influencing each calendar month within your Personal Year cycle. Returns the monthly theme, practical focus guidance, and the parent Personal Year context. Perfect for monthly forecast features, push notification content, calendar integrations, editorial monthly columns, and life coaching tools.
|
|
1882
1916
|
*/
|
|
1883
|
-
public calculatePersonalMonth<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalMonthData, ThrowOnError>) {
|
|
1917
|
+
public calculatePersonalMonth<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalMonthData, ThrowOnError>): RequestResult<PostNumerologyPersonalMonthResponses, PostNumerologyPersonalMonthErrors, ThrowOnError> {
|
|
1884
1918
|
return (options?.client ?? this.client).post<PostNumerologyPersonalMonthResponses, PostNumerologyPersonalMonthErrors, ThrowOnError>({
|
|
1885
1919
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1886
1920
|
url: '/numerology/personal-month',
|
|
@@ -1897,7 +1931,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1897
1931
|
*
|
|
1898
1932
|
* 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.
|
|
1899
1933
|
*/
|
|
1900
|
-
public calculatePersonalYear<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalYearData, ThrowOnError>) {
|
|
1934
|
+
public calculatePersonalYear<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalYearData, ThrowOnError>): RequestResult<PostNumerologyPersonalYearResponses, PostNumerologyPersonalYearErrors, ThrowOnError> {
|
|
1901
1935
|
return (options?.client ?? this.client).post<PostNumerologyPersonalYearResponses, PostNumerologyPersonalYearErrors, ThrowOnError>({
|
|
1902
1936
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1903
1937
|
url: '/numerology/personal-year',
|
|
@@ -1914,7 +1948,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1914
1948
|
*
|
|
1915
1949
|
* Calculate numerology compatibility between two people using Pythagorean numerology. Accepts two input modes per person: pre-calculated Life Path, Expression, and Soul Urge numbers, or raw name and birthdate for automatic calculation. You can mix modes across persons (e.g. numbers for person1, raw inputs for person2). 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.
|
|
1916
1950
|
*/
|
|
1917
|
-
public calculateNumCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyCompatibilityData, ThrowOnError>) {
|
|
1951
|
+
public calculateNumCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyCompatibilityData, ThrowOnError>): RequestResult<PostNumerologyCompatibilityResponses, PostNumerologyCompatibilityErrors, ThrowOnError> {
|
|
1918
1952
|
return (options?.client ?? this.client).post<PostNumerologyCompatibilityResponses, PostNumerologyCompatibilityErrors, ThrowOnError>({
|
|
1919
1953
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1920
1954
|
url: '/numerology/compatibility',
|
|
@@ -1931,7 +1965,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1931
1965
|
*
|
|
1932
1966
|
* 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.
|
|
1933
1967
|
*/
|
|
1934
|
-
public generateNumerologyChart<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChartData, ThrowOnError>) {
|
|
1968
|
+
public generateNumerologyChart<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChartData, ThrowOnError>): RequestResult<PostNumerologyChartResponses, PostNumerologyChartErrors, ThrowOnError> {
|
|
1935
1969
|
return (options?.client ?? this.client).post<PostNumerologyChartResponses, PostNumerologyChartErrors, ThrowOnError>({
|
|
1936
1970
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1937
1971
|
url: '/numerology/chart',
|
|
@@ -1948,7 +1982,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1948
1982
|
*
|
|
1949
1983
|
* 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.
|
|
1950
1984
|
*/
|
|
1951
|
-
public getNumberMeaning<ThrowOnError extends boolean = false>(options: Options<GetNumerologyMeaningsByNumberData, ThrowOnError>) {
|
|
1985
|
+
public getNumberMeaning<ThrowOnError extends boolean = false>(options: Options<GetNumerologyMeaningsByNumberData, ThrowOnError>): RequestResult<GetNumerologyMeaningsByNumberResponses, GetNumerologyMeaningsByNumberErrors, ThrowOnError> {
|
|
1952
1986
|
return (options.client ?? this.client).get<GetNumerologyMeaningsByNumberResponses, GetNumerologyMeaningsByNumberErrors, ThrowOnError>({
|
|
1953
1987
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1954
1988
|
url: '/numerology/meanings/{number}',
|
|
@@ -1961,7 +1995,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1961
1995
|
*
|
|
1962
1996
|
* 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.
|
|
1963
1997
|
*/
|
|
1964
|
-
public getDailyNumber<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDailyData, ThrowOnError>) {
|
|
1998
|
+
public getDailyNumber<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDailyData, ThrowOnError>): RequestResult<PostNumerologyDailyResponses, PostNumerologyDailyErrors, ThrowOnError> {
|
|
1965
1999
|
return (options?.client ?? this.client).post<PostNumerologyDailyResponses, PostNumerologyDailyErrors, ThrowOnError>({
|
|
1966
2000
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1967
2001
|
url: '/numerology/daily',
|
|
@@ -1978,7 +2012,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1978
2012
|
*
|
|
1979
2013
|
* Calculate a complete Chaldean numerology reading for a name. The older Chaldean system maps letters to values 1 to 8 by vibration (the number 9 is sacred and never assigned to a letter) and reads the unreduced two-digit compound number (10 to 52, also called a fadic number, defined by Cheiro) in addition to the single-digit root. Returns the Destiny or name number from all letters, the Soul Urge from vowels, and the Personality from consonants, each with its compound number, root, and Cheiro compound interpretation, plus the planetary ruler of the Destiny root and a caution flag for the karmic numbers 4 and 8. Perfect for Chaldean numerology calculators, name analysis tools, and AI numerology assistants that need both the compound and root layers in one call.
|
|
1980
2014
|
*/
|
|
1981
|
-
public calculateChaldean<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChaldeanData, ThrowOnError>) {
|
|
2015
|
+
public calculateChaldean<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChaldeanData, ThrowOnError>): RequestResult<PostNumerologyChaldeanResponses, PostNumerologyChaldeanErrors, ThrowOnError> {
|
|
1982
2016
|
return (options?.client ?? this.client).post<PostNumerologyChaldeanResponses, PostNumerologyChaldeanErrors, ThrowOnError>({
|
|
1983
2017
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1984
2018
|
url: '/numerology/chaldean',
|
|
@@ -1995,7 +2029,7 @@ export class Numerology extends HeyApiClient {
|
|
|
1995
2029
|
*
|
|
1996
2030
|
* Get the classical Chaldean interpretation of a compound number (also called a fadic number) from 10 to 52, as defined by Cheiro in the Book of Numbers. Compound numbers are the unreduced two-digit numbers that reveal the hidden influence behind a name or date, beyond the single-digit root. Each returns its symbolic title (such as The Wheel of Fortune for 10, The Star of the Magi for 17, or The Crown of the Magi for 21), its nature (fortunate, unfortunate, or mixed), and a full interpretation. Numbers 33 to 52 share the meaning of a lower number in their series, returned with a sameAs pointer. Perfect for Chaldean numerology references, compound number lookups, and AI numerology tools.
|
|
1997
2031
|
*/
|
|
1998
|
-
public getCompoundNumber<ThrowOnError extends boolean = false>(options: Options<GetNumerologyCompoundNumberByNumberData, ThrowOnError>) {
|
|
2032
|
+
public getCompoundNumber<ThrowOnError extends boolean = false>(options: Options<GetNumerologyCompoundNumberByNumberData, ThrowOnError>): RequestResult<GetNumerologyCompoundNumberByNumberResponses, GetNumerologyCompoundNumberByNumberErrors, ThrowOnError> {
|
|
1999
2033
|
return (options.client ?? this.client).get<GetNumerologyCompoundNumberByNumberResponses, GetNumerologyCompoundNumberByNumberErrors, ThrowOnError>({
|
|
2000
2034
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2001
2035
|
url: '/numerology/compound-number/{number}',
|
|
@@ -2008,7 +2042,7 @@ export class Numerology extends HeyApiClient {
|
|
|
2008
2042
|
*
|
|
2009
2043
|
* Calculate a name number in both major numerology systems at once and compare them. The Pythagorean system maps letters 1 to 9 in alphabetical order and preserves master numbers (11, 22, 33), giving the Expression or Destiny number used in modern Western numerology. The Chaldean system maps letters 1 to 8 by vibration, reads the compound number (10 to 52), and reduces to a root 1 to 9. Returns both results with their interpretations, plus an agreement flag showing whether the two systems point to the same single-digit energy. The only numerology API that returns Pythagorean and Chaldean for a name in a single request, ideal for comparison tools and AI numerology assistants.
|
|
2010
2044
|
*/
|
|
2011
|
-
public calculateDual<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDualData, ThrowOnError>) {
|
|
2045
|
+
public calculateDual<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDualData, ThrowOnError>): RequestResult<PostNumerologyDualResponses, PostNumerologyDualErrors, ThrowOnError> {
|
|
2012
2046
|
return (options?.client ?? this.client).post<PostNumerologyDualResponses, PostNumerologyDualErrors, ThrowOnError>({
|
|
2013
2047
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2014
2048
|
url: '/numerology/dual',
|
|
@@ -2025,7 +2059,7 @@ export class Numerology extends HeyApiClient {
|
|
|
2025
2059
|
*
|
|
2026
2060
|
* Analyze a business or brand name with Chaldean numerology, the system practitioners use for trade names. Returns the name number (compound and root), its planetary ruler, an overall business rating, the industries the number favors, and whether the compound is one of Cheiro fortunate compounds. The most favorable business roots are 1 (leadership), 3 (expansion), 5 (commerce) and 6 (beauty and hospitality); the numbers 4 and 8 carry caution as the karmic numbers of instability and heavy demand. Use it to vet a company name, compare brand options, or guide a naming decision. This is positioning guidance layered over the fundamentals of a memorable, available name, not a guarantee.
|
|
2027
2061
|
*/
|
|
2028
|
-
public calculateBusinessName<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBusinessNameData, ThrowOnError>) {
|
|
2062
|
+
public calculateBusinessName<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBusinessNameData, ThrowOnError>): RequestResult<PostNumerologyBusinessNameResponses, PostNumerologyBusinessNameErrors, ThrowOnError> {
|
|
2029
2063
|
return (options?.client ?? this.client).post<PostNumerologyBusinessNameResponses, PostNumerologyBusinessNameErrors, ThrowOnError>({
|
|
2030
2064
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2031
2065
|
url: '/numerology/business-name',
|
|
@@ -2044,7 +2078,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2044
2078
|
*
|
|
2045
2079
|
* 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.
|
|
2046
2080
|
*/
|
|
2047
|
-
public listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>) {
|
|
2081
|
+
public listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>): RequestResult<GetTarotCardsResponses, GetTarotCardsErrors, ThrowOnError> {
|
|
2048
2082
|
return (options?.client ?? this.client).get<GetTarotCardsResponses, GetTarotCardsErrors, ThrowOnError>({
|
|
2049
2083
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2050
2084
|
url: '/tarot/cards',
|
|
@@ -2057,7 +2091,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2057
2091
|
*
|
|
2058
2092
|
* 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.
|
|
2059
2093
|
*/
|
|
2060
|
-
public getCard<ThrowOnError extends boolean = false>(options: Options<GetTarotCardsByIdData, ThrowOnError>) {
|
|
2094
|
+
public getCard<ThrowOnError extends boolean = false>(options: Options<GetTarotCardsByIdData, ThrowOnError>): RequestResult<GetTarotCardsByIdResponses, GetTarotCardsByIdErrors, ThrowOnError> {
|
|
2061
2095
|
return (options.client ?? this.client).get<GetTarotCardsByIdResponses, GetTarotCardsByIdErrors, ThrowOnError>({
|
|
2062
2096
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2063
2097
|
url: '/tarot/cards/{id}',
|
|
@@ -2070,7 +2104,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2070
2104
|
*
|
|
2071
2105
|
* 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).
|
|
2072
2106
|
*/
|
|
2073
|
-
public drawCards<ThrowOnError extends boolean = false>(options: Options<PostTarotDrawData, ThrowOnError>) {
|
|
2107
|
+
public drawCards<ThrowOnError extends boolean = false>(options: Options<PostTarotDrawData, ThrowOnError>): RequestResult<PostTarotDrawResponses, PostTarotDrawErrors, ThrowOnError> {
|
|
2074
2108
|
return (options.client ?? this.client).post<PostTarotDrawResponses, PostTarotDrawErrors, ThrowOnError>({
|
|
2075
2109
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2076
2110
|
url: '/tarot/draw',
|
|
@@ -2087,7 +2121,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2087
2121
|
*
|
|
2088
2122
|
* 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.
|
|
2089
2123
|
*/
|
|
2090
|
-
public getDailyCard<ThrowOnError extends boolean = false>(options?: Options<PostTarotDailyData, ThrowOnError>) {
|
|
2124
|
+
public getDailyCard<ThrowOnError extends boolean = false>(options?: Options<PostTarotDailyData, ThrowOnError>): RequestResult<PostTarotDailyResponses, PostTarotDailyErrors, ThrowOnError> {
|
|
2091
2125
|
return (options?.client ?? this.client).post<PostTarotDailyResponses, PostTarotDailyErrors, ThrowOnError>({
|
|
2092
2126
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2093
2127
|
url: '/tarot/daily',
|
|
@@ -2104,7 +2138,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2104
2138
|
*
|
|
2105
2139
|
* 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.
|
|
2106
2140
|
*/
|
|
2107
|
-
public castYesNo<ThrowOnError extends boolean = false>(options: Options<PostTarotYesNoData, ThrowOnError>) {
|
|
2141
|
+
public castYesNo<ThrowOnError extends boolean = false>(options: Options<PostTarotYesNoData, ThrowOnError>): RequestResult<PostTarotYesNoResponses, PostTarotYesNoErrors, ThrowOnError> {
|
|
2108
2142
|
return (options.client ?? this.client).post<PostTarotYesNoResponses, PostTarotYesNoErrors, ThrowOnError>({
|
|
2109
2143
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2110
2144
|
url: '/tarot/yes-no',
|
|
@@ -2121,7 +2155,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2121
2155
|
*
|
|
2122
2156
|
* 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.
|
|
2123
2157
|
*/
|
|
2124
|
-
public castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>) {
|
|
2158
|
+
public castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>): RequestResult<PostTarotSpreadsThreeCardResponses, PostTarotSpreadsThreeCardErrors, ThrowOnError> {
|
|
2125
2159
|
return (options.client ?? this.client).post<PostTarotSpreadsThreeCardResponses, PostTarotSpreadsThreeCardErrors, ThrowOnError>({
|
|
2126
2160
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2127
2161
|
url: '/tarot/spreads/three-card',
|
|
@@ -2138,7 +2172,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2138
2172
|
*
|
|
2139
2173
|
* 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.
|
|
2140
2174
|
*/
|
|
2141
|
-
public castCelticCross<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCelticCrossData, ThrowOnError>) {
|
|
2175
|
+
public castCelticCross<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCelticCrossData, ThrowOnError>): RequestResult<PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCelticCrossErrors, ThrowOnError> {
|
|
2142
2176
|
return (options.client ?? this.client).post<PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCelticCrossErrors, ThrowOnError>({
|
|
2143
2177
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2144
2178
|
url: '/tarot/spreads/celtic-cross',
|
|
@@ -2155,7 +2189,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2155
2189
|
*
|
|
2156
2190
|
* 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.
|
|
2157
2191
|
*/
|
|
2158
|
-
public castLoveSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsLoveData, ThrowOnError>) {
|
|
2192
|
+
public castLoveSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsLoveData, ThrowOnError>): RequestResult<PostTarotSpreadsLoveResponses, PostTarotSpreadsLoveErrors, ThrowOnError> {
|
|
2159
2193
|
return (options.client ?? this.client).post<PostTarotSpreadsLoveResponses, PostTarotSpreadsLoveErrors, ThrowOnError>({
|
|
2160
2194
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2161
2195
|
url: '/tarot/spreads/love',
|
|
@@ -2172,7 +2206,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2172
2206
|
*
|
|
2173
2207
|
* 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.
|
|
2174
2208
|
*/
|
|
2175
|
-
public castCareerSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCareerData, ThrowOnError>) {
|
|
2209
|
+
public castCareerSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCareerData, ThrowOnError>): RequestResult<PostTarotSpreadsCareerResponses, PostTarotSpreadsCareerErrors, ThrowOnError> {
|
|
2176
2210
|
return (options.client ?? this.client).post<PostTarotSpreadsCareerResponses, PostTarotSpreadsCareerErrors, ThrowOnError>({
|
|
2177
2211
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2178
2212
|
url: '/tarot/spreads/career',
|
|
@@ -2189,7 +2223,7 @@ export class Tarot extends HeyApiClient {
|
|
|
2189
2223
|
*
|
|
2190
2224
|
* 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.
|
|
2191
2225
|
*/
|
|
2192
|
-
public castCustomSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCustomData, ThrowOnError>) {
|
|
2226
|
+
public castCustomSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCustomData, ThrowOnError>): RequestResult<PostTarotSpreadsCustomResponses, PostTarotSpreadsCustomErrors, ThrowOnError> {
|
|
2193
2227
|
return (options.client ?? this.client).post<PostTarotSpreadsCustomResponses, PostTarotSpreadsCustomErrors, ThrowOnError>({
|
|
2194
2228
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2195
2229
|
url: '/tarot/spreads/custom',
|
|
@@ -2208,7 +2242,7 @@ export class Biorhythm extends HeyApiClient {
|
|
|
2208
2242
|
*
|
|
2209
2243
|
* Calculate a complete biorhythm reading for a given birth date and target date. Returns all 10 cycle values (physical, emotional, intellectual, intuitive, aesthetic, awareness, spiritual, passion, mastery, wisdom), phase detection with 8 distinct states, energy rating (1-10), overall phase assessment, editorial-grade interpretation, actionable advice, and critical day alerts. Perfect for wellness apps, dating platforms, productivity tools, and AI chatbot integrations that need structured biorhythm data.
|
|
2210
2244
|
*/
|
|
2211
|
-
public getReading<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmReadingData, ThrowOnError>) {
|
|
2245
|
+
public getReading<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmReadingData, ThrowOnError>): RequestResult<PostBiorhythmReadingResponses, PostBiorhythmReadingErrors, ThrowOnError> {
|
|
2212
2246
|
return (options?.client ?? this.client).post<PostBiorhythmReadingResponses, PostBiorhythmReadingErrors, ThrowOnError>({
|
|
2213
2247
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2214
2248
|
url: '/biorhythm/reading',
|
|
@@ -2225,7 +2259,7 @@ export class Biorhythm extends HeyApiClient {
|
|
|
2225
2259
|
*
|
|
2226
2260
|
* Generate a biorhythm forecast for a date range up to 90 days. Returns daily cycle values for physical, emotional, intellectual, and intuitive cycles, daily energy ratings, critical day identification, and a summary with best day, worst day, average energy, and period-level guidance. Ideal for wellness apps, productivity planners, scheduling tools, and calendar integrations that need forward-looking biorhythm data.
|
|
2227
2261
|
*/
|
|
2228
|
-
public getForecast<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmForecastData, ThrowOnError>) {
|
|
2262
|
+
public getForecast<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmForecastData, ThrowOnError>): RequestResult<PostBiorhythmForecastResponses, PostBiorhythmForecastErrors, ThrowOnError> {
|
|
2229
2263
|
return (options?.client ?? this.client).post<PostBiorhythmForecastResponses, PostBiorhythmForecastErrors, ThrowOnError>({
|
|
2230
2264
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2231
2265
|
url: '/biorhythm/forecast',
|
|
@@ -2242,7 +2276,7 @@ export class Biorhythm extends HeyApiClient {
|
|
|
2242
2276
|
*
|
|
2243
2277
|
* Find all critical days (zero crossings) within a date range up to 180 days. Returns each critical day with cycle name, period, direction (ascending or descending), severity (single, double, or triple), and advisory text. Highlights rare double critical days where two primary cycles cross zero simultaneously and extremely rare triple critical days where all three primary cycles cross zero on the same date. Ideal for calendar integrations, push notification systems, alert engines, and wellness scheduling tools.
|
|
2244
2278
|
*/
|
|
2245
|
-
public getCriticalDays<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCriticalDaysData, ThrowOnError>) {
|
|
2279
|
+
public getCriticalDays<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCriticalDaysData, ThrowOnError>): RequestResult<PostBiorhythmCriticalDaysResponses, PostBiorhythmCriticalDaysErrors, ThrowOnError> {
|
|
2246
2280
|
return (options?.client ?? this.client).post<PostBiorhythmCriticalDaysResponses, PostBiorhythmCriticalDaysErrors, ThrowOnError>({
|
|
2247
2281
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2248
2282
|
url: '/biorhythm/critical-days',
|
|
@@ -2259,7 +2293,7 @@ export class Biorhythm extends HeyApiClient {
|
|
|
2259
2293
|
*
|
|
2260
2294
|
* Calculate biorhythm compatibility between two people by overlaying their cycle profiles on a target date. Returns per-cycle alignment scores (0-100) for physical, emotional, and intellectual cycles, an overall compatibility score, relationship rating, strengths, challenges, practical advice, and a daily sync snapshot showing the absolute difference in each primary cycle. Perfect for dating apps, relationship platforms, team-building tools, and couples coaching applications.
|
|
2261
2295
|
*/
|
|
2262
|
-
public calculateBioCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCompatibilityData, ThrowOnError>) {
|
|
2296
|
+
public calculateBioCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCompatibilityData, ThrowOnError>): RequestResult<PostBiorhythmCompatibilityResponses, PostBiorhythmCompatibilityErrors, ThrowOnError> {
|
|
2263
2297
|
return (options?.client ?? this.client).post<PostBiorhythmCompatibilityResponses, PostBiorhythmCompatibilityErrors, ThrowOnError>({
|
|
2264
2298
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2265
2299
|
url: '/biorhythm/compatibility',
|
|
@@ -2276,7 +2310,7 @@ export class Biorhythm extends HeyApiClient {
|
|
|
2276
2310
|
*
|
|
2277
2311
|
* Get current phase information for all 10 biorhythm cycles without the full interpretation payload. Returns value, phase name, phase label, day position within cycle, cycle period, days until next critical crossing, and short-term trend for each cycle. Includes a compact summary string. Designed as a lightweight endpoint for dashboards, widgets, status bars, and quick-check interfaces that need biorhythm phase data without editorial text.
|
|
2278
2312
|
*/
|
|
2279
|
-
public getPhases<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmPhasesData, ThrowOnError>) {
|
|
2313
|
+
public getPhases<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmPhasesData, ThrowOnError>): RequestResult<PostBiorhythmPhasesResponses, PostBiorhythmPhasesErrors, ThrowOnError> {
|
|
2280
2314
|
return (options?.client ?? this.client).post<PostBiorhythmPhasesResponses, PostBiorhythmPhasesErrors, ThrowOnError>({
|
|
2281
2315
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2282
2316
|
url: '/biorhythm/phases',
|
|
@@ -2293,7 +2327,7 @@ export class Biorhythm extends HeyApiClient {
|
|
|
2293
2327
|
*
|
|
2294
2328
|
* Get a daily biorhythm reading with seeded randomness for consistent "biorhythm of the day" features. Same seed and same date always produce the same reading, perfect for daily push notifications, morning briefings, and wellness app check-ins. Returns energy rating, overall phase, a spotlight on one featured cycle, quick-read values for all three primary cycles, a daily message, and actionable advice. The spotlight cycle is deterministically selected by the seed, creating variety across users while maintaining consistency for each individual.
|
|
2295
2329
|
*/
|
|
2296
|
-
public getDailyBiorhythm<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmDailyData, ThrowOnError>) {
|
|
2330
|
+
public getDailyBiorhythm<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmDailyData, ThrowOnError>): RequestResult<PostBiorhythmDailyResponses, PostBiorhythmDailyErrors, ThrowOnError> {
|
|
2297
2331
|
return (options?.client ?? this.client).post<PostBiorhythmDailyResponses, PostBiorhythmDailyErrors, ThrowOnError>({
|
|
2298
2332
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2299
2333
|
url: '/biorhythm/daily',
|
|
@@ -2312,7 +2346,7 @@ export class Iching extends HeyApiClient {
|
|
|
2312
2346
|
*
|
|
2313
2347
|
* 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.
|
|
2314
2348
|
*/
|
|
2315
|
-
public getDailyHexagram<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyData, ThrowOnError>) {
|
|
2349
|
+
public getDailyHexagram<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyData, ThrowOnError>): RequestResult<PostIchingDailyResponses, PostIchingDailyErrors, ThrowOnError> {
|
|
2316
2350
|
return (options?.client ?? this.client).post<PostIchingDailyResponses, PostIchingDailyErrors, ThrowOnError>({
|
|
2317
2351
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2318
2352
|
url: '/iching/daily',
|
|
@@ -2329,7 +2363,7 @@ export class Iching extends HeyApiClient {
|
|
|
2329
2363
|
*
|
|
2330
2364
|
* 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.
|
|
2331
2365
|
*/
|
|
2332
|
-
public castDailyReading<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyCastData, ThrowOnError>) {
|
|
2366
|
+
public castDailyReading<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyCastData, ThrowOnError>): RequestResult<PostIchingDailyCastResponses, PostIchingDailyCastErrors, ThrowOnError> {
|
|
2333
2367
|
return (options?.client ?? this.client).post<PostIchingDailyCastResponses, PostIchingDailyCastErrors, ThrowOnError>({
|
|
2334
2368
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2335
2369
|
url: '/iching/daily/cast',
|
|
@@ -2346,7 +2380,7 @@ export class Iching extends HeyApiClient {
|
|
|
2346
2380
|
*
|
|
2347
2381
|
* 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.
|
|
2348
2382
|
*/
|
|
2349
|
-
public listHexagrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsData, ThrowOnError>) {
|
|
2383
|
+
public listHexagrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsData, ThrowOnError>): RequestResult<GetIchingHexagramsResponses, GetIchingHexagramsErrors, ThrowOnError> {
|
|
2350
2384
|
return (options?.client ?? this.client).get<GetIchingHexagramsResponses, GetIchingHexagramsErrors, ThrowOnError>({
|
|
2351
2385
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2352
2386
|
url: '/iching/hexagrams',
|
|
@@ -2359,7 +2393,7 @@ export class Iching extends HeyApiClient {
|
|
|
2359
2393
|
*
|
|
2360
2394
|
* 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.
|
|
2361
2395
|
*/
|
|
2362
|
-
public getRandomHexagram<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsRandomData, ThrowOnError>) {
|
|
2396
|
+
public getRandomHexagram<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsRandomData, ThrowOnError>): RequestResult<GetIchingHexagramsRandomResponses, GetIchingHexagramsRandomErrors, ThrowOnError> {
|
|
2363
2397
|
return (options?.client ?? this.client).get<GetIchingHexagramsRandomResponses, GetIchingHexagramsRandomErrors, ThrowOnError>({
|
|
2364
2398
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2365
2399
|
url: '/iching/hexagrams/random',
|
|
@@ -2372,7 +2406,7 @@ export class Iching extends HeyApiClient {
|
|
|
2372
2406
|
*
|
|
2373
2407
|
* 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).
|
|
2374
2408
|
*/
|
|
2375
|
-
public lookupHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsLookupData, ThrowOnError>) {
|
|
2409
|
+
public lookupHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsLookupData, ThrowOnError>): RequestResult<GetIchingHexagramsLookupResponses, GetIchingHexagramsLookupErrors, ThrowOnError> {
|
|
2376
2410
|
return (options.client ?? this.client).get<GetIchingHexagramsLookupResponses, GetIchingHexagramsLookupErrors, ThrowOnError>({
|
|
2377
2411
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2378
2412
|
url: '/iching/hexagrams/lookup',
|
|
@@ -2385,7 +2419,7 @@ export class Iching extends HeyApiClient {
|
|
|
2385
2419
|
*
|
|
2386
2420
|
* 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.
|
|
2387
2421
|
*/
|
|
2388
|
-
public getHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsByNumberData, ThrowOnError>) {
|
|
2422
|
+
public getHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsByNumberData, ThrowOnError>): RequestResult<GetIchingHexagramsByNumberResponses, GetIchingHexagramsByNumberErrors, ThrowOnError> {
|
|
2389
2423
|
return (options.client ?? this.client).get<GetIchingHexagramsByNumberResponses, GetIchingHexagramsByNumberErrors, ThrowOnError>({
|
|
2390
2424
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2391
2425
|
url: '/iching/hexagrams/{number}',
|
|
@@ -2398,7 +2432,7 @@ export class Iching extends HeyApiClient {
|
|
|
2398
2432
|
*
|
|
2399
2433
|
* 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.
|
|
2400
2434
|
*/
|
|
2401
|
-
public castReading<ThrowOnError extends boolean = false>(options?: Options<GetIchingCastData, ThrowOnError>) {
|
|
2435
|
+
public castReading<ThrowOnError extends boolean = false>(options?: Options<GetIchingCastData, ThrowOnError>): RequestResult<GetIchingCastResponses, GetIchingCastErrors, ThrowOnError> {
|
|
2402
2436
|
return (options?.client ?? this.client).get<GetIchingCastResponses, GetIchingCastErrors, ThrowOnError>({
|
|
2403
2437
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2404
2438
|
url: '/iching/cast',
|
|
@@ -2411,7 +2445,7 @@ export class Iching extends HeyApiClient {
|
|
|
2411
2445
|
*
|
|
2412
2446
|
* 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.
|
|
2413
2447
|
*/
|
|
2414
|
-
public listTrigrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingTrigramsData, ThrowOnError>) {
|
|
2448
|
+
public listTrigrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingTrigramsData, ThrowOnError>): RequestResult<GetIchingTrigramsResponses, GetIchingTrigramsErrors, ThrowOnError> {
|
|
2415
2449
|
return (options?.client ?? this.client).get<GetIchingTrigramsResponses, GetIchingTrigramsErrors, ThrowOnError>({
|
|
2416
2450
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2417
2451
|
url: '/iching/trigrams',
|
|
@@ -2424,7 +2458,7 @@ export class Iching extends HeyApiClient {
|
|
|
2424
2458
|
*
|
|
2425
2459
|
* 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.
|
|
2426
2460
|
*/
|
|
2427
|
-
public getTrigram<ThrowOnError extends boolean = false>(options: Options<GetIchingTrigramsByIdData, ThrowOnError>) {
|
|
2461
|
+
public getTrigram<ThrowOnError extends boolean = false>(options: Options<GetIchingTrigramsByIdData, ThrowOnError>): RequestResult<GetIchingTrigramsByIdResponses, GetIchingTrigramsByIdErrors, ThrowOnError> {
|
|
2428
2462
|
return (options.client ?? this.client).get<GetIchingTrigramsByIdResponses, GetIchingTrigramsByIdErrors, ThrowOnError>({
|
|
2429
2463
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2430
2464
|
url: '/iching/trigrams/{id}',
|
|
@@ -2439,7 +2473,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2439
2473
|
*
|
|
2440
2474
|
* Get healing crystals and gemstones associated with a specific zodiac sign. Returns summary data for each crystal. Use the /crystals/:id 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.
|
|
2441
2475
|
*/
|
|
2442
|
-
public getCrystalsByZodiac<ThrowOnError extends boolean = false>(options: Options<GetCrystalsZodiacBySignData, ThrowOnError>) {
|
|
2476
|
+
public getCrystalsByZodiac<ThrowOnError extends boolean = false>(options: Options<GetCrystalsZodiacBySignData, ThrowOnError>): RequestResult<GetCrystalsZodiacBySignResponses, GetCrystalsZodiacBySignErrors, ThrowOnError> {
|
|
2443
2477
|
return (options.client ?? this.client).get<GetCrystalsZodiacBySignResponses, GetCrystalsZodiacBySignErrors, ThrowOnError>({
|
|
2444
2478
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2445
2479
|
url: '/crystals/zodiac/{sign}',
|
|
@@ -2452,7 +2486,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2452
2486
|
*
|
|
2453
2487
|
* Get healing crystals and gemstones that resonate with a specific chakra energy center. Returns summary data for each crystal. Use the /crystals/:id 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.
|
|
2454
2488
|
*/
|
|
2455
|
-
public getCrystalsByChakra<ThrowOnError extends boolean = false>(options: Options<GetCrystalsChakraByChakraData, ThrowOnError>) {
|
|
2489
|
+
public getCrystalsByChakra<ThrowOnError extends boolean = false>(options: Options<GetCrystalsChakraByChakraData, ThrowOnError>): RequestResult<GetCrystalsChakraByChakraResponses, GetCrystalsChakraByChakraErrors, ThrowOnError> {
|
|
2456
2490
|
return (options.client ?? this.client).get<GetCrystalsChakraByChakraResponses, GetCrystalsChakraByChakraErrors, ThrowOnError>({
|
|
2457
2491
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2458
2492
|
url: '/crystals/chakra/{chakra}',
|
|
@@ -2465,7 +2499,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2465
2499
|
*
|
|
2466
2500
|
* Get healing crystals and gemstones associated with a specific natural element. Returns summary data for each crystal. Use the /crystals/:id 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.
|
|
2467
2501
|
*/
|
|
2468
|
-
public getCrystalsByElement<ThrowOnError extends boolean = false>(options: Options<GetCrystalsElementByElementData, ThrowOnError>) {
|
|
2502
|
+
public getCrystalsByElement<ThrowOnError extends boolean = false>(options: Options<GetCrystalsElementByElementData, ThrowOnError>): RequestResult<GetCrystalsElementByElementResponses, GetCrystalsElementByElementErrors, ThrowOnError> {
|
|
2469
2503
|
return (options.client ?? this.client).get<GetCrystalsElementByElementResponses, GetCrystalsElementByElementErrors, ThrowOnError>({
|
|
2470
2504
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2471
2505
|
url: '/crystals/element/{element}',
|
|
@@ -2478,7 +2512,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2478
2512
|
*
|
|
2479
2513
|
* Get the traditional birthstone crystals for a given birth month. Returns summary data for each crystal. Use the /crystals/:id detail endpoint for full healing properties. Based on GIA-authoritative birthstone assignments. Perfect for birthday gift recommendations, personalized crystal suggestions, and birthstone jewelry applications.
|
|
2480
2514
|
*/
|
|
2481
|
-
public getBirthstones<ThrowOnError extends boolean = false>(options: Options<GetCrystalsBirthstoneByMonthData, ThrowOnError>) {
|
|
2515
|
+
public getBirthstones<ThrowOnError extends boolean = false>(options: Options<GetCrystalsBirthstoneByMonthData, ThrowOnError>): RequestResult<GetCrystalsBirthstoneByMonthResponses, GetCrystalsBirthstoneByMonthErrors, ThrowOnError> {
|
|
2482
2516
|
return (options.client ?? this.client).get<GetCrystalsBirthstoneByMonthResponses, GetCrystalsBirthstoneByMonthErrors, ThrowOnError>({
|
|
2483
2517
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2484
2518
|
url: '/crystals/birthstone/{month}',
|
|
@@ -2491,7 +2525,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2491
2525
|
*
|
|
2492
2526
|
* 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/:id detail endpoint for full healing properties. Useful for building crystal search bars, keyword-based recommendation features, and healing property lookups.
|
|
2493
2527
|
*/
|
|
2494
|
-
public searchCrystals<ThrowOnError extends boolean = false>(options: Options<GetCrystalsSearchData, ThrowOnError>) {
|
|
2528
|
+
public searchCrystals<ThrowOnError extends boolean = false>(options: Options<GetCrystalsSearchData, ThrowOnError>): RequestResult<GetCrystalsSearchResponses, GetCrystalsSearchErrors, ThrowOnError> {
|
|
2495
2529
|
return (options.client ?? this.client).get<GetCrystalsSearchResponses, GetCrystalsSearchErrors, ThrowOnError>({
|
|
2496
2530
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2497
2531
|
url: '/crystals/search',
|
|
@@ -2504,7 +2538,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2504
2538
|
*
|
|
2505
2539
|
* 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.
|
|
2506
2540
|
*/
|
|
2507
|
-
public getCrystalPairings<ThrowOnError extends boolean = false>(options: Options<GetCrystalsPairingsByIdData, ThrowOnError>) {
|
|
2541
|
+
public getCrystalPairings<ThrowOnError extends boolean = false>(options: Options<GetCrystalsPairingsByIdData, ThrowOnError>): RequestResult<GetCrystalsPairingsByIdResponses, GetCrystalsPairingsByIdErrors, ThrowOnError> {
|
|
2508
2542
|
return (options.client ?? this.client).get<GetCrystalsPairingsByIdResponses, GetCrystalsPairingsByIdErrors, ThrowOnError>({
|
|
2509
2543
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2510
2544
|
url: '/crystals/pairings/{id}',
|
|
@@ -2517,7 +2551,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2517
2551
|
*
|
|
2518
2552
|
* 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/:id detail endpoint for complete spiritual, emotional, and physical healing properties. Perfect for daily guidance features, push notifications, wellness app widgets, and crystal journal integrations.
|
|
2519
2553
|
*/
|
|
2520
|
-
public getDailyCrystal<ThrowOnError extends boolean = false>(options?: Options<PostCrystalsDailyData, ThrowOnError>) {
|
|
2554
|
+
public getDailyCrystal<ThrowOnError extends boolean = false>(options?: Options<PostCrystalsDailyData, ThrowOnError>): RequestResult<PostCrystalsDailyResponses, PostCrystalsDailyErrors, ThrowOnError> {
|
|
2521
2555
|
return (options?.client ?? this.client).post<PostCrystalsDailyResponses, PostCrystalsDailyErrors, ThrowOnError>({
|
|
2522
2556
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2523
2557
|
url: '/crystals/daily',
|
|
@@ -2534,7 +2568,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2534
2568
|
*
|
|
2535
2569
|
* Get a randomly selected healing crystal as a discovery teaser. Returns a different crystal on each request (non-deterministic). Use the /crystals/:id 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.
|
|
2536
2570
|
*/
|
|
2537
|
-
public getRandomCrystal<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsRandomData, ThrowOnError>) {
|
|
2571
|
+
public getRandomCrystal<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsRandomData, ThrowOnError>): RequestResult<GetCrystalsRandomResponses, GetCrystalsRandomErrors, ThrowOnError> {
|
|
2538
2572
|
return (options?.client ?? this.client).get<GetCrystalsRandomResponses, GetCrystalsRandomErrors, ThrowOnError>({
|
|
2539
2573
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2540
2574
|
url: '/crystals/random',
|
|
@@ -2547,7 +2581,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2547
2581
|
*
|
|
2548
2582
|
* 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.
|
|
2549
2583
|
*/
|
|
2550
|
-
public listCrystalColors<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsColorsData, ThrowOnError>) {
|
|
2584
|
+
public listCrystalColors<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsColorsData, ThrowOnError>): RequestResult<GetCrystalsColorsResponses, GetCrystalsColorsErrors, ThrowOnError> {
|
|
2551
2585
|
return (options?.client ?? this.client).get<GetCrystalsColorsResponses, GetCrystalsColorsErrors, ThrowOnError>({
|
|
2552
2586
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2553
2587
|
url: '/crystals/colors',
|
|
@@ -2560,7 +2594,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2560
2594
|
*
|
|
2561
2595
|
* 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.
|
|
2562
2596
|
*/
|
|
2563
|
-
public listCrystalPlanets<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsPlanetsData, ThrowOnError>) {
|
|
2597
|
+
public listCrystalPlanets<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsPlanetsData, ThrowOnError>): RequestResult<GetCrystalsPlanetsResponses, GetCrystalsPlanetsErrors, ThrowOnError> {
|
|
2564
2598
|
return (options?.client ?? this.client).get<GetCrystalsPlanetsResponses, GetCrystalsPlanetsErrors, ThrowOnError>({
|
|
2565
2599
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2566
2600
|
url: '/crystals/planets',
|
|
@@ -2573,7 +2607,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2573
2607
|
*
|
|
2574
2608
|
* 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.
|
|
2575
2609
|
*/
|
|
2576
|
-
public listCrystals<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsData, ThrowOnError>) {
|
|
2610
|
+
public listCrystals<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsData, ThrowOnError>): RequestResult<GetCrystalsResponses, GetCrystalsErrors, ThrowOnError> {
|
|
2577
2611
|
return (options?.client ?? this.client).get<GetCrystalsResponses, GetCrystalsErrors, ThrowOnError>({
|
|
2578
2612
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2579
2613
|
url: '/crystals',
|
|
@@ -2586,7 +2620,7 @@ export class Crystals extends HeyApiClient {
|
|
|
2586
2620
|
*
|
|
2587
2621
|
* 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.
|
|
2588
2622
|
*/
|
|
2589
|
-
public getCrystal<ThrowOnError extends boolean = false>(options: Options<GetCrystalsByIdData, ThrowOnError>) {
|
|
2623
|
+
public getCrystal<ThrowOnError extends boolean = false>(options: Options<GetCrystalsByIdData, ThrowOnError>): RequestResult<GetCrystalsByIdResponses, GetCrystalsByIdErrors, ThrowOnError> {
|
|
2590
2624
|
return (options.client ?? this.client).get<GetCrystalsByIdResponses, GetCrystalsByIdErrors, ThrowOnError>({
|
|
2591
2625
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2592
2626
|
url: '/crystals/{id}',
|
|
@@ -2601,7 +2635,7 @@ export class Dreams extends HeyApiClient {
|
|
|
2601
2635
|
*
|
|
2602
2636
|
* 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.
|
|
2603
2637
|
*/
|
|
2604
|
-
public searchDreamSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsData, ThrowOnError>) {
|
|
2638
|
+
public searchDreamSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsData, ThrowOnError>): RequestResult<GetDreamsSymbolsResponses, GetDreamsSymbolsErrors, ThrowOnError> {
|
|
2605
2639
|
return (options?.client ?? this.client).get<GetDreamsSymbolsResponses, GetDreamsSymbolsErrors, ThrowOnError>({
|
|
2606
2640
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2607
2641
|
url: '/dreams/symbols',
|
|
@@ -2614,7 +2648,7 @@ export class Dreams extends HeyApiClient {
|
|
|
2614
2648
|
*
|
|
2615
2649
|
* 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.
|
|
2616
2650
|
*/
|
|
2617
|
-
public getRandomSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsRandomData, ThrowOnError>) {
|
|
2651
|
+
public getRandomSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsRandomData, ThrowOnError>): RequestResult<GetDreamsSymbolsRandomResponses, GetDreamsSymbolsRandomErrors, ThrowOnError> {
|
|
2618
2652
|
return (options?.client ?? this.client).get<GetDreamsSymbolsRandomResponses, GetDreamsSymbolsRandomErrors, ThrowOnError>({
|
|
2619
2653
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2620
2654
|
url: '/dreams/symbols/random',
|
|
@@ -2627,7 +2661,7 @@ export class Dreams extends HeyApiClient {
|
|
|
2627
2661
|
*
|
|
2628
2662
|
* 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.
|
|
2629
2663
|
*/
|
|
2630
|
-
public getSymbolLetterCounts<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsLettersData, ThrowOnError>) {
|
|
2664
|
+
public getSymbolLetterCounts<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsLettersData, ThrowOnError>): RequestResult<GetDreamsSymbolsLettersResponses, GetDreamsSymbolsLettersErrors, ThrowOnError> {
|
|
2631
2665
|
return (options?.client ?? this.client).get<GetDreamsSymbolsLettersResponses, GetDreamsSymbolsLettersErrors, ThrowOnError>({
|
|
2632
2666
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2633
2667
|
url: '/dreams/symbols/letters',
|
|
@@ -2640,7 +2674,7 @@ export class Dreams extends HeyApiClient {
|
|
|
2640
2674
|
*
|
|
2641
2675
|
* 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.
|
|
2642
2676
|
*/
|
|
2643
|
-
public getDreamSymbol<ThrowOnError extends boolean = false>(options: Options<GetDreamsSymbolsByIdData, ThrowOnError>) {
|
|
2677
|
+
public getDreamSymbol<ThrowOnError extends boolean = false>(options: Options<GetDreamsSymbolsByIdData, ThrowOnError>): RequestResult<GetDreamsSymbolsByIdResponses, GetDreamsSymbolsByIdErrors, ThrowOnError> {
|
|
2644
2678
|
return (options.client ?? this.client).get<GetDreamsSymbolsByIdResponses, GetDreamsSymbolsByIdErrors, ThrowOnError>({
|
|
2645
2679
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2646
2680
|
url: '/dreams/symbols/{id}',
|
|
@@ -2653,7 +2687,7 @@ export class Dreams extends HeyApiClient {
|
|
|
2653
2687
|
*
|
|
2654
2688
|
* 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.
|
|
2655
2689
|
*/
|
|
2656
|
-
public getDailyDreamSymbol<ThrowOnError extends boolean = false>(options?: Options<PostDreamsDailyData, ThrowOnError>) {
|
|
2690
|
+
public getDailyDreamSymbol<ThrowOnError extends boolean = false>(options?: Options<PostDreamsDailyData, ThrowOnError>): RequestResult<PostDreamsDailyResponses, PostDreamsDailyErrors, ThrowOnError> {
|
|
2657
2691
|
return (options?.client ?? this.client).post<PostDreamsDailyResponses, PostDreamsDailyErrors, ThrowOnError>({
|
|
2658
2692
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2659
2693
|
url: '/dreams/daily',
|
|
@@ -2672,7 +2706,7 @@ export class AngelNumbers extends HeyApiClient {
|
|
|
2672
2706
|
*
|
|
2673
2707
|
* Retrieve the complete database of angel numbers with summary information. Returns 75+ angel numbers covering root digits (0-9), master numbers (11, 22, 33), double digits (44-99), triple repeating (111-999), quad repeating (1111-9999), the mirror families (X0X like 101-909, X1X, four-digit mirrors like 1212-2121), palindromes (1221, 1331), compound sequences (911, 1122), and sequential numbers (123, 1234). Supports optional type filtering. Perfect for building angel number explorer apps, reference guides, and spiritual databases.
|
|
2674
2708
|
*/
|
|
2675
|
-
public listAngelNumbers<ThrowOnError extends boolean = false>(options?: Options<GetAngelNumbersNumbersData, ThrowOnError>) {
|
|
2709
|
+
public listAngelNumbers<ThrowOnError extends boolean = false>(options?: Options<GetAngelNumbersNumbersData, ThrowOnError>): RequestResult<GetAngelNumbersNumbersResponses, GetAngelNumbersNumbersErrors, ThrowOnError> {
|
|
2676
2710
|
return (options?.client ?? this.client).get<GetAngelNumbersNumbersResponses, GetAngelNumbersNumbersErrors, ThrowOnError>({
|
|
2677
2711
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2678
2712
|
url: '/angel-numbers/numbers',
|
|
@@ -2685,7 +2719,7 @@ export class AngelNumbers extends HeyApiClient {
|
|
|
2685
2719
|
*
|
|
2686
2720
|
* Get the complete, authoritative meaning and interpretation for a specific angel number. Returns detailed spiritual, love, career, money, and twin flame interpretations, plus a biblical perspective and a shadow reading, along with keywords, affirmation, and actionable steps. Covers 75+ 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.
|
|
2687
2721
|
*/
|
|
2688
|
-
public getAngelNumber<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersNumbersByNumberData, ThrowOnError>) {
|
|
2722
|
+
public getAngelNumber<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersNumbersByNumberData, ThrowOnError>): RequestResult<GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersByNumberErrors, ThrowOnError> {
|
|
2689
2723
|
return (options.client ?? this.client).get<GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersByNumberErrors, ThrowOnError>({
|
|
2690
2724
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2691
2725
|
url: '/angel-numbers/numbers/{number}',
|
|
@@ -2698,7 +2732,7 @@ export class AngelNumbers extends HeyApiClient {
|
|
|
2698
2732
|
*
|
|
2699
2733
|
* 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, compound), calculates the numerology digit root, checks the database for a known meaning, and provides the foundational digit root interpretation (with full spiritual, love, career, money, and twin flame guidance) as a fallback. An optional context parameter adds a note tailored to where the number was seen. Perfect for synchronicity tracking apps where users enter arbitrary number sequences they encounter.
|
|
2700
2734
|
*/
|
|
2701
|
-
public analyzeNumberSequence<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersLookupData, ThrowOnError>) {
|
|
2735
|
+
public analyzeNumberSequence<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersLookupData, ThrowOnError>): RequestResult<GetAngelNumbersLookupResponses, GetAngelNumbersLookupErrors, ThrowOnError> {
|
|
2702
2736
|
return (options.client ?? this.client).get<GetAngelNumbersLookupResponses, GetAngelNumbersLookupErrors, ThrowOnError>({
|
|
2703
2737
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2704
2738
|
url: '/angel-numbers/lookup',
|
|
@@ -2711,7 +2745,7 @@ export class AngelNumbers extends HeyApiClient {
|
|
|
2711
2745
|
*
|
|
2712
2746
|
* 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, money, and twin flame interpretations plus a biblical perspective and a shadow reading. Perfect for daily guidance features, push notifications, content generation, and angel number widget integrations.
|
|
2713
2747
|
*/
|
|
2714
|
-
public getDailyAngelNumber<ThrowOnError extends boolean = false>(options?: Options<PostAngelNumbersDailyData, ThrowOnError>) {
|
|
2748
|
+
public getDailyAngelNumber<ThrowOnError extends boolean = false>(options?: Options<PostAngelNumbersDailyData, ThrowOnError>): RequestResult<PostAngelNumbersDailyResponses, PostAngelNumbersDailyErrors, ThrowOnError> {
|
|
2715
2749
|
return (options?.client ?? this.client).post<PostAngelNumbersDailyResponses, PostAngelNumbersDailyErrors, ThrowOnError>({
|
|
2716
2750
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2717
2751
|
url: '/angel-numbers/daily',
|
|
@@ -2730,7 +2764,7 @@ export class Location extends HeyApiClient {
|
|
|
2730
2764
|
*
|
|
2731
2765
|
* City autocomplete and geocoding search across 23,000+ locations in 240+ countries, including deep coverage of Indian tier-2 and tier-3 cities. Returns geographic coordinates (latitude, longitude), IANA timezone, and DST-aware UTC offset for each match. Built for birth chart location pickers, horoscope apps, event scheduling, and any feature requiring place-to-coordinates resolution. Partial name matching with intelligent ranking: exact prefix matches first, then sorted by population for relevance. Common alternate names like Bombay, Calcutta, Madras, and Banaras transparently resolve to their canonical entries.
|
|
2732
2766
|
*/
|
|
2733
|
-
public searchCities<ThrowOnError extends boolean = false>(options: Options<GetLocationSearchData, ThrowOnError>) {
|
|
2767
|
+
public searchCities<ThrowOnError extends boolean = false>(options: Options<GetLocationSearchData, ThrowOnError>): RequestResult<GetLocationSearchResponses, GetLocationSearchErrors, ThrowOnError> {
|
|
2734
2768
|
return (options.client ?? this.client).get<GetLocationSearchResponses, GetLocationSearchErrors, ThrowOnError>({
|
|
2735
2769
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2736
2770
|
url: '/location/search',
|
|
@@ -2743,7 +2777,7 @@ export class Location extends HeyApiClient {
|
|
|
2743
2777
|
*
|
|
2744
2778
|
* Returns every country with ISO 3166-1 alpha-2 and alpha-3 codes, plus the number of searchable cities per country. Use this endpoint to build country dropdown menus, regional filters, or to check city coverage before querying. Sorted alphabetically by country name. Covers Europe, Americas, Asia, Middle East, Africa, and Oceania.
|
|
2745
2779
|
*/
|
|
2746
|
-
public listCountries<ThrowOnError extends boolean = false>(options?: Options<GetLocationCountriesData, ThrowOnError>) {
|
|
2780
|
+
public listCountries<ThrowOnError extends boolean = false>(options?: Options<GetLocationCountriesData, ThrowOnError>): RequestResult<GetLocationCountriesResponses, GetLocationCountriesErrors, ThrowOnError> {
|
|
2747
2781
|
return (options?.client ?? this.client).get<GetLocationCountriesResponses, GetLocationCountriesErrors, ThrowOnError>({
|
|
2748
2782
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2749
2783
|
url: '/location/countries',
|
|
@@ -2756,7 +2790,7 @@ export class Location extends HeyApiClient {
|
|
|
2756
2790
|
*
|
|
2757
2791
|
* 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.
|
|
2758
2792
|
*/
|
|
2759
|
-
public getCitiesByCountry<ThrowOnError extends boolean = false>(options: Options<GetLocationCountriesByIso2Data, ThrowOnError>) {
|
|
2793
|
+
public getCitiesByCountry<ThrowOnError extends boolean = false>(options: Options<GetLocationCountriesByIso2Data, ThrowOnError>): RequestResult<GetLocationCountriesByIso2Responses, GetLocationCountriesByIso2Errors, ThrowOnError> {
|
|
2760
2794
|
return (options.client ?? this.client).get<GetLocationCountriesByIso2Responses, GetLocationCountriesByIso2Errors, ThrowOnError>({
|
|
2761
2795
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2762
2796
|
url: '/location/countries/{iso2}',
|
|
@@ -2771,7 +2805,7 @@ export class Usage extends HeyApiClient {
|
|
|
2771
2805
|
*
|
|
2772
2806
|
* Returns current usage and plan limits for your subscription.
|
|
2773
2807
|
*/
|
|
2774
|
-
public getUsageStats<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) {
|
|
2808
|
+
public getUsageStats<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError> {
|
|
2775
2809
|
return (options?.client ?? this.client).get<GetUsageResponses, GetUsageErrors, ThrowOnError>({
|
|
2776
2810
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2777
2811
|
url: '/usage',
|
|
@@ -2786,7 +2820,7 @@ export class Languages extends HeyApiClient {
|
|
|
2786
2820
|
*
|
|
2787
2821
|
* Returns the language codes accepted by the `lang` query parameter on every i18n-aware endpoint. Use this to populate language pickers, validate user input before calling chart or reading endpoints, or auto-detect available locales in agent integrations. Codes follow ISO 639-1. Endpoints without a translation for the requested language fall back to English silently.
|
|
2788
2822
|
*/
|
|
2789
|
-
public listLanguages<ThrowOnError extends boolean = false>(options?: Options<GetLanguagesData, ThrowOnError>) {
|
|
2823
|
+
public listLanguages<ThrowOnError extends boolean = false>(options?: Options<GetLanguagesData, ThrowOnError>): RequestResult<GetLanguagesResponses, GetLanguagesErrors, ThrowOnError> {
|
|
2790
2824
|
return (options?.client ?? this.client).get<GetLanguagesResponses, GetLanguagesErrors, ThrowOnError>({
|
|
2791
2825
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2792
2826
|
url: '/languages',
|
|
@@ -2796,7 +2830,7 @@ export class Languages extends HeyApiClient {
|
|
|
2796
2830
|
}
|
|
2797
2831
|
|
|
2798
2832
|
export class Roxy extends HeyApiClient {
|
|
2799
|
-
public static readonly __registry = new HeyApiRegistry<Roxy>();
|
|
2833
|
+
public static readonly __registry: HeyApiRegistry<Roxy> = new HeyApiRegistry<Roxy>();
|
|
2800
2834
|
|
|
2801
2835
|
constructor(args?: {
|
|
2802
2836
|
client?: Client;
|