@roxyapi/sdk 1.2.31 → 1.2.33

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.
@@ -22451,7 +22451,7 @@ export type PostHumanDesignBodygraphResponses = {
22451
22451
  */
22452
22452
  angleCode: string;
22453
22453
  /**
22454
- * Composed name of the incarnation cross from the angle and the four gates.
22454
+ * Canonical published name of the incarnation cross, determined by the Personality Sun gate and the angle. Falls back to a name composed from the angle and the four gates if no canonical name exists.
22455
22455
  */
22456
22456
  name: string;
22457
22457
  };
@@ -22813,6 +22813,240 @@ export type PostHumanDesignConnectionResponses = {
22813
22813
  };
22814
22814
  };
22815
22815
  export type PostHumanDesignConnectionResponse = PostHumanDesignConnectionResponses[keyof PostHumanDesignConnectionResponses];
22816
+ export type PostHumanDesignPentaData = {
22817
+ body?: {
22818
+ /**
22819
+ * Birth moments of the three to five people in the group. Below three no Penta forms; above five a second Penta emerges.
22820
+ */
22821
+ members: Array<{
22822
+ /**
22823
+ * Birth date in YYYY-MM-DD format. The anchor for both the Personality activations at birth and the Design activations 88 degrees of solar arc earlier.
22824
+ */
22825
+ date: string;
22826
+ /**
22827
+ * Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
22828
+ */
22829
+ time: string;
22830
+ /**
22831
+ * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
22832
+ */
22833
+ timezone: number | string;
22834
+ /**
22835
+ * Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
22836
+ */
22837
+ latitude?: number;
22838
+ /**
22839
+ * Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
22840
+ */
22841
+ longitude?: number;
22842
+ }>;
22843
+ };
22844
+ path?: never;
22845
+ query?: {
22846
+ /**
22847
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
22848
+ */
22849
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
22850
+ };
22851
+ url: '/human-design/penta';
22852
+ };
22853
+ export type PostHumanDesignPentaErrors = {
22854
+ /**
22855
+ * Validation error. `issues[]` lists every failed field.
22856
+ */
22857
+ 400: {
22858
+ /**
22859
+ * First issue summary.
22860
+ */
22861
+ error: string;
22862
+ code: 'validation_error';
22863
+ /**
22864
+ * Every validation failure. Use this to rebuild a valid request.
22865
+ */
22866
+ issues: Array<{
22867
+ /**
22868
+ * Dot-separated field path, or "(root)" for top-level.
22869
+ */
22870
+ path: string;
22871
+ message: string;
22872
+ /**
22873
+ * Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
22874
+ */
22875
+ code?: string;
22876
+ /**
22877
+ * Expected type for invalid_type.
22878
+ */
22879
+ expected?: string;
22880
+ /**
22881
+ * Minimum bound for too_small issues.
22882
+ */
22883
+ minimum?: number | string;
22884
+ /**
22885
+ * Maximum bound for too_big issues.
22886
+ */
22887
+ maximum?: number | string;
22888
+ inclusive?: boolean;
22889
+ /**
22890
+ * Format name for string issues (regex, email, url, uuid).
22891
+ */
22892
+ format?: string;
22893
+ /**
22894
+ * Regex pattern when format is regex.
22895
+ */
22896
+ pattern?: string;
22897
+ }>;
22898
+ };
22899
+ /**
22900
+ * Invalid or missing API key
22901
+ */
22902
+ 401: {
22903
+ /**
22904
+ * Human-readable error message. May change wording.
22905
+ */
22906
+ error: string;
22907
+ /**
22908
+ * Machine-readable error code. Stable identifier.
22909
+ */
22910
+ code: string;
22911
+ };
22912
+ /**
22913
+ * Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
22914
+ */
22915
+ 405: {
22916
+ error: string;
22917
+ code: 'method_not_allowed';
22918
+ /**
22919
+ * Allowed HTTP methods for this path. Mirrors the Allow response header.
22920
+ */
22921
+ allow: Array<string>;
22922
+ /**
22923
+ * Link to the product page for this domain.
22924
+ */
22925
+ docs?: string;
22926
+ };
22927
+ /**
22928
+ * Monthly rate limit exceeded
22929
+ */
22930
+ 429: {
22931
+ /**
22932
+ * Human-readable error message. May change wording.
22933
+ */
22934
+ error: string;
22935
+ /**
22936
+ * Machine-readable error code. Stable identifier.
22937
+ */
22938
+ code: string;
22939
+ };
22940
+ /**
22941
+ * Internal server error
22942
+ */
22943
+ 500: {
22944
+ /**
22945
+ * Human-readable error message. May change wording.
22946
+ */
22947
+ error: string;
22948
+ /**
22949
+ * Machine-readable error code. Stable identifier.
22950
+ */
22951
+ code: string;
22952
+ };
22953
+ };
22954
+ export type PostHumanDesignPentaError = PostHumanDesignPentaErrors[keyof PostHumanDesignPentaErrors];
22955
+ export type PostHumanDesignPentaResponses = {
22956
+ /**
22957
+ * Penta chart with per-channel Strengths, per-gate fill state, and a group summary
22958
+ */
22959
+ 200: {
22960
+ /**
22961
+ * Number of people in the group, always between 3 and 5.
22962
+ */
22963
+ memberCount: number;
22964
+ /**
22965
+ * The six channels of the Penta with their defined Strength state and which members supply each gate. Three upper channels run G to Throat (The Alpha, Inspiration, The Prodigal); three lower channels run G to Sacral (Rhythm, The Beat, Discovery).
22966
+ */
22967
+ channels: Array<{
22968
+ /**
22969
+ * First gate of the Penta channel.
22970
+ */
22971
+ gateA: number;
22972
+ /**
22973
+ * Second gate of the Penta channel.
22974
+ */
22975
+ gateB: number;
22976
+ /**
22977
+ * Name of the Penta channel. One of The Alpha, Inspiration, The Prodigal, Rhythm, The Beat, Discovery.
22978
+ */
22979
+ name: string;
22980
+ /**
22981
+ * Circuit family of the channel. One of Individual, Collective, Tribal.
22982
+ */
22983
+ circuit: string;
22984
+ /**
22985
+ * Position of the channel in the Penta. upper channels run from the G Center to the Throat and carry the leadership and how-the-group-presents roles. lower channels run from the G Center to the Sacral and carry the managed, generative, resource roles.
22986
+ */
22987
+ position: string;
22988
+ /**
22989
+ * Whether this is the 2/14 Channel of the Beat, the material core of the Penta vortex: gate 2 the direction for resources, gate 14 the resources themselves.
22990
+ */
22991
+ isCore: boolean;
22992
+ /**
22993
+ * Whether the channel is a defined Strength: both of its gates are present somewhere in the group, so the function it governs has no gap.
22994
+ */
22995
+ defined: boolean;
22996
+ /**
22997
+ * Zero-based indices of the members whose chart holds gate A, in member order.
22998
+ */
22999
+ gateAHeldBy: Array<number>;
23000
+ /**
23001
+ * Zero-based indices of the members whose chart holds gate B, in member order.
23002
+ */
23003
+ gateBHeldBy: Array<number>;
23004
+ }>;
23005
+ /**
23006
+ * The twelve Penta gates with their filled state and which members hold each.
23007
+ */
23008
+ gates: Array<{
23009
+ /**
23010
+ * Penta gate number. One of 1, 2, 5, 7, 8, 13, 14, 15, 29, 31, 33, 46.
23011
+ */
23012
+ gate: number;
23013
+ /**
23014
+ * Human Design keynote name of the gate, describing the role it brings to the group.
23015
+ */
23016
+ gateName: string;
23017
+ /**
23018
+ * Whether at least one member holds this gate. A gate held by nobody is a gap that conditions the group to compensate for the missing role.
23019
+ */
23020
+ filled: boolean;
23021
+ /**
23022
+ * Zero-based indices of the members whose chart holds this gate. Empty when the gate is a gap.
23023
+ */
23024
+ heldBy: Array<number>;
23025
+ }>;
23026
+ /**
23027
+ * Group-level rollup of the Penta channels and gates.
23028
+ */
23029
+ summary: {
23030
+ /**
23031
+ * Count of the six Penta channels that are defined Strengths in the group.
23032
+ */
23033
+ definedChannels: number;
23034
+ /**
23035
+ * Count of the twelve Penta gates filled by at least one member.
23036
+ */
23037
+ filledGates: number;
23038
+ /**
23039
+ * Penta gates held by no member. A non-empty list flags the functional gaps in the group.
23040
+ */
23041
+ gapGates: Array<number>;
23042
+ /**
23043
+ * Whether the 2/14 Channel of the Beat, the material core of the Penta, is defined across the group.
23044
+ */
23045
+ coreDefined: boolean;
23046
+ };
23047
+ };
23048
+ };
23049
+ export type PostHumanDesignPentaResponse = PostHumanDesignPentaResponses[keyof PostHumanDesignPentaResponses];
22816
23050
  export type PostHumanDesignTransitData = {
22817
23051
  body?: {
22818
23052
  /**
@@ -24303,49 +24537,28 @@ export type PostHumanDesignProfileResponses = {
24303
24537
  };
24304
24538
  };
24305
24539
  export type PostHumanDesignProfileResponse = PostHumanDesignProfileResponses[keyof PostHumanDesignProfileResponses];
24306
- export type PostForecastTimelineData = {
24540
+ export type PostHumanDesignVariablesData = {
24307
24541
  body?: {
24308
24542
  /**
24309
- * The single birth subject this forecast is built for. One object only, never an array.
24543
+ * Birth date in YYYY-MM-DD format. The anchor for both the Personality activations at birth and the Design activations 88 degrees of solar arc earlier.
24310
24544
  */
24311
- birthData: {
24312
- /**
24313
- * Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
24314
- */
24315
- date: string;
24316
- /**
24317
- * Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
24318
- */
24319
- time: string;
24320
- /**
24321
- * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
24322
- */
24323
- timezone: number | string;
24324
- /**
24325
- * Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24326
- */
24327
- latitude?: number;
24328
- /**
24329
- * Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24330
- */
24331
- longitude?: number;
24332
- };
24545
+ date: string;
24333
24546
  /**
24334
- * First day of the forecast window in YYYY-MM-DD format. Defaults to today in UTC.
24547
+ * Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
24335
24548
  */
24336
- startDate?: string;
24549
+ time: string;
24337
24550
  /**
24338
- * Last day of the forecast window in YYYY-MM-DD format. Defaults to startDate plus 30 days. The window is clamped to a maximum of 90 days from startDate.
24551
+ * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
24339
24552
  */
24340
- endDate?: string;
24553
+ timezone: number | string;
24341
24554
  /**
24342
- * Which forecast domains to include. Defaults to all three. Pass a subset to scope the timeline to one or two engines.
24555
+ * Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
24343
24556
  */
24344
- domains?: Array<'western' | 'vedic' | 'biorhythm'>;
24557
+ latitude?: number;
24345
24558
  /**
24346
- * Drop events scoring below this significance threshold from 0 to 100. Defaults to 0, keeping all events.
24559
+ * Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
24347
24560
  */
24348
- minSignificance?: number;
24561
+ longitude?: number;
24349
24562
  };
24350
24563
  path?: never;
24351
24564
  query?: {
@@ -24354,9 +24567,9 @@ export type PostForecastTimelineData = {
24354
24567
  */
24355
24568
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
24356
24569
  };
24357
- url: '/forecast/timeline';
24570
+ url: '/human-design/variables';
24358
24571
  };
24359
- export type PostForecastTimelineErrors = {
24572
+ export type PostHumanDesignVariablesErrors = {
24360
24573
  /**
24361
24574
  * Validation error. `issues[]` lists every failed field.
24362
24575
  */
@@ -24457,38 +24670,288 @@ export type PostForecastTimelineErrors = {
24457
24670
  code: string;
24458
24671
  };
24459
24672
  };
24460
- export type PostForecastTimelineError = PostForecastTimelineErrors[keyof PostForecastTimelineErrors];
24461
- export type PostForecastTimelineResponses = {
24673
+ export type PostHumanDesignVariablesError = PostHumanDesignVariablesErrors[keyof PostHumanDesignVariablesErrors];
24674
+ export type PostHumanDesignVariablesResponses = {
24462
24675
  /**
24463
- * Merged forecast timeline with time-ordered events across the requested domains
24676
+ * The four Variable arrows with substructure numbers, labels, and confidence flags
24464
24677
  */
24465
24678
  200: {
24466
24679
  /**
24467
- * Echo of the birth subject this forecast was built for.
24680
+ * The four Variable arrows: Determination and Environment from the design side, Perspective and Motivation from the personality side. Together they form the Rave Variables / Primary Health System layer that sits beneath Type, Strategy, Authority, and Profile.
24468
24681
  */
24469
- birthData: {
24682
+ arrows: Array<{
24470
24683
  /**
24471
- * Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
24684
+ * Stable arrow identifier. One of determination, environment, perspective, motivation.
24472
24685
  */
24473
- date: string;
24686
+ key: string;
24474
24687
  /**
24475
- * Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
24688
+ * Arrow name. Determination is the top-left arrow governing the Primary Health System and digestion, Environment the bottom-left arrow, Perspective the bottom-right arrow also called View, and Motivation the top-right arrow.
24476
24689
  */
24477
- time: string;
24690
+ name: string;
24478
24691
  /**
24479
- * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
24692
+ * Which half of the advanced layer the arrow belongs to. Primary Health System covers the body-side Determination and Environment arrows, Rave Psychology covers the mind-side Perspective and Motivation arrows.
24480
24693
  */
24481
- timezone: number | string;
24694
+ layer: string;
24482
24695
  /**
24483
- * Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24696
+ * Position of the arrow at the head of the bodygraph. One of Top left, Bottom left, Top right, Bottom right.
24484
24697
  */
24485
- latitude?: number;
24698
+ position: string;
24486
24699
  /**
24487
- * Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24700
+ * The single activation, body and chart side, that this arrow is derived from.
24488
24701
  */
24489
- longitude?: number;
24490
- };
24491
- /**
24702
+ activation: {
24703
+ /**
24704
+ * Activating body whose substructure feeds this arrow. Determination and Motivation come from the Sun, Environment and Perspective from the North Node.
24705
+ */
24706
+ planet: string;
24707
+ /**
24708
+ * Chart side of the activation. Determination and Environment come from the design side, Perspective and Motivation from the personality side.
24709
+ */
24710
+ side: string;
24711
+ };
24712
+ /**
24713
+ * Color number from 1 to 6, the substructure level one octave finer than the line. Color selects the arrow theme, for example the determination family or the motivation.
24714
+ */
24715
+ color: number;
24716
+ /**
24717
+ * Tone number from 1 to 6, the substructure level beneath Color. Tone sets the arrow direction: tones 1 to 3 face left, tones 4 to 6 face right.
24718
+ */
24719
+ tone: number;
24720
+ /**
24721
+ * Base number from 1 to 5, the finest published subdivision of the wheel. Returned for completeness but treated as informational, since it is finer than most birth times can resolve.
24722
+ */
24723
+ base: number;
24724
+ /**
24725
+ * Arrow direction derived from the Tone. left for tones 1 to 3, right for tones 4 to 6.
24726
+ */
24727
+ direction: string;
24728
+ /**
24729
+ * Name of the Color theme for this arrow, for example a determination family such as Touch, an environment such as Mountains, a perspective such as Personal, or a motivation such as Hope.
24730
+ */
24731
+ colorLabel: string;
24732
+ /**
24733
+ * Keynote of the arrow direction for this arrow, for example Active or Passive for Determination, Focused or Peripheral for Perspective.
24734
+ */
24735
+ directionLabel: string;
24736
+ /**
24737
+ * Whether this arrow is far enough from a Color or Tone boundary to be reliable. When false the activation sits on a knife edge where the Color label or the arrow direction could flip with a more precise birth time, and the arrow should not be presented as fact.
24738
+ */
24739
+ confident: boolean;
24740
+ }>;
24741
+ /**
24742
+ * True only when all four arrows are confident. A single knife-edge arrow makes the whole configuration uncertain.
24743
+ */
24744
+ confident: boolean;
24745
+ /**
24746
+ * Boundary margin in degrees of ecliptic longitude used for the per-arrow confidence flag, the solar arc over a few minutes of clock time. An activation within this distance of a Color or Tone boundary is flagged low-confidence.
24747
+ */
24748
+ confidenceMarginDeg: number;
24749
+ };
24750
+ };
24751
+ export type PostHumanDesignVariablesResponse = PostHumanDesignVariablesResponses[keyof PostHumanDesignVariablesResponses];
24752
+ export type PostForecastTimelineData = {
24753
+ body?: {
24754
+ /**
24755
+ * The single birth subject this forecast is built for. One object only, never an array.
24756
+ */
24757
+ birthData: {
24758
+ /**
24759
+ * Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
24760
+ */
24761
+ date: string;
24762
+ /**
24763
+ * Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
24764
+ */
24765
+ time: string;
24766
+ /**
24767
+ * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
24768
+ */
24769
+ timezone: number | string;
24770
+ /**
24771
+ * Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24772
+ */
24773
+ latitude?: number;
24774
+ /**
24775
+ * Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24776
+ */
24777
+ longitude?: number;
24778
+ };
24779
+ /**
24780
+ * First day of the forecast window in YYYY-MM-DD format. Defaults to today in UTC.
24781
+ */
24782
+ startDate?: string;
24783
+ /**
24784
+ * Last day of the forecast window in YYYY-MM-DD format. Defaults to startDate plus 30 days. The window is clamped to a maximum of 90 days from startDate.
24785
+ */
24786
+ endDate?: string;
24787
+ /**
24788
+ * Which forecast domains to include. Defaults to all three. Pass a subset to scope the timeline to one or two engines.
24789
+ */
24790
+ domains?: Array<'western' | 'vedic' | 'biorhythm'>;
24791
+ /**
24792
+ * Drop events scoring below this significance threshold from 0 to 100. Defaults to 0, keeping all events.
24793
+ */
24794
+ minSignificance?: number;
24795
+ /**
24796
+ * Per-domain significance multipliers applied before the significance floor and event cap. Bias which domains survive filtering and the cap. Omitted domains default to a weight of 1. Valid keys are western, vedic, and biorhythm.
24797
+ */
24798
+ domainWeights?: {
24799
+ /**
24800
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
24801
+ */
24802
+ western?: number;
24803
+ /**
24804
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
24805
+ */
24806
+ vedic?: number;
24807
+ /**
24808
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
24809
+ */
24810
+ biorhythm?: number;
24811
+ };
24812
+ };
24813
+ path?: never;
24814
+ query?: {
24815
+ /**
24816
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
24817
+ */
24818
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
24819
+ };
24820
+ url: '/forecast/timeline';
24821
+ };
24822
+ export type PostForecastTimelineErrors = {
24823
+ /**
24824
+ * Validation error. `issues[]` lists every failed field.
24825
+ */
24826
+ 400: {
24827
+ /**
24828
+ * First issue summary.
24829
+ */
24830
+ error: string;
24831
+ code: 'validation_error';
24832
+ /**
24833
+ * Every validation failure. Use this to rebuild a valid request.
24834
+ */
24835
+ issues: Array<{
24836
+ /**
24837
+ * Dot-separated field path, or "(root)" for top-level.
24838
+ */
24839
+ path: string;
24840
+ message: string;
24841
+ /**
24842
+ * Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
24843
+ */
24844
+ code?: string;
24845
+ /**
24846
+ * Expected type for invalid_type.
24847
+ */
24848
+ expected?: string;
24849
+ /**
24850
+ * Minimum bound for too_small issues.
24851
+ */
24852
+ minimum?: number | string;
24853
+ /**
24854
+ * Maximum bound for too_big issues.
24855
+ */
24856
+ maximum?: number | string;
24857
+ inclusive?: boolean;
24858
+ /**
24859
+ * Format name for string issues (regex, email, url, uuid).
24860
+ */
24861
+ format?: string;
24862
+ /**
24863
+ * Regex pattern when format is regex.
24864
+ */
24865
+ pattern?: string;
24866
+ }>;
24867
+ };
24868
+ /**
24869
+ * Invalid or missing API key
24870
+ */
24871
+ 401: {
24872
+ /**
24873
+ * Human-readable error message. May change wording.
24874
+ */
24875
+ error: string;
24876
+ /**
24877
+ * Machine-readable error code. Stable identifier.
24878
+ */
24879
+ code: string;
24880
+ };
24881
+ /**
24882
+ * Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
24883
+ */
24884
+ 405: {
24885
+ error: string;
24886
+ code: 'method_not_allowed';
24887
+ /**
24888
+ * Allowed HTTP methods for this path. Mirrors the Allow response header.
24889
+ */
24890
+ allow: Array<string>;
24891
+ /**
24892
+ * Link to the product page for this domain.
24893
+ */
24894
+ docs?: string;
24895
+ };
24896
+ /**
24897
+ * Monthly rate limit exceeded
24898
+ */
24899
+ 429: {
24900
+ /**
24901
+ * Human-readable error message. May change wording.
24902
+ */
24903
+ error: string;
24904
+ /**
24905
+ * Machine-readable error code. Stable identifier.
24906
+ */
24907
+ code: string;
24908
+ };
24909
+ /**
24910
+ * Internal server error
24911
+ */
24912
+ 500: {
24913
+ /**
24914
+ * Human-readable error message. May change wording.
24915
+ */
24916
+ error: string;
24917
+ /**
24918
+ * Machine-readable error code. Stable identifier.
24919
+ */
24920
+ code: string;
24921
+ };
24922
+ };
24923
+ export type PostForecastTimelineError = PostForecastTimelineErrors[keyof PostForecastTimelineErrors];
24924
+ export type PostForecastTimelineResponses = {
24925
+ /**
24926
+ * Merged forecast timeline with time-ordered events across the requested domains
24927
+ */
24928
+ 200: {
24929
+ /**
24930
+ * Echo of the birth subject this forecast was built for.
24931
+ */
24932
+ birthData: {
24933
+ /**
24934
+ * Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
24935
+ */
24936
+ date: string;
24937
+ /**
24938
+ * Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
24939
+ */
24940
+ time: string;
24941
+ /**
24942
+ * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
24943
+ */
24944
+ timezone: number | string;
24945
+ /**
24946
+ * Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24947
+ */
24948
+ latitude?: number;
24949
+ /**
24950
+ * Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
24951
+ */
24952
+ longitude?: number;
24953
+ };
24954
+ /**
24492
24955
  * First day of the resolved forecast window.
24493
24956
  */
24494
24957
  startDate: string;
@@ -24517,11 +24980,11 @@ export type PostForecastTimelineResponses = {
24517
24980
  */
24518
24981
  domain: 'western' | 'vedic' | 'biorhythm';
24519
24982
  /**
24520
- * Event kind. transit-aspect, sign-ingress, and retrograde-station are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
24983
+ * Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
24521
24984
  */
24522
- type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'dasha-change' | 'critical-day';
24985
+ type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
24523
24986
  /**
24524
- * Primary subject of the event. A transiting planet for western events, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
24987
+ * Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
24525
24988
  */
24526
24989
  body: string;
24527
24990
  /**
@@ -24540,12 +25003,20 @@ export type PostForecastTimelineResponses = {
24540
25003
  * For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
24541
25004
  */
24542
25005
  station?: 'retrograde' | 'direct';
25006
+ /**
25007
+ * For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
25008
+ */
25009
+ kind?: 'penumbral' | 'partial' | 'annular' | 'total';
25010
+ /**
25011
+ * For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
25012
+ */
25013
+ obscuration?: number;
24543
25014
  /**
24544
25015
  * Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
24545
25016
  */
24546
25017
  description: string;
24547
25018
  /**
24548
- * Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower.
25019
+ * Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
24549
25020
  */
24550
25021
  significance: number;
24551
25022
  }>;
@@ -24762,11 +25233,11 @@ export type PostForecastTransitsResponses = {
24762
25233
  */
24763
25234
  domain: 'western' | 'vedic' | 'biorhythm';
24764
25235
  /**
24765
- * Event kind. transit-aspect, sign-ingress, and retrograde-station are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
25236
+ * Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
24766
25237
  */
24767
- type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'dasha-change' | 'critical-day';
25238
+ type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
24768
25239
  /**
24769
- * Primary subject of the event. A transiting planet for western events, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
25240
+ * Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
24770
25241
  */
24771
25242
  body: string;
24772
25243
  /**
@@ -24785,12 +25256,20 @@ export type PostForecastTransitsResponses = {
24785
25256
  * For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
24786
25257
  */
24787
25258
  station?: 'retrograde' | 'direct';
25259
+ /**
25260
+ * For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
25261
+ */
25262
+ kind?: 'penumbral' | 'partial' | 'annular' | 'total';
25263
+ /**
25264
+ * For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
25265
+ */
25266
+ obscuration?: number;
24788
25267
  /**
24789
25268
  * Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
24790
25269
  */
24791
25270
  description: string;
24792
25271
  /**
24793
- * Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower.
25272
+ * Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
24794
25273
  */
24795
25274
  significance: number;
24796
25275
  }>;
@@ -24840,6 +25319,23 @@ export type PostForecastSignificantDatesData = {
24840
25319
  * Significance floor from 0 to 100 for what counts as a significant date. Defaults to 70.
24841
25320
  */
24842
25321
  minSignificance?: number;
25322
+ /**
25323
+ * Per-domain significance multipliers applied before the significance floor and event cap. Bias which domains survive filtering and the cap. Omitted domains default to a weight of 1. Valid keys are western, vedic, and biorhythm.
25324
+ */
25325
+ domainWeights?: {
25326
+ /**
25327
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
25328
+ */
25329
+ western?: number;
25330
+ /**
25331
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
25332
+ */
25333
+ vedic?: number;
25334
+ /**
25335
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
25336
+ */
25337
+ biorhythm?: number;
25338
+ };
24843
25339
  };
24844
25340
  path?: never;
24845
25341
  query?: {
@@ -25011,11 +25507,11 @@ export type PostForecastSignificantDatesResponses = {
25011
25507
  */
25012
25508
  domain: 'western' | 'vedic' | 'biorhythm';
25013
25509
  /**
25014
- * Event kind. transit-aspect, sign-ingress, and retrograde-station are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
25510
+ * Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
25015
25511
  */
25016
- type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'dasha-change' | 'critical-day';
25512
+ type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
25017
25513
  /**
25018
- * Primary subject of the event. A transiting planet for western events, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
25514
+ * Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
25019
25515
  */
25020
25516
  body: string;
25021
25517
  /**
@@ -25034,18 +25530,699 @@ export type PostForecastSignificantDatesResponses = {
25034
25530
  * For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
25035
25531
  */
25036
25532
  station?: 'retrograde' | 'direct';
25533
+ /**
25534
+ * For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
25535
+ */
25536
+ kind?: 'penumbral' | 'partial' | 'annular' | 'total';
25537
+ /**
25538
+ * For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
25539
+ */
25540
+ obscuration?: number;
25037
25541
  /**
25038
25542
  * Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
25039
25543
  */
25040
25544
  description: string;
25041
25545
  /**
25042
- * Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower.
25546
+ * Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
25043
25547
  */
25044
25548
  significance: number;
25045
25549
  }>;
25046
25550
  };
25047
25551
  };
25048
25552
  export type PostForecastSignificantDatesResponse = PostForecastSignificantDatesResponses[keyof PostForecastSignificantDatesResponses];
25553
+ export type PostForecastDigestData = {
25554
+ body?: {
25555
+ /**
25556
+ * The single birth subject this digest is built for. One object only, never an array.
25557
+ */
25558
+ birthData: {
25559
+ /**
25560
+ * Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
25561
+ */
25562
+ date: string;
25563
+ /**
25564
+ * Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
25565
+ */
25566
+ time: string;
25567
+ /**
25568
+ * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
25569
+ */
25570
+ timezone: number | string;
25571
+ /**
25572
+ * Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
25573
+ */
25574
+ latitude?: number;
25575
+ /**
25576
+ * Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
25577
+ */
25578
+ longitude?: number;
25579
+ };
25580
+ /**
25581
+ * Start anchor for every window in YYYY-MM-DD format. The next 24h, 7d, 30d, and 90d windows are measured forward from this date at 00:00:00 UTC. Defaults to today in UTC.
25582
+ */
25583
+ startDate?: string;
25584
+ /**
25585
+ * Which forecast domains to include before rolling up the windows. Defaults to all three.
25586
+ */
25587
+ domains?: Array<'western' | 'vedic' | 'biorhythm'>;
25588
+ /**
25589
+ * Drop events scoring below this significance threshold from 0 to 100 before the rollup. Defaults to 0.
25590
+ */
25591
+ minSignificance?: number;
25592
+ /**
25593
+ * Per-domain significance multipliers applied before the significance floor and event cap. Bias which domains survive filtering and the cap. Omitted domains default to a weight of 1. Valid keys are western, vedic, and biorhythm.
25594
+ */
25595
+ domainWeights?: {
25596
+ /**
25597
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
25598
+ */
25599
+ western?: number;
25600
+ /**
25601
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
25602
+ */
25603
+ vedic?: number;
25604
+ /**
25605
+ * Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
25606
+ */
25607
+ biorhythm?: number;
25608
+ };
25609
+ /**
25610
+ * Number of highest-significance events to surface per window. Defaults to 3, capped at 20.
25611
+ */
25612
+ top?: number;
25613
+ };
25614
+ path?: never;
25615
+ query?: {
25616
+ /**
25617
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
25618
+ */
25619
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
25620
+ };
25621
+ url: '/forecast/digest';
25622
+ };
25623
+ export type PostForecastDigestErrors = {
25624
+ /**
25625
+ * Validation error. `issues[]` lists every failed field.
25626
+ */
25627
+ 400: {
25628
+ /**
25629
+ * First issue summary.
25630
+ */
25631
+ error: string;
25632
+ code: 'validation_error';
25633
+ /**
25634
+ * Every validation failure. Use this to rebuild a valid request.
25635
+ */
25636
+ issues: Array<{
25637
+ /**
25638
+ * Dot-separated field path, or "(root)" for top-level.
25639
+ */
25640
+ path: string;
25641
+ message: string;
25642
+ /**
25643
+ * Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
25644
+ */
25645
+ code?: string;
25646
+ /**
25647
+ * Expected type for invalid_type.
25648
+ */
25649
+ expected?: string;
25650
+ /**
25651
+ * Minimum bound for too_small issues.
25652
+ */
25653
+ minimum?: number | string;
25654
+ /**
25655
+ * Maximum bound for too_big issues.
25656
+ */
25657
+ maximum?: number | string;
25658
+ inclusive?: boolean;
25659
+ /**
25660
+ * Format name for string issues (regex, email, url, uuid).
25661
+ */
25662
+ format?: string;
25663
+ /**
25664
+ * Regex pattern when format is regex.
25665
+ */
25666
+ pattern?: string;
25667
+ }>;
25668
+ };
25669
+ /**
25670
+ * Invalid or missing API key
25671
+ */
25672
+ 401: {
25673
+ /**
25674
+ * Human-readable error message. May change wording.
25675
+ */
25676
+ error: string;
25677
+ /**
25678
+ * Machine-readable error code. Stable identifier.
25679
+ */
25680
+ code: string;
25681
+ };
25682
+ /**
25683
+ * Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
25684
+ */
25685
+ 405: {
25686
+ error: string;
25687
+ code: 'method_not_allowed';
25688
+ /**
25689
+ * Allowed HTTP methods for this path. Mirrors the Allow response header.
25690
+ */
25691
+ allow: Array<string>;
25692
+ /**
25693
+ * Link to the product page for this domain.
25694
+ */
25695
+ docs?: string;
25696
+ };
25697
+ /**
25698
+ * Monthly rate limit exceeded
25699
+ */
25700
+ 429: {
25701
+ /**
25702
+ * Human-readable error message. May change wording.
25703
+ */
25704
+ error: string;
25705
+ /**
25706
+ * Machine-readable error code. Stable identifier.
25707
+ */
25708
+ code: string;
25709
+ };
25710
+ /**
25711
+ * Internal server error
25712
+ */
25713
+ 500: {
25714
+ /**
25715
+ * Human-readable error message. May change wording.
25716
+ */
25717
+ error: string;
25718
+ /**
25719
+ * Machine-readable error code. Stable identifier.
25720
+ */
25721
+ code: string;
25722
+ };
25723
+ };
25724
+ export type PostForecastDigestError = PostForecastDigestErrors[keyof PostForecastDigestErrors];
25725
+ export type PostForecastDigestResponses = {
25726
+ /**
25727
+ * Pre-summarized forecast windows: next 24h, 7d, 30d, and 90d rollups
25728
+ */
25729
+ 200: {
25730
+ /**
25731
+ * Echo of the birth subject this digest was built for.
25732
+ */
25733
+ birthData: {
25734
+ /**
25735
+ * Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
25736
+ */
25737
+ date: string;
25738
+ /**
25739
+ * Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
25740
+ */
25741
+ time: string;
25742
+ /**
25743
+ * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
25744
+ */
25745
+ timezone: number | string;
25746
+ /**
25747
+ * Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
25748
+ */
25749
+ latitude?: number;
25750
+ /**
25751
+ * Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
25752
+ */
25753
+ longitude?: number;
25754
+ };
25755
+ /**
25756
+ * Start anchor every window is measured from.
25757
+ */
25758
+ startDate: string;
25759
+ /**
25760
+ * Last day of the resolved 90 day horizon the timeline was built over before slicing.
25761
+ */
25762
+ endDate: string;
25763
+ /**
25764
+ * The four rollups in ascending window length: next 24h, 7d, 30d, and 90d from the start anchor.
25765
+ */
25766
+ windows: Array<{
25767
+ /**
25768
+ * Length of this window in days forward from the start anchor. One of 1, 7, 30, 90.
25769
+ */
25770
+ days: number;
25771
+ /**
25772
+ * Inclusive lower bound of the window as an ISO-8601 UTC datetime, the start anchor.
25773
+ */
25774
+ from: string;
25775
+ /**
25776
+ * Exclusive upper bound of the window as an ISO-8601 UTC datetime, the start anchor plus the window length.
25777
+ */
25778
+ to: string;
25779
+ /**
25780
+ * Number of events whose datetime falls inside this window.
25781
+ */
25782
+ count: number;
25783
+ /**
25784
+ * Count of events in this window broken down by domain. Only domains with at least one event in the window are present. The values sum to count.
25785
+ */
25786
+ byDomain: {
25787
+ western?: number;
25788
+ vedic?: number;
25789
+ biorhythm?: number;
25790
+ };
25791
+ /**
25792
+ * Count of events in this window broken down by event type. Only types with at least one event in the window are present. The values sum to count.
25793
+ */
25794
+ byType: {
25795
+ 'transit-aspect'?: number;
25796
+ 'sign-ingress'?: number;
25797
+ 'retrograde-station'?: number;
25798
+ eclipse?: number;
25799
+ 'dasha-change'?: number;
25800
+ 'critical-day'?: number;
25801
+ };
25802
+ /**
25803
+ * The highest-significance events in this window, most significant first, up to the requested top count. The same TimelineEvent shape as the timeline endpoints.
25804
+ */
25805
+ top: Array<{
25806
+ /**
25807
+ * Calendar date of the event in YYYY-MM-DD (UTC).
25808
+ */
25809
+ date: string;
25810
+ /**
25811
+ * Exact instant of the event as an ISO-8601 UTC datetime. Astronomical events are refined to this instant by search, not reported at a daily sample point.
25812
+ */
25813
+ datetime: string;
25814
+ /**
25815
+ * Forecast domain. western covers transit aspects, sign ingresses, and retrograde stations. vedic covers Vimshottari mahadasha and antardasha boundaries. biorhythm covers critical days. A stable machine value, never localized, so consumers can branch on it under any language.
25816
+ */
25817
+ domain: 'western' | 'vedic' | 'biorhythm';
25818
+ /**
25819
+ * Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
25820
+ */
25821
+ type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
25822
+ /**
25823
+ * Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
25824
+ */
25825
+ body: string;
25826
+ /**
25827
+ * For a transit-aspect, the natal body the transit aspects. For a sign-ingress, the zodiac sign entered. Absent for other event types.
25828
+ */
25829
+ target?: string;
25830
+ /**
25831
+ * For a transit-aspect, the angular relationship. One of conjunction, sextile, square, trine, opposition. Absent for other event types.
25832
+ */
25833
+ aspect?: string;
25834
+ /**
25835
+ * For a transit-aspect, the separation in degrees from the exact aspect at the reported instant. Tighter orb means a more exact and significant aspect.
25836
+ */
25837
+ orb?: number;
25838
+ /**
25839
+ * For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
25840
+ */
25841
+ station?: 'retrograde' | 'direct';
25842
+ /**
25843
+ * For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
25844
+ */
25845
+ kind?: 'penumbral' | 'partial' | 'annular' | 'total';
25846
+ /**
25847
+ * For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
25848
+ */
25849
+ obscuration?: number;
25850
+ /**
25851
+ * Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
25852
+ */
25853
+ description: string;
25854
+ /**
25855
+ * Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
25856
+ */
25857
+ significance: number;
25858
+ }>;
25859
+ }>;
25860
+ };
25861
+ };
25862
+ export type PostForecastDigestResponse = PostForecastDigestResponses[keyof PostForecastDigestResponses];
25863
+ export type PostForecastSolarReturnData = {
25864
+ body?: {
25865
+ /**
25866
+ * Birth date in YYYY-MM-DD format. Anchors the natal Sun longitude the transiting Sun returns to each year.
25867
+ */
25868
+ date: string;
25869
+ /**
25870
+ * Birth time in 24-hour HH:MM:SS format. Pins the exact natal Sun position that defines the solar return moment.
25871
+ */
25872
+ time: string;
25873
+ /**
25874
+ * Year to cast the solar return for. The chart is erected for the moment in this year when the transiting Sun returns to the natal Sun longitude, on or within a day of the birthday.
25875
+ */
25876
+ year: number;
25877
+ /**
25878
+ * Latitude of the solar return location in decimal degrees. The solar return is location-sensitive: use the birthplace to anchor the chart to natal geography, or the current city for a relocated solar return.
25879
+ */
25880
+ latitude: number;
25881
+ /**
25882
+ * Longitude of the solar return location in decimal degrees. Sets the local sidereal time, so it drives the Ascendant, Midheaven, and house cusps of the return chart.
25883
+ */
25884
+ longitude: number;
25885
+ /**
25886
+ * Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
25887
+ */
25888
+ timezone: number | string;
25889
+ /**
25890
+ * House system for the return chart. placidus is the Western default. whole-sign, equal, and koch are also supported.
25891
+ */
25892
+ houseSystem?: 'placidus' | 'whole-sign' | 'equal' | 'koch';
25893
+ };
25894
+ path?: never;
25895
+ query?: {
25896
+ /**
25897
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
25898
+ */
25899
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
25900
+ };
25901
+ url: '/forecast/solar-return';
25902
+ };
25903
+ export type PostForecastSolarReturnErrors = {
25904
+ /**
25905
+ * Validation error. `issues[]` lists every failed field.
25906
+ */
25907
+ 400: {
25908
+ /**
25909
+ * First issue summary.
25910
+ */
25911
+ error: string;
25912
+ code: 'validation_error';
25913
+ /**
25914
+ * Every validation failure. Use this to rebuild a valid request.
25915
+ */
25916
+ issues: Array<{
25917
+ /**
25918
+ * Dot-separated field path, or "(root)" for top-level.
25919
+ */
25920
+ path: string;
25921
+ message: string;
25922
+ /**
25923
+ * Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
25924
+ */
25925
+ code?: string;
25926
+ /**
25927
+ * Expected type for invalid_type.
25928
+ */
25929
+ expected?: string;
25930
+ /**
25931
+ * Minimum bound for too_small issues.
25932
+ */
25933
+ minimum?: number | string;
25934
+ /**
25935
+ * Maximum bound for too_big issues.
25936
+ */
25937
+ maximum?: number | string;
25938
+ inclusive?: boolean;
25939
+ /**
25940
+ * Format name for string issues (regex, email, url, uuid).
25941
+ */
25942
+ format?: string;
25943
+ /**
25944
+ * Regex pattern when format is regex.
25945
+ */
25946
+ pattern?: string;
25947
+ }>;
25948
+ };
25949
+ /**
25950
+ * Invalid or missing API key
25951
+ */
25952
+ 401: {
25953
+ /**
25954
+ * Human-readable error message. May change wording.
25955
+ */
25956
+ error: string;
25957
+ /**
25958
+ * Machine-readable error code. Stable identifier.
25959
+ */
25960
+ code: string;
25961
+ };
25962
+ /**
25963
+ * Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
25964
+ */
25965
+ 405: {
25966
+ error: string;
25967
+ code: 'method_not_allowed';
25968
+ /**
25969
+ * Allowed HTTP methods for this path. Mirrors the Allow response header.
25970
+ */
25971
+ allow: Array<string>;
25972
+ /**
25973
+ * Link to the product page for this domain.
25974
+ */
25975
+ docs?: string;
25976
+ };
25977
+ /**
25978
+ * Monthly rate limit exceeded
25979
+ */
25980
+ 429: {
25981
+ /**
25982
+ * Human-readable error message. May change wording.
25983
+ */
25984
+ error: string;
25985
+ /**
25986
+ * Machine-readable error code. Stable identifier.
25987
+ */
25988
+ code: string;
25989
+ };
25990
+ /**
25991
+ * Internal server error
25992
+ */
25993
+ 500: {
25994
+ /**
25995
+ * Human-readable error message. May change wording.
25996
+ */
25997
+ error: string;
25998
+ /**
25999
+ * Machine-readable error code. Stable identifier.
26000
+ */
26001
+ code: string;
26002
+ };
26003
+ };
26004
+ export type PostForecastSolarReturnError = PostForecastSolarReturnErrors[keyof PostForecastSolarReturnErrors];
26005
+ export type PostForecastSolarReturnResponses = {
26006
+ /**
26007
+ * Solar return chart cast for the requested year and location
26008
+ */
26009
+ 200: {
26010
+ /**
26011
+ * Echo of the birth date used to find the natal Sun longitude.
26012
+ */
26013
+ birthDate: string;
26014
+ /**
26015
+ * Exact solar return moment, when the transiting Sun returns to the natal Sun longitude, formatted in the requested timezone. The astrological birthday for the year.
26016
+ */
26017
+ solarReturnDate: string;
26018
+ /**
26019
+ * Year of this solar return. The chart covers the period to the next birthday.
26020
+ */
26021
+ solarReturnYear: number;
26022
+ /**
26023
+ * Location the return chart was cast for. The Ascendant and house cusps change with this location, the basis of the relocated solar return technique.
26024
+ */
26025
+ location: {
26026
+ /**
26027
+ * Latitude used for the return chart house cusps and Ascendant.
26028
+ */
26029
+ latitude: number;
26030
+ /**
26031
+ * Longitude used for local sidereal time and the Midheaven.
26032
+ */
26033
+ longitude: number;
26034
+ /**
26035
+ * Decimal timezone offset applied to the output datetime.
26036
+ */
26037
+ timezone: number;
26038
+ };
26039
+ /**
26040
+ * The natal Sun position whose annual return defines this chart.
26041
+ */
26042
+ natalSunPosition: {
26043
+ /**
26044
+ * Natal Sun ecliptic longitude in degrees from 0 to 360 that the Sun returns to.
26045
+ */
26046
+ longitude: number;
26047
+ /**
26048
+ * Tropical zodiac sign of the natal Sun.
26049
+ */
26050
+ sign: string;
26051
+ /**
26052
+ * Degree within the sign from 0 to 29.999 that the Sun returns to.
26053
+ */
26054
+ degree: number;
26055
+ };
26056
+ /**
26057
+ * Full chart erected for the solar return moment: all bodies with house placements, the 12 house cusps, aspects, Part of Fortune, and Vertex in the tropical zodiac.
26058
+ */
26059
+ chart: {
26060
+ /**
26061
+ * Birth details used to generate this chart.
26062
+ */
26063
+ birthDetails: {
26064
+ /**
26065
+ * Birth date in YYYY-MM-DD format. Determines planetary positions for the specific calendar day.
26066
+ */
26067
+ date: string;
26068
+ /**
26069
+ * Birth time in 24-hour HH:MM:SS format. Determines the Ascendant (rising sign) and house cusps. Use 12:00:00 if unknown.
26070
+ */
26071
+ time: string;
26072
+ /**
26073
+ * Birth location latitude in decimal degrees (-90 to 90). Positive = North, negative = South.
26074
+ */
26075
+ latitude: number;
26076
+ /**
26077
+ * Birth location longitude in decimal degrees (-180 to 180). Positive = East, negative = West.
26078
+ */
26079
+ longitude: number;
26080
+ /**
26081
+ * Timezone offset from UTC in decimal hours. Examples: New York = -5, London = 0, India = 5.5, Tokyo = 9.
26082
+ */
26083
+ timezone: number;
26084
+ };
26085
+ /**
26086
+ * All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node), Chiron, and Black Moon Lilith.
26087
+ */
26088
+ planets: Array<{
26089
+ /**
26090
+ * Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
26091
+ */
26092
+ name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
26093
+ /**
26094
+ * Tropical ecliptic longitude in degrees (0-360). Primary coordinate for zodiac sign and aspect calculations.
26095
+ */
26096
+ longitude: number;
26097
+ /**
26098
+ * Ecliptic latitude in degrees. Near zero for most planets, varies for the Moon and Pluto, and reaches up to about 5 degrees for Black Moon Lilith (projected from the inclined mean lunar orbit).
26099
+ */
26100
+ latitude: number;
26101
+ /**
26102
+ * Tropical zodiac sign this planet occupies. Determined by 30-degree divisions of ecliptic longitude.
26103
+ */
26104
+ sign: string;
26105
+ /**
26106
+ * Degree within the zodiac sign (0-29.999). Indicates how far the planet has progressed through the sign.
26107
+ */
26108
+ degree: number;
26109
+ /**
26110
+ * House placement (1-12). Determined by the selected house system and birth location.
26111
+ */
26112
+ house: number;
26113
+ /**
26114
+ * Daily motion in degrees per day. Negative values indicate retrograde motion.
26115
+ */
26116
+ speed: number;
26117
+ /**
26118
+ * Whether the planet appears to move backward from Earth perspective. Retrograde periods signal review and introspection.
26119
+ */
26120
+ isRetrograde: boolean;
26121
+ }>;
26122
+ /**
26123
+ * All 12 house cusps calculated using the selected house system.
26124
+ */
26125
+ houses: Array<{
26126
+ /**
26127
+ * House number (1-12). Each house governs specific life themes in Western astrology.
26128
+ */
26129
+ number: number;
26130
+ /**
26131
+ * Ecliptic longitude of this house cusp in degrees (0-360).
26132
+ */
26133
+ longitude: number;
26134
+ /**
26135
+ * Zodiac sign on this house cusp. Colors the themes of this life area.
26136
+ */
26137
+ sign: string;
26138
+ /**
26139
+ * Degree within the zodiac sign on this cusp (0-29.999).
26140
+ */
26141
+ degree: number;
26142
+ }>;
26143
+ /**
26144
+ * House system used for this chart (placidus, whole-sign, equal, or koch).
26145
+ */
26146
+ houseSystem: 'placidus' | 'whole-sign' | 'equal' | 'koch';
26147
+ /**
26148
+ * All planetary aspects found in this chart with orbs, strength, and applying/separating status.
26149
+ */
26150
+ aspects: Array<{
26151
+ /**
26152
+ * First planet in the aspect pair.
26153
+ */
26154
+ planet1: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
26155
+ /**
26156
+ * Second planet in the aspect pair.
26157
+ */
26158
+ planet2: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
26159
+ /**
26160
+ * Aspect type. Major: conjunction (0), opposition (180), trine (120), square (90), sextile (60). Minor: semi-sextile, quincunx, semi-square, sesquiquadrate.
26161
+ */
26162
+ type: 'CONJUNCTION' | 'OPPOSITION' | 'TRINE' | 'SQUARE' | 'SEXTILE' | 'SEMI_SEXTILE' | 'QUINCUNX' | 'SEMI_SQUARE' | 'SESQUIQUADRATE';
26163
+ /**
26164
+ * Exact angular separation that defines this aspect type in degrees.
26165
+ */
26166
+ angle: number;
26167
+ /**
26168
+ * Deviation from exact aspect in degrees. Tighter orb means stronger influence.
26169
+ */
26170
+ orb: number;
26171
+ /**
26172
+ * Whether the aspect is applying (planets moving toward exact) or separating (moving apart). Applying aspects grow stronger.
26173
+ */
26174
+ isApplying: boolean;
26175
+ /**
26176
+ * Aspect strength percentage (0-100). Based on orb tightness relative to the allowed maximum.
26177
+ */
26178
+ strength: number;
26179
+ /**
26180
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
26181
+ */
26182
+ interpretation: 'harmonious' | 'challenging' | 'neutral';
26183
+ }>;
26184
+ /**
26185
+ * Part of Fortune (Lot of Fortune). A point derived from the Ascendant and the two luminaries that marks an area of ease, vitality, and material wellbeing in the chart.
26186
+ */
26187
+ partOfFortune: {
26188
+ /**
26189
+ * Zodiac sign holding the Part of Fortune.
26190
+ */
26191
+ sign: string;
26192
+ /**
26193
+ * Degree within the Part of Fortune sign (0-29.999).
26194
+ */
26195
+ degree: number;
26196
+ /**
26197
+ * Absolute ecliptic longitude of the Part of Fortune (0-360).
26198
+ */
26199
+ longitude: number;
26200
+ /**
26201
+ * Chart sect used for the calculation. Day (diurnal) when the Sun is above the horizon, night (nocturnal) when below. Day charts use Ascendant plus Moon minus Sun, night charts use Ascendant plus Sun minus Moon.
26202
+ */
26203
+ sect: 'day' | 'night';
26204
+ };
26205
+ /**
26206
+ * Vertex. The western intersection of the prime vertical with the ecliptic, often read as a point of fated encounters and turning-point relationships. The opposite point is the Anti-Vertex.
26207
+ */
26208
+ vertex: {
26209
+ /**
26210
+ * Zodiac sign holding the Vertex.
26211
+ */
26212
+ sign: string;
26213
+ /**
26214
+ * Degree within the Vertex sign (0-29.999).
26215
+ */
26216
+ degree: number;
26217
+ /**
26218
+ * Absolute ecliptic longitude of the Vertex (0-360).
26219
+ */
26220
+ longitude: number;
26221
+ };
26222
+ };
26223
+ };
26224
+ };
26225
+ export type PostForecastSolarReturnResponse = PostForecastSolarReturnResponses[keyof PostForecastSolarReturnResponses];
25049
26226
  export type PostBiorhythmReadingData = {
25050
26227
  body?: {
25051
26228
  /**