@roxyapi/sdk 1.2.61 → 1.2.63

package/src/types.gen.ts

@@ -74,6 +74,10 @@ export type NatalChartResponse = {
          * Whether the planet is in retrograde motion.
          */
         isRetrograde: boolean;
+        /**
+         * Essential dignity of this body in the sign it occupies: domicile (the sign it rules, its strongest placement), exaltation (honoured and amplified), detriment (opposite its rulership, where it struggles), fall (opposite its exaltation, where it is weakened), or peregrine (in none of its own dignity signs). Absent for the lunar nodes, Chiron and Black Moon Lilith, which rule no sign and therefore hold no dignity at all, so an absent field and peregrine are different answers. Derived by sign only, so triplicity, bounds and face are not considered. Always English, whatever the lang parameter says, so it stays safe to compare against in code. The four dignity signs behind it are published per body by GET /planet-meanings/{id}.
+         */
+        dignity?: 'domicile' | 'exaltation' | 'detriment' | 'fall' | 'peregrine';
         /**
          * Planet-in-sign-in-house interpretation. Narrative analysis of what this placement means in the natal chart.
          */
@@ -166,9 +170,22 @@ export type NatalChartResponse = {
          */
         strength: number;
         /**
-         * Aspect nature: harmonious, challenging, or neutral.
+         * Aspect nature: harmonious, challenging, or neutral. Always English, whatever the lang parameter says, because it is an identifier to compare and style on. Read aspectInterpretation for the sentence a reader sees.
          */
         interpretation: string;
+        /**
+         * Narrative interpretation of this aspect for this chart. The reference description of the aspect TYPE is not repeated per row, use GET or POST /astrology/aspects for that card.
+         */
+        aspectInterpretation: {
+            /**
+             * One-sentence read of THIS pair: which two bodies, how tight the aspect is, whether it is applying or separating, and how it is classified. Translated in place, so it arrives in the requested language.
+             */
+            summary: string;
+            /**
+             * Themes this aspect activates between the two bodies. Translated in place, so they arrive in the requested language.
+             */
+            keywords: Array<string>;
+        };
     }>;
     /**
      * Detected multi-planet aspect configurations (Grand Trine, Kite, T-Square, Grand Cross, Yod, Mystic Rectangle, Stellium). Grand Cross suppresses contained T-Squares, Kite suppresses underlying Grand Trine.
@@ -580,7 +597,7 @@ export type AspectsResponse = {
          */
         strength: number;
         /**
-         * Aspect nature: harmonious, challenging, or neutral.
+         * Aspect nature for this pair: harmonious, challenging, or neutral. Always English, whatever the lang parameter says, because it is an identifier to compare and style on. This is the field to branch on; meaning.nature is the reference card characterisation of the aspect type and is translated for display.
          */
         interpretation: string;
         /**
@@ -609,7 +626,7 @@ export type AspectsResponse = {
              */
             keywords: Array<string>;
             /**
-             * Aspect nature classification.
+             * How this aspect type is characterised in its reference card, in the requested language, exactly like the name, description and keywords beside it. This is a property of the aspect TYPE, so branch on the aspect-level interpretation field instead, which is always English and is the classification applied to this particular pair.
              */
             nature: string;
         };
