@roxyapi/sdk 1.2.87 → 1.2.88

package/dist/types.gen.d.ts

@@ -5078,6 +5078,10 @@ export type KpChartResponse = {
              * Nakshatra of Rahu.
              */
             nakshatra: string;
+            /**
+             * Nakshatra pada (1-4) of Rahu.
+             */
+            pada: number;
             /**
              * KP star lord of Rahu.
              */
@@ -5119,6 +5123,10 @@ export type KpChartResponse = {
              * Nakshatra of Ketu.
              */
             nakshatra: string;
+            /**
+             * Nakshatra pada (1-4) of Ketu.
+             */
+            pada: number;
             /**
              * KP star lord of Ketu.
              */
@@ -16675,7 +16683,7 @@ export type PostAstrologyFixedStarsData = {
         /**
          * Conjunction orb in degrees, the maximum separation for a star to count as conjunct a chart point. Defaults to 1, maximum 3. Widen it to surface looser contacts or tighten it for only the closest hits.
          */
-        orb?: number | null;
+        orb?: number;
     };
     url: '/astrology/fixed-stars';
 };
@@ -28187,11 +28195,11 @@ export type PostVedicAstrologyEclipticCrossingsResponses = {
              */
             direction: 'ascending' | 'descending';
             /**
-             * Sidereal longitude of the planet at the moment of crossing (Lahiri ayanamsa).
+             * Longitude of the planet at the moment of crossing, in the requested coordinateSystem: sidereal (Lahiri ayanamsa) by default, tropical when asked.
              */
             longitude: number;
             /**
-             * Vedic zodiac sign (rashi) the planet occupies at the crossing.
+             * Zodiac sign the planet occupies at the crossing, read in the same coordinateSystem as longitude: the rashi under sidereal, the tropical sign under tropical.
              */
             sign: string;
         }>;
@@ -37567,7 +37575,7 @@ export type GetChineseAstrologyZodiacAnimalsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/chinese-astrology/zodiac/animals';
 };
