@roxyapi/sdk 1.2.85 → 1.2.86

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.
Files changed (47) hide show
  1. package/AGENTS.md +50 -29
  2. package/README.md +251 -185
  3. package/dist/client/client.gen.d.ts +1 -1
  4. package/dist/client/client.gen.d.ts.map +1 -1
  5. package/dist/client/index.d.ts +10 -10
  6. package/dist/client/index.d.ts.map +1 -1
  7. package/dist/client/types.gen.d.ts +4 -4
  8. package/dist/client/types.gen.d.ts.map +1 -1
  9. package/dist/client/utils.gen.d.ts +2 -2
  10. package/dist/client/utils.gen.d.ts.map +1 -1
  11. package/dist/client.gen.d.ts +2 -2
  12. package/dist/client.gen.d.ts.map +1 -1
  13. package/dist/core/bodySerializer.gen.d.ts +1 -1
  14. package/dist/core/bodySerializer.gen.d.ts.map +1 -1
  15. package/dist/core/serverSentEvents.gen.d.ts +1 -1
  16. package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
  17. package/dist/core/types.gen.d.ts +2 -2
  18. package/dist/core/types.gen.d.ts.map +1 -1
  19. package/dist/core/utils.gen.d.ts +1 -1
  20. package/dist/core/utils.gen.d.ts.map +1 -1
  21. package/dist/factory.cjs +2 -2
  22. package/dist/factory.d.ts +2 -2
  23. package/dist/factory.d.ts.map +1 -1
  24. package/dist/factory.js +2 -2
  25. package/dist/index.d.ts +2 -2
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/sdk.gen.d.ts +3 -3
  28. package/dist/sdk.gen.d.ts.map +1 -1
  29. package/dist/types.gen.d.ts +38 -64
  30. package/dist/types.gen.d.ts.map +1 -1
  31. package/dist/version.d.ts +1 -1
  32. package/docs/llms-full.txt +27 -23
  33. package/package.json +23 -11
  34. package/src/client/client.gen.ts +5 -5
  35. package/src/client/index.ts +10 -10
  36. package/src/client/types.gen.ts +4 -4
  37. package/src/client/utils.gen.ts +6 -6
  38. package/src/client.gen.ts +2 -2
  39. package/src/core/bodySerializer.gen.ts +1 -1
  40. package/src/core/serverSentEvents.gen.ts +1 -1
  41. package/src/core/types.gen.ts +2 -2
  42. package/src/core/utils.gen.ts +2 -2
  43. package/src/factory.ts +4 -4
  44. package/src/index.ts +2 -2
  45. package/src/sdk.gen.ts +5 -5
  46. package/src/types.gen.ts +38 -64
  47. package/src/version.ts +1 -1
package/dist/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.2.85";
1
+ export declare const VERSION = "1.2.86";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1,4 +1,4 @@
1
- # @roxyapi/sdk — Complete Method Reference
1
+ # @roxyapi/sdk: Complete Method Reference
2
2
 
3
3
  > TypeScript SDK for RoxyAPI. Multi-domain spiritual and metaphysical intelligence API. Fully typed, zero runtime dependencies. Install: `npm install @roxyapi/sdk`
4
4
 