@@ -4244,7 +4261,7 @@ export type YogaDetail = {
 
 export type YogaDetectResponse = {
     /**
-     * Array of 44 detected yogas, always the full set so a caller can render absent verdicts too. Every entry carries a `present` boolean and a `quality` (Positive, Negative, or Both = auspicious, inauspicious, or context-dependent); filter on present === true for active yogas. Evidence text names the rule that triggered or failed, or the precedence norm that outranked it.
+     * Array of 48 detected yogas, always the full set so a caller can render absent verdicts too. Every entry carries a `present` boolean and a `quality` (Positive, Negative, or Both = auspicious, inauspicious, or context-dependent); filter on present === true for active yogas. Evidence text names the rule that triggered or failed, or the precedence norm that outranked it.
      */
     yogas: Array<{
         /**
@@ -4298,7 +4315,7 @@ export type YogaDetectResponse = {
         ayanamsaDegrees: number;
     };
     /**
-     * Count of yogas where present === true in this chart. Range 0-44, though real charts sit in the low single digits: the Nabhasa families are mutually constrained by the precedence norms, and most shape yogas are rare.
+     * Count of yogas where present === true in this chart. Range 0-48, though real charts sit in the low single digits: the Nabhasa families are mutually constrained by the precedence norms, and most shape yogas are rare.
      */
     total: number;
     /**
@@ -7440,6 +7457,148 @@ export type DreamSymbol = {
     meaning: string;
 };
 
+export type GetLanguagesFieldLabelsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
+         */
+        lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
+    };
+    url: '/languages/field-labels';
+};
+
+export type GetLanguagesFieldLabelsErrors = {
+    /**
+     * Validation error. `issues[]` lists every failed field.
+     */
+    400: {
+        /**
+         * First issue summary.
+         */
+        error: string;
+        code: 'validation_error';
+        /**
+         * Every validation failure. Use this to rebuild a valid request.
+         */
+        issues: Array<{
+            /**
+             * Dot-separated field path, or "(root)" for top-level.
+             */
+            path: string;
+            message: string;
+            /**
+             * Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
+             */
+            code?: string;
+            /**
+             * Expected type for invalid_type.
+             */
+            expected?: string;
+            /**
+             * Minimum bound for too_small issues.
+             */
+            minimum?: number | string;
+            /**
+             * Maximum bound for too_big issues.
+             */
+            maximum?: number | string;
+            inclusive?: boolean;
+            /**
+             * Format name for string issues (regex, email, url, uuid).
+             */
+            format?: string;
+            /**
+             * Regex pattern when format is regex.
+             */
+            pattern?: string;
+        }>;
+    };
+    /**
+     * Invalid or missing API key
+     */
+    401: {
+        /**
+         * Human-readable error message. May change wording.
+         */
+        error: string;
+        /**
+         * Machine-readable error code. Stable identifier.
+         */
+        code: string;
+    };
+    /**
+     * Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
+     */
+    405: {
+        error: string;
+        code: 'method_not_allowed';
+        /**
+         * Allowed HTTP methods for this path. Mirrors the Allow response header.
+         */
+        allow: Array<string>;
+        /**
+         * Link to the product page for this domain.
+         */
+        docs?: string;
+    };
+    /**
+     * Monthly rate limit exceeded
+     */
+    429: {
+        /**
+         * Human-readable error message. May change wording.
+         */
+        error: string;
+        /**
+         * Machine-readable error code. Stable identifier.
+         */
+        code: string;
+    };
+    /**
+     * Internal server error
+     */
+    500: {
+        /**
+         * Human-readable error message. May change wording.
+         */
+        error: string;
+        /**
+         * Machine-readable error code. Stable identifier.
+         */
+        code: string;
+    };
+};
+
+export type GetLanguagesFieldLabelsError = GetLanguagesFieldLabelsErrors[keyof GetLanguagesFieldLabelsErrors];
+
+export type GetLanguagesFieldLabelsResponses = {
+    /**
+     * Form labels resolved for the requested language
+     */
+    200: {
+        /**
+         * Language these labels resolved to. Echoes the `lang` query parameter, or `en` when it is omitted.
+         */
+        lang: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
+        /**
+         * Label per request field or parameter name. Keys are the wire names used in request bodies and query parameters, such as `birthDate`, `timezone` or `houseSystem`.
+         */
+        fields: {
+            [key: string]: string;
+        };
+        /**
+         * Label per selectable option, keyed `{fieldName}.{value}` so the same value can read differently under different fields. For example `nodeType.mean` and `houseSystem.whole-sign`. Split on the first dot: the field name is before it, and everything after it is the value you send back unchanged.
+         */
+        enums: {
+            [key: string]: string;
+        };
+    };
+};
+
+export type GetLanguagesFieldLabelsResponse = GetLanguagesFieldLabelsResponses[keyof GetLanguagesFieldLabelsResponses];
+
 export type GetAstrologySignsData = {
     body?: never;
     path?: never;
@@ -9676,7 +9835,7 @@ export type PostAstrologySynastryResponses = {
                  */
                 keywords: Array<string>;
                 /**
-                 * Aspect nature classification.
+                 * How this aspect type is characterised in its reference card, in the requested language, exactly like the name, description and keywords beside it. Branch on the aspect-level interpretation field instead, which is always English.
                  */
                 nature: string;
                 /**
@@ -10619,7 +10778,7 @@ export type PostAstrologyTransitAspectsResponses = {
              */
             strength: number;
             /**
-             * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
+             * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
              */
             interpretation: 'harmonious' | 'challenging' | 'neutral';
             /**
@@ -10713,7 +10872,7 @@ export type PostAstrologyTransitAspectsResponses = {
                  */
                 strength: number;
                 /**
-                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
+                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
                  */
                 interpretation: 'harmonious' | 'challenging' | 'neutral';
                 /**
@@ -11069,7 +11228,7 @@ export type PostAstrologySolarReturnResponses = {
                  */
                 strength: number;
                 /**
-                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
+                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
                  */
                 interpretation: 'harmonious' | 'challenging' | 'neutral';
             }>;
@@ -11450,7 +11609,7 @@ export type PostAstrologyLunarReturnResponses = {
                  */
                 strength: number;
                 /**
-                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
+                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
                  */
                 interpretation: 'harmonious' | 'challenging' | 'neutral';
             }>;
@@ -11908,7 +12067,7 @@ export type PostAstrologyCompositeChartResponses = {
              */
             strength: number;
             /**
-             * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
+             * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
              */
             interpretation: 'harmonious' | 'challenging' | 'neutral';
         }>;
@@ -13380,7 +13539,7 @@ export type PostAstrologyPlanetaryReturnsResponses = {
                  */
                 strength: number;
                 /**
-                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
+                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
                  */
                 interpretation: 'harmonious' | 'challenging' | 'neutral';
             }>;
@@ -20488,7 +20647,7 @@ export type PostVedicAstrologyYogaDetectError = PostVedicAstrologyYogaDetectErro
 
 export type PostVedicAstrologyYogaDetectResponses = {
     /**
-     * List of 44 classical yogas with present/absent verdicts and classical-text evidence.
+     * List of 48 classical yogas with present/absent verdicts and classical-text evidence.
      */
     200: YogaDetectResponse;
 };
@@ -26908,7 +27067,7 @@ export type PostForecastSolarReturnResponses = {
                  */
                 strength: number;
                 /**
-                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
+                 * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
                  */
                 interpretation: 'harmonious' | 'challenging' | 'neutral';
             }>;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.2.61';
+export const VERSION = '1.2.63';