@roxyapi/sdk 1.2.67 → 1.2.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/factory.cjs +1 -1
- package/dist/factory.js +1 -1
- package/dist/types.gen.d.ts +48 -40
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/package.json +1 -1
- package/src/types.gen.ts +48 -40
- package/src/version.ts +1 -1
package/dist/factory.cjs
CHANGED
package/dist/factory.js
CHANGED
package/dist/types.gen.d.ts
CHANGED
|
@@ -9530,9 +9530,13 @@ export type PostAstrologySynastryResponses = {
|
|
|
9530
9530
|
*/
|
|
9531
9531
|
degree: number;
|
|
9532
9532
|
/**
|
|
9533
|
-
* House this planet occupies in the person 1 chart (1-12).
|
|
9533
|
+
* 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.
|
|
9534
9534
|
*/
|
|
9535
9535
|
house: number;
|
|
9536
|
+
/**
|
|
9537
|
+
* 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.
|
|
9538
|
+
*/
|
|
9539
|
+
houseInOtherChart: number;
|
|
9536
9540
|
/**
|
|
9537
9541
|
* True when the planet is retrograde at this moment.
|
|
9538
9542
|
*/
|
|
@@ -9609,9 +9613,13 @@ export type PostAstrologySynastryResponses = {
|
|
|
9609
9613
|
*/
|
|
9610
9614
|
degree: number;
|
|
9611
9615
|
/**
|
|
9612
|
-
* House this planet occupies in the person 2 chart (1-12).
|
|
9616
|
+
* 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.
|
|
9613
9617
|
*/
|
|
9614
9618
|
house: number;
|
|
9619
|
+
/**
|
|
9620
|
+
* 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.
|
|
9621
|
+
*/
|
|
9622
|
+
houseInOtherChart: number;
|
|
9615
9623
|
/**
|
|
9616
9624
|
* True when the planet is retrograde at this moment.
|
|
9617
9625
|
*/
|
|
@@ -28154,7 +28162,7 @@ export type PostHumanDesignBodygraphData = {
|
|
|
28154
28162
|
*/
|
|
28155
28163
|
longitude?: number;
|
|
28156
28164
|
/**
|
|
28157
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
28165
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
28158
28166
|
*/
|
|
28159
28167
|
nodeType?: 'mean' | 'true';
|
|
28160
28168
|
};
|
|
@@ -28580,7 +28588,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
28580
28588
|
*/
|
|
28581
28589
|
longitude?: number;
|
|
28582
28590
|
/**
|
|
28583
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
28591
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
28584
28592
|
*/
|
|
28585
28593
|
nodeType?: 'mean' | 'true';
|
|
28586
28594
|
};
|
|
@@ -28609,7 +28617,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
28609
28617
|
*/
|
|
28610
28618
|
longitude?: number;
|
|
28611
28619
|
/**
|
|
28612
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
28620
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
28613
28621
|
*/
|
|
28614
28622
|
nodeType?: 'mean' | 'true';
|
|
28615
28623
|
};
|
|
@@ -28867,7 +28875,7 @@ export type PostHumanDesignPentaData = {
|
|
|
28867
28875
|
*/
|
|
28868
28876
|
longitude?: number;
|
|
28869
28877
|
/**
|
|
28870
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
28878
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
28871
28879
|
*/
|
|
28872
28880
|
nodeType?: 'mean' | 'true';
|
|
28873
28881
|
}>;
|
|
@@ -29117,7 +29125,7 @@ export type PostHumanDesignTransitData = {
|
|
|
29117
29125
|
*/
|
|
29118
29126
|
longitude?: number;
|
|
29119
29127
|
/**
|
|
29120
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
29128
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
29121
29129
|
*/
|
|
29122
29130
|
nodeType?: 'mean' | 'true';
|
|
29123
29131
|
};
|
|
@@ -29400,7 +29408,7 @@ export type PostHumanDesignTypeData = {
|
|
|
29400
29408
|
*/
|
|
29401
29409
|
longitude?: number;
|
|
29402
29410
|
/**
|
|
29403
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
29411
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
29404
29412
|
*/
|
|
29405
29413
|
nodeType?: 'mean' | 'true';
|
|
29406
29414
|
};
|
|
@@ -29606,7 +29614,7 @@ export type PostHumanDesignGatesData = {
|
|
|
29606
29614
|
*/
|
|
29607
29615
|
longitude?: number;
|
|
29608
29616
|
/**
|
|
29609
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
29617
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
29610
29618
|
*/
|
|
29611
29619
|
nodeType?: 'mean' | 'true';
|
|
29612
29620
|
};
|
|
@@ -30061,7 +30069,7 @@ export type PostHumanDesignChannelsData = {
|
|
|
30061
30069
|
*/
|
|
30062
30070
|
longitude?: number;
|
|
30063
30071
|
/**
|
|
30064
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
30072
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
30065
30073
|
*/
|
|
30066
30074
|
nodeType?: 'mean' | 'true';
|
|
30067
30075
|
};
|
|
@@ -30256,7 +30264,7 @@ export type PostHumanDesignCentersData = {
|
|
|
30256
30264
|
*/
|
|
30257
30265
|
longitude?: number;
|
|
30258
30266
|
/**
|
|
30259
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
30267
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
30260
30268
|
*/
|
|
30261
30269
|
nodeType?: 'mean' | 'true';
|
|
30262
30270
|
};
|
|
@@ -30605,7 +30613,7 @@ export type PostHumanDesignProfileData = {
|
|
|
30605
30613
|
*/
|
|
30606
30614
|
longitude?: number;
|
|
30607
30615
|
/**
|
|
30608
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
30616
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
30609
30617
|
*/
|
|
30610
30618
|
nodeType?: 'mean' | 'true';
|
|
30611
30619
|
};
|
|
@@ -30771,7 +30779,7 @@ export type PostHumanDesignVariablesData = {
|
|
|
30771
30779
|
*/
|
|
30772
30780
|
longitude?: number;
|
|
30773
30781
|
/**
|
|
30774
|
-
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice
|
|
30782
|
+
* 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 activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice moves a node gate. Because a gate can be half of a channel, that can change the completed channels and, with them, whether a center reads defined or open, plus the definition, authority, profile or type. A chart where only one center disagrees is the usual shape, since the type and profile often survive unchanged. If another calculator disagrees on any of those, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
30775
30783
|
*/
|
|
30776
30784
|
nodeType?: 'mean' | 'true';
|
|
30777
30785
|
};
|
|
@@ -37459,9 +37467,9 @@ export type PostBiorhythmReadingResponses = {
|
|
|
37459
37467
|
*/
|
|
37460
37468
|
rawValue: number;
|
|
37461
37469
|
/**
|
|
37462
|
-
* Current phase of the cycle. One of: peak, high, rising, critical_ascending, critical_descending, falling, low, trough.
|
|
37470
|
+
* 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.
|
|
37463
37471
|
*/
|
|
37464
|
-
phase:
|
|
37472
|
+
phase: 'peak' | 'high' | 'rising' | 'critical_ascending' | 'critical_descending' | 'falling' | 'low' | 'trough';
|
|
37465
37473
|
/**
|
|
37466
37474
|
* Human-readable phase name for display in UIs, dashboards, and reports.
|
|
37467
37475
|
*/
|
|
@@ -37483,9 +37491,9 @@ export type PostBiorhythmReadingResponses = {
|
|
|
37483
37491
|
*/
|
|
37484
37492
|
daysUntilCritical: number;
|
|
37485
37493
|
/**
|
|
37486
|
-
* Short-term direction of the cycle. One of: rising, falling, peaking, bottoming.
|
|
37494
|
+
* 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.
|
|
37487
37495
|
*/
|
|
37488
|
-
trend:
|
|
37496
|
+
trend: 'rising' | 'falling' | 'peaking' | 'bottoming';
|
|
37489
37497
|
/**
|
|
37490
37498
|
* Editorial 2-3 sentence reading specific to this cycle at its current phase position.
|
|
37491
37499
|
*/
|
|
@@ -37497,9 +37505,9 @@ export type PostBiorhythmReadingResponses = {
|
|
|
37497
37505
|
*/
|
|
37498
37506
|
energyRating: number;
|
|
37499
37507
|
/**
|
|
37500
|
-
* Summary phase
|
|
37508
|
+
* Summary phase across every cycle for the day. One of: high_energy, mixed, recovery, critical.
|
|
37501
37509
|
*/
|
|
37502
|
-
overallPhase:
|
|
37510
|
+
overallPhase: 'high_energy' | 'mixed' | 'recovery' | 'critical';
|
|
37503
37511
|
/**
|
|
37504
37512
|
* Editorial 3-5 sentence reading combining all cycle states into a coherent daily assessment.
|
|
37505
37513
|
*/
|
|
@@ -37515,15 +37523,15 @@ export type PostBiorhythmReadingResponses = {
|
|
|
37515
37523
|
/**
|
|
37516
37524
|
* Which cycle is at or near zero crossing.
|
|
37517
37525
|
*/
|
|
37518
|
-
cycle:
|
|
37526
|
+
cycle: 'physical' | 'emotional' | 'intellectual' | 'intuitive' | 'aesthetic' | 'awareness' | 'spiritual' | 'passion' | 'mastery' | 'wisdom';
|
|
37519
37527
|
/**
|
|
37520
|
-
* Alert type. zero_crossing
|
|
37528
|
+
* 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.
|
|
37521
37529
|
*/
|
|
37522
|
-
type:
|
|
37530
|
+
type: 'zero_crossing';
|
|
37523
37531
|
/**
|
|
37524
37532
|
* Whether the cycle is rising through zero (ascending) or falling through zero (descending).
|
|
37525
37533
|
*/
|
|
37526
|
-
direction:
|
|
37534
|
+
direction: 'ascending' | 'descending';
|
|
37527
37535
|
/**
|
|
37528
37536
|
* Specific advisory text for this critical alert.
|
|
37529
37537
|
*/
|
|
@@ -37901,9 +37909,9 @@ export type PostBiorhythmCriticalDaysResponses = {
|
|
|
37901
37909
|
*/
|
|
37902
37910
|
date: string;
|
|
37903
37911
|
/**
|
|
37904
|
-
* Which primary cycle crosses zero on this date.
|
|
37912
|
+
* 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.
|
|
37905
37913
|
*/
|
|
37906
|
-
cycle:
|
|
37914
|
+
cycle: 'physical' | 'emotional' | 'intellectual';
|
|
37907
37915
|
/**
|
|
37908
37916
|
* Cycle period in days.
|
|
37909
37917
|
*/
|
|
@@ -37911,11 +37919,11 @@ export type PostBiorhythmCriticalDaysResponses = {
|
|
|
37911
37919
|
/**
|
|
37912
37920
|
* Whether the cycle is rising through zero (ascending) or falling through zero (descending).
|
|
37913
37921
|
*/
|
|
37914
|
-
direction:
|
|
37922
|
+
direction: 'ascending' | 'descending';
|
|
37915
37923
|
/**
|
|
37916
|
-
* How many primary cycles are critical on this date. single, double,
|
|
37924
|
+
* How many primary cycles are critical on this date. One of: single, double, triple.
|
|
37917
37925
|
*/
|
|
37918
|
-
severity:
|
|
37926
|
+
severity: 'single' | 'double' | 'triple';
|
|
37919
37927
|
/**
|
|
37920
37928
|
* Advisory text explaining the significance of this critical day and recommended precautions.
|
|
37921
37929
|
*/
|
|
@@ -38113,9 +38121,9 @@ export type PostBiorhythmCompatibilityResponses = {
|
|
|
38113
38121
|
*/
|
|
38114
38122
|
alignment: number;
|
|
38115
38123
|
/**
|
|
38116
|
-
*
|
|
38124
|
+
* 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.
|
|
38117
38125
|
*/
|
|
38118
|
-
phase:
|
|
38126
|
+
phase: 'in_sync' | 'complementary' | 'neutral' | 'opposing';
|
|
38119
38127
|
/**
|
|
38120
38128
|
* Human-readable description of how this cycle alignment affects the relationship.
|
|
38121
38129
|
*/
|
|
@@ -38302,7 +38310,7 @@ export type PostBiorhythmPhasesResponses = {
|
|
|
38302
38310
|
/**
|
|
38303
38311
|
* Current phase identifier.
|
|
38304
38312
|
*/
|
|
38305
|
-
phase:
|
|
38313
|
+
phase: 'peak' | 'high' | 'rising' | 'critical_ascending' | 'critical_descending' | 'falling' | 'low' | 'trough';
|
|
38306
38314
|
/**
|
|
38307
38315
|
* Human-readable phase label.
|
|
38308
38316
|
*/
|
|
@@ -38322,7 +38330,7 @@ export type PostBiorhythmPhasesResponses = {
|
|
|
38322
38330
|
/**
|
|
38323
38331
|
* Short-term direction: rising, falling, peaking, or bottoming.
|
|
38324
38332
|
*/
|
|
38325
|
-
trend:
|
|
38333
|
+
trend: 'rising' | 'falling' | 'peaking' | 'bottoming';
|
|
38326
38334
|
};
|
|
38327
38335
|
};
|
|
38328
38336
|
/**
|
|
@@ -38472,14 +38480,14 @@ export type PostBiorhythmDailyResponses = {
|
|
|
38472
38480
|
*/
|
|
38473
38481
|
energyRating: number;
|
|
38474
38482
|
/**
|
|
38475
|
-
* Summary phase. One of: high_energy, mixed, recovery, critical.
|
|
38483
|
+
* Summary phase across every cycle for the day. One of: high_energy, mixed, recovery, critical.
|
|
38476
38484
|
*/
|
|
38477
|
-
overallPhase:
|
|
38485
|
+
overallPhase: 'high_energy' | 'mixed' | 'recovery' | 'critical';
|
|
38478
38486
|
spotlight: {
|
|
38479
38487
|
/**
|
|
38480
|
-
* Which primary cycle is featured as the daily spotlight.
|
|
38488
|
+
* Which primary cycle is featured as the daily spotlight. One of: physical, emotional, intellectual.
|
|
38481
38489
|
*/
|
|
38482
|
-
cycle:
|
|
38490
|
+
cycle: 'physical' | 'emotional' | 'intellectual';
|
|
38483
38491
|
/**
|
|
38484
38492
|
* Current value of the spotlight cycle (-100 to 100).
|
|
38485
38493
|
*/
|
|
@@ -38487,7 +38495,7 @@ export type PostBiorhythmDailyResponses = {
|
|
|
38487
38495
|
/**
|
|
38488
38496
|
* Current phase of the spotlight cycle.
|
|
38489
38497
|
*/
|
|
38490
|
-
phase:
|
|
38498
|
+
phase: 'peak' | 'high' | 'rising' | 'critical_ascending' | 'critical_descending' | 'falling' | 'low' | 'trough';
|
|
38491
38499
|
/**
|
|
38492
38500
|
* Personalized message about the spotlight cycle and what it means for today.
|
|
38493
38501
|
*/
|
|
@@ -44143,7 +44151,7 @@ export type GetUsageResponses = {
|
|
|
44143
44151
|
*/
|
|
44144
44152
|
plan: string;
|
|
44145
44153
|
/**
|
|
44146
|
-
* 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.
|
|
44154
|
+
* 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.
|
|
44147
44155
|
*/
|
|
44148
44156
|
usedThisMonth: number;
|
|
44149
44157
|
/**
|
|
@@ -44151,7 +44159,7 @@ export type GetUsageResponses = {
|
|
|
44151
44159
|
*/
|
|
44152
44160
|
requestsPerMonth: number;
|
|
44153
44161
|
/**
|
|
44154
|
-
* Requests left before the monthly allowance is exhausted, floored at zero. Equal to requestsPerMonth minus usedThisMonth.
|
|
44162
|
+
* 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.
|
|
44155
44163
|
*/
|
|
44156
44164
|
remainingThisMonth: number;
|
|
44157
44165
|
/**
|
|
@@ -44163,7 +44171,7 @@ export type GetUsageResponses = {
|
|
|
44163
44171
|
*/
|
|
44164
44172
|
status: string;
|
|
44165
44173
|
/**
|
|
44166
|
-
* 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.
|
|
44174
|
+
* 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.
|
|
44167
44175
|
*/
|
|
44168
44176
|
endDate: string;
|
|
44169
44177
|
};
|