@@ -25,7 +25,7 @@ const { data } = await roxy.astrology.getDailyHoroscope({
25
25
  <!-- Method sections below are generated from the OpenAPI spec by scripts/sync-docs.ts. Do not hand-edit between the BEGIN/END:METHODS markers; edit the spec instead. The intro above and the Error Handling / Advanced / Links sections below are curated. -->
26
26
  <!-- BEGIN:METHODS -->
27
27
 
28
- ## Western Astrology — `roxy.astrology`
28
+ ## Western Astrology: `roxy.astrology`
29
29
 
30
30
  Western astrology API for natal birth charts, daily, weekly, monthly, and yearly horoscopes with unique content per s...
31
31
 
@@ -442,7 +442,7 @@ const { data } = await roxy.astrology.generateProfections({
442
442
 
443
443
  ---
444
444
 
445
- ## Vedic Astrology — `roxy.vedicAstrology`
445
+ ## Vedic Astrology: `roxy.vedicAstrology`
446
446
 
447
447
  Vedic astrology (Jyotish) and KP API for kundli generation with 15 divisional charts (D1-D60), panchang with choghadi...
448
448
 
@@ -1107,7 +1107,7 @@ const { data } = await roxy.vedicAstrology.getHeliacalVisibility({
1107
1107
 
1108
1108
  ---
1109
1109
 
1110
- ## Forecast — `roxy.forecast`
1110
+ ## Forecast: `roxy.forecast`
1111
1111
 
1112
1112
  Astrology forecast API that merges upcoming transit aspects, sign ingresses, retrograde stations, new and full moons,...
1113
1113
 
@@ -1198,7 +1198,7 @@ const { data } = await roxy.forecast.forecastSolarReturn({
1198
1198
 
1199
1199
  ---
1200
1200
 
1201
- ## Human Design — `roxy.humanDesign`
1201
+ ## Human Design: `roxy.humanDesign`
1202
1202
 
1203
1203
  Human Design API that generates the full bodygraph from a birth moment: type, strategy, inner authority, profile, def...
1204
1204
 
@@ -1350,7 +1350,7 @@ const { data } = await roxy.humanDesign.calculateVariables({
1350
1350
 
1351
1351
  ---
1352
1352
 
1353
- ## Chinese Astrology — `roxy.chineseAstrology`
1353
+ ## Chinese Astrology: `roxy.chineseAstrology`
1354
1354
 
1355
1355
  Chinese zodiac and BaZi astrology API: Four Pillars charts, Chinese zodiac signs and the Chinese lunisolar calendar f...
1356
1356
 
@@ -1498,7 +1498,7 @@ const { data } = await roxy.chineseAstrology.listFiveElements({ query: { limit:
1498
1498
 
1499
1499
  ---
1500
1500
 
1501
- ## Feng Shui — `roxy.fengShui`
1501
+ ## Feng Shui: `roxy.fengShui`
1502
1502
 
1503
1503
  Compute classical feng shui from one API: Xuan Kong flying star natal charts for any of the nine periods and 24 mount...
1504
1504
 
@@ -1553,7 +1553,7 @@ const { data } = await roxy.fengShui.listNinePeriods({ query: { date: '2026-08-2
1553
1553
 
1554
1554
  ---
1555
1555
 
1556
- ## Mesoamerican Astrology — `roxy.mesoamericanAstrology`
1556
+ ## Mesoamerican Astrology: `roxy.mesoamericanAstrology`
1557
1557
 
1558
1558
  Calculate Mayan astrology day signs, the Tzolkin sacred round, the Haab year, the full Long Count and the Aztec tonal...
1559
1559
 
@@ -1641,7 +1641,7 @@ const { data } = await roxy.mesoamericanAstrology.getAztecTrecena({ path: { numb
1641
1641
 
1642
1642
  ---
1643
1643
 
1644
- ## Vastu — `roxy.vastu`
1644
+ ## Vastu: `roxy.vastu`
1645
1645
 
1646
1646
  Vastu Shastra API for directional home and plot analysis: entrance padas with the classical effect of each of the 32...
1647
1647
 
@@ -1782,7 +1782,7 @@ const { data } = await roxy.vastu.getDevata({ path: { id: 'jayanta' } });
1782
1782
 
1783
1783
  ---
1784
1784
 
1785
- ## Numerology — `roxy.numerology`
1785
+ ## Numerology: `roxy.numerology`
1786
1786
 
1787
1787
  Numerology API to calculate life path, expression, soul urge, personality, and maturity numbers, with Pinnacle and Ch...
1788
1788
 
@@ -1902,7 +1902,7 @@ const { data } = await roxy.numerology.calculateBusinessName({ body: { name: 'Fo
1902
1902
 
1903
1903
  ---
1904
1904
 
1905
- ## Kabbalah — `roxy.kabbalah`
1905
+ ## Kabbalah: `roxy.kabbalah`
1906
1906
 
1907
1907
  Kabbalah API for gematria, the 72 names, the Tree of Life and the Hebrew birthday, from one key
1908
1908
 
@@ -2004,7 +2004,7 @@ const { data } = await roxy.kabbalah.getDailySephirah({
2004
2004
 
2005
2005
  ---
2006
2006
 
2007
- ## Tarot — `roxy.tarot`
2007
+ ## Tarot: `roxy.tarot`
2008
2008
 
2009
2009
  Tarot reading API with the complete 78-card Rider-Waite-Smith deck and card meanings for love, career, health, and sp...
2010
2010
 
@@ -2099,7 +2099,7 @@ const { data } = await roxy.tarot.castCustomSpread({
2099
2099
 
2100
2100
  ---
2101
2101
 
2102
- ## Biorhythm — `roxy.biorhythm`
2102
+ ## Biorhythm: `roxy.biorhythm`
2103
2103
 
2104
2104
  The most complete biorhythm API: 10 cycle types across 3 primary (physical, emotional, intellectual), 4 secondary (in...
2105
2105
 
@@ -2147,7 +2147,7 @@ const { data } = await roxy.biorhythm.getDailyBiorhythm({ body: { seed: 'user123
2147
2147
 
2148
2148
  ---
2149
2149
 
2150
- ## Ayurveda — `roxy.ayurveda`
2150
+ ## Ayurveda: `roxy.ayurveda`
2151
2151
 
2152
2152
  Ayurveda API for dosha profiles, the dinacharya daily routine and the ritucharya seasonal regimen, with a verse cited...
2153
2153
 
@@ -2212,7 +2212,7 @@ const { data } = await roxy.ayurveda.listGunas({ query: { limit: 10, offset: 0 }
2212
2212
 
2213
2213
  ---
2214
2214
 
2215
- ## I-Ching — `roxy.iching`
2215
+ ## I-Ching: `roxy.iching`
2216
2216
 
2217
2217
  I-Ching oracle API with all 64 hexagrams, 384 changing lines, 8 trigrams, and modern interpretations for love, career...
2218
2218
 
@@ -2247,7 +2247,7 @@ const { data } = await roxy.iching.getTrigram({ path: { id: 'Heaven' } });
2247
2247
 
2248
2248
  ---
2249
2249
 
2250
- ## Crystals and Healing Stones — `roxy.crystals`
2250
+ ## Crystals and Healing Stones: `roxy.crystals`
2251
2251
 
2252
2252
  Crystal healing API covering the most popular and widely-searched healing crystals and gemstones, from Amethyst and R...
2253
2253
 
@@ -2310,7 +2310,7 @@ const { data } = await roxy.crystals.getCrystal({ path: { id: 'amethyst' } });
2310
2310
 
2311
2311
  ---
2312
2312
 
2313
- ## Dreams — `roxy.dreams`
2313
+ ## Dreams: `roxy.dreams`
2314
2314
 
2315
2315
  Dream interpretation API with a 2,000+ symbol dream dictionary and psychological meanings covering animals, objects,...
2316
2316
 
@@ -2333,7 +2333,7 @@ const { data } = await roxy.dreams.getDailyDreamSymbol({ body: { seed: 'user123'
2333
2333
 
2334
2334
  ---
2335
2335
 
2336
- ## Angel Numbers — `roxy.angelNumbers`
2336
+ ## Angel Numbers: `roxy.angelNumbers`
2337
2337
 
2338
2338
  Angel numbers API with meanings for 111, 222, 333, 444, 555, 666, 777, 888, 999, 1111, and 75+ sequences covering eve...
2339
2339
 
@@ -2353,7 +2353,7 @@ const { data } = await roxy.angelNumbers.getDailyAngelNumber({ body: { seed: 'us
2353
2353
 
2354
2354
  ---
2355
2355
 
2356
- ## Location and Timezone — `roxy.location`
2356
+ ## Location and Timezone: `roxy.location`
2357
2357
 
2358
2358
  Timezone and location API with city search and geocoding across 235,000+ cities in 240+ countries, returning latitude...
2359
2359
 
@@ -2370,7 +2370,7 @@ const { data } = await roxy.location.getCitiesByCountry({ path: { iso2: 'DE' },
2370
2370
 
2371
2371
  ---
2372
2372
 
2373
- ## Usage — `roxy.usage`
2373
+ ## Usage: `roxy.usage`
2374
2374
 
2375
2375
  Monitor your API usage, check rate limits, and track request consumption
2376
2376
 
@@ -2381,7 +2381,7 @@ const { data } = await roxy.usage.getUsageStats();
2381
2381
 
2382
2382
  ---
2383
2383
 
2384
- ## Languages — `roxy.languages`
2384
+ ## Languages: `roxy.languages`
2385
2385
 
2386
2386
  List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint
2387
2387
 
@@ -2400,8 +2400,10 @@ const { data } = await roxy.languages.listLanguages();
2400
2400
  ## Error Handling
2401
2401
 
2402
2402
  Every method returns `{ data, error, response }`. All errors have `{ error: string, code: string }`:
2403
- - `error` — human-readable message (may change wording, do not parse)
2404
- - `code` — machine-readable identifier (stable, safe to switch on)
2403
+ - `error` is the human-readable message (may change wording, do not parse)
2404
+ - `code` is the machine-readable identifier (stable, safe to switch on)
2405
+
2406
+ `data` and `error` are a discriminated pair: `data` is typed as possibly undefined until `error` is checked, so narrow with `if (error)` first, or pass `throwOnError: true` in the call options to have failures throw and `data` typed as always present.
2405
2407
 
2406
2408
  ```typescript
2407
2409
  const { data, error, response } = await roxy.astrology.getDailyHoroscope({
@@ -2431,7 +2433,9 @@ Error codes:
2431
2433
  | 401 | `invalid_api_key` | Key format invalid or tampered |
2432
2434
  | 401 | `subscription_not_found` | Key references non-existent subscription |
2433
2435
  | 401 | `subscription_inactive` | Subscription cancelled, expired, or suspended |
2436
+ | 401 | `api_key_revoked` | Key was deleted from the account |
2434
2437
  | 404 | `not_found` | Resource not found |
2438
+ | 4xx | `bad_request` and other status-derived codes | A client error the endpoint itself detected, such as a date window whose `endDate` precedes `startDate` |
2435
2439
  | 429 | `rate_limit_exceeded` | Monthly quota reached |
2436
2440
  | 500 | `internal_error` | Server error |
2437
2441
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@roxyapi/sdk",
3
- "version": "1.2.85",
4
- "description": "TypeScript SDK for Roxy — the multi-domain spiritual intelligence API",
3
+ "version": "1.2.86",
4
+ "description": "TypeScript SDK for RoxyAPI: astrology, Vedic astrology, forecasts, human design, Chinese zodiac, feng shui, numerology, tarot and 18+ domains behind one key, verified against NASA JPL Horizons",
5
5
  "type": "module",
6
6
  "exports": {
7
7
  ".": {
@@ -35,21 +35,33 @@
35
35
  },
36
36
  "keywords": [
37
37
  "astrology",
38
- "vedic",
39
- "tarot",
40
- "numerology",
41
38
  "horoscope",
42
- "kundli",
43
- "birth-chart",
44
39
  "natal-chart",
40
+ "birth-chart",
41
+ "vedic",
42
+ "kundli",
43
+ "panchang",
44
+ "kp-astrology",
45
+ "transits",
46
+ "human-design",
47
+ "chinese-zodiac",
48
+ "bazi",
49
+ "feng-shui",
50
+ "mayan-astrology",
51
+ "vastu",
52
+ "numerology",
53
+ "kabbalah",
54
+ "gematria",
55
+ "tarot",
56
+ "biorhythm",
57
+ "ayurveda",
45
58
  "iching",
46
59
  "crystals",
47
- "angel-numbers",
48
60
  "dreams",
49
- "biorhythm",
61
+ "angel-numbers",
50
62
  "spiritual",
51
- "API",
52
- "SDK",
63
+ "api",
64
+ "sdk",
53
65
  "typescript-sdk",
54
66
  "nodejs",
55
67
  "ai-agent",
@@ -1,9 +1,9 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import { createSseClient } from '../core/serverSentEvents.gen';
4
- import type { HttpMethod } from '../core/types.gen';
5
- import { getValidRequestBody } from '../core/utils.gen';
6
- import type { Client, Config, RequestOptions, ResolvedRequestOptions } from './types.gen';
3
+ import { createSseClient } from '../core/serverSentEvents.gen.js';
4
+ import type { HttpMethod } from '../core/types.gen.js';
5
+ import { getValidRequestBody } from '../core/utils.gen.js';
6
+ import type { Client, Config, RequestOptions, ResolvedRequestOptions } from './types.gen.js';
7
7
  import {
8
8
  buildUrl,
9
9
  createConfig,
@@ -12,7 +12,7 @@ import {
12
12
  mergeConfigs,
13
13
  mergeHeaders,
14
14
  setAuthParams,
15
- } from './utils.gen';
15
+ } from './utils.gen.js';
16
16
 
17
17
  type ReqInit = Omit<RequestInit, 'body' | 'headers'> & {
18
18
  body?: any;
@@ -1,17 +1,17 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- export type { Auth } from '../core/auth.gen';
4
- export type { QuerySerializerOptions } from '../core/bodySerializer.gen';
3
+ export type { Auth } from '../core/auth.gen.js';
4
+ export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
5
5
  export {
6
6
  formDataBodySerializer,
7
7
  jsonBodySerializer,
8
8
  urlSearchParamsBodySerializer,
9
- } from '../core/bodySerializer.gen';
10
- export { buildClientParams } from '../core/params.gen';
11
- export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen';
12
- export type { ServerSentEventsResult } from '../core/serverSentEvents.gen';
13
- export type { ClientMeta } from '../core/types.gen';
14
- export { createClient } from './client.gen';
9
+ } from '../core/bodySerializer.gen.js';
10
+ export { buildClientParams } from '../core/params.gen.js';
11
+ export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
12
+ export type { ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
13
+ export type { ClientMeta } from '../core/types.gen.js';
14
+ export { createClient } from './client.gen.js';
15
15
  export type {
16
16
  Client,
17
17
  ClientOptions,
@@ -23,5 +23,5 @@ export type {
23
23
  ResolvedRequestOptions,
24
24
  ResponseStyle,
25
25
  TDataShape,
26
- } from './types.gen';
27
- export { createConfig, mergeHeaders } from './utils.gen';
26
+ } from './types.gen.js';
27
+ export { createConfig, mergeHeaders } from './utils.gen.js';
@@ -1,12 +1,12 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import type { Auth } from '../core/auth.gen';
3
+ import type { Auth } from '../core/auth.gen.js';
4
4
  import type {
5
5
  ServerSentEventsOptions,
6
6
  ServerSentEventsResult,
7
- } from '../core/serverSentEvents.gen';
8
- import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen';
9
- import type { Middleware } from './utils.gen';
7
+ } from '../core/serverSentEvents.gen.js';
8
+ import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen.js';
9
+ import type { Middleware } from './utils.gen.js';
10
10
 
11
11
  export type ResponseStyle = 'data' | 'fields';
12
12
 
@@ -1,15 +1,15 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import { getAuthToken } from '../core/auth.gen';
4
- import type { QuerySerializerOptions } from '../core/bodySerializer.gen';
5
- import { jsonBodySerializer } from '../core/bodySerializer.gen';
3
+ import { getAuthToken } from '../core/auth.gen.js';
4
+ import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
5
+ import { jsonBodySerializer } from '../core/bodySerializer.gen.js';
6
6
  import {
7
7
  serializeArrayParam,
8
8
  serializeObjectParam,
9
9
  serializePrimitiveParam,
10
- } from '../core/pathSerializer.gen';
11
- import { getUrl } from '../core/utils.gen';
12
- import type { Client, ClientOptions, Config, RequestOptions } from './types.gen';
10
+ } from '../core/pathSerializer.gen.js';
11
+ import { getUrl } from '../core/utils.gen.js';
12
+ import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js';
13
13
 
14
14
  export const createQuerySerializer = <T = unknown>({
15
15
  parameters = {},
package/src/client.gen.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import { type Client, type ClientOptions, type Config, createClient, createConfig } from './client';
4
- import type { ClientOptions as ClientOptions2 } from './types.gen';
3
+ import { type Client, type ClientOptions, type Config, createClient, createConfig } from './client/index.js';
4
+ import type { ClientOptions as ClientOptions2 } from './types.gen.js';
5
5
 
6
6
  /**
7
7
  * The `createClientConfig()` function will be called on client initialization
@@ -1,6 +1,6 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import type { ArrayStyle, ObjectStyle, SerializerOptions } from './pathSerializer.gen';
3
+ import type { ArrayStyle, ObjectStyle, SerializerOptions } from './pathSerializer.gen.js';
4
4
 
5
5
  export type QuerySerializer = (query: Record<string, unknown>) => string;
6
6
 
@@ -1,6 +1,6 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import type { Config } from './types.gen';
3
+ import type { Config } from './types.gen.js';
4
4
 
5
5
  export type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> &
6
6
  Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & {
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import type { Auth, AuthToken } from './auth.gen';
4
- import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from './bodySerializer.gen';
3
+ import type { Auth, AuthToken } from './auth.gen.js';
4
+ import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from './bodySerializer.gen.js';
5
5
 
6
6
  export type HttpMethod =
7
7
  | 'connect'
@@ -1,12 +1,12 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
- import type { BodySerializer, QuerySerializer } from './bodySerializer.gen';
3
+ import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js';
4
4
  import {
5
5
  type ArraySeparatorStyle,
6
6
  serializeArrayParam,
7
7
  serializeObjectParam,
8
8
  serializePrimitiveParam,
9
- } from './pathSerializer.gen';
9
+ } from './pathSerializer.gen.js';
10
10
 
11
11
  export interface PathSerializer {
12
12
  path: Record<string, unknown>;
package/src/factory.ts CHANGED
@@ -2,11 +2,11 @@
2
2
  * Hand-written entry point — NOT auto-generated. Safe to edit.
3
3
  * Re-exports all generated SDK classes and types, plus the createRoxy factory.
4
4
  */
5
- export * from './index';
5
+ export * from './index.js';
6
6
 
7
- import { createClient, createConfig } from './client';
8
- import { Roxy } from './sdk.gen';
9
- import { VERSION } from './version';
7
+ import { createClient, createConfig } from './client/index.js';
8
+ import { Roxy } from './sdk.gen.js';
9
+ import { VERSION } from './version.js';
10
10
 
11
11
  type AuthToken = string | (() => Promise<string> | string);
12
12