@roxyapi/sdk 1.2.66 → 1.2.68

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/src/types.gen.ts CHANGED
@@ -7030,7 +7030,7 @@ export type HeliacalRequest = {
7030
7030
 
7031
7031
  export type BasicCard = {
7032
7032
  /**
7033
- * Unique card identifier in kebab-case (e.g. fool, ace-of-cups, queen-of-swords).
7033
+ * Unique card identifier in kebab-case, with no leading article on Major Arcana (e.g. fool, star, ace-of-cups, queen-of-swords). This is the canonical form, whatever spelling was requested.
7034
7034
  */
7035
7035
  id: string;
7036
7036
  /**
@@ -7057,7 +7057,7 @@ export type BasicCard = {
7057
7057
 
7058
7058
  export type Card = {
7059
7059
  /**
7060
- * Unique card identifier in kebab-case (e.g. fool, ace-of-cups, queen-of-swords).
7060
+ * Unique card identifier in kebab-case, with no leading article on Major Arcana (e.g. fool, star, ace-of-cups, queen-of-swords). This is the canonical form, whatever spelling was requested.
7061
7061
  */
7062
7062
  id: string;
7063
7063
  /**
@@ -8174,7 +8174,7 @@ export type GetAstrologyPlanetMeaningsByIdData = {
8174
8174
  body?: never;
8175
8175
  path: {
8176
8176
  /**
8177
- * Planet ID (lowercase, e.g., sun, moon, mercury) or display name (case-insensitive, e.g., Sun, MOON).
8177
+ * Planet ID (lowercase, e.g., sun, moon, mercury) or display name (case-insensitive, e.g., Sun, MOON). Spaces, hyphens and underscores are interchangeable, so the two lunar nodes answer to north-node and south-node as well as to their ids north node and south node, and Black Moon Lilith answers to black-moon-lilith as well as to lilith.
8178
8178
  */
8179
8179
  id: string;
8180
8180
  };
@@ -9685,9 +9685,13 @@ export type PostAstrologySynastryResponses = {
9685
9685
  */
9686
9686
  degree: number;
9687
9687
  /**
9688
- * House this planet occupies in the person 1 chart (1-12).
9688
+ * House this planet occupies in the person 1 chart (1-12). This is the placement in this person OWN chart. For the house overlay a synastry reading is built on, read houseInOtherChart.
9689
9689
  */
9690
9690
  house: number;
9691
+ /**
9692
+ * Which of person 2 houses this planet of person 1 falls into (1-12), counted on that person cusps in the same house system. This is the house OVERLAY, the half of synastry the inter-aspects do not cover: an aspect says two bodies are in relationship, an overlay says which area of the other person life this body lands in. Both people get their own overlay, so person 2 planets carry the reverse reading.
9693
+ */
9694
+ houseInOtherChart: number;
9691
9695
  /**
9692
9696
  * True when the planet is retrograde at this moment.
9693
9697
  */
@@ -9764,9 +9768,13 @@ export type PostAstrologySynastryResponses = {
9764
9768
  */
9765
9769
  degree: number;
9766
9770
  /**
9767
- * House this planet occupies in the person 2 chart (1-12).
9771
+ * House this planet occupies in the person 2 chart (1-12). This is the placement in this person OWN chart. For the house overlay a synastry reading is built on, read houseInOtherChart.
9768
9772
  */
9769
9773
  house: number;
9774
+ /**
9775
+ * Which of person 1 houses this planet of person 2 falls into (1-12), counted on that person cusps in the same house system. This is the house OVERLAY, the half of synastry the inter-aspects do not cover: an aspect says two bodies are in relationship, an overlay says which area of the other person life this body lands in. Both people get their own overlay, so person 1 planets carry the reverse reading.
9776
+ */
9777
+ houseInOtherChart: number;
9770
9778
  /**
9771
9779
  * True when the planet is retrograde at this moment.
9772
9780
  */
@@ -11382,6 +11390,402 @@ export type PostAstrologyTransitAspectsResponses = {
11382
11390
 
11383
11391
  export type PostAstrologyTransitAspectsResponse = PostAstrologyTransitAspectsResponses[keyof PostAstrologyTransitAspectsResponses];
11384
11392
 
11393
+ export type PostAstrologyParallelsMonthlyData = {
11394
+ body?: {
11395
+ /**
11396
+ * Year for the declination calendar (1900-2100). Defaults to the current year (UTC).
11397
+ */
11398
+ year?: number;
11399
+ /**
11400
+ * Month number (1-12). Defaults to the current month (UTC).
11401
+ */
11402
+ month?: number;
11403
+ /**
11404
+ * Timezone offset from UTC in hours. Event dates and times are reported in this zone, which is what makes a published calendar read correctly for its audience. Defaults to 0 (UTC).
11405
+ */
11406
+ timezone?: number | string;
11407
+ /**
11408
+ * How far from exact still counts, in degrees. The traditional orb for a declination contact is tighter than for a zodiacal aspect because declination changes slowly. Defaults to 1.5.
11409
+ */
11410
+ orb?: number;
11411
+ /**
11412
+ * Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is the osculating node and the default, because it is what most Western chart software reports; mean is the smoothed node preferred by several evolutionary schools, so pass "mean" to match one. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
11413
+ */
11414
+ nodeType?: 'mean' | 'true';
11415
+ };
11416
+ path?: never;
11417
+ query?: {
11418
+ /**
11419
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
11420
+ */
11421
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
11422
+ };
11423
+ url: '/astrology/parallels/monthly';
11424
+ };
11425
+
11426
+ export type PostAstrologyParallelsMonthlyErrors = {
11427
+ /**
11428
+ * Validation error. `issues[]` lists every failed field.
11429
+ */
11430
+ 400: {
11431
+ /**
11432
+ * First issue summary.
11433
+ */
11434
+ error: string;
11435
+ code: 'validation_error';
11436
+ /**
11437
+ * Every validation failure. Use this to rebuild a valid request.
11438
+ */
11439
+ issues: Array<{
11440
+ /**
11441
+ * Dot-separated field path, or "(root)" for top-level.
11442
+ */
11443
+ path: string;
11444
+ message: string;
11445
+ /**
11446
+ * Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
11447
+ */
11448
+ code?: string;
11449
+ /**
11450
+ * Expected type for invalid_type.
11451
+ */
11452
+ expected?: string;
11453
+ /**
11454
+ * Minimum bound for too_small issues.
11455
+ */
11456
+ minimum?: number | string;
11457
+ /**
11458
+ * Maximum bound for too_big issues.
11459
+ */
11460
+ maximum?: number | string;
11461
+ inclusive?: boolean;
11462
+ /**
11463
+ * Format name for string issues (regex, email, url, uuid).
11464
+ */
11465
+ format?: string;
11466
+ /**
11467
+ * Regex pattern when format is regex.
11468
+ */
11469
+ pattern?: string;
11470
+ }>;
11471
+ };
11472
+ /**
11473
+ * Invalid or missing API key
11474
+ */
11475
+ 401: {
11476
+ /**
11477
+ * Human-readable error message. May change wording.
11478
+ */
11479
+ error: string;
11480
+ /**
11481
+ * Machine-readable error code. Stable identifier.
11482
+ */
11483
+ code: string;
11484
+ };
11485
+ /**
11486
+ * Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
11487
+ */
11488
+ 405: {
11489
+ error: string;
11490
+ code: 'method_not_allowed';
11491
+ /**
11492
+ * Allowed HTTP methods for this path. Mirrors the Allow response header.
11493
+ */
11494
+ allow: Array<string>;
11495
+ /**
11496
+ * Link to the product page for this domain.
11497
+ */
11498
+ docs?: string;
11499
+ };
11500
+ /**
11501
+ * Monthly rate limit exceeded
11502
+ */
11503
+ 429: {
11504
+ /**
11505
+ * Human-readable error message. May change wording.
11506
+ */
11507
+ error: string;
11508
+ /**
11509
+ * Machine-readable error code. Stable identifier.
11510
+ */
11511
+ code: string;
11512
+ };
11513
+ /**
11514
+ * Internal server error
11515
+ */
11516
+ 500: {
11517
+ /**
11518
+ * Human-readable error message. May change wording.
11519
+ */
11520
+ error: string;
11521
+ /**
11522
+ * Machine-readable error code. Stable identifier.
11523
+ */
11524
+ code: string;
11525
+ };
11526
+ };
11527
+
11528
+ export type PostAstrologyParallelsMonthlyError = PostAstrologyParallelsMonthlyErrors[keyof PostAstrologyParallelsMonthlyErrors];
11529
+
11530
+ export type PostAstrologyParallelsMonthlyResponses = {
11531
+ /**
11532
+ * Monthly declination calendar calculated successfully
11533
+ */
11534
+ 200: {
11535
+ /**
11536
+ * Year of the calendar. Echoes the year requested, or the current UTC year when it was omitted.
11537
+ */
11538
+ year: number;
11539
+ /**
11540
+ * Month of the calendar. Echoes the month requested, or the current UTC month when it was omitted.
11541
+ */
11542
+ month: number;
11543
+ /**
11544
+ * Timezone the event dates and times are reported in. Echoes the request.
11545
+ */
11546
+ timezone: number;
11547
+ /**
11548
+ * Orb in degrees that was applied. Echoes the request.
11549
+ */
11550
+ orb: number;
11551
+ /**
11552
+ * Every declination contact in the month, in chronological order across all body pairs.
11553
+ */
11554
+ events: Array<{
11555
+ /**
11556
+ * First body in the contact. Always canonical English whatever the lang parameter says, so it stays safe to compare against in code. Use planet1Localized for anything a reader sees.
11557
+ */
11558
+ planet1: string;
11559
+ /**
11560
+ * First body in the requested language. Present only when lang is supplied.
11561
+ */
11562
+ planet1Localized?: string;
11563
+ /**
11564
+ * Second body in the contact. Always canonical English.
11565
+ */
11566
+ planet2: string;
11567
+ /**
11568
+ * Second body in the requested language. Present only when lang is supplied.
11569
+ */
11570
+ planet2Localized?: string;
11571
+ /**
11572
+ * parallel means both bodies stand at the same declination, the same distance north or south of the celestial equator, and reads much like a conjunction. contraparallel means equal and opposite declinations, one as far north as the other is south, and reads much like an opposition. Neither depends on how far apart the two bodies are along the zodiac, which is what makes them worth tracking alongside ordinary aspects.
11573
+ */
11574
+ type: 'parallel' | 'contraparallel';
11575
+ /**
11576
+ * Date the contact is closest to exact, in the requested timezone (YYYY-MM-DD).
11577
+ */
11578
+ date: string;
11579
+ /**
11580
+ * Time the contact is closest to exact, in the requested timezone (HH:MM).
11581
+ */
11582
+ time: string;
11583
+ /**
11584
+ * Combined timestamp of closest approach, in the requested timezone.
11585
+ */
11586
+ datetime: string;
11587
+ /**
11588
+ * Distance from exact in degrees at the reported instant. Effectively zero for a contact that perfects inside the month, and larger only where the pair turns before reaching exact.
11589
+ */
11590
+ orb: number;
11591
+ /**
11592
+ * Geocentric declination of the first body at the reported instant, in degrees. Positive is north of the celestial equator, negative south.
11593
+ */
11594
+ declination1: number;
11595
+ /**
11596
+ * Geocentric declination of the second body at the reported instant, in degrees.
11597
+ */
11598
+ declination2: number;
11599
+ }>;
11600
+ };
11601
+ };
11602
+
11603
+ export type PostAstrologyParallelsMonthlyResponse = PostAstrologyParallelsMonthlyResponses[keyof PostAstrologyParallelsMonthlyResponses];
11604
+
11605
+ export type PostAstrologyEclipticCrossingsData = {
11606
+ body?: {
11607
+ /**
11608
+ * Year to scan for node passages (1900-2100).
11609
+ */
11610
+ year: number;
11611
+ /**
11612
+ * Timezone offset from UTC in hours. Crossing dates and times are reported in this zone. Defaults to 0 (UTC).
11613
+ */
11614
+ timezone?: number | string;
11615
+ };
11616
+ path?: never;
11617
+ query?: {
11618
+ /**
11619
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
11620
+ */
11621
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
11622
+ };
11623
+ url: '/astrology/ecliptic-crossings';
11624
+ };
11625
+
11626
+ export type PostAstrologyEclipticCrossingsErrors = {
11627
+ /**
11628
+ * Validation error. `issues[]` lists every failed field.
11629
+ */
11630
+ 400: {
11631
+ /**
11632
+ * First issue summary.
11633
+ */
11634
+ error: string;
11635
+ code: 'validation_error';
11636
+ /**
11637
+ * Every validation failure. Use this to rebuild a valid request.
11638
+ */
11639
+ issues: Array<{
11640
+ /**
11641
+ * Dot-separated field path, or "(root)" for top-level.
11642
+ */
11643
+ path: string;
11644
+ message: string;
11645
+ /**
11646
+ * Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
11647
+ */
11648
+ code?: string;
11649
+ /**
11650
+ * Expected type for invalid_type.
11651
+ */
11652
+ expected?: string;
11653
+ /**
11654
+ * Minimum bound for too_small issues.
11655
+ */
11656
+ minimum?: number | string;
11657
+ /**
11658
+ * Maximum bound for too_big issues.
11659
+ */
11660
+ maximum?: number | string;
11661
+ inclusive?: boolean;
11662
+ /**
11663
+ * Format name for string issues (regex, email, url, uuid).
11664
+ */
11665
+ format?: string;
11666
+ /**
11667
+ * Regex pattern when format is regex.
11668
+ */
11669
+ pattern?: string;
11670
+ }>;
11671
+ };
11672
+ /**
11673
+ * Invalid or missing API key
11674
+ */
11675
+ 401: {
11676
+ /**
11677
+ * Human-readable error message. May change wording.
11678
+ */
11679
+ error: string;
11680
+ /**
11681
+ * Machine-readable error code. Stable identifier.
11682
+ */
11683
+ code: string;
11684
+ };
11685
+ /**
11686
+ * Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
11687
+ */
11688
+ 405: {
11689
+ error: string;
11690
+ code: 'method_not_allowed';
11691
+ /**
11692
+ * Allowed HTTP methods for this path. Mirrors the Allow response header.
11693
+ */
11694
+ allow: Array<string>;
11695
+ /**
11696
+ * Link to the product page for this domain.
11697
+ */
11698
+ docs?: string;
11699
+ };
11700
+ /**
11701
+ * Monthly rate limit exceeded
11702
+ */
11703
+ 429: {
11704
+ /**
11705
+ * Human-readable error message. May change wording.
11706
+ */
11707
+ error: string;
11708
+ /**
11709
+ * Machine-readable error code. Stable identifier.
11710
+ */
11711
+ code: string;
11712
+ };
11713
+ /**
11714
+ * Internal server error
11715
+ */
11716
+ 500: {
11717
+ /**
11718
+ * Human-readable error message. May change wording.
11719
+ */
11720
+ error: string;
11721
+ /**
11722
+ * Machine-readable error code. Stable identifier.
11723
+ */
11724
+ code: string;
11725
+ };
11726
+ };
11727
+
11728
+ export type PostAstrologyEclipticCrossingsError = PostAstrologyEclipticCrossingsErrors[keyof PostAstrologyEclipticCrossingsErrors];
11729
+
11730
+ export type PostAstrologyEclipticCrossingsResponses = {
11731
+ /**
11732
+ * Node passages calculated successfully
11733
+ */
11734
+ 200: {
11735
+ /**
11736
+ * Year that was scanned. Echoes the request.
11737
+ */
11738
+ year: number;
11739
+ /**
11740
+ * Timezone the dates and times are reported in. Echoes the request.
11741
+ */
11742
+ timezone: number;
11743
+ /**
11744
+ * Every node passage in the year, in chronological order across all bodies. The fast bodies dominate: a slow body can go years or decades between node passages, so an absent planet means it did not cross that year rather than that it was not checked.
11745
+ */
11746
+ events: Array<{
11747
+ /**
11748
+ * Body making the crossing. Always canonical English whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
11749
+ */
11750
+ planet: string;
11751
+ /**
11752
+ * Body name in the requested language. Present only when lang is supplied.
11753
+ */
11754
+ planetLocalized?: string;
11755
+ /**
11756
+ * ascending is the crossing from south of the ecliptic to north, at the body north node. descending is the reverse, at its south node.
11757
+ */
11758
+ direction: 'ascending' | 'descending';
11759
+ /**
11760
+ * Date of the crossing in the requested timezone (YYYY-MM-DD).
11761
+ */
11762
+ date: string;
11763
+ /**
11764
+ * Time of the crossing in the requested timezone (HH:MM).
11765
+ */
11766
+ time: string;
11767
+ /**
11768
+ * Combined crossing timestamp in the requested timezone.
11769
+ */
11770
+ datetime: string;
11771
+ /**
11772
+ * Tropical ecliptic longitude of the body at the crossing, in degrees. This is the only value in the response that depends on the zodiac frame.
11773
+ */
11774
+ longitude: number;
11775
+ /**
11776
+ * Tropical sign the body occupies at the crossing. Canonical English.
11777
+ */
11778
+ sign: string;
11779
+ /**
11780
+ * Sign in the requested language. Present only when lang is supplied.
11781
+ */
11782
+ signLocalized?: string;
11783
+ }>;
11784
+ };
11785
+ };
11786
+
11787
+ export type PostAstrologyEclipticCrossingsResponse = PostAstrologyEclipticCrossingsResponses[keyof PostAstrologyEclipticCrossingsResponses];
11788
+
11385
11789
  export type PostAstrologySolarReturnData = {
11386
11790
  body?: {
11387
11791
  /**
@@ -19600,11 +20004,11 @@ export type PostVedicAstrologyDailyResponses = {
19600
20004
  */
19601
20005
  areas: {
19602
20006
  /**
19603
- * The finance area: the positive house group 2, 5, 11 netted against the negative group 6, 8, 12, read off the lords of the running dasha, bhukti and antara, because that is the KP rule for when a matter fructifies, plus the natal basis the day is read against. ALWAYS AN OBJECT. Above latitude 66.56 the six netted members are null, because the Placidus cusps behind the significators have no solution there, while natal is still populated because it is a property of the birth chart and needs no cusps; the reading also still carries its gochara, panchanga and dasha and names the omission in degraded. The two house groups are Krishnamurti Paddhati practice, but the NET is a KP practitioner convention rather than a classical operation: the KP sources that carry these groups use them as a promise test and an avoidance test, never as arithmetic. The groups also vary by author, and the 6th house is the live disagreement, since some KP authors place it on the POSITIVE side as service income and salary, the exact opposite of the assignment used here. This is a six house net and it is NOT the focus=finance lens, which re-reads all twelve bhavas in money vocabulary and moves no number. The two are orthogonal and both ship.
20007
+ * The finance area: the positive house group 2, 5, 11 netted against the negative group 6, 8, 12, read off the lords of the running dasha, bhukti and antara, because that is the KP rule for when a matter fructifies, plus the natal basis the day is read against. ALWAYS AN OBJECT. Above latitude 66.56 the six netted members are null, because the Placidus cusps behind the significators have no solution there, while natal is still populated because it is a property of the birth chart and needs no cusps; the reading also still carries its gochara, panchanga and dasha and names the omission in degraded. The two house groups are Krishnamurti Paddhati practice, but the NET is a KP practitioner convention rather than a classical operation: the KP sources that carry these groups use them as a promise test and an avoidance test, never as arithmetic. The groups also vary by author, and TWO houses are live disagreements rather than one. The 6th: some KP authors place it on the POSITIVE side as service income and salary, the exact opposite of the assignment used here. The 5th: it is named as a speculative GAIN house in the same KP sources that elsewhere call it a negation house, reading it as the 12th from the 6th and therefore loss of earning capacity, and both readings appear in one publication. The 1st is treated as a negation house by some authors on the same logic, as the 12th from the 2nd, and is not on either side here. This is a six house net and it is NOT the focus=finance lens, which re-reads all twelve bhavas in money vocabulary and moves no number. The two are orthogonal and both ship.
19604
20008
  */
19605
20009
  finance: {
19606
20010
  /**
19607
- * Share of the running lords six-house connections that land on the positive group, 0 to 100, rounded. A COUNT, so positive and negative below reproduce it in one division: round(positive / (positive + negative) * 100). Zero when the running lords reach none of the six houses, which is an ABSENCE of connection rather than a negative verdict. Null above latitude 66.56, where the Placidus cusps the KP significators are read from have no solution: the question does not apply there rather than the answer being no, so never render it as zero or as a weak verdict. The natal block beside it is unaffected and still ships, and degraded names areas.finance.score. The two house groups are Krishnamurti Paddhati practice, but the NET is a KP practitioner convention rather than a classical operation: the KP sources that carry these groups use them as a promise test and an avoidance test, never as arithmetic. The groups also vary by author, and the 6th house is the live disagreement, since some KP authors place it on the POSITIVE side as service income and salary, the exact opposite of the assignment used here. This is a six house net and it is NOT the focus=finance lens, which re-reads all twelve bhavas in money vocabulary and moves no number. The two are orthogonal and both ship.
20011
+ * Share of the running lords six-house connections that land on the positive group, 0 to 100, rounded. A COUNT, so positive and negative below reproduce it in one division: round(positive / (positive + negative) * 100). Zero when the running lords reach none of the six houses, which is an ABSENCE of connection rather than a negative verdict. Null above latitude 66.56, where the Placidus cusps the KP significators are read from have no solution: the question does not apply there rather than the answer being no, so never render it as zero or as a weak verdict. The natal block beside it is unaffected and still ships, and degraded names areas.finance.score. The two house groups are Krishnamurti Paddhati practice, but the NET is a KP practitioner convention rather than a classical operation: the KP sources that carry these groups use them as a promise test and an avoidance test, never as arithmetic. The groups also vary by author, and TWO houses are live disagreements rather than one. The 6th: some KP authors place it on the POSITIVE side as service income and salary, the exact opposite of the assignment used here. The 5th: it is named as a speculative GAIN house in the same KP sources that elsewhere call it a negation house, reading it as the 12th from the 6th and therefore loss of earning capacity, and both readings appear in one publication. The 1st is treated as a negation house by some authors on the same logic, as the 12th from the 2nd, and is not on either side here. This is a six house net and it is NOT the focus=finance lens, which re-reads all twelve bhavas in money vocabulary and moves no number. The two are orthogonal and both ship.
19608
20012
  */
19609
20013
  score: number | null;
19610
20014
  /**
@@ -36235,7 +36639,7 @@ export type GetTarotCardsByIdData = {
36235
36639
  body?: never;
36236
36640
  path: {
36237
36641
  /**
36238
- * Unique card identifier in kebab-case. Major arcana: "fool", "magician", "death", etc. Minor arcana: "ace-of-cups", "seven-of-wands", "queen-of-swords", "king-of-pentacles", etc.
36642
+ * Card identifier. Major arcana: "fool", "magician", "death". Minor arcana: "ace-of-cups", "seven-of-wands", "queen-of-swords", "king-of-pentacles". Casing and separators are flexible, so "Fool" and "ACE_OF_CUPS" both resolve, and a leading definite article is optional, so "the-star" resolves to "star". The canonical form, and the one every response echoes, is kebab-case with no article.
36239
36643
  */
36240
36644
  id: string;
36241
36645
  };
@@ -37868,9 +38272,9 @@ export type PostBiorhythmReadingResponses = {
37868
38272
  */
37869
38273
  rawValue: number;
37870
38274
  /**
37871
- * Current phase of the cycle. One of: peak, high, rising, critical_ascending, critical_descending, falling, low, trough.
38275
+ * Current phase of the cycle. One of: peak, high, rising, critical_ascending, critical_descending, falling, low, trough. Canonical English whatever the lang parameter says, so it stays safe to compare against in code; phaseLabel carries the reader-facing form and IS translated.
37872
38276
  */
37873
- phase: string;
38277
+ phase: 'peak' | 'high' | 'rising' | 'critical_ascending' | 'critical_descending' | 'falling' | 'low' | 'trough';
37874
38278
  /**
37875
38279
  * Human-readable phase name for display in UIs, dashboards, and reports.
37876
38280
  */
@@ -37892,9 +38296,9 @@ export type PostBiorhythmReadingResponses = {
37892
38296
  */
37893
38297
  daysUntilCritical: number;
37894
38298
  /**
37895
- * Short-term direction of the cycle. One of: rising, falling, peaking, bottoming.
38299
+ * Short-term direction of the cycle, which is its SLOPE rather than its band, so it moves independently of phase. One of: rising, falling, peaking, bottoming. Canonical English, like phase.
37896
38300
  */
37897
- trend: string;
38301
+ trend: 'rising' | 'falling' | 'peaking' | 'bottoming';
37898
38302
  /**
37899
38303
  * Editorial 2-3 sentence reading specific to this cycle at its current phase position.
37900
38304
  */
@@ -37906,9 +38310,9 @@ export type PostBiorhythmReadingResponses = {
37906
38310
  */
37907
38311
  energyRating: number;
37908
38312
  /**
37909
- * Summary phase label. One of: high_energy, mixed, recovery, critical.
38313
+ * Summary phase across every cycle for the day. One of: high_energy, mixed, recovery, critical.
37910
38314
  */
37911
- overallPhase: string;
38315
+ overallPhase: 'high_energy' | 'mixed' | 'recovery' | 'critical';
37912
38316
  /**
37913
38317
  * Editorial 3-5 sentence reading combining all cycle states into a coherent daily assessment.
37914
38318
  */
@@ -37924,15 +38328,15 @@ export type PostBiorhythmReadingResponses = {
37924
38328
  /**
37925
38329
  * Which cycle is at or near zero crossing.
37926
38330
  */
37927
- cycle: string;
38331
+ cycle: 'physical' | 'emotional' | 'intellectual' | 'intuitive' | 'aesthetic' | 'awareness' | 'spiritual' | 'passion' | 'mastery' | 'wisdom';
37928
38332
  /**
37929
- * Alert type. zero_crossing when a cycle crosses zero, approaching_critical when within 1 day of zero.
38333
+ * Alert type. One of: zero_crossing. Raised once for the whole critical band, when the cycle sits within 9 points of zero in either direction.
37930
38334
  */
37931
- type: string;
38335
+ type: 'zero_crossing';
37932
38336
  /**
37933
38337
  * Whether the cycle is rising through zero (ascending) or falling through zero (descending).
37934
38338
  */
37935
- direction: string;
38339
+ direction: 'ascending' | 'descending';
37936
38340
  /**
37937
38341
  * Specific advisory text for this critical alert.
37938
38342
  */
@@ -38320,9 +38724,9 @@ export type PostBiorhythmCriticalDaysResponses = {
38320
38724
  */
38321
38725
  date: string;
38322
38726
  /**
38323
- * Which primary cycle crosses zero on this date.
38727
+ * Which primary cycle crosses zero on this date. One of: physical, emotional, intellectual. Only the three primary cycles are scanned; the secondary and composite cycles are not.
38324
38728
  */
38325
- cycle: string;
38729
+ cycle: 'physical' | 'emotional' | 'intellectual';
38326
38730
  /**
38327
38731
  * Cycle period in days.
38328
38732
  */
@@ -38330,11 +38734,11 @@ export type PostBiorhythmCriticalDaysResponses = {
38330
38734
  /**
38331
38735
  * Whether the cycle is rising through zero (ascending) or falling through zero (descending).
38332
38736
  */
38333
- direction: string;
38737
+ direction: 'ascending' | 'descending';
38334
38738
  /**
38335
- * How many primary cycles are critical on this date. single, double, or triple.
38739
+ * How many primary cycles are critical on this date. One of: single, double, triple.
38336
38740
  */
38337
- severity: string;
38741
+ severity: 'single' | 'double' | 'triple';
38338
38742
  /**
38339
38743
  * Advisory text explaining the significance of this critical day and recommended precautions.
38340
38744
  */
@@ -38537,9 +38941,9 @@ export type PostBiorhythmCompatibilityResponses = {
38537
38941
  */
38538
38942
  alignment: number;
38539
38943
  /**
38540
- * Alignment phase. One of: in_sync, complementary, neutral, opposing.
38944
+ * How the two people's cycles sit against each other. One of: in_sync, complementary, neutral, opposing. This is a PAIR alignment and shares no values with the single-person cycle phase.
38541
38945
  */
38542
- phase: string;
38946
+ phase: 'in_sync' | 'complementary' | 'neutral' | 'opposing';
38543
38947
  /**
38544
38948
  * Human-readable description of how this cycle alignment affects the relationship.
38545
38949
  */
@@ -38731,7 +39135,7 @@ export type PostBiorhythmPhasesResponses = {
38731
39135
  /**
38732
39136
  * Current phase identifier.
38733
39137
  */
38734
- phase: string;
39138
+ phase: 'peak' | 'high' | 'rising' | 'critical_ascending' | 'critical_descending' | 'falling' | 'low' | 'trough';
38735
39139
  /**
38736
39140
  * Human-readable phase label.
38737
39141
  */
@@ -38751,7 +39155,7 @@ export type PostBiorhythmPhasesResponses = {
38751
39155
  /**
38752
39156
  * Short-term direction: rising, falling, peaking, or bottoming.
38753
39157
  */
38754
- trend: string;
39158
+ trend: 'rising' | 'falling' | 'peaking' | 'bottoming';
38755
39159
  };
38756
39160
  };
38757
39161
  /**
@@ -38906,14 +39310,14 @@ export type PostBiorhythmDailyResponses = {
38906
39310
  */
38907
39311
  energyRating: number;
38908
39312
  /**
38909
- * Summary phase. One of: high_energy, mixed, recovery, critical.
39313
+ * Summary phase across every cycle for the day. One of: high_energy, mixed, recovery, critical.
38910
39314
  */
38911
- overallPhase: string;
39315
+ overallPhase: 'high_energy' | 'mixed' | 'recovery' | 'critical';
38912
39316
  spotlight: {
38913
39317
  /**
38914
- * Which primary cycle is featured as the daily spotlight.
39318
+ * Which primary cycle is featured as the daily spotlight. One of: physical, emotional, intellectual.
38915
39319
  */
38916
- cycle: string;
39320
+ cycle: 'physical' | 'emotional' | 'intellectual';
38917
39321
  /**
38918
39322
  * Current value of the spotlight cycle (-100 to 100).
38919
39323
  */
@@ -38921,7 +39325,7 @@ export type PostBiorhythmDailyResponses = {
38921
39325
  /**
38922
39326
  * Current phase of the spotlight cycle.
38923
39327
  */
38924
- phase: string;
39328
+ phase: 'peak' | 'high' | 'rising' | 'critical_ascending' | 'critical_descending' | 'falling' | 'low' | 'trough';
38925
39329
  /**
38926
39330
  * Personalized message about the spotlight cycle and what it means for today.
38927
39331
  */
@@ -44747,7 +45151,7 @@ export type GetUsageResponses = {
44747
45151
  */
44748
45152
  plan: string;
44749
45153
  /**
44750
- * Billable requests counted against the current calendar month. Read from the same counter the rate limiter enforces on, so it never reports a rosier number than the limit that will 429 you. Cached responses still count.
45154
+ * Billable requests counted against the current calendar month. The quota window is the UTC calendar month and resets on the 1st at 12:00 AM UTC, never on your renewal date, so an annual plan refills every month and a plan bought mid month still refills on the 1st. Read from the same counter the rate limiter enforces on, so it never reports a rosier number than the limit that will 429 you. Cached responses still count.
44751
45155
  */
44752
45156
  usedThisMonth: number;
44753
45157
  /**
@@ -44755,7 +45159,7 @@ export type GetUsageResponses = {
44755
45159
  */
44756
45160
  requestsPerMonth: number;
44757
45161
  /**
44758
- * Requests left before the monthly allowance is exhausted, floored at zero. Equal to requestsPerMonth minus usedThisMonth.
45162
+ * Requests left before the monthly allowance is exhausted, floored at zero. Equal to requestsPerMonth minus usedThisMonth. Refills at the calendar month rollover, whose exact instant every API response carries as a Unix timestamp in the X-RateLimit-Reset header.
44759
45163
  */
44760
45164
  remainingThisMonth: number;
44761
45165
  /**
@@ -44767,7 +45171,7 @@ export type GetUsageResponses = {
44767
45171
  */
44768
45172
  status: string;
44769
45173
  /**
44770
- * ISO 8601 timestamp when the current billing period ends. A renewal extends this date in place. API access survives a cancelled or suspended status until this moment passes.
45174
+ * ISO 8601 timestamp when the current billing period ends. A renewal extends this date in place. API access survives a cancelled or suspended status until this moment passes. This is a BILLING date, not a quota date: the monthly allowance resets on the 1st of each month independently of it.
44771
45175
  */
44772
45176
  endDate: string;
44773
45177
  };
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.2.66';
1
+ export const VERSION = '1.2.68';