@@ -39125,7 +39133,7 @@ export type GetChineseAstrologyCalendarSolarTermsByYearResponses = {
 export type GetChineseAstrologyCalendarSolarTermsByYearResponse = GetChineseAstrologyCalendarSolarTermsByYearResponses[keyof GetChineseAstrologyCalendarSolarTermsByYearResponses];
 export type PostChineseAstrologyCalendarLunarDateData = {
     /**
-     * Send a Gregorian date to convert forward, or a lunar year, month and day to convert back.
+     * Send a Gregorian date to convert forward, or a lunar year, month and day to convert back. The two sides are exclusive, which is why the whole body carries one example rather than leaving the per field ones to be read together.
      */
     body?: {
         /**
@@ -40517,7 +40525,7 @@ export type GetChineseAstrologyElementsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/chinese-astrology/elements';
 };
@@ -42352,7 +42360,7 @@ export type GetFengShuiFlyingStarsStarsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/feng-shui/flying-stars/stars';
 };
@@ -43036,7 +43044,7 @@ export type GetFengShuiBaguaData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/feng-shui/bagua';
 };
@@ -44498,6 +44506,9 @@ export type PostMesoamericanAstrologyMayanChartResponses = {
 };
 export type PostMesoamericanAstrologyMayanChartResponse = PostMesoamericanAstrologyMayanChartResponses[keyof PostMesoamericanAstrologyMayanChartResponses];
 export type PostMesoamericanAstrologyMayanLongCountConvertData = {
+    /**
+     * What to convert, and under which correlation. Exactly one of date and longCount is present, which is why the whole body carries one example rather than leaving the per field ones to be read together.
+     */
     body: {
         /**
          * Proleptic Gregorian date to convert INTO a Long Count. Supply this or longCount, never both and never neither.
@@ -45468,7 +45479,7 @@ export type GetMesoamericanAstrologyMayanDaySignsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/mesoamerican-astrology/mayan/day-signs';
 };
@@ -45911,7 +45922,7 @@ export type GetMesoamericanAstrologyMayanTrecenasData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/mesoamerican-astrology/mayan/trecenas';
 };
@@ -46271,7 +46282,7 @@ export type GetMesoamericanAstrologyMayanHaabMonthsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/mesoamerican-astrology/mayan/haab-months';
 };
@@ -47066,7 +47077,7 @@ export type GetMesoamericanAstrologyAztecDaySignsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/mesoamerican-astrology/aztec/day-signs';
 };
@@ -47442,7 +47453,7 @@ export type GetMesoamericanAstrologyAztecTrecenasData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/mesoamerican-astrology/aztec/trecenas';
 };
@@ -47780,6 +47791,9 @@ export type GetMesoamericanAstrologyAztecTrecenasByNumberResponses = {
 };
 export type GetMesoamericanAstrologyAztecTrecenasByNumberResponse = GetMesoamericanAstrologyAztecTrecenasByNumberResponses[keyof GetMesoamericanAstrologyAztecTrecenasByNumberResponses];
 export type PostVastuEntranceData = {
+    /**
+     * Where the main door sits on the plot. Send facing or facingDegrees, never both, and locate the door with either door coordinates or doorPosition, never both.
+     */
     body?: {
         /**
          * The ground the mandala is projected over. Send width and depth for a compass-aligned rectangle, or polygon for anything else. The x axis runs east and the y axis north, and the mandala is aligned to the compass rather than to the building.
@@ -48480,6 +48494,9 @@ export type PostVastuMandalaResponses = {
 };
 export type PostVastuMandalaResponse = PostVastuMandalaResponses[keyof PostVastuMandalaResponses];
 export type PostVastuPlotData = {
+    /**
+     * The site to read: the ground, which way the front looks, and whichever of the slope, road, extensions, cuts and water you know. Send facing or facingDegrees, never both, and the same for the two plot forms.
+     */
     body?: {
         /**
          * The ground the mandala is projected over. Send width and depth for a compass-aligned rectangle, or polygon for anything else. The x axis runs east and the y axis north, and the mandala is aligned to the compass rather than to the building.
@@ -49462,6 +49479,9 @@ export type PostVastuAyadiResponses = {
 };
 export type PostVastuAyadiResponse = PostVastuAyadiResponses[keyof PostVastuAyadiResponses];
 export type PostVastuRoomsData = {
+    /**
+     * The floor plan to check. Send facing or facingDegrees, never both, and give each room either its quarter or its outline, never both.
+     */
     body?: {
         /**
          * The ground the mandala is projected over. Send width and depth for a compass-aligned rectangle, or polygon for anything else. The x axis runs east and the y axis north, and the mandala is aligned to the compass rather than to the building.
@@ -50191,7 +50211,7 @@ export type GetVastuDirectionsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/vastu/directions';
 };
@@ -50677,7 +50697,7 @@ export type GetVastuDevatasData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/vastu/devatas';
 };
@@ -56243,6 +56263,9 @@ export type PostNumerologyBusinessNameResponses = {
 };
 export type PostNumerologyBusinessNameResponse = PostNumerologyBusinessNameResponses[keyof PostNumerologyBusinessNameResponses];
 export type PostKabbalahGematriaData = {
+    /**
+     * What to score and how. Send text for a Latin input or textHebrew for a Hebrew one, never both: which one you send decides whether a transliteration step runs at all. Every other field has a default.
+     */
     body: {
         /**
          * Latin text to write in Hebrew and then score, up to 200 characters. Non Latin scripts are folded to Latin first, so a Cyrillic or Devanagari name works. Send textHebrew instead to control the Hebrew spelling yourself.
@@ -56259,7 +56282,7 @@ export type PostKabbalahGematriaData = {
         /**
          * Which ciphers to return, by identifier. Omit for every computed cipher. Valid values are mispar-hechrachi, mispar-gadol, otiyot-be-milui, mispar-katan, mispar-kidmi, mispar-prati, mispar-ha-merubah-ha-klali, mispar-meshulash, mispar-musafi, kolel.
          */
-        ciphers?: Array<string>;
+        ciphers?: Array<'mispar-hechrachi' | 'mispar-gadol' | 'otiyot-be-milui' | 'mispar-katan' | 'mispar-kidmi' | 'mispar-prati' | 'mispar-ha-merubah-ha-klali' | 'mispar-meshulash' | 'mispar-musafi' | 'kolel'>;
         /**
          * Which method the name mispar gadol means, because the sources use it for two. Use finals-500-900 to score the five word final letters as 500 to 900, or milui to score each letter as the value of its own spelled out name.
          */
@@ -56890,6 +56913,9 @@ export type GetKabbalahCiphersResponses = {
 };
 export type GetKabbalahCiphersResponse = GetKabbalahCiphersResponses[keyof GetKabbalahCiphersResponses];
 export type PostKabbalahNameProfileData = {
+    /**
+     * The name to profile. Send name for a Latin input or nameHebrew for a Hebrew one, never both: which one you send decides whether a transliteration step runs at all.
+     */
     body: {
         /**
          * The name in Latin script, to be written in Hebrew and then scored. Non Latin scripts are folded to Latin first. Send nameHebrew instead to control the spelling yourself.
@@ -57599,11 +57625,11 @@ export type GetKabbalahNamesData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
         /**
          * Ecliptic longitude in degrees, 0 inclusive to 360 exclusive, measured from 0 Aries. Returns the single name governing that degree instead of the list. 360 is rejected because it is the same point as 0 and the arcs are half open at the top.
          */
-        longitude?: number | null;
+        longitude?: number;
     };
     url: '/kabbalah/names';
 };
@@ -59043,6 +59069,9 @@ export type GetKabbalahLettersByIdResponses = {
 };
 export type GetKabbalahLettersByIdResponse = GetKabbalahLettersByIdResponses[keyof GetKabbalahLettersByIdResponses];
 export type PostKabbalahCompatibilityData = {
+    /**
+     * The two names to compare. Each side takes the Latin field or the Hebrew one, never both: which one you send decides whether a transliteration step runs for that side.
+     */
     body: {
         /**
          * First name in Latin script. Send firstNameHebrew instead to control the spelling.
@@ -59582,7 +59611,7 @@ export type GetTarotCardsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
         /**
          * Filter by arcana type. Major arcana (0-21) represents life lessons and spiritual themes. Minor arcana (Ace-King in 4 suits) represents daily situations and practical matters.
          */
@@ -59594,7 +59623,7 @@ export type GetTarotCardsData = {
         /**
          * Filter by card number. Major Arcana: 0 (The Fool) through 21 (The World). Minor Arcana: 1 (Ace) through 14 (King). Combine with arcana or suit filters for precise results.
          */
-        number?: number | null;
+        number?: number;
     };
     url: '/tarot/cards';
 };
@@ -64003,7 +64032,7 @@ export type PostAyurvedaRitucharyaResponse = PostAyurvedaRitucharyaResponses[key
 export type GetAyurvedaDailyData = {
     body?: never;
     path?: never;
-    query?: {
+    query: {
         /**
          * Response language (BCP 47). Supported: en, tr, de, es, hi, pt, fr, ru, zh-Hans, zh-Hant. Defaults to en. Coverage varies by domain, and a field with no translation in the requested language returns English.
          */
@@ -64015,11 +64044,11 @@ export type GetAyurvedaDailyData = {
         /**
          * Latitude in decimal degrees. It sets how long the day and the night actually are, which is what the dosha periods are cut from.
          */
-        latitude?: number | null;
+        latitude: number;
         /**
          * Longitude in decimal degrees. It sets the clock time of sunrise at this place.
          */
-        longitude?: number | null;
+        longitude: number;
         /**
          * Selects which day counts as current when date is omitted, and which local day sunrise is computed for. Defaults to UTC, so the reading rolls over at 00:00 UTC. Accepts an IANA name (e.g. "Europe/London"), decimal hours (e.g. 5.5 for IST), or a fixed UTC offset (e.g. "-05:00").
          */
@@ -64339,7 +64368,7 @@ export type GetAyurvedaDoshasData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/ayurveda/doshas';
 };
@@ -65134,7 +65163,7 @@ export type GetAyurvedaTastesData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/ayurveda/tastes';
 };
@@ -65393,7 +65422,7 @@ export type GetAyurvedaQualitiesData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/ayurveda/qualities';
 };
@@ -66195,7 +66224,7 @@ export type GetIchingHexagramsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/iching/hexagrams';
 };
@@ -67315,7 +67344,7 @@ export type GetCrystalsZodiacBySignData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/crystals/zodiac/{sign}';
 };
@@ -67506,7 +67535,7 @@ export type GetCrystalsChakraByChakraData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/crystals/chakra/{chakra}';
 };
@@ -67697,7 +67726,7 @@ export type GetCrystalsElementByElementData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/crystals/element/{element}';
 };
@@ -68066,7 +68095,7 @@ export type GetCrystalsSearchData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/crystals/search';
 };
@@ -69129,7 +69158,7 @@ export type GetCrystalsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/crystals';
 };
@@ -69559,7 +69588,7 @@ export type GetDreamsSymbolsData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/dreams/symbols';
 };
@@ -70344,7 +70373,7 @@ export type GetAngelNumbersNumbersData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
         /**
          * Filter results by angel number pattern type. "repeating" returns numbers like 111, 444, 7777. "sequential" returns patterns like 1234. "mirror" returns palindrome or alternating patterns like 1212, 717. "master" returns 11, 22, 33. "root" returns single digits 0-9. "compound" returns mixed sequences with no pure pattern like 911, 1122.
          */
@@ -71291,7 +71320,7 @@ export type GetLocationSearchData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/location/search';
 };
@@ -71489,7 +71518,7 @@ export type GetLocationCountriesData = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/location/countries';
 };
@@ -71672,7 +71701,7 @@ export type GetLocationCountriesByIso2Data = {
         /**
          * Number of items to skip for pagination. Default 0.
          */
-        offset?: number | null;
+        offset?: number;
     };
     url: '/location/countries/{iso2}';
 };