@roxyapi/sdk 1.2.69 → 1.2.70
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +2 -0
- package/README.md +2 -0
- package/dist/factory.cjs +394 -10
- package/dist/factory.js +392 -10
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +180 -10
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +8554 -351
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +204 -1
- package/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/sdk.gen.ts +419 -10
- package/src/types.gen.ts +8689 -351
- package/src/version.ts +1 -1
package/AGENTS.md
CHANGED
|
@@ -45,6 +45,8 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
45
45
|
| `roxy.vedicAstrology` | Vedic astrology (Jyotish) and KP API for kundli generation with 15 divisional charts (D1-D60), Ashtakoot Gun Milan ku... |
|
|
46
46
|
| `roxy.forecast` | Forecast API that merges upcoming transit aspects, sign ingresses, retrograde stations, new and full moons, biorhythm... |
|
|
47
47
|
| `roxy.humanDesign` | Generate the full Human Design bodygraph from a birth moment: type, strategy, inner authority, profile, definition, i... |
|
|
48
|
+
| `roxy.chineseAstrology` | Calculate BaZi Four Pillars charts, Chinese zodiac signs, and the Chinese lunisolar calendar from any birth moment: y... |
|
|
49
|
+
| `roxy.fengShui` | Compute classical feng shui from one API: Xuan Kong flying star natal charts for any of the nine periods and 24 mount... |
|
|
48
50
|
| `roxy.numerology` | Numerology API to calculate life path, expression, soul urge, personality, and maturity numbers, with Pinnacle and Ch... |
|
|
49
51
|
| `roxy.tarot` | Tarot reading API with the complete 78-card Rider-Waite-Smith deck and card meanings for love, career, health, and sp... |
|
|
50
52
|
| `roxy.biorhythm` | The most complete biorhythm API: 10 cycle types across 3 primary (physical, emotional, intellectual), 4 secondary (in... |
|
package/README.md
CHANGED
|
@@ -89,6 +89,8 @@ const { latitude, longitude, timezone } = data.cities[0];
|
|
|
89
89
|
| `roxy.vedicAstrology` | Vedic astrology (Jyotish) and KP API for kundli generation with 15 divisional charts (D1-D60), Ashtakoot Gun Milan ku... |
|
|
90
90
|
| `roxy.forecast` | Forecast API that merges upcoming transit aspects, sign ingresses, retrograde stations, new and full moons, biorhythm... |
|
|
91
91
|
| `roxy.humanDesign` | Generate the full Human Design bodygraph from a birth moment: type, strategy, inner authority, profile, definition, i... |
|
|
92
|
+
| `roxy.chineseAstrology` | Calculate BaZi Four Pillars charts, Chinese zodiac signs, and the Chinese lunisolar calendar from any birth moment: y... |
|
|
93
|
+
| `roxy.fengShui` | Compute classical feng shui from one API: Xuan Kong flying star natal charts for any of the nine periods and 24 mount... |
|
|
92
94
|
| `roxy.numerology` | Numerology API to calculate life path, expression, soul urge, personality, and maturity numbers, with Pinnacle and Ch... |
|
|
93
95
|
| `roxy.tarot` | Tarot reading API with the complete 78-card Rider-Waite-Smith deck and card meanings for love, career, health, and sp... |
|
|
94
96
|
| `roxy.biorhythm` | The most complete biorhythm API: 10 cycle types across 3 primary (physical, emotional, intellectual), 4 secondary (in... |
|
package/dist/factory.cjs
CHANGED
|
@@ -23,8 +23,10 @@ __export(factory_exports, {
|
|
|
23
23
|
AngelNumbers: () => AngelNumbers,
|
|
24
24
|
Astrology: () => Astrology,
|
|
25
25
|
Biorhythm: () => Biorhythm,
|
|
26
|
+
ChineseAstrology: () => ChineseAstrology,
|
|
26
27
|
Crystals: () => Crystals,
|
|
27
28
|
Dreams: () => Dreams,
|
|
29
|
+
FengShui: () => FengShui,
|
|
28
30
|
Forecast: () => Forecast,
|
|
29
31
|
HumanDesign: () => HumanDesign,
|
|
30
32
|
Iching: () => Iching,
|
|
@@ -1122,7 +1124,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
1122
1124
|
/**
|
|
1123
1125
|
* Transit Aspects - Detailed transit-to-natal aspect analysis with interpretations
|
|
1124
1126
|
*
|
|
1125
|
-
* 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
|
|
1127
|
+
* 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, adding AI-friendly interpretation fields. Transit aspects API, transit-to-natal analysis, predictive astrology, personalized transit forecast.
|
|
1126
1128
|
*/
|
|
1127
1129
|
calculateTransitAspects(options) {
|
|
1128
1130
|
return (options?.client ?? this.client).post({
|
|
@@ -2558,6 +2560,378 @@ var HumanDesign = class extends HeyApiClient {
|
|
|
2558
2560
|
});
|
|
2559
2561
|
}
|
|
2560
2562
|
};
|
|
2563
|
+
var ChineseAstrology = class extends HeyApiClient {
|
|
2564
|
+
/**
|
|
2565
|
+
* Generate BaZi chart - Four Pillars of Destiny calculator API
|
|
2566
|
+
*
|
|
2567
|
+
* Calculate a complete BaZi chart, the Four Pillars of Destiny, from a birth moment. Returns the year, month, day and hour pillars with every Heavenly Stem and Earthly Branch, the stems hidden inside each branch, the Ten God relation each one holds to the Day Master, the Na Yin sound element of each pair, the five-element balance across the chart, and the combinations and clashes running between the pillars. The day boundary, year boundary and hour clock are all selectable and the applied conventions come back on every response, so a chart is self-describing. Built for astrology apps, matchmaking services, and agents that need a Four Pillars reading they can reproduce.
|
|
2568
|
+
*/
|
|
2569
|
+
generateBaziChart(options) {
|
|
2570
|
+
return (options?.client ?? this.client).post({
|
|
2571
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2572
|
+
url: "/chinese-astrology/bazi/chart",
|
|
2573
|
+
...options,
|
|
2574
|
+
headers: {
|
|
2575
|
+
"Content-Type": "application/json",
|
|
2576
|
+
...options?.headers
|
|
2577
|
+
}
|
|
2578
|
+
});
|
|
2579
|
+
}
|
|
2580
|
+
/**
|
|
2581
|
+
* Calculate luck pillars - BaZi Da Yun ten-year cycle API
|
|
2582
|
+
*
|
|
2583
|
+
* Calculate the da yun luck pillars, the ten-year periods a BaZi chart walks through after birth. Returns the direction the sequence runs, the age it begins at with the day count behind that age, each ten-year pillar with the Ten God relation its stem holds to the natal Day Master, and an optional year-by-year annual overlay. Direction follows the classical rule: a male born in a yang-stem year and a female born in a yin-stem year run forward through the sexagenary cycle, the other two combinations run backward. Built for astrology apps, life-timing features, and agents that need a reproducible forecast spine.
|
|
2584
|
+
*/
|
|
2585
|
+
calculateLuckPillars(options) {
|
|
2586
|
+
return (options?.client ?? this.client).post({
|
|
2587
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2588
|
+
url: "/chinese-astrology/bazi/luck-pillars",
|
|
2589
|
+
...options,
|
|
2590
|
+
headers: {
|
|
2591
|
+
"Content-Type": "application/json",
|
|
2592
|
+
...options?.headers
|
|
2593
|
+
}
|
|
2594
|
+
});
|
|
2595
|
+
}
|
|
2596
|
+
/**
|
|
2597
|
+
* Calculate Day Master strength - BaZi favorable element API
|
|
2598
|
+
*
|
|
2599
|
+
* Assess how well the Day Master is supported by the rest of a BaZi chart, and which of the five elements help it. Uses the classical three-factor method: whether the birth month season backs the Day Master element, whether any branch stores a root for it, and whether the other stems help or spend it. Returns the verdict, an auditable score with each factor contribution, the seasonal state, the root count, the element headcount, and the favorable and unfavorable element lists that follow from the verdict. Built for chart readers, remedy features, and agents that need the usable half of a Four Pillars reading.
|
|
2600
|
+
*/
|
|
2601
|
+
calculateDayMasterStrength(options) {
|
|
2602
|
+
return (options?.client ?? this.client).post({
|
|
2603
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2604
|
+
url: "/chinese-astrology/bazi/day-master",
|
|
2605
|
+
...options,
|
|
2606
|
+
headers: {
|
|
2607
|
+
"Content-Type": "application/json",
|
|
2608
|
+
...options?.headers
|
|
2609
|
+
}
|
|
2610
|
+
});
|
|
2611
|
+
}
|
|
2612
|
+
/**
|
|
2613
|
+
* Calculate BaZi compatibility - Four Pillars matchmaking API
|
|
2614
|
+
*
|
|
2615
|
+
* Compare two BaZi charts pillar by pillar. Returns both resolved charts, how the two Day Masters stand to each other on the five-phase cycle, and every combination, clash, harm and punishment that crosses between them, each naming the two positions it joins. A tallied score summarises the balance and the interaction list behind it is returned in full, so a caller that disagrees with the weighting can recompute its own. Built for matchmaking products, relationship features, and agents that need a defensible two-chart reading.
|
|
2616
|
+
*/
|
|
2617
|
+
calculateBaziCompatibility(options) {
|
|
2618
|
+
return (options?.client ?? this.client).post({
|
|
2619
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2620
|
+
url: "/chinese-astrology/bazi/compatibility",
|
|
2621
|
+
...options,
|
|
2622
|
+
headers: {
|
|
2623
|
+
"Content-Type": "application/json",
|
|
2624
|
+
...options?.headers
|
|
2625
|
+
}
|
|
2626
|
+
});
|
|
2627
|
+
}
|
|
2628
|
+
/**
|
|
2629
|
+
* Calculate BaZi annual forecast - Liu Nian yearly pillar API
|
|
2630
|
+
*
|
|
2631
|
+
* Read one Gregorian year against a natal BaZi chart. Returns the annual pillar for that year, the Ten God relation its stem holds to the natal Day Master, the same reading for the hidden stem of its branch, how the annual branch stands to the natal year branch including the ben ming nian return of the birth animal, and every combination, clash, harm and punishment the annual pillar forms with each of the four natal pillars. Built for yearly horoscope features, timing tools, and agents that need a year read against a specific chart rather than against an animal sign.
|
|
2632
|
+
*/
|
|
2633
|
+
calculateAnnualForecast(options) {
|
|
2634
|
+
return (options?.client ?? this.client).post({
|
|
2635
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2636
|
+
url: "/chinese-astrology/bazi/annual-forecast",
|
|
2637
|
+
...options,
|
|
2638
|
+
headers: {
|
|
2639
|
+
"Content-Type": "application/json",
|
|
2640
|
+
...options?.headers
|
|
2641
|
+
}
|
|
2642
|
+
});
|
|
2643
|
+
}
|
|
2644
|
+
/**
|
|
2645
|
+
* List the 12 Chinese zodiac animals - Sheng Xiao sign catalogue
|
|
2646
|
+
*
|
|
2647
|
+
* Retrieve all twelve Chinese zodiac animals in cycle order, from Rat through Pig. Each entry returns the machine id, the Chinese character and tone-marked pinyin for the animal, its Earthly Branch, the fixed Five Element phase and yin or yang polarity of that branch, and a set of trait keywords. Built for sign pickers, zodiac cards and compatibility widgets that need the whole set in one call.
|
|
2648
|
+
*/
|
|
2649
|
+
listZodiacAnimals(options) {
|
|
2650
|
+
return (options?.client ?? this.client).get({
|
|
2651
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2652
|
+
url: "/chinese-astrology/zodiac/animals",
|
|
2653
|
+
...options
|
|
2654
|
+
});
|
|
2655
|
+
}
|
|
2656
|
+
/**
|
|
2657
|
+
* Get one Chinese zodiac animal - Full sign profile with compatibility partners
|
|
2658
|
+
*
|
|
2659
|
+
* Retrieve the complete profile of one Chinese zodiac animal: character summary, strengths, weaknesses, trait keywords, the double-hour its Earthly Branch governs, and its five element variants with the Gregorian years that carry each one. Also returns the four classical branch relationships, the three-harmony trine it belongs to, its six-harmony secret friend, its clashing opposite and its harming partner. Built for sign detail pages and compatibility features.
|
|
2660
|
+
*/
|
|
2661
|
+
getZodiacAnimal(options) {
|
|
2662
|
+
return (options.client ?? this.client).get({
|
|
2663
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2664
|
+
url: "/chinese-astrology/zodiac/animals/{id}",
|
|
2665
|
+
...options
|
|
2666
|
+
});
|
|
2667
|
+
}
|
|
2668
|
+
/**
|
|
2669
|
+
* Find the Chinese zodiac animal for a birth date - Sheng Xiao calculator
|
|
2670
|
+
*
|
|
2671
|
+
* Resolve a birth date to its Chinese zodiac animal, the sexagenary year pillar behind it, and the Five Element phase of that year, so a 1990 birth returns Horse as a Metal Horse rather than merely a Horse. The year boundary is a request parameter because the two schools genuinely disagree for dates in January and early February, and the resolved convention is echoed back so the answer is self-describing. Built for sign lookups, onboarding forms and birthday features.
|
|
2672
|
+
*/
|
|
2673
|
+
calculateZodiacAnimal(options) {
|
|
2674
|
+
return (options.client ?? this.client).post({
|
|
2675
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2676
|
+
url: "/chinese-astrology/zodiac/sign",
|
|
2677
|
+
...options,
|
|
2678
|
+
headers: {
|
|
2679
|
+
"Content-Type": "application/json",
|
|
2680
|
+
...options.headers
|
|
2681
|
+
}
|
|
2682
|
+
});
|
|
2683
|
+
}
|
|
2684
|
+
/**
|
|
2685
|
+
* Chinese zodiac compatibility - Trine, six harmony, clash and harm analysis
|
|
2686
|
+
*
|
|
2687
|
+
* Score and explain the relationship between two Chinese zodiac animals from the classical branch relations rather than from a lookup table of opinions. Returns which of the six relations the pair stands in, a score out of 100, the phase the two branches combine into where they combine at all, and a composed reading with strengths, frictions and advice. The six relations are mutually exclusive by construction, so exactly one applies to any pair. Built for matchmaking features, relationship reports and compatibility widgets.
|
|
2688
|
+
*/
|
|
2689
|
+
getZodiacCompatibility(options) {
|
|
2690
|
+
return (options.client ?? this.client).get({
|
|
2691
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2692
|
+
url: "/chinese-astrology/zodiac/compatibility/{sign1}/{sign2}",
|
|
2693
|
+
...options
|
|
2694
|
+
});
|
|
2695
|
+
}
|
|
2696
|
+
/**
|
|
2697
|
+
* Daily Chinese zodiac reading - Day pillar forecast by animal sign
|
|
2698
|
+
*
|
|
2699
|
+
* Get the daily reading for one Chinese zodiac animal, built from the sexagenary day pillar rather than from a rotation of stock text. The day carries its own Earthly Branch, that branch stands in exactly one of six classical relations to the requested sign, and the reading is that relation applied to the sign temperament. Returns the day pillar, the relation, an energy rating, overview, love and career guidance, advice, and the sexagenary year in force with its Ben Ming Nian flag. Content is fixed for a given date and rolls over at midnight, by default UTC.
|
|
2700
|
+
*/
|
|
2701
|
+
getDailyZodiacReading(options) {
|
|
2702
|
+
return (options.client ?? this.client).get({
|
|
2703
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2704
|
+
url: "/chinese-astrology/zodiac/{id}/daily",
|
|
2705
|
+
...options
|
|
2706
|
+
});
|
|
2707
|
+
}
|
|
2708
|
+
/**
|
|
2709
|
+
* List the 24 solar terms - Jie Qi calendar API with exact instants
|
|
2710
|
+
*
|
|
2711
|
+
* Return all 24 solar terms of a year as astronomical instants rather than dates, each computed from the moment the sun reaches its exact apparent longitude at 15 degree steps. The year is the SOLAR year, which opens at Li Chun in early February, so Minor Cold and Major Cold, the last two terms, are dated in the January of the following Gregorian year. Every instant is returned twice, once in UTC and once at the UTC+8 reference meridian the Chinese calendar is defined on. Built for calendar apps, festival scheduling, and any BaZi feature that has to place a birth on the correct side of a term boundary.
|
|
2712
|
+
*/
|
|
2713
|
+
listSolarTerms(options) {
|
|
2714
|
+
return (options.client ?? this.client).get({
|
|
2715
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2716
|
+
url: "/chinese-astrology/calendar/solar-terms/{year}",
|
|
2717
|
+
...options
|
|
2718
|
+
});
|
|
2719
|
+
}
|
|
2720
|
+
/**
|
|
2721
|
+
* Convert lunar and Gregorian dates - Chinese lunisolar calendar API
|
|
2722
|
+
*
|
|
2723
|
+
* Convert a Gregorian date to the Chinese lunisolar calendar or convert a lunar date back, in one endpoint. The calendar is computed at the UTC+8 reference meridian with the month containing the winter solstice fixed as month 11 and the leap month placed as the first month of the cycle carrying no major solar term, so a lunar date is the same worldwide rather than shifting with the caller timezone. The response reports the length of the lunar month, whether the date sits in a leap month, and which month the year doubles if any. Built for festival calendars, birthday features that follow the lunar date, and any app that has to survive a leap month without shifting every date after it.
|
|
2724
|
+
*/
|
|
2725
|
+
calculateLunarDate(options) {
|
|
2726
|
+
return (options?.client ?? this.client).post({
|
|
2727
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2728
|
+
url: "/chinese-astrology/calendar/lunar-date",
|
|
2729
|
+
...options,
|
|
2730
|
+
headers: {
|
|
2731
|
+
"Content-Type": "application/json",
|
|
2732
|
+
...options?.headers
|
|
2733
|
+
}
|
|
2734
|
+
});
|
|
2735
|
+
}
|
|
2736
|
+
/**
|
|
2737
|
+
* Get the almanac for a day - Tong Shu API with day officers and mansions
|
|
2738
|
+
*
|
|
2739
|
+
* Return the full almanac reading of one day: its lunisolar date, the year, month and day pillars with their Na Yin, the day officer from the twelve jian chu sequence, the lunar mansion on duty, the zodiac animal the day clashes with, and the activities the officer favours or opposes. The day officer is the layer a printed almanac reaches its verdict from first, and the response says exactly what it rules on rather than reducing the day to a single score. The year and month pillars here are attributed by whole days, which is what an almanac prints: the day a solar term falls on belongs to the new period for its whole length, however late in the day the term arrives. Built for date pickers, daily calendar widgets, and wedding or opening date tools.
|
|
2740
|
+
*/
|
|
2741
|
+
getAlmanacDay(options) {
|
|
2742
|
+
return (options.client ?? this.client).get({
|
|
2743
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2744
|
+
url: "/chinese-astrology/calendar/day/{date}",
|
|
2745
|
+
...options
|
|
2746
|
+
});
|
|
2747
|
+
}
|
|
2748
|
+
/**
|
|
2749
|
+
* Get a month of almanac days - Chinese calendar month view API
|
|
2750
|
+
*
|
|
2751
|
+
* Return every day of one Gregorian month with its lunisolar date, its three pillars, its day officer, its lunar mansion and its clash animal, plus the solar terms that fall inside the month. This is the month view a calendar widget renders in one call rather than thirty one. Omit the year and month to get the month in progress. Built for calendar UIs, almanac pages, and planning tools that show a whole month at a glance.
|
|
2752
|
+
*/
|
|
2753
|
+
getMonthlyAlmanac(options) {
|
|
2754
|
+
return (options?.client ?? this.client).get({
|
|
2755
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2756
|
+
url: "/chinese-astrology/calendar/monthly",
|
|
2757
|
+
...options
|
|
2758
|
+
});
|
|
2759
|
+
}
|
|
2760
|
+
/**
|
|
2761
|
+
* Find auspicious days - Chinese date selection API for weddings and openings
|
|
2762
|
+
*
|
|
2763
|
+
* Search a date range for the days a chosen activity is favoured on, ranked by the jian chu day officer and filtered against a zodiac animal to protect. Every candidate day comes back with its officer, its pillars, its lunar date and the animal it clashes with, so a caller can show the reasoning rather than a bare verdict. The range is capped at 93 days, which is a quarter, because date selection is done inside a planning window rather than across a lifetime. Built for wedding planners, business opening tools, and moving and travel date pickers.
|
|
2764
|
+
*/
|
|
2765
|
+
lookupAuspiciousDays(options) {
|
|
2766
|
+
return (options.client ?? this.client).post({
|
|
2767
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2768
|
+
url: "/chinese-astrology/calendar/auspicious-days",
|
|
2769
|
+
...options,
|
|
2770
|
+
headers: {
|
|
2771
|
+
"Content-Type": "application/json",
|
|
2772
|
+
...options.headers
|
|
2773
|
+
}
|
|
2774
|
+
});
|
|
2775
|
+
}
|
|
2776
|
+
/**
|
|
2777
|
+
* List the five elements - Wu Xing API with generating and controlling cycles
|
|
2778
|
+
*
|
|
2779
|
+
* Return the five phases of Wu Xing with the Chinese character, the season and direction each governs, the Heavenly Stems and Earthly Branches that carry it, and both of the cycles that connect them. The generating cycle and the controlling cycle are returned as ordered rings as well as on each phase, so a caller can render either without deriving it. This is the one place the five phase vocabulary is defined: BaZi charts, Na Yin, zodiac element variants and every feng shui star reuse these identifiers rather than restating them.
|
|
2780
|
+
*/
|
|
2781
|
+
listFiveElements(options) {
|
|
2782
|
+
return (options?.client ?? this.client).get({
|
|
2783
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2784
|
+
url: "/chinese-astrology/elements",
|
|
2785
|
+
...options
|
|
2786
|
+
});
|
|
2787
|
+
}
|
|
2788
|
+
};
|
|
2789
|
+
var FengShui = class extends HeyApiClient {
|
|
2790
|
+
/**
|
|
2791
|
+
* Calculate Kua number - Feng shui personal direction calculator API
|
|
2792
|
+
*
|
|
2793
|
+
* Calculate the Kua number, also called the Ming Gua or life gua, from a birth date and sex. Returns the number, the east or west life group, the personal trigram, and all eight compass sectors classified from best to worst. The Chinese year is resolved at Li Chun by default, so an early February birthday is placed in the correct year rather than the calendar one, and the boundary that decided it is echoed back. Built for room and desk placement features, personalised feng shui reports, and any product that needs a favourable direction per person.
|
|
2794
|
+
*/
|
|
2795
|
+
calculateKuaNumber(options) {
|
|
2796
|
+
return (options?.client ?? this.client).post({
|
|
2797
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2798
|
+
url: "/feng-shui/kua",
|
|
2799
|
+
...options,
|
|
2800
|
+
headers: {
|
|
2801
|
+
"Content-Type": "application/json",
|
|
2802
|
+
...options?.headers
|
|
2803
|
+
}
|
|
2804
|
+
});
|
|
2805
|
+
}
|
|
2806
|
+
/**
|
|
2807
|
+
* Look up a Kua number - Eight Mansions reference API
|
|
2808
|
+
*
|
|
2809
|
+
* Look up the reference chart for one Kua number: its trigram, its east or west life group, and how it classifies all eight compass sectors. A pure reference endpoint with no birth data required, for building a lookup table or a picker. Number 5 is served for completeness and is never a computed result, because it belongs to the centre and has no direction of its own: a man whose formula gives 5 reads Kua 2 and a woman reads Kua 8, and the chart returned for 5 is therefore the Kua 2 chart.
|
|
2810
|
+
*/
|
|
2811
|
+
getKuaNumber(options) {
|
|
2812
|
+
return (options.client ?? this.client).get({
|
|
2813
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2814
|
+
url: "/feng-shui/kua/{number}",
|
|
2815
|
+
...options
|
|
2816
|
+
});
|
|
2817
|
+
}
|
|
2818
|
+
/**
|
|
2819
|
+
* Generate Eight Mansions map - Ba Zhai lucky direction API
|
|
2820
|
+
*
|
|
2821
|
+
* Build the full Eight Mansions (Ba Zhai) map for a person: all eight compass sectors classified into the four favourable stars, Sheng Chi, Tian Yi, Yan Nian and Fu Wei, and the four unfavourable ones, Huo Hai, Wu Gui, Liu Sha and Jue Ming. Sectors come back ordered best to worst with a composed reading each, plus the ranking that decides which affliction to accept when no favourable sector is reachable. Accepts a Kua number directly or derives one from a birth date and sex. Built for bed and desk placement tools, room-by-room reports and floor plan overlays.
|
|
2822
|
+
*/
|
|
2823
|
+
generateEightMansions(options) {
|
|
2824
|
+
return (options?.client ?? this.client).post({
|
|
2825
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2826
|
+
url: "/feng-shui/eight-mansions",
|
|
2827
|
+
...options,
|
|
2828
|
+
headers: {
|
|
2829
|
+
"Content-Type": "application/json",
|
|
2830
|
+
...options?.headers
|
|
2831
|
+
}
|
|
2832
|
+
});
|
|
2833
|
+
}
|
|
2834
|
+
/**
|
|
2835
|
+
* Generate flying star natal chart - Xuan Kong Fei Xing API
|
|
2836
|
+
*
|
|
2837
|
+
* Cast the Xuan Kong flying star natal chart for a building from its construction period and the direction it faces. Returns all nine palaces with the period star, the mountain star that governs health and relationships and the water star that governs wealth, plus the named formation and a composed reading for every palace, and the classical verdict on how the two prosperous stars landed. Facing is accepted as one of the 24 mountains or as a compass bearing. Built for property analysis tools, floor plan overlays and consultation software.
|
|
2838
|
+
*/
|
|
2839
|
+
generateFlyingStarChart(options) {
|
|
2840
|
+
return (options?.client ?? this.client).post({
|
|
2841
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2842
|
+
url: "/feng-shui/flying-stars/natal",
|
|
2843
|
+
...options,
|
|
2844
|
+
headers: {
|
|
2845
|
+
"Content-Type": "application/json",
|
|
2846
|
+
...options?.headers
|
|
2847
|
+
}
|
|
2848
|
+
});
|
|
2849
|
+
}
|
|
2850
|
+
/**
|
|
2851
|
+
* Annual flying stars - Yearly feng shui star chart API
|
|
2852
|
+
*
|
|
2853
|
+
* Return the annual flying star plate for a solar year: which of the nine stars occupies each of the nine palaces, what it means there, and which element strengthens or drains it. The annual plate is universal and does not depend on any building, so it is the layer every yearly feng shui guide is built on. The changeover is Li Chun in early February rather than Lunar New Year, and the exact date is returned so a caller can apply the plate on the right day.
|
|
2854
|
+
*/
|
|
2855
|
+
getAnnualFlyingStars(options) {
|
|
2856
|
+
return (options.client ?? this.client).get({
|
|
2857
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2858
|
+
url: "/feng-shui/flying-stars/annual/{year}",
|
|
2859
|
+
...options
|
|
2860
|
+
});
|
|
2861
|
+
}
|
|
2862
|
+
/**
|
|
2863
|
+
* Monthly flying stars - Month by month feng shui overlay API
|
|
2864
|
+
*
|
|
2865
|
+
* Return the monthly flying star plate, the faster overlay that sits on top of the annual one. Months here are SOLAR months: month 1 begins at Li Chun in early February and each month begins at the next of the twelve major solar terms, so they never line up with calendar months. Omit both parameters to get the month in progress. Built for monthly guidance features and for timing work around an affliction that only lands for part of the year.
|
|
2866
|
+
*/
|
|
2867
|
+
getMonthlyFlyingStars(options) {
|
|
2868
|
+
return (options?.client ?? this.client).get({
|
|
2869
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2870
|
+
url: "/feng-shui/flying-stars/monthly",
|
|
2871
|
+
...options
|
|
2872
|
+
});
|
|
2873
|
+
}
|
|
2874
|
+
/**
|
|
2875
|
+
* List the nine flying stars - Xuan Kong star reference API
|
|
2876
|
+
*
|
|
2877
|
+
* The reference catalogue of the nine flying stars: name, Chinese characters, five phase, home palace and trigram, the period each rules, what each means, and which element strengthens or drains it. The remedy element is what the star itself produces, because a harmful star is drained by giving it somewhere to go rather than fought with the phase that controls it. A pure reference endpoint that needs no chart.
|
|
2878
|
+
*/
|
|
2879
|
+
listFlyingStars(options) {
|
|
2880
|
+
return (options?.client ?? this.client).get({
|
|
2881
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2882
|
+
url: "/feng-shui/flying-stars/stars",
|
|
2883
|
+
...options
|
|
2884
|
+
});
|
|
2885
|
+
}
|
|
2886
|
+
/**
|
|
2887
|
+
* Annual afflictions - Tai Sui, San Sha and Five Yellow API
|
|
2888
|
+
*
|
|
2889
|
+
* Return the four annual feng shui afflictions for a solar year with their exact positions: Tai Sui on the mountain of the year branch, Sui Po on the mountain opposite, the Three Killings across the cardinal span opposite the elemental frame of the year, and the Five Yellow wherever it lands on the annual star plate. Positions come with degree ranges rather than only sector names, because Tai Sui occupies 15 degrees and the neighbouring mountains of the same sector are unaffected. All four move at Li Chun in early February, not at Lunar New Year, and the changeover date is returned. Built for renovation planning, date selection and yearly guidance features.
|
|
2890
|
+
*/
|
|
2891
|
+
getAnnualAfflictions(options) {
|
|
2892
|
+
return (options.client ?? this.client).get({
|
|
2893
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2894
|
+
url: "/feng-shui/afflictions/{year}",
|
|
2895
|
+
...options
|
|
2896
|
+
});
|
|
2897
|
+
}
|
|
2898
|
+
/**
|
|
2899
|
+
* List Bagua sectors - Feng shui bagua map API
|
|
2900
|
+
*
|
|
2901
|
+
* The nine palaces of the compass Bagua map: the eight trigram sectors plus the centre, each with the life area it governs, its five phase, its colours, and both its Later Heaven and Earlier Heaven trigrams. This is the compass map aligned to true directions, so career is always North and wealth is always Southeast whichever way the entrance faces. Trigram details are served from the same source as the I-Ching trigram endpoints, so the two agree field for field. Built for floor plan overlays, room-by-room guides and any interface that maps a space onto life areas.
|
|
2902
|
+
*/
|
|
2903
|
+
listBaguaSectors(options) {
|
|
2904
|
+
return (options?.client ?? this.client).get({
|
|
2905
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2906
|
+
url: "/feng-shui/bagua",
|
|
2907
|
+
...options
|
|
2908
|
+
});
|
|
2909
|
+
}
|
|
2910
|
+
/**
|
|
2911
|
+
* Look up a Bagua sector - Life area reference API
|
|
2912
|
+
*
|
|
2913
|
+
* Look up one palace of the compass Bagua map by its life area id, such as wealth, career or love. Returns the compass sector it occupies, its five phase and colours, both trigram arrangements and what the sector governs. The health palace is the centre and carries no direction and no trigram, because the centre of the Lo Shu is not a trigram.
|
|
2914
|
+
*/
|
|
2915
|
+
getBaguaSector(options) {
|
|
2916
|
+
return (options.client ?? this.client).get({
|
|
2917
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2918
|
+
url: "/feng-shui/bagua/{id}",
|
|
2919
|
+
...options
|
|
2920
|
+
});
|
|
2921
|
+
}
|
|
2922
|
+
/**
|
|
2923
|
+
* List the nine periods - San Yuan period table API
|
|
2924
|
+
*
|
|
2925
|
+
* The nine twenty year periods of the 180 year San Yuan cycle from 1864 to 2043, each with its ruling star, five phase, palace and the exact Li Chun date it opened, plus which period is in force on a given date. A building takes the period it was completed in and keeps that period plate for life, so this is the table that decides which natal chart a property gets. Period 9 opened on 4 February 2024, which means a building finished in January 2024 is still a Period 8 building.
|
|
2926
|
+
*/
|
|
2927
|
+
listNinePeriods(options) {
|
|
2928
|
+
return (options?.client ?? this.client).get({
|
|
2929
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2930
|
+
url: "/feng-shui/periods",
|
|
2931
|
+
...options
|
|
2932
|
+
});
|
|
2933
|
+
}
|
|
2934
|
+
};
|
|
2561
2935
|
var Numerology = class extends HeyApiClient {
|
|
2562
2936
|
/**
|
|
2563
2937
|
* Calculate Life Path number - Most important numerology calculation
|
|
@@ -2876,7 +3250,7 @@ var Tarot = class extends HeyApiClient {
|
|
|
2876
3250
|
/**
|
|
2877
3251
|
* List all 78 tarot cards
|
|
2878
3252
|
*
|
|
2879
|
-
* 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
|
|
3253
|
+
* 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.
|
|
2880
3254
|
*/
|
|
2881
3255
|
listCards(options) {
|
|
2882
3256
|
return (options?.client ?? this.client).get({
|
|
@@ -3246,7 +3620,7 @@ var Crystals = class extends HeyApiClient {
|
|
|
3246
3620
|
/**
|
|
3247
3621
|
* Crystals by Zodiac Sign
|
|
3248
3622
|
*
|
|
3249
|
-
* Get healing crystals and gemstones associated with a specific zodiac sign. Returns summary data for each crystal. Use the /crystals
|
|
3623
|
+
* 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.
|
|
3250
3624
|
*/
|
|
3251
3625
|
getCrystalsByZodiac(options) {
|
|
3252
3626
|
return (options.client ?? this.client).get({
|
|
@@ -3258,7 +3632,7 @@ var Crystals = class extends HeyApiClient {
|
|
|
3258
3632
|
/**
|
|
3259
3633
|
* Crystals by Chakra
|
|
3260
3634
|
*
|
|
3261
|
-
* Get healing crystals and gemstones that resonate with a specific chakra energy center. Returns summary data for each crystal. Use the /crystals
|
|
3635
|
+
* 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.
|
|
3262
3636
|
*/
|
|
3263
3637
|
getCrystalsByChakra(options) {
|
|
3264
3638
|
return (options.client ?? this.client).get({
|
|
@@ -3270,7 +3644,7 @@ var Crystals = class extends HeyApiClient {
|
|
|
3270
3644
|
/**
|
|
3271
3645
|
* Crystals by Element
|
|
3272
3646
|
*
|
|
3273
|
-
* Get healing crystals and gemstones associated with a specific natural element. Returns summary data for each crystal. Use the /crystals
|
|
3647
|
+
* 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.
|
|
3274
3648
|
*/
|
|
3275
3649
|
getCrystalsByElement(options) {
|
|
3276
3650
|
return (options.client ?? this.client).get({
|
|
@@ -3282,7 +3656,7 @@ var Crystals = class extends HeyApiClient {
|
|
|
3282
3656
|
/**
|
|
3283
3657
|
* Birthstone Crystals by Month
|
|
3284
3658
|
*
|
|
3285
|
-
* Get the traditional birthstone crystals for a given birth month. Returns summary data for each crystal. Use the /crystals
|
|
3659
|
+
* 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.
|
|
3286
3660
|
*/
|
|
3287
3661
|
getBirthstones(options) {
|
|
3288
3662
|
return (options.client ?? this.client).get({
|
|
@@ -3294,7 +3668,7 @@ var Crystals = class extends HeyApiClient {
|
|
|
3294
3668
|
/**
|
|
3295
3669
|
* Search Crystals
|
|
3296
3670
|
*
|
|
3297
|
-
* 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
|
|
3671
|
+
* 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.
|
|
3298
3672
|
*/
|
|
3299
3673
|
searchCrystals(options) {
|
|
3300
3674
|
return (options.client ?? this.client).get({
|
|
@@ -3318,7 +3692,7 @@ var Crystals = class extends HeyApiClient {
|
|
|
3318
3692
|
/**
|
|
3319
3693
|
* Daily Crystal
|
|
3320
3694
|
*
|
|
3321
|
-
* 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
|
|
3695
|
+
* 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.
|
|
3322
3696
|
*/
|
|
3323
3697
|
getDailyCrystal(options) {
|
|
3324
3698
|
return (options?.client ?? this.client).post({
|
|
@@ -3334,7 +3708,7 @@ var Crystals = class extends HeyApiClient {
|
|
|
3334
3708
|
/**
|
|
3335
3709
|
* Random Crystal
|
|
3336
3710
|
*
|
|
3337
|
-
* Get a randomly selected healing crystal as a discovery teaser. Returns a different crystal on each request (non-deterministic). Use the /crystals
|
|
3711
|
+
* 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.
|
|
3338
3712
|
*/
|
|
3339
3713
|
getRandomCrystal(options) {
|
|
3340
3714
|
return (options?.client ?? this.client).get({
|
|
@@ -3590,6 +3964,14 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
3590
3964
|
get humanDesign() {
|
|
3591
3965
|
return this._humanDesign ??= new HumanDesign({ client: this.client });
|
|
3592
3966
|
}
|
|
3967
|
+
_chineseAstrology;
|
|
3968
|
+
get chineseAstrology() {
|
|
3969
|
+
return this._chineseAstrology ??= new ChineseAstrology({ client: this.client });
|
|
3970
|
+
}
|
|
3971
|
+
_fengShui;
|
|
3972
|
+
get fengShui() {
|
|
3973
|
+
return this._fengShui ??= new FengShui({ client: this.client });
|
|
3974
|
+
}
|
|
3593
3975
|
_numerology;
|
|
3594
3976
|
get numerology() {
|
|
3595
3977
|
return this._numerology ??= new Numerology({ client: this.client });
|
|
@@ -3629,7 +4011,7 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
3629
4011
|
};
|
|
3630
4012
|
|
|
3631
4013
|
// src/version.ts
|
|
3632
|
-
var VERSION = "1.2.
|
|
4014
|
+
var VERSION = "1.2.70";
|
|
3633
4015
|
|
|
3634
4016
|
// src/factory.ts
|
|
3635
4017
|
function createRoxy(auth) {
|
|
@@ -3649,8 +4031,10 @@ function createRoxy(auth) {
|
|
|
3649
4031
|
AngelNumbers,
|
|
3650
4032
|
Astrology,
|
|
3651
4033
|
Biorhythm,
|
|
4034
|
+
ChineseAstrology,
|
|
3652
4035
|
Crystals,
|
|
3653
4036
|
Dreams,
|
|
4037
|
+
FengShui,
|
|
3654
4038
|
Forecast,
|
|
3655
4039
|
HumanDesign,
|
|
3656
4040
|
Iching,
|