@roxyapi/sdk 1.2.30 → 1.2.32
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/AGENTS.md +2 -0
- package/README.md +2 -0
- package/dist/factory.cjs +281 -1
- package/dist/factory.js +279 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +111 -1
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +3994 -6
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +1020 -383
- package/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/sdk.gen.ts +296 -1
- package/src/types.gen.ts +4079 -6
- package/src/version.ts +1 -1
package/dist/types.gen.d.ts
CHANGED
|
@@ -15221,7 +15221,7 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
15221
15221
|
*/
|
|
15222
15222
|
sign: string;
|
|
15223
15223
|
/**
|
|
15224
|
-
*
|
|
15224
|
+
* Bhava (house) number 1-12, counted whole-sign from the Lagna (house 1 is the Lagna rashi).
|
|
15225
15225
|
*/
|
|
15226
15226
|
house: number;
|
|
15227
15227
|
}>;
|
|
@@ -15242,7 +15242,7 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
15242
15242
|
*/
|
|
15243
15243
|
sign: string;
|
|
15244
15244
|
/**
|
|
15245
|
-
* Which natal house this planet is currently transiting through. Key for Gochar predictions.
|
|
15245
|
+
* Which natal house (whole-sign bhava from the Lagna) this planet is currently transiting through. Key for Gochar predictions.
|
|
15246
15246
|
*/
|
|
15247
15247
|
natalHouse: number;
|
|
15248
15248
|
/**
|
|
@@ -20345,17 +20345,49 @@ export type GetNumerologyMeaningsByNumberData = {
|
|
|
20345
20345
|
};
|
|
20346
20346
|
export type GetNumerologyMeaningsByNumberErrors = {
|
|
20347
20347
|
/**
|
|
20348
|
-
*
|
|
20348
|
+
* Validation error. `issues[]` lists every failed field.
|
|
20349
20349
|
*/
|
|
20350
20350
|
400: {
|
|
20351
20351
|
/**
|
|
20352
|
-
*
|
|
20352
|
+
* First issue summary.
|
|
20353
20353
|
*/
|
|
20354
20354
|
error: string;
|
|
20355
|
+
code: 'validation_error';
|
|
20355
20356
|
/**
|
|
20356
|
-
*
|
|
20357
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
20357
20358
|
*/
|
|
20358
|
-
|
|
20359
|
+
issues: Array<{
|
|
20360
|
+
/**
|
|
20361
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
20362
|
+
*/
|
|
20363
|
+
path: string;
|
|
20364
|
+
message: string;
|
|
20365
|
+
/**
|
|
20366
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
20367
|
+
*/
|
|
20368
|
+
code?: string;
|
|
20369
|
+
/**
|
|
20370
|
+
* Expected type for invalid_type.
|
|
20371
|
+
*/
|
|
20372
|
+
expected?: string;
|
|
20373
|
+
/**
|
|
20374
|
+
* Minimum bound for too_small issues.
|
|
20375
|
+
*/
|
|
20376
|
+
minimum?: number | string;
|
|
20377
|
+
/**
|
|
20378
|
+
* Maximum bound for too_big issues.
|
|
20379
|
+
*/
|
|
20380
|
+
maximum?: number | string;
|
|
20381
|
+
inclusive?: boolean;
|
|
20382
|
+
/**
|
|
20383
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
20384
|
+
*/
|
|
20385
|
+
format?: string;
|
|
20386
|
+
/**
|
|
20387
|
+
* Regex pattern when format is regex.
|
|
20388
|
+
*/
|
|
20389
|
+
pattern?: string;
|
|
20390
|
+
}>;
|
|
20359
20391
|
};
|
|
20360
20392
|
/**
|
|
20361
20393
|
* Invalid or missing API key
|
|
@@ -22235,6 +22267,3962 @@ export type PostTarotSpreadsCustomResponses = {
|
|
|
22235
22267
|
};
|
|
22236
22268
|
};
|
|
22237
22269
|
export type PostTarotSpreadsCustomResponse = PostTarotSpreadsCustomResponses[keyof PostTarotSpreadsCustomResponses];
|
|
22270
|
+
export type PostHumanDesignBodygraphData = {
|
|
22271
|
+
body?: {
|
|
22272
|
+
/**
|
|
22273
|
+
* 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.
|
|
22274
|
+
*/
|
|
22275
|
+
date: string;
|
|
22276
|
+
/**
|
|
22277
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
22278
|
+
*/
|
|
22279
|
+
time: string;
|
|
22280
|
+
/**
|
|
22281
|
+
* 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.
|
|
22282
|
+
*/
|
|
22283
|
+
timezone: number | string;
|
|
22284
|
+
/**
|
|
22285
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
22286
|
+
*/
|
|
22287
|
+
latitude?: number;
|
|
22288
|
+
/**
|
|
22289
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
22290
|
+
*/
|
|
22291
|
+
longitude?: number;
|
|
22292
|
+
};
|
|
22293
|
+
path?: never;
|
|
22294
|
+
query?: {
|
|
22295
|
+
/**
|
|
22296
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
22297
|
+
*/
|
|
22298
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
22299
|
+
};
|
|
22300
|
+
url: '/human-design/bodygraph';
|
|
22301
|
+
};
|
|
22302
|
+
export type PostHumanDesignBodygraphErrors = {
|
|
22303
|
+
/**
|
|
22304
|
+
* Validation error. `issues[]` lists every failed field.
|
|
22305
|
+
*/
|
|
22306
|
+
400: {
|
|
22307
|
+
/**
|
|
22308
|
+
* First issue summary.
|
|
22309
|
+
*/
|
|
22310
|
+
error: string;
|
|
22311
|
+
code: 'validation_error';
|
|
22312
|
+
/**
|
|
22313
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
22314
|
+
*/
|
|
22315
|
+
issues: Array<{
|
|
22316
|
+
/**
|
|
22317
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
22318
|
+
*/
|
|
22319
|
+
path: string;
|
|
22320
|
+
message: string;
|
|
22321
|
+
/**
|
|
22322
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
22323
|
+
*/
|
|
22324
|
+
code?: string;
|
|
22325
|
+
/**
|
|
22326
|
+
* Expected type for invalid_type.
|
|
22327
|
+
*/
|
|
22328
|
+
expected?: string;
|
|
22329
|
+
/**
|
|
22330
|
+
* Minimum bound for too_small issues.
|
|
22331
|
+
*/
|
|
22332
|
+
minimum?: number | string;
|
|
22333
|
+
/**
|
|
22334
|
+
* Maximum bound for too_big issues.
|
|
22335
|
+
*/
|
|
22336
|
+
maximum?: number | string;
|
|
22337
|
+
inclusive?: boolean;
|
|
22338
|
+
/**
|
|
22339
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
22340
|
+
*/
|
|
22341
|
+
format?: string;
|
|
22342
|
+
/**
|
|
22343
|
+
* Regex pattern when format is regex.
|
|
22344
|
+
*/
|
|
22345
|
+
pattern?: string;
|
|
22346
|
+
}>;
|
|
22347
|
+
};
|
|
22348
|
+
/**
|
|
22349
|
+
* Invalid or missing API key
|
|
22350
|
+
*/
|
|
22351
|
+
401: {
|
|
22352
|
+
/**
|
|
22353
|
+
* Human-readable error message. May change wording.
|
|
22354
|
+
*/
|
|
22355
|
+
error: string;
|
|
22356
|
+
/**
|
|
22357
|
+
* Machine-readable error code. Stable identifier.
|
|
22358
|
+
*/
|
|
22359
|
+
code: string;
|
|
22360
|
+
};
|
|
22361
|
+
/**
|
|
22362
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
22363
|
+
*/
|
|
22364
|
+
405: {
|
|
22365
|
+
error: string;
|
|
22366
|
+
code: 'method_not_allowed';
|
|
22367
|
+
/**
|
|
22368
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
22369
|
+
*/
|
|
22370
|
+
allow: Array<string>;
|
|
22371
|
+
/**
|
|
22372
|
+
* Link to the product page for this domain.
|
|
22373
|
+
*/
|
|
22374
|
+
docs?: string;
|
|
22375
|
+
};
|
|
22376
|
+
/**
|
|
22377
|
+
* Monthly rate limit exceeded
|
|
22378
|
+
*/
|
|
22379
|
+
429: {
|
|
22380
|
+
/**
|
|
22381
|
+
* Human-readable error message. May change wording.
|
|
22382
|
+
*/
|
|
22383
|
+
error: string;
|
|
22384
|
+
/**
|
|
22385
|
+
* Machine-readable error code. Stable identifier.
|
|
22386
|
+
*/
|
|
22387
|
+
code: string;
|
|
22388
|
+
};
|
|
22389
|
+
/**
|
|
22390
|
+
* Internal server error
|
|
22391
|
+
*/
|
|
22392
|
+
500: {
|
|
22393
|
+
/**
|
|
22394
|
+
* Human-readable error message. May change wording.
|
|
22395
|
+
*/
|
|
22396
|
+
error: string;
|
|
22397
|
+
/**
|
|
22398
|
+
* Machine-readable error code. Stable identifier.
|
|
22399
|
+
*/
|
|
22400
|
+
code: string;
|
|
22401
|
+
};
|
|
22402
|
+
};
|
|
22403
|
+
export type PostHumanDesignBodygraphError = PostHumanDesignBodygraphErrors[keyof PostHumanDesignBodygraphErrors];
|
|
22404
|
+
export type PostHumanDesignBodygraphResponses = {
|
|
22405
|
+
/**
|
|
22406
|
+
* Complete bodygraph with type, authority, profile, centers, channels, and gates
|
|
22407
|
+
*/
|
|
22408
|
+
200: {
|
|
22409
|
+
/**
|
|
22410
|
+
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
22411
|
+
*/
|
|
22412
|
+
type: string;
|
|
22413
|
+
/**
|
|
22414
|
+
* The aura strategy for engaging life correctly for this type.
|
|
22415
|
+
*/
|
|
22416
|
+
strategy: string;
|
|
22417
|
+
/**
|
|
22418
|
+
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
22419
|
+
*/
|
|
22420
|
+
authority: string;
|
|
22421
|
+
/**
|
|
22422
|
+
* The signature feeling of living in alignment with the type.
|
|
22423
|
+
*/
|
|
22424
|
+
signature: string;
|
|
22425
|
+
/**
|
|
22426
|
+
* The not-self theme, the recurring feeling that signals being out of alignment.
|
|
22427
|
+
*/
|
|
22428
|
+
notSelf: string;
|
|
22429
|
+
/**
|
|
22430
|
+
* Profile in conscious/unconscious form from the Personality Sun line over the Design Sun line.
|
|
22431
|
+
*/
|
|
22432
|
+
profile: string;
|
|
22433
|
+
/**
|
|
22434
|
+
* Definition type from the number of connected components among defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
22435
|
+
*/
|
|
22436
|
+
definition: string;
|
|
22437
|
+
/**
|
|
22438
|
+
* The incarnation cross built from the four cardinal gates and the profile angle.
|
|
22439
|
+
*/
|
|
22440
|
+
incarnationCross: {
|
|
22441
|
+
/**
|
|
22442
|
+
* The four cardinal gates of the cross: Personality Sun, Personality Earth, Design Sun, Design Earth.
|
|
22443
|
+
*/
|
|
22444
|
+
gates: Array<number>;
|
|
22445
|
+
/**
|
|
22446
|
+
* Cross angle. One of Right Angle, Juxtaposition, Left Angle.
|
|
22447
|
+
*/
|
|
22448
|
+
angle: string;
|
|
22449
|
+
/**
|
|
22450
|
+
* Short code for the angle. One of RAX, JXT, LAX.
|
|
22451
|
+
*/
|
|
22452
|
+
angleCode: string;
|
|
22453
|
+
/**
|
|
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
|
+
*/
|
|
22456
|
+
name: string;
|
|
22457
|
+
};
|
|
22458
|
+
/**
|
|
22459
|
+
* All nine centers with their defined state and active gates.
|
|
22460
|
+
*/
|
|
22461
|
+
centers: Array<{
|
|
22462
|
+
/**
|
|
22463
|
+
* Center identifier. One of head, ajna, throat, g, heart, sacral, solar-plexus, spleen, root.
|
|
22464
|
+
*/
|
|
22465
|
+
id: string;
|
|
22466
|
+
/**
|
|
22467
|
+
* Display name of the center.
|
|
22468
|
+
*/
|
|
22469
|
+
name: string;
|
|
22470
|
+
/**
|
|
22471
|
+
* Whether the center is defined. A defined center is a consistent source of energy or awareness; an undefined center is open and conditioned by others.
|
|
22472
|
+
*/
|
|
22473
|
+
defined: boolean;
|
|
22474
|
+
/**
|
|
22475
|
+
* Whether this is a motor center (energy source). The four motors are Heart, Sacral, Solar Plexus, and Root.
|
|
22476
|
+
*/
|
|
22477
|
+
motor: boolean;
|
|
22478
|
+
/**
|
|
22479
|
+
* Whether this is an awareness center. The three awareness centers are Ajna, Solar Plexus, and Spleen.
|
|
22480
|
+
*/
|
|
22481
|
+
awareness: boolean;
|
|
22482
|
+
/**
|
|
22483
|
+
* Theme text describing the center in its current defined or undefined state.
|
|
22484
|
+
*/
|
|
22485
|
+
theme: string;
|
|
22486
|
+
/**
|
|
22487
|
+
* Active gate numbers that sit in this center.
|
|
22488
|
+
*/
|
|
22489
|
+
gates: Array<number>;
|
|
22490
|
+
}>;
|
|
22491
|
+
/**
|
|
22492
|
+
* The defined channels where both gates are activated.
|
|
22493
|
+
*/
|
|
22494
|
+
channels: Array<{
|
|
22495
|
+
/**
|
|
22496
|
+
* First gate of the channel.
|
|
22497
|
+
*/
|
|
22498
|
+
gateA: number;
|
|
22499
|
+
/**
|
|
22500
|
+
* Second gate of the channel.
|
|
22501
|
+
*/
|
|
22502
|
+
gateB: number;
|
|
22503
|
+
/**
|
|
22504
|
+
* Name of the defined channel.
|
|
22505
|
+
*/
|
|
22506
|
+
name: string;
|
|
22507
|
+
/**
|
|
22508
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal.
|
|
22509
|
+
*/
|
|
22510
|
+
circuit: string;
|
|
22511
|
+
/**
|
|
22512
|
+
* The two centers this channel connects and defines.
|
|
22513
|
+
*/
|
|
22514
|
+
centers: Array<string>;
|
|
22515
|
+
}>;
|
|
22516
|
+
/**
|
|
22517
|
+
* All 26 activations, 13 Personality and 13 Design.
|
|
22518
|
+
*/
|
|
22519
|
+
gates: Array<{
|
|
22520
|
+
/**
|
|
22521
|
+
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
22522
|
+
*/
|
|
22523
|
+
planet: string;
|
|
22524
|
+
/**
|
|
22525
|
+
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
22526
|
+
*/
|
|
22527
|
+
side: string;
|
|
22528
|
+
/**
|
|
22529
|
+
* Human Design gate number from 1 to 64 that this activation falls in.
|
|
22530
|
+
*/
|
|
22531
|
+
gate: number;
|
|
22532
|
+
/**
|
|
22533
|
+
* Line number from 1 to 6 within the gate, setting the line keynote and the profile.
|
|
22534
|
+
*/
|
|
22535
|
+
line: number;
|
|
22536
|
+
/**
|
|
22537
|
+
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
22538
|
+
*/
|
|
22539
|
+
gateName: string;
|
|
22540
|
+
/**
|
|
22541
|
+
* Cross-reference to the I-Ching hexagram that shares this gate number.
|
|
22542
|
+
*/
|
|
22543
|
+
ichingHexagram: {
|
|
22544
|
+
/**
|
|
22545
|
+
* I-Ching hexagram number, identical to the gate number it corresponds to.
|
|
22546
|
+
*/
|
|
22547
|
+
number: number;
|
|
22548
|
+
/**
|
|
22549
|
+
* English name of the corresponding I-Ching hexagram.
|
|
22550
|
+
*/
|
|
22551
|
+
english: string;
|
|
22552
|
+
};
|
|
22553
|
+
}>;
|
|
22554
|
+
};
|
|
22555
|
+
};
|
|
22556
|
+
export type PostHumanDesignBodygraphResponse = PostHumanDesignBodygraphResponses[keyof PostHumanDesignBodygraphResponses];
|
|
22557
|
+
export type PostHumanDesignConnectionData = {
|
|
22558
|
+
body?: {
|
|
22559
|
+
/**
|
|
22560
|
+
* Birth moment of the first person in the connection.
|
|
22561
|
+
*/
|
|
22562
|
+
personA: {
|
|
22563
|
+
/**
|
|
22564
|
+
* 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.
|
|
22565
|
+
*/
|
|
22566
|
+
date: string;
|
|
22567
|
+
/**
|
|
22568
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
22569
|
+
*/
|
|
22570
|
+
time: string;
|
|
22571
|
+
/**
|
|
22572
|
+
* 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.
|
|
22573
|
+
*/
|
|
22574
|
+
timezone: number | string;
|
|
22575
|
+
/**
|
|
22576
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
22577
|
+
*/
|
|
22578
|
+
latitude?: number;
|
|
22579
|
+
/**
|
|
22580
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
22581
|
+
*/
|
|
22582
|
+
longitude?: number;
|
|
22583
|
+
};
|
|
22584
|
+
/**
|
|
22585
|
+
* Birth moment of the second person in the connection.
|
|
22586
|
+
*/
|
|
22587
|
+
personB: {
|
|
22588
|
+
/**
|
|
22589
|
+
* 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.
|
|
22590
|
+
*/
|
|
22591
|
+
date: string;
|
|
22592
|
+
/**
|
|
22593
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
22594
|
+
*/
|
|
22595
|
+
time: string;
|
|
22596
|
+
/**
|
|
22597
|
+
* 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.
|
|
22598
|
+
*/
|
|
22599
|
+
timezone: number | string;
|
|
22600
|
+
/**
|
|
22601
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
22602
|
+
*/
|
|
22603
|
+
latitude?: number;
|
|
22604
|
+
/**
|
|
22605
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
22606
|
+
*/
|
|
22607
|
+
longitude?: number;
|
|
22608
|
+
};
|
|
22609
|
+
};
|
|
22610
|
+
path?: never;
|
|
22611
|
+
query?: {
|
|
22612
|
+
/**
|
|
22613
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
22614
|
+
*/
|
|
22615
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
22616
|
+
};
|
|
22617
|
+
url: '/human-design/connection';
|
|
22618
|
+
};
|
|
22619
|
+
export type PostHumanDesignConnectionErrors = {
|
|
22620
|
+
/**
|
|
22621
|
+
* Validation error. `issues[]` lists every failed field.
|
|
22622
|
+
*/
|
|
22623
|
+
400: {
|
|
22624
|
+
/**
|
|
22625
|
+
* First issue summary.
|
|
22626
|
+
*/
|
|
22627
|
+
error: string;
|
|
22628
|
+
code: 'validation_error';
|
|
22629
|
+
/**
|
|
22630
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
22631
|
+
*/
|
|
22632
|
+
issues: Array<{
|
|
22633
|
+
/**
|
|
22634
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
22635
|
+
*/
|
|
22636
|
+
path: string;
|
|
22637
|
+
message: string;
|
|
22638
|
+
/**
|
|
22639
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
22640
|
+
*/
|
|
22641
|
+
code?: string;
|
|
22642
|
+
/**
|
|
22643
|
+
* Expected type for invalid_type.
|
|
22644
|
+
*/
|
|
22645
|
+
expected?: string;
|
|
22646
|
+
/**
|
|
22647
|
+
* Minimum bound for too_small issues.
|
|
22648
|
+
*/
|
|
22649
|
+
minimum?: number | string;
|
|
22650
|
+
/**
|
|
22651
|
+
* Maximum bound for too_big issues.
|
|
22652
|
+
*/
|
|
22653
|
+
maximum?: number | string;
|
|
22654
|
+
inclusive?: boolean;
|
|
22655
|
+
/**
|
|
22656
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
22657
|
+
*/
|
|
22658
|
+
format?: string;
|
|
22659
|
+
/**
|
|
22660
|
+
* Regex pattern when format is regex.
|
|
22661
|
+
*/
|
|
22662
|
+
pattern?: string;
|
|
22663
|
+
}>;
|
|
22664
|
+
};
|
|
22665
|
+
/**
|
|
22666
|
+
* Invalid or missing API key
|
|
22667
|
+
*/
|
|
22668
|
+
401: {
|
|
22669
|
+
/**
|
|
22670
|
+
* Human-readable error message. May change wording.
|
|
22671
|
+
*/
|
|
22672
|
+
error: string;
|
|
22673
|
+
/**
|
|
22674
|
+
* Machine-readable error code. Stable identifier.
|
|
22675
|
+
*/
|
|
22676
|
+
code: string;
|
|
22677
|
+
};
|
|
22678
|
+
/**
|
|
22679
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
22680
|
+
*/
|
|
22681
|
+
405: {
|
|
22682
|
+
error: string;
|
|
22683
|
+
code: 'method_not_allowed';
|
|
22684
|
+
/**
|
|
22685
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
22686
|
+
*/
|
|
22687
|
+
allow: Array<string>;
|
|
22688
|
+
/**
|
|
22689
|
+
* Link to the product page for this domain.
|
|
22690
|
+
*/
|
|
22691
|
+
docs?: string;
|
|
22692
|
+
};
|
|
22693
|
+
/**
|
|
22694
|
+
* Monthly rate limit exceeded
|
|
22695
|
+
*/
|
|
22696
|
+
429: {
|
|
22697
|
+
/**
|
|
22698
|
+
* Human-readable error message. May change wording.
|
|
22699
|
+
*/
|
|
22700
|
+
error: string;
|
|
22701
|
+
/**
|
|
22702
|
+
* Machine-readable error code. Stable identifier.
|
|
22703
|
+
*/
|
|
22704
|
+
code: string;
|
|
22705
|
+
};
|
|
22706
|
+
/**
|
|
22707
|
+
* Internal server error
|
|
22708
|
+
*/
|
|
22709
|
+
500: {
|
|
22710
|
+
/**
|
|
22711
|
+
* Human-readable error message. May change wording.
|
|
22712
|
+
*/
|
|
22713
|
+
error: string;
|
|
22714
|
+
/**
|
|
22715
|
+
* Machine-readable error code. Stable identifier.
|
|
22716
|
+
*/
|
|
22717
|
+
code: string;
|
|
22718
|
+
};
|
|
22719
|
+
};
|
|
22720
|
+
export type PostHumanDesignConnectionError = PostHumanDesignConnectionErrors[keyof PostHumanDesignConnectionErrors];
|
|
22721
|
+
export type PostHumanDesignConnectionResponses = {
|
|
22722
|
+
/**
|
|
22723
|
+
* Connection chart with per-channel dynamics, combined centers, definition, and a dynamic count
|
|
22724
|
+
*/
|
|
22725
|
+
200: {
|
|
22726
|
+
/**
|
|
22727
|
+
* Total number of connected channels between the two people. Equals the length of channels and the sum of the summary counts.
|
|
22728
|
+
*/
|
|
22729
|
+
totalChannels: number;
|
|
22730
|
+
/**
|
|
22731
|
+
* Every connected channel between the two people with its dynamic. A channel is connected when the two people together hold both of its gates.
|
|
22732
|
+
*/
|
|
22733
|
+
channels: Array<{
|
|
22734
|
+
/**
|
|
22735
|
+
* First gate of the channel.
|
|
22736
|
+
*/
|
|
22737
|
+
gateA: number;
|
|
22738
|
+
/**
|
|
22739
|
+
* Second gate of the channel.
|
|
22740
|
+
*/
|
|
22741
|
+
gateB: number;
|
|
22742
|
+
/**
|
|
22743
|
+
* Name of the channel whose connection dynamic is reported.
|
|
22744
|
+
*/
|
|
22745
|
+
name: string;
|
|
22746
|
+
/**
|
|
22747
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal.
|
|
22748
|
+
*/
|
|
22749
|
+
circuit: string;
|
|
22750
|
+
/**
|
|
22751
|
+
* The two centers this channel connects in the bodygraph.
|
|
22752
|
+
*/
|
|
22753
|
+
centers: Array<string>;
|
|
22754
|
+
/**
|
|
22755
|
+
* Connection dynamic for this channel. Electromagnetic means each person holds one of the two gates and the channel completes only together, the classic point of attraction. Dominance means one person holds both gates and the other holds neither, a one-way conditioning. Compromise means one person holds both gates and the other holds a single hanging gate. Companionship means both people independently hold both gates, a shared and familiar frequency.
|
|
22756
|
+
*/
|
|
22757
|
+
dynamic: string;
|
|
22758
|
+
/**
|
|
22759
|
+
* Which of the channel two gates person A holds, from one to both.
|
|
22760
|
+
*/
|
|
22761
|
+
personAGates: Array<number>;
|
|
22762
|
+
/**
|
|
22763
|
+
* Which of the channel two gates person B holds, from one to both.
|
|
22764
|
+
*/
|
|
22765
|
+
personBGates: Array<number>;
|
|
22766
|
+
}>;
|
|
22767
|
+
/**
|
|
22768
|
+
* All nine centers with their defined state in the combined connection bodygraph and which person defines each.
|
|
22769
|
+
*/
|
|
22770
|
+
centers: Array<{
|
|
22771
|
+
/**
|
|
22772
|
+
* Center identifier. One of head, ajna, throat, g, heart, sacral, solar-plexus, spleen, root.
|
|
22773
|
+
*/
|
|
22774
|
+
id: string;
|
|
22775
|
+
/**
|
|
22776
|
+
* Display name of the center.
|
|
22777
|
+
*/
|
|
22778
|
+
name: string;
|
|
22779
|
+
/**
|
|
22780
|
+
* Whether the center is defined in the combined connection bodygraph, where a channel counts as defined when the two people together hold both of its gates.
|
|
22781
|
+
*/
|
|
22782
|
+
defined: boolean;
|
|
22783
|
+
/**
|
|
22784
|
+
* Who defines this center in their own chart. A, B, both, or empty when the center is open in both individual charts.
|
|
22785
|
+
*/
|
|
22786
|
+
definedBy: Array<string>;
|
|
22787
|
+
}>;
|
|
22788
|
+
/**
|
|
22789
|
+
* Definition of the combined connection bodygraph from connected components among its defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
22790
|
+
*/
|
|
22791
|
+
combinedDefinition: string;
|
|
22792
|
+
/**
|
|
22793
|
+
* Count of each connection dynamic across all connected channels.
|
|
22794
|
+
*/
|
|
22795
|
+
summary: {
|
|
22796
|
+
/**
|
|
22797
|
+
* Count of electromagnetic channels, the points of mutual attraction.
|
|
22798
|
+
*/
|
|
22799
|
+
electromagnetic: number;
|
|
22800
|
+
/**
|
|
22801
|
+
* Count of dominance channels, where one person conditions the other one way.
|
|
22802
|
+
*/
|
|
22803
|
+
dominance: number;
|
|
22804
|
+
/**
|
|
22805
|
+
* Count of compromise channels, a full channel meeting a single hanging gate.
|
|
22806
|
+
*/
|
|
22807
|
+
compromise: number;
|
|
22808
|
+
/**
|
|
22809
|
+
* Count of companionship channels, where both people share the whole channel.
|
|
22810
|
+
*/
|
|
22811
|
+
companionship: number;
|
|
22812
|
+
};
|
|
22813
|
+
};
|
|
22814
|
+
};
|
|
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];
|
|
23050
|
+
export type PostHumanDesignTransitData = {
|
|
23051
|
+
body?: {
|
|
23052
|
+
/**
|
|
23053
|
+
* Birth moment whose natal bodygraph the transit is overlaid on.
|
|
23054
|
+
*/
|
|
23055
|
+
birthData: {
|
|
23056
|
+
/**
|
|
23057
|
+
* 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.
|
|
23058
|
+
*/
|
|
23059
|
+
date: string;
|
|
23060
|
+
/**
|
|
23061
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
23062
|
+
*/
|
|
23063
|
+
time: string;
|
|
23064
|
+
/**
|
|
23065
|
+
* 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.
|
|
23066
|
+
*/
|
|
23067
|
+
timezone: number | string;
|
|
23068
|
+
/**
|
|
23069
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
23070
|
+
*/
|
|
23071
|
+
latitude?: number;
|
|
23072
|
+
/**
|
|
23073
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
23074
|
+
*/
|
|
23075
|
+
longitude?: number;
|
|
23076
|
+
};
|
|
23077
|
+
/**
|
|
23078
|
+
* Transit date in YYYY-MM-DD UTC. Optional. Defaults to today in UTC when omitted, giving the just-now transit.
|
|
23079
|
+
*/
|
|
23080
|
+
date?: string;
|
|
23081
|
+
/**
|
|
23082
|
+
* Transit time in HH:MM:SS UTC. Optional. Defaults to the current UTC time when omitted. Precision matters: the Moon moves through a gate in roughly half a day.
|
|
23083
|
+
*/
|
|
23084
|
+
time?: string;
|
|
23085
|
+
};
|
|
23086
|
+
path?: never;
|
|
23087
|
+
query?: {
|
|
23088
|
+
/**
|
|
23089
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
23090
|
+
*/
|
|
23091
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
23092
|
+
};
|
|
23093
|
+
url: '/human-design/transit';
|
|
23094
|
+
};
|
|
23095
|
+
export type PostHumanDesignTransitErrors = {
|
|
23096
|
+
/**
|
|
23097
|
+
* Validation error. `issues[]` lists every failed field.
|
|
23098
|
+
*/
|
|
23099
|
+
400: {
|
|
23100
|
+
/**
|
|
23101
|
+
* First issue summary.
|
|
23102
|
+
*/
|
|
23103
|
+
error: string;
|
|
23104
|
+
code: 'validation_error';
|
|
23105
|
+
/**
|
|
23106
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
23107
|
+
*/
|
|
23108
|
+
issues: Array<{
|
|
23109
|
+
/**
|
|
23110
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
23111
|
+
*/
|
|
23112
|
+
path: string;
|
|
23113
|
+
message: string;
|
|
23114
|
+
/**
|
|
23115
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
23116
|
+
*/
|
|
23117
|
+
code?: string;
|
|
23118
|
+
/**
|
|
23119
|
+
* Expected type for invalid_type.
|
|
23120
|
+
*/
|
|
23121
|
+
expected?: string;
|
|
23122
|
+
/**
|
|
23123
|
+
* Minimum bound for too_small issues.
|
|
23124
|
+
*/
|
|
23125
|
+
minimum?: number | string;
|
|
23126
|
+
/**
|
|
23127
|
+
* Maximum bound for too_big issues.
|
|
23128
|
+
*/
|
|
23129
|
+
maximum?: number | string;
|
|
23130
|
+
inclusive?: boolean;
|
|
23131
|
+
/**
|
|
23132
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
23133
|
+
*/
|
|
23134
|
+
format?: string;
|
|
23135
|
+
/**
|
|
23136
|
+
* Regex pattern when format is regex.
|
|
23137
|
+
*/
|
|
23138
|
+
pattern?: string;
|
|
23139
|
+
}>;
|
|
23140
|
+
};
|
|
23141
|
+
/**
|
|
23142
|
+
* Invalid or missing API key
|
|
23143
|
+
*/
|
|
23144
|
+
401: {
|
|
23145
|
+
/**
|
|
23146
|
+
* Human-readable error message. May change wording.
|
|
23147
|
+
*/
|
|
23148
|
+
error: string;
|
|
23149
|
+
/**
|
|
23150
|
+
* Machine-readable error code. Stable identifier.
|
|
23151
|
+
*/
|
|
23152
|
+
code: string;
|
|
23153
|
+
};
|
|
23154
|
+
/**
|
|
23155
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
23156
|
+
*/
|
|
23157
|
+
405: {
|
|
23158
|
+
error: string;
|
|
23159
|
+
code: 'method_not_allowed';
|
|
23160
|
+
/**
|
|
23161
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
23162
|
+
*/
|
|
23163
|
+
allow: Array<string>;
|
|
23164
|
+
/**
|
|
23165
|
+
* Link to the product page for this domain.
|
|
23166
|
+
*/
|
|
23167
|
+
docs?: string;
|
|
23168
|
+
};
|
|
23169
|
+
/**
|
|
23170
|
+
* Monthly rate limit exceeded
|
|
23171
|
+
*/
|
|
23172
|
+
429: {
|
|
23173
|
+
/**
|
|
23174
|
+
* Human-readable error message. May change wording.
|
|
23175
|
+
*/
|
|
23176
|
+
error: string;
|
|
23177
|
+
/**
|
|
23178
|
+
* Machine-readable error code. Stable identifier.
|
|
23179
|
+
*/
|
|
23180
|
+
code: string;
|
|
23181
|
+
};
|
|
23182
|
+
/**
|
|
23183
|
+
* Internal server error
|
|
23184
|
+
*/
|
|
23185
|
+
500: {
|
|
23186
|
+
/**
|
|
23187
|
+
* Human-readable error message. May change wording.
|
|
23188
|
+
*/
|
|
23189
|
+
error: string;
|
|
23190
|
+
/**
|
|
23191
|
+
* Machine-readable error code. Stable identifier.
|
|
23192
|
+
*/
|
|
23193
|
+
code: string;
|
|
23194
|
+
};
|
|
23195
|
+
};
|
|
23196
|
+
export type PostHumanDesignTransitError = PostHumanDesignTransitErrors[keyof PostHumanDesignTransitErrors];
|
|
23197
|
+
export type PostHumanDesignTransitResponses = {
|
|
23198
|
+
/**
|
|
23199
|
+
* Transit overlay with transiting activations, completed channels, temporary centers, and a summary
|
|
23200
|
+
*/
|
|
23201
|
+
200: {
|
|
23202
|
+
/**
|
|
23203
|
+
* Date the transit overlay was computed for, in YYYY-MM-DD UTC.
|
|
23204
|
+
*/
|
|
23205
|
+
date: string;
|
|
23206
|
+
/**
|
|
23207
|
+
* Time the transit overlay was computed for, in HH:MM:SS UTC.
|
|
23208
|
+
*/
|
|
23209
|
+
time: string;
|
|
23210
|
+
/**
|
|
23211
|
+
* UTC offset of the transit moment. Always 0, since the transit is computed in UTC.
|
|
23212
|
+
*/
|
|
23213
|
+
timezone: number;
|
|
23214
|
+
/**
|
|
23215
|
+
* The 13 transiting bodies at this moment with the gate and line each currently activates. A transit is a single instant, so there is no Design side, only current positions.
|
|
23216
|
+
*/
|
|
23217
|
+
activations: Array<{
|
|
23218
|
+
/**
|
|
23219
|
+
* Transiting body whose current position lands on this gate. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
23220
|
+
*/
|
|
23221
|
+
body: string;
|
|
23222
|
+
/**
|
|
23223
|
+
* Human Design gate number from 1 to 64 this transiting body currently sits in.
|
|
23224
|
+
*/
|
|
23225
|
+
gate: number;
|
|
23226
|
+
/**
|
|
23227
|
+
* Line number from 1 to 6 within the gate, setting the line keynote of the transit.
|
|
23228
|
+
*/
|
|
23229
|
+
line: number;
|
|
23230
|
+
/**
|
|
23231
|
+
* Human Design keynote name of the gate the transiting body activates.
|
|
23232
|
+
*/
|
|
23233
|
+
gateName: string;
|
|
23234
|
+
/**
|
|
23235
|
+
* Cross-reference to the I-Ching hexagram that shares this gate number.
|
|
23236
|
+
*/
|
|
23237
|
+
ichingHexagram: {
|
|
23238
|
+
/**
|
|
23239
|
+
* I-Ching hexagram number, identical to the gate number it corresponds to.
|
|
23240
|
+
*/
|
|
23241
|
+
number: number;
|
|
23242
|
+
/**
|
|
23243
|
+
* English name of the corresponding I-Ching hexagram.
|
|
23244
|
+
*/
|
|
23245
|
+
english: string;
|
|
23246
|
+
};
|
|
23247
|
+
}>;
|
|
23248
|
+
/**
|
|
23249
|
+
* Channels the transit temporarily completes that the natal chart did not already define, each labelled personal or educational with the side that supplied each gate.
|
|
23250
|
+
*/
|
|
23251
|
+
completedChannels: Array<{
|
|
23252
|
+
/**
|
|
23253
|
+
* First gate of the completed channel.
|
|
23254
|
+
*/
|
|
23255
|
+
gateA: number;
|
|
23256
|
+
/**
|
|
23257
|
+
* Second gate of the completed channel.
|
|
23258
|
+
*/
|
|
23259
|
+
gateB: number;
|
|
23260
|
+
/**
|
|
23261
|
+
* Name of the channel the transit temporarily completes.
|
|
23262
|
+
*/
|
|
23263
|
+
name: string;
|
|
23264
|
+
/**
|
|
23265
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal.
|
|
23266
|
+
*/
|
|
23267
|
+
circuit: string;
|
|
23268
|
+
/**
|
|
23269
|
+
* The two centers this channel connects and temporarily defines.
|
|
23270
|
+
*/
|
|
23271
|
+
centers: Array<string>;
|
|
23272
|
+
/**
|
|
23273
|
+
* How the transit completes the channel. personal means the natal chart already holds one gate and the transit supplies the other, the classic electromagnetic completion. educational means both gates are open in the natal chart and the transit supplies both at once.
|
|
23274
|
+
*/
|
|
23275
|
+
kind: string;
|
|
23276
|
+
/**
|
|
23277
|
+
* Gate or gates of this channel the natal chart already holds. Empty for an educational channel.
|
|
23278
|
+
*/
|
|
23279
|
+
natalGates: Array<number>;
|
|
23280
|
+
/**
|
|
23281
|
+
* Gate or gates of this channel supplied by the transit. One gate for a personal channel, both gates for an educational channel.
|
|
23282
|
+
*/
|
|
23283
|
+
transitGates: Array<number>;
|
|
23284
|
+
}>;
|
|
23285
|
+
/**
|
|
23286
|
+
* Centers that are open in the natal chart and temporarily defined by a transit-completed channel.
|
|
23287
|
+
*/
|
|
23288
|
+
temporaryCenters: Array<{
|
|
23289
|
+
/**
|
|
23290
|
+
* Center identifier. One of head, ajna, throat, g, heart, sacral, solar-plexus, spleen, root.
|
|
23291
|
+
*/
|
|
23292
|
+
id: string;
|
|
23293
|
+
/**
|
|
23294
|
+
* Display name of the center.
|
|
23295
|
+
*/
|
|
23296
|
+
name: string;
|
|
23297
|
+
/**
|
|
23298
|
+
* Always true. The center is open in the natal chart and temporarily defined by a transit-completed channel for the duration of the transit.
|
|
23299
|
+
*/
|
|
23300
|
+
temporarilyDefined: boolean;
|
|
23301
|
+
}>;
|
|
23302
|
+
/**
|
|
23303
|
+
* Short factual summary of the overlay with channel and center counts only.
|
|
23304
|
+
*/
|
|
23305
|
+
summary: string;
|
|
23306
|
+
};
|
|
23307
|
+
};
|
|
23308
|
+
export type PostHumanDesignTransitResponse = PostHumanDesignTransitResponses[keyof PostHumanDesignTransitResponses];
|
|
23309
|
+
export type PostHumanDesignTypeData = {
|
|
23310
|
+
body?: {
|
|
23311
|
+
/**
|
|
23312
|
+
* 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.
|
|
23313
|
+
*/
|
|
23314
|
+
date: string;
|
|
23315
|
+
/**
|
|
23316
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
23317
|
+
*/
|
|
23318
|
+
time: string;
|
|
23319
|
+
/**
|
|
23320
|
+
* 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.
|
|
23321
|
+
*/
|
|
23322
|
+
timezone: number | string;
|
|
23323
|
+
/**
|
|
23324
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
23325
|
+
*/
|
|
23326
|
+
latitude?: number;
|
|
23327
|
+
/**
|
|
23328
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
23329
|
+
*/
|
|
23330
|
+
longitude?: number;
|
|
23331
|
+
};
|
|
23332
|
+
path?: never;
|
|
23333
|
+
query?: {
|
|
23334
|
+
/**
|
|
23335
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
23336
|
+
*/
|
|
23337
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
23338
|
+
};
|
|
23339
|
+
url: '/human-design/type';
|
|
23340
|
+
};
|
|
23341
|
+
export type PostHumanDesignTypeErrors = {
|
|
23342
|
+
/**
|
|
23343
|
+
* Validation error. `issues[]` lists every failed field.
|
|
23344
|
+
*/
|
|
23345
|
+
400: {
|
|
23346
|
+
/**
|
|
23347
|
+
* First issue summary.
|
|
23348
|
+
*/
|
|
23349
|
+
error: string;
|
|
23350
|
+
code: 'validation_error';
|
|
23351
|
+
/**
|
|
23352
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
23353
|
+
*/
|
|
23354
|
+
issues: Array<{
|
|
23355
|
+
/**
|
|
23356
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
23357
|
+
*/
|
|
23358
|
+
path: string;
|
|
23359
|
+
message: string;
|
|
23360
|
+
/**
|
|
23361
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
23362
|
+
*/
|
|
23363
|
+
code?: string;
|
|
23364
|
+
/**
|
|
23365
|
+
* Expected type for invalid_type.
|
|
23366
|
+
*/
|
|
23367
|
+
expected?: string;
|
|
23368
|
+
/**
|
|
23369
|
+
* Minimum bound for too_small issues.
|
|
23370
|
+
*/
|
|
23371
|
+
minimum?: number | string;
|
|
23372
|
+
/**
|
|
23373
|
+
* Maximum bound for too_big issues.
|
|
23374
|
+
*/
|
|
23375
|
+
maximum?: number | string;
|
|
23376
|
+
inclusive?: boolean;
|
|
23377
|
+
/**
|
|
23378
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
23379
|
+
*/
|
|
23380
|
+
format?: string;
|
|
23381
|
+
/**
|
|
23382
|
+
* Regex pattern when format is regex.
|
|
23383
|
+
*/
|
|
23384
|
+
pattern?: string;
|
|
23385
|
+
}>;
|
|
23386
|
+
};
|
|
23387
|
+
/**
|
|
23388
|
+
* Invalid or missing API key
|
|
23389
|
+
*/
|
|
23390
|
+
401: {
|
|
23391
|
+
/**
|
|
23392
|
+
* Human-readable error message. May change wording.
|
|
23393
|
+
*/
|
|
23394
|
+
error: string;
|
|
23395
|
+
/**
|
|
23396
|
+
* Machine-readable error code. Stable identifier.
|
|
23397
|
+
*/
|
|
23398
|
+
code: string;
|
|
23399
|
+
};
|
|
23400
|
+
/**
|
|
23401
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
23402
|
+
*/
|
|
23403
|
+
405: {
|
|
23404
|
+
error: string;
|
|
23405
|
+
code: 'method_not_allowed';
|
|
23406
|
+
/**
|
|
23407
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
23408
|
+
*/
|
|
23409
|
+
allow: Array<string>;
|
|
23410
|
+
/**
|
|
23411
|
+
* Link to the product page for this domain.
|
|
23412
|
+
*/
|
|
23413
|
+
docs?: string;
|
|
23414
|
+
};
|
|
23415
|
+
/**
|
|
23416
|
+
* Monthly rate limit exceeded
|
|
23417
|
+
*/
|
|
23418
|
+
429: {
|
|
23419
|
+
/**
|
|
23420
|
+
* Human-readable error message. May change wording.
|
|
23421
|
+
*/
|
|
23422
|
+
error: string;
|
|
23423
|
+
/**
|
|
23424
|
+
* Machine-readable error code. Stable identifier.
|
|
23425
|
+
*/
|
|
23426
|
+
code: string;
|
|
23427
|
+
};
|
|
23428
|
+
/**
|
|
23429
|
+
* Internal server error
|
|
23430
|
+
*/
|
|
23431
|
+
500: {
|
|
23432
|
+
/**
|
|
23433
|
+
* Human-readable error message. May change wording.
|
|
23434
|
+
*/
|
|
23435
|
+
error: string;
|
|
23436
|
+
/**
|
|
23437
|
+
* Machine-readable error code. Stable identifier.
|
|
23438
|
+
*/
|
|
23439
|
+
code: string;
|
|
23440
|
+
};
|
|
23441
|
+
};
|
|
23442
|
+
export type PostHumanDesignTypeError = PostHumanDesignTypeErrors[keyof PostHumanDesignTypeErrors];
|
|
23443
|
+
export type PostHumanDesignTypeResponses = {
|
|
23444
|
+
/**
|
|
23445
|
+
* Type, strategy, authority, signature, not-self theme, and profile
|
|
23446
|
+
*/
|
|
23447
|
+
200: {
|
|
23448
|
+
/**
|
|
23449
|
+
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
23450
|
+
*/
|
|
23451
|
+
type: string;
|
|
23452
|
+
/**
|
|
23453
|
+
* The aura strategy for engaging life correctly for this type.
|
|
23454
|
+
*/
|
|
23455
|
+
strategy: string;
|
|
23456
|
+
/**
|
|
23457
|
+
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
23458
|
+
*/
|
|
23459
|
+
authority: string;
|
|
23460
|
+
/**
|
|
23461
|
+
* The signature feeling of living in alignment.
|
|
23462
|
+
*/
|
|
23463
|
+
signature: string;
|
|
23464
|
+
/**
|
|
23465
|
+
* The not-self theme that signals being out of alignment.
|
|
23466
|
+
*/
|
|
23467
|
+
notSelf: string;
|
|
23468
|
+
/**
|
|
23469
|
+
* Profile from the Personality Sun line over the Design Sun line.
|
|
23470
|
+
*/
|
|
23471
|
+
profile: string;
|
|
23472
|
+
};
|
|
23473
|
+
};
|
|
23474
|
+
export type PostHumanDesignTypeResponse = PostHumanDesignTypeResponses[keyof PostHumanDesignTypeResponses];
|
|
23475
|
+
export type PostHumanDesignGatesData = {
|
|
23476
|
+
body?: {
|
|
23477
|
+
/**
|
|
23478
|
+
* 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.
|
|
23479
|
+
*/
|
|
23480
|
+
date: string;
|
|
23481
|
+
/**
|
|
23482
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
23483
|
+
*/
|
|
23484
|
+
time: string;
|
|
23485
|
+
/**
|
|
23486
|
+
* 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.
|
|
23487
|
+
*/
|
|
23488
|
+
timezone: number | string;
|
|
23489
|
+
/**
|
|
23490
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
23491
|
+
*/
|
|
23492
|
+
latitude?: number;
|
|
23493
|
+
/**
|
|
23494
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
23495
|
+
*/
|
|
23496
|
+
longitude?: number;
|
|
23497
|
+
};
|
|
23498
|
+
path?: never;
|
|
23499
|
+
query?: {
|
|
23500
|
+
/**
|
|
23501
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
23502
|
+
*/
|
|
23503
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
23504
|
+
};
|
|
23505
|
+
url: '/human-design/gates';
|
|
23506
|
+
};
|
|
23507
|
+
export type PostHumanDesignGatesErrors = {
|
|
23508
|
+
/**
|
|
23509
|
+
* Validation error. `issues[]` lists every failed field.
|
|
23510
|
+
*/
|
|
23511
|
+
400: {
|
|
23512
|
+
/**
|
|
23513
|
+
* First issue summary.
|
|
23514
|
+
*/
|
|
23515
|
+
error: string;
|
|
23516
|
+
code: 'validation_error';
|
|
23517
|
+
/**
|
|
23518
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
23519
|
+
*/
|
|
23520
|
+
issues: Array<{
|
|
23521
|
+
/**
|
|
23522
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
23523
|
+
*/
|
|
23524
|
+
path: string;
|
|
23525
|
+
message: string;
|
|
23526
|
+
/**
|
|
23527
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
23528
|
+
*/
|
|
23529
|
+
code?: string;
|
|
23530
|
+
/**
|
|
23531
|
+
* Expected type for invalid_type.
|
|
23532
|
+
*/
|
|
23533
|
+
expected?: string;
|
|
23534
|
+
/**
|
|
23535
|
+
* Minimum bound for too_small issues.
|
|
23536
|
+
*/
|
|
23537
|
+
minimum?: number | string;
|
|
23538
|
+
/**
|
|
23539
|
+
* Maximum bound for too_big issues.
|
|
23540
|
+
*/
|
|
23541
|
+
maximum?: number | string;
|
|
23542
|
+
inclusive?: boolean;
|
|
23543
|
+
/**
|
|
23544
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
23545
|
+
*/
|
|
23546
|
+
format?: string;
|
|
23547
|
+
/**
|
|
23548
|
+
* Regex pattern when format is regex.
|
|
23549
|
+
*/
|
|
23550
|
+
pattern?: string;
|
|
23551
|
+
}>;
|
|
23552
|
+
};
|
|
23553
|
+
/**
|
|
23554
|
+
* Invalid or missing API key
|
|
23555
|
+
*/
|
|
23556
|
+
401: {
|
|
23557
|
+
/**
|
|
23558
|
+
* Human-readable error message. May change wording.
|
|
23559
|
+
*/
|
|
23560
|
+
error: string;
|
|
23561
|
+
/**
|
|
23562
|
+
* Machine-readable error code. Stable identifier.
|
|
23563
|
+
*/
|
|
23564
|
+
code: string;
|
|
23565
|
+
};
|
|
23566
|
+
/**
|
|
23567
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
23568
|
+
*/
|
|
23569
|
+
405: {
|
|
23570
|
+
error: string;
|
|
23571
|
+
code: 'method_not_allowed';
|
|
23572
|
+
/**
|
|
23573
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
23574
|
+
*/
|
|
23575
|
+
allow: Array<string>;
|
|
23576
|
+
/**
|
|
23577
|
+
* Link to the product page for this domain.
|
|
23578
|
+
*/
|
|
23579
|
+
docs?: string;
|
|
23580
|
+
};
|
|
23581
|
+
/**
|
|
23582
|
+
* Monthly rate limit exceeded
|
|
23583
|
+
*/
|
|
23584
|
+
429: {
|
|
23585
|
+
/**
|
|
23586
|
+
* Human-readable error message. May change wording.
|
|
23587
|
+
*/
|
|
23588
|
+
error: string;
|
|
23589
|
+
/**
|
|
23590
|
+
* Machine-readable error code. Stable identifier.
|
|
23591
|
+
*/
|
|
23592
|
+
code: string;
|
|
23593
|
+
};
|
|
23594
|
+
/**
|
|
23595
|
+
* Internal server error
|
|
23596
|
+
*/
|
|
23597
|
+
500: {
|
|
23598
|
+
/**
|
|
23599
|
+
* Human-readable error message. May change wording.
|
|
23600
|
+
*/
|
|
23601
|
+
error: string;
|
|
23602
|
+
/**
|
|
23603
|
+
* Machine-readable error code. Stable identifier.
|
|
23604
|
+
*/
|
|
23605
|
+
code: string;
|
|
23606
|
+
};
|
|
23607
|
+
};
|
|
23608
|
+
export type PostHumanDesignGatesError = PostHumanDesignGatesErrors[keyof PostHumanDesignGatesErrors];
|
|
23609
|
+
export type PostHumanDesignGatesResponses = {
|
|
23610
|
+
/**
|
|
23611
|
+
* Personality and Design activation lists, 13 each
|
|
23612
|
+
*/
|
|
23613
|
+
200: {
|
|
23614
|
+
/**
|
|
23615
|
+
* The 13 conscious Personality activations computed at the exact birth moment, in black on a standard chart.
|
|
23616
|
+
*/
|
|
23617
|
+
personality: Array<{
|
|
23618
|
+
/**
|
|
23619
|
+
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
23620
|
+
*/
|
|
23621
|
+
planet: string;
|
|
23622
|
+
/**
|
|
23623
|
+
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
23624
|
+
*/
|
|
23625
|
+
side: string;
|
|
23626
|
+
/**
|
|
23627
|
+
* Human Design gate number from 1 to 64 that this activation falls in.
|
|
23628
|
+
*/
|
|
23629
|
+
gate: number;
|
|
23630
|
+
/**
|
|
23631
|
+
* Line number from 1 to 6 within the gate, setting the line keynote and the profile.
|
|
23632
|
+
*/
|
|
23633
|
+
line: number;
|
|
23634
|
+
/**
|
|
23635
|
+
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
23636
|
+
*/
|
|
23637
|
+
gateName: string;
|
|
23638
|
+
/**
|
|
23639
|
+
* Cross-reference to the I-Ching hexagram that shares this gate number.
|
|
23640
|
+
*/
|
|
23641
|
+
ichingHexagram: {
|
|
23642
|
+
/**
|
|
23643
|
+
* I-Ching hexagram number, identical to the gate number it corresponds to.
|
|
23644
|
+
*/
|
|
23645
|
+
number: number;
|
|
23646
|
+
/**
|
|
23647
|
+
* English name of the corresponding I-Ching hexagram.
|
|
23648
|
+
*/
|
|
23649
|
+
english: string;
|
|
23650
|
+
};
|
|
23651
|
+
}>;
|
|
23652
|
+
/**
|
|
23653
|
+
* The 13 unconscious Design activations computed 88 degrees of solar arc before birth, in red on a standard chart.
|
|
23654
|
+
*/
|
|
23655
|
+
design: Array<{
|
|
23656
|
+
/**
|
|
23657
|
+
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
23658
|
+
*/
|
|
23659
|
+
planet: string;
|
|
23660
|
+
/**
|
|
23661
|
+
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
23662
|
+
*/
|
|
23663
|
+
side: string;
|
|
23664
|
+
/**
|
|
23665
|
+
* Human Design gate number from 1 to 64 that this activation falls in.
|
|
23666
|
+
*/
|
|
23667
|
+
gate: number;
|
|
23668
|
+
/**
|
|
23669
|
+
* Line number from 1 to 6 within the gate, setting the line keynote and the profile.
|
|
23670
|
+
*/
|
|
23671
|
+
line: number;
|
|
23672
|
+
/**
|
|
23673
|
+
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
23674
|
+
*/
|
|
23675
|
+
gateName: string;
|
|
23676
|
+
/**
|
|
23677
|
+
* Cross-reference to the I-Ching hexagram that shares this gate number.
|
|
23678
|
+
*/
|
|
23679
|
+
ichingHexagram: {
|
|
23680
|
+
/**
|
|
23681
|
+
* I-Ching hexagram number, identical to the gate number it corresponds to.
|
|
23682
|
+
*/
|
|
23683
|
+
number: number;
|
|
23684
|
+
/**
|
|
23685
|
+
* English name of the corresponding I-Ching hexagram.
|
|
23686
|
+
*/
|
|
23687
|
+
english: string;
|
|
23688
|
+
};
|
|
23689
|
+
}>;
|
|
23690
|
+
};
|
|
23691
|
+
};
|
|
23692
|
+
export type PostHumanDesignGatesResponse = PostHumanDesignGatesResponses[keyof PostHumanDesignGatesResponses];
|
|
23693
|
+
export type GetHumanDesignGatesByNumberData = {
|
|
23694
|
+
body?: never;
|
|
23695
|
+
path?: {
|
|
23696
|
+
/**
|
|
23697
|
+
* Gate number from 1 to 64.
|
|
23698
|
+
*/
|
|
23699
|
+
number?: number;
|
|
23700
|
+
};
|
|
23701
|
+
query?: {
|
|
23702
|
+
/**
|
|
23703
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
23704
|
+
*/
|
|
23705
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
23706
|
+
};
|
|
23707
|
+
url: '/human-design/gates/{number}';
|
|
23708
|
+
};
|
|
23709
|
+
export type GetHumanDesignGatesByNumberErrors = {
|
|
23710
|
+
/**
|
|
23711
|
+
* Validation error. `issues[]` lists every failed field.
|
|
23712
|
+
*/
|
|
23713
|
+
400: {
|
|
23714
|
+
/**
|
|
23715
|
+
* First issue summary.
|
|
23716
|
+
*/
|
|
23717
|
+
error: string;
|
|
23718
|
+
code: 'validation_error';
|
|
23719
|
+
/**
|
|
23720
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
23721
|
+
*/
|
|
23722
|
+
issues: Array<{
|
|
23723
|
+
/**
|
|
23724
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
23725
|
+
*/
|
|
23726
|
+
path: string;
|
|
23727
|
+
message: string;
|
|
23728
|
+
/**
|
|
23729
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
23730
|
+
*/
|
|
23731
|
+
code?: string;
|
|
23732
|
+
/**
|
|
23733
|
+
* Expected type for invalid_type.
|
|
23734
|
+
*/
|
|
23735
|
+
expected?: string;
|
|
23736
|
+
/**
|
|
23737
|
+
* Minimum bound for too_small issues.
|
|
23738
|
+
*/
|
|
23739
|
+
minimum?: number | string;
|
|
23740
|
+
/**
|
|
23741
|
+
* Maximum bound for too_big issues.
|
|
23742
|
+
*/
|
|
23743
|
+
maximum?: number | string;
|
|
23744
|
+
inclusive?: boolean;
|
|
23745
|
+
/**
|
|
23746
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
23747
|
+
*/
|
|
23748
|
+
format?: string;
|
|
23749
|
+
/**
|
|
23750
|
+
* Regex pattern when format is regex.
|
|
23751
|
+
*/
|
|
23752
|
+
pattern?: string;
|
|
23753
|
+
}>;
|
|
23754
|
+
};
|
|
23755
|
+
/**
|
|
23756
|
+
* Invalid or missing API key
|
|
23757
|
+
*/
|
|
23758
|
+
401: {
|
|
23759
|
+
/**
|
|
23760
|
+
* Human-readable error message. May change wording.
|
|
23761
|
+
*/
|
|
23762
|
+
error: string;
|
|
23763
|
+
/**
|
|
23764
|
+
* Machine-readable error code. Stable identifier.
|
|
23765
|
+
*/
|
|
23766
|
+
code: string;
|
|
23767
|
+
};
|
|
23768
|
+
/**
|
|
23769
|
+
* Gate number is outside the range 1 to 64
|
|
23770
|
+
*/
|
|
23771
|
+
404: {
|
|
23772
|
+
/**
|
|
23773
|
+
* Human-readable error message. May change wording — do not parse programmatically.
|
|
23774
|
+
*/
|
|
23775
|
+
error: string;
|
|
23776
|
+
/**
|
|
23777
|
+
* Machine-readable error code. Stable identifier for programmatic error handling.
|
|
23778
|
+
*/
|
|
23779
|
+
code: string;
|
|
23780
|
+
};
|
|
23781
|
+
/**
|
|
23782
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
23783
|
+
*/
|
|
23784
|
+
405: {
|
|
23785
|
+
error: string;
|
|
23786
|
+
code: 'method_not_allowed';
|
|
23787
|
+
/**
|
|
23788
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
23789
|
+
*/
|
|
23790
|
+
allow: Array<string>;
|
|
23791
|
+
/**
|
|
23792
|
+
* Link to the product page for this domain.
|
|
23793
|
+
*/
|
|
23794
|
+
docs?: string;
|
|
23795
|
+
};
|
|
23796
|
+
/**
|
|
23797
|
+
* Monthly rate limit exceeded
|
|
23798
|
+
*/
|
|
23799
|
+
429: {
|
|
23800
|
+
/**
|
|
23801
|
+
* Human-readable error message. May change wording.
|
|
23802
|
+
*/
|
|
23803
|
+
error: string;
|
|
23804
|
+
/**
|
|
23805
|
+
* Machine-readable error code. Stable identifier.
|
|
23806
|
+
*/
|
|
23807
|
+
code: string;
|
|
23808
|
+
};
|
|
23809
|
+
/**
|
|
23810
|
+
* Internal server error
|
|
23811
|
+
*/
|
|
23812
|
+
500: {
|
|
23813
|
+
/**
|
|
23814
|
+
* Human-readable error message. May change wording.
|
|
23815
|
+
*/
|
|
23816
|
+
error: string;
|
|
23817
|
+
/**
|
|
23818
|
+
* Machine-readable error code. Stable identifier.
|
|
23819
|
+
*/
|
|
23820
|
+
code: string;
|
|
23821
|
+
};
|
|
23822
|
+
};
|
|
23823
|
+
export type GetHumanDesignGatesByNumberError = GetHumanDesignGatesByNumberErrors[keyof GetHumanDesignGatesByNumberErrors];
|
|
23824
|
+
export type GetHumanDesignGatesByNumberResponses = {
|
|
23825
|
+
/**
|
|
23826
|
+
* Gate reference data with center, hexagram, and channel partners
|
|
23827
|
+
*/
|
|
23828
|
+
200: {
|
|
23829
|
+
/**
|
|
23830
|
+
* Gate number from 1 to 64.
|
|
23831
|
+
*/
|
|
23832
|
+
number: number;
|
|
23833
|
+
/**
|
|
23834
|
+
* Human Design keynote name of the gate.
|
|
23835
|
+
*/
|
|
23836
|
+
name: string;
|
|
23837
|
+
/**
|
|
23838
|
+
* Center the gate sits in.
|
|
23839
|
+
*/
|
|
23840
|
+
center: string;
|
|
23841
|
+
/**
|
|
23842
|
+
* Display name of the center.
|
|
23843
|
+
*/
|
|
23844
|
+
centerName: string;
|
|
23845
|
+
/**
|
|
23846
|
+
* The I-Ching hexagram that shares this gate number.
|
|
23847
|
+
*/
|
|
23848
|
+
ichingHexagram: {
|
|
23849
|
+
/**
|
|
23850
|
+
* I-Ching hexagram number.
|
|
23851
|
+
*/
|
|
23852
|
+
number: number;
|
|
23853
|
+
/**
|
|
23854
|
+
* Hexagram name.
|
|
23855
|
+
*/
|
|
23856
|
+
english: string;
|
|
23857
|
+
};
|
|
23858
|
+
/**
|
|
23859
|
+
* Gates that form a channel with this gate, with the channel name for each.
|
|
23860
|
+
*/
|
|
23861
|
+
channelPartners: Array<{
|
|
23862
|
+
/**
|
|
23863
|
+
* Partner gate number.
|
|
23864
|
+
*/
|
|
23865
|
+
gate: number;
|
|
23866
|
+
/**
|
|
23867
|
+
* Name of the shared channel.
|
|
23868
|
+
*/
|
|
23869
|
+
channel: string;
|
|
23870
|
+
}>;
|
|
23871
|
+
};
|
|
23872
|
+
};
|
|
23873
|
+
export type GetHumanDesignGatesByNumberResponse = GetHumanDesignGatesByNumberResponses[keyof GetHumanDesignGatesByNumberResponses];
|
|
23874
|
+
export type PostHumanDesignChannelsData = {
|
|
23875
|
+
body?: {
|
|
23876
|
+
/**
|
|
23877
|
+
* 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.
|
|
23878
|
+
*/
|
|
23879
|
+
date: string;
|
|
23880
|
+
/**
|
|
23881
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
23882
|
+
*/
|
|
23883
|
+
time: string;
|
|
23884
|
+
/**
|
|
23885
|
+
* 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.
|
|
23886
|
+
*/
|
|
23887
|
+
timezone: number | string;
|
|
23888
|
+
/**
|
|
23889
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
23890
|
+
*/
|
|
23891
|
+
latitude?: number;
|
|
23892
|
+
/**
|
|
23893
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
23894
|
+
*/
|
|
23895
|
+
longitude?: number;
|
|
23896
|
+
};
|
|
23897
|
+
path?: never;
|
|
23898
|
+
query?: {
|
|
23899
|
+
/**
|
|
23900
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
23901
|
+
*/
|
|
23902
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
23903
|
+
};
|
|
23904
|
+
url: '/human-design/channels';
|
|
23905
|
+
};
|
|
23906
|
+
export type PostHumanDesignChannelsErrors = {
|
|
23907
|
+
/**
|
|
23908
|
+
* Validation error. `issues[]` lists every failed field.
|
|
23909
|
+
*/
|
|
23910
|
+
400: {
|
|
23911
|
+
/**
|
|
23912
|
+
* First issue summary.
|
|
23913
|
+
*/
|
|
23914
|
+
error: string;
|
|
23915
|
+
code: 'validation_error';
|
|
23916
|
+
/**
|
|
23917
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
23918
|
+
*/
|
|
23919
|
+
issues: Array<{
|
|
23920
|
+
/**
|
|
23921
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
23922
|
+
*/
|
|
23923
|
+
path: string;
|
|
23924
|
+
message: string;
|
|
23925
|
+
/**
|
|
23926
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
23927
|
+
*/
|
|
23928
|
+
code?: string;
|
|
23929
|
+
/**
|
|
23930
|
+
* Expected type for invalid_type.
|
|
23931
|
+
*/
|
|
23932
|
+
expected?: string;
|
|
23933
|
+
/**
|
|
23934
|
+
* Minimum bound for too_small issues.
|
|
23935
|
+
*/
|
|
23936
|
+
minimum?: number | string;
|
|
23937
|
+
/**
|
|
23938
|
+
* Maximum bound for too_big issues.
|
|
23939
|
+
*/
|
|
23940
|
+
maximum?: number | string;
|
|
23941
|
+
inclusive?: boolean;
|
|
23942
|
+
/**
|
|
23943
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
23944
|
+
*/
|
|
23945
|
+
format?: string;
|
|
23946
|
+
/**
|
|
23947
|
+
* Regex pattern when format is regex.
|
|
23948
|
+
*/
|
|
23949
|
+
pattern?: string;
|
|
23950
|
+
}>;
|
|
23951
|
+
};
|
|
23952
|
+
/**
|
|
23953
|
+
* Invalid or missing API key
|
|
23954
|
+
*/
|
|
23955
|
+
401: {
|
|
23956
|
+
/**
|
|
23957
|
+
* Human-readable error message. May change wording.
|
|
23958
|
+
*/
|
|
23959
|
+
error: string;
|
|
23960
|
+
/**
|
|
23961
|
+
* Machine-readable error code. Stable identifier.
|
|
23962
|
+
*/
|
|
23963
|
+
code: string;
|
|
23964
|
+
};
|
|
23965
|
+
/**
|
|
23966
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
23967
|
+
*/
|
|
23968
|
+
405: {
|
|
23969
|
+
error: string;
|
|
23970
|
+
code: 'method_not_allowed';
|
|
23971
|
+
/**
|
|
23972
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
23973
|
+
*/
|
|
23974
|
+
allow: Array<string>;
|
|
23975
|
+
/**
|
|
23976
|
+
* Link to the product page for this domain.
|
|
23977
|
+
*/
|
|
23978
|
+
docs?: string;
|
|
23979
|
+
};
|
|
23980
|
+
/**
|
|
23981
|
+
* Monthly rate limit exceeded
|
|
23982
|
+
*/
|
|
23983
|
+
429: {
|
|
23984
|
+
/**
|
|
23985
|
+
* Human-readable error message. May change wording.
|
|
23986
|
+
*/
|
|
23987
|
+
error: string;
|
|
23988
|
+
/**
|
|
23989
|
+
* Machine-readable error code. Stable identifier.
|
|
23990
|
+
*/
|
|
23991
|
+
code: string;
|
|
23992
|
+
};
|
|
23993
|
+
/**
|
|
23994
|
+
* Internal server error
|
|
23995
|
+
*/
|
|
23996
|
+
500: {
|
|
23997
|
+
/**
|
|
23998
|
+
* Human-readable error message. May change wording.
|
|
23999
|
+
*/
|
|
24000
|
+
error: string;
|
|
24001
|
+
/**
|
|
24002
|
+
* Machine-readable error code. Stable identifier.
|
|
24003
|
+
*/
|
|
24004
|
+
code: string;
|
|
24005
|
+
};
|
|
24006
|
+
};
|
|
24007
|
+
export type PostHumanDesignChannelsError = PostHumanDesignChannelsErrors[keyof PostHumanDesignChannelsErrors];
|
|
24008
|
+
export type PostHumanDesignChannelsResponses = {
|
|
24009
|
+
/**
|
|
24010
|
+
* Defined channels with circuits and the centers they define
|
|
24011
|
+
*/
|
|
24012
|
+
200: {
|
|
24013
|
+
/**
|
|
24014
|
+
* The defined channels, where both gates are activated.
|
|
24015
|
+
*/
|
|
24016
|
+
channels: Array<{
|
|
24017
|
+
/**
|
|
24018
|
+
* First gate of the channel.
|
|
24019
|
+
*/
|
|
24020
|
+
gateA: number;
|
|
24021
|
+
/**
|
|
24022
|
+
* Second gate of the channel.
|
|
24023
|
+
*/
|
|
24024
|
+
gateB: number;
|
|
24025
|
+
/**
|
|
24026
|
+
* Name of the defined channel.
|
|
24027
|
+
*/
|
|
24028
|
+
name: string;
|
|
24029
|
+
/**
|
|
24030
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal.
|
|
24031
|
+
*/
|
|
24032
|
+
circuit: string;
|
|
24033
|
+
/**
|
|
24034
|
+
* The two centers this channel connects and defines.
|
|
24035
|
+
*/
|
|
24036
|
+
centers: Array<string>;
|
|
24037
|
+
}>;
|
|
24038
|
+
/**
|
|
24039
|
+
* Number of defined channels in the bodygraph.
|
|
24040
|
+
*/
|
|
24041
|
+
total: number;
|
|
24042
|
+
/**
|
|
24043
|
+
* The centers defined by these channels.
|
|
24044
|
+
*/
|
|
24045
|
+
definedCenters: Array<string>;
|
|
24046
|
+
};
|
|
24047
|
+
};
|
|
24048
|
+
export type PostHumanDesignChannelsResponse = PostHumanDesignChannelsResponses[keyof PostHumanDesignChannelsResponses];
|
|
24049
|
+
export type PostHumanDesignCentersData = {
|
|
24050
|
+
body?: {
|
|
24051
|
+
/**
|
|
24052
|
+
* 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.
|
|
24053
|
+
*/
|
|
24054
|
+
date: string;
|
|
24055
|
+
/**
|
|
24056
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
24057
|
+
*/
|
|
24058
|
+
time: string;
|
|
24059
|
+
/**
|
|
24060
|
+
* 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.
|
|
24061
|
+
*/
|
|
24062
|
+
timezone: number | string;
|
|
24063
|
+
/**
|
|
24064
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
24065
|
+
*/
|
|
24066
|
+
latitude?: number;
|
|
24067
|
+
/**
|
|
24068
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
24069
|
+
*/
|
|
24070
|
+
longitude?: number;
|
|
24071
|
+
};
|
|
24072
|
+
path?: never;
|
|
24073
|
+
query?: {
|
|
24074
|
+
/**
|
|
24075
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
24076
|
+
*/
|
|
24077
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
24078
|
+
};
|
|
24079
|
+
url: '/human-design/centers';
|
|
24080
|
+
};
|
|
24081
|
+
export type PostHumanDesignCentersErrors = {
|
|
24082
|
+
/**
|
|
24083
|
+
* Validation error. `issues[]` lists every failed field.
|
|
24084
|
+
*/
|
|
24085
|
+
400: {
|
|
24086
|
+
/**
|
|
24087
|
+
* First issue summary.
|
|
24088
|
+
*/
|
|
24089
|
+
error: string;
|
|
24090
|
+
code: 'validation_error';
|
|
24091
|
+
/**
|
|
24092
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
24093
|
+
*/
|
|
24094
|
+
issues: Array<{
|
|
24095
|
+
/**
|
|
24096
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
24097
|
+
*/
|
|
24098
|
+
path: string;
|
|
24099
|
+
message: string;
|
|
24100
|
+
/**
|
|
24101
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
24102
|
+
*/
|
|
24103
|
+
code?: string;
|
|
24104
|
+
/**
|
|
24105
|
+
* Expected type for invalid_type.
|
|
24106
|
+
*/
|
|
24107
|
+
expected?: string;
|
|
24108
|
+
/**
|
|
24109
|
+
* Minimum bound for too_small issues.
|
|
24110
|
+
*/
|
|
24111
|
+
minimum?: number | string;
|
|
24112
|
+
/**
|
|
24113
|
+
* Maximum bound for too_big issues.
|
|
24114
|
+
*/
|
|
24115
|
+
maximum?: number | string;
|
|
24116
|
+
inclusive?: boolean;
|
|
24117
|
+
/**
|
|
24118
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
24119
|
+
*/
|
|
24120
|
+
format?: string;
|
|
24121
|
+
/**
|
|
24122
|
+
* Regex pattern when format is regex.
|
|
24123
|
+
*/
|
|
24124
|
+
pattern?: string;
|
|
24125
|
+
}>;
|
|
24126
|
+
};
|
|
24127
|
+
/**
|
|
24128
|
+
* Invalid or missing API key
|
|
24129
|
+
*/
|
|
24130
|
+
401: {
|
|
24131
|
+
/**
|
|
24132
|
+
* Human-readable error message. May change wording.
|
|
24133
|
+
*/
|
|
24134
|
+
error: string;
|
|
24135
|
+
/**
|
|
24136
|
+
* Machine-readable error code. Stable identifier.
|
|
24137
|
+
*/
|
|
24138
|
+
code: string;
|
|
24139
|
+
};
|
|
24140
|
+
/**
|
|
24141
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
24142
|
+
*/
|
|
24143
|
+
405: {
|
|
24144
|
+
error: string;
|
|
24145
|
+
code: 'method_not_allowed';
|
|
24146
|
+
/**
|
|
24147
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
24148
|
+
*/
|
|
24149
|
+
allow: Array<string>;
|
|
24150
|
+
/**
|
|
24151
|
+
* Link to the product page for this domain.
|
|
24152
|
+
*/
|
|
24153
|
+
docs?: string;
|
|
24154
|
+
};
|
|
24155
|
+
/**
|
|
24156
|
+
* Monthly rate limit exceeded
|
|
24157
|
+
*/
|
|
24158
|
+
429: {
|
|
24159
|
+
/**
|
|
24160
|
+
* Human-readable error message. May change wording.
|
|
24161
|
+
*/
|
|
24162
|
+
error: string;
|
|
24163
|
+
/**
|
|
24164
|
+
* Machine-readable error code. Stable identifier.
|
|
24165
|
+
*/
|
|
24166
|
+
code: string;
|
|
24167
|
+
};
|
|
24168
|
+
/**
|
|
24169
|
+
* Internal server error
|
|
24170
|
+
*/
|
|
24171
|
+
500: {
|
|
24172
|
+
/**
|
|
24173
|
+
* Human-readable error message. May change wording.
|
|
24174
|
+
*/
|
|
24175
|
+
error: string;
|
|
24176
|
+
/**
|
|
24177
|
+
* Machine-readable error code. Stable identifier.
|
|
24178
|
+
*/
|
|
24179
|
+
code: string;
|
|
24180
|
+
};
|
|
24181
|
+
};
|
|
24182
|
+
export type PostHumanDesignCentersError = PostHumanDesignCentersErrors[keyof PostHumanDesignCentersErrors];
|
|
24183
|
+
export type PostHumanDesignCentersResponses = {
|
|
24184
|
+
/**
|
|
24185
|
+
* All nine centers with defined state, flags, theme, and active gates
|
|
24186
|
+
*/
|
|
24187
|
+
200: {
|
|
24188
|
+
/**
|
|
24189
|
+
* All nine centers with their defined state and active gates.
|
|
24190
|
+
*/
|
|
24191
|
+
centers: Array<{
|
|
24192
|
+
/**
|
|
24193
|
+
* Center identifier. One of head, ajna, throat, g, heart, sacral, solar-plexus, spleen, root.
|
|
24194
|
+
*/
|
|
24195
|
+
id: string;
|
|
24196
|
+
/**
|
|
24197
|
+
* Display name of the center.
|
|
24198
|
+
*/
|
|
24199
|
+
name: string;
|
|
24200
|
+
/**
|
|
24201
|
+
* Whether the center is defined. A defined center is a consistent source of energy or awareness; an undefined center is open and conditioned by others.
|
|
24202
|
+
*/
|
|
24203
|
+
defined: boolean;
|
|
24204
|
+
/**
|
|
24205
|
+
* Whether this is a motor center (energy source). The four motors are Heart, Sacral, Solar Plexus, and Root.
|
|
24206
|
+
*/
|
|
24207
|
+
motor: boolean;
|
|
24208
|
+
/**
|
|
24209
|
+
* Whether this is an awareness center. The three awareness centers are Ajna, Solar Plexus, and Spleen.
|
|
24210
|
+
*/
|
|
24211
|
+
awareness: boolean;
|
|
24212
|
+
/**
|
|
24213
|
+
* Theme text describing the center in its current defined or undefined state.
|
|
24214
|
+
*/
|
|
24215
|
+
theme: string;
|
|
24216
|
+
/**
|
|
24217
|
+
* Active gate numbers that sit in this center.
|
|
24218
|
+
*/
|
|
24219
|
+
gates: Array<number>;
|
|
24220
|
+
}>;
|
|
24221
|
+
/**
|
|
24222
|
+
* How many of the nine centers are defined.
|
|
24223
|
+
*/
|
|
24224
|
+
definedCount: number;
|
|
24225
|
+
};
|
|
24226
|
+
};
|
|
24227
|
+
export type PostHumanDesignCentersResponse = PostHumanDesignCentersResponses[keyof PostHumanDesignCentersResponses];
|
|
24228
|
+
export type GetHumanDesignCentersByIdData = {
|
|
24229
|
+
body?: never;
|
|
24230
|
+
path: {
|
|
24231
|
+
/**
|
|
24232
|
+
* Center id. One of head, ajna, throat, g, heart, sacral, solar-plexus, spleen, root.
|
|
24233
|
+
*/
|
|
24234
|
+
id: 'head' | 'ajna' | 'throat' | 'g' | 'heart' | 'sacral' | 'solar-plexus' | 'spleen' | 'root';
|
|
24235
|
+
};
|
|
24236
|
+
query?: {
|
|
24237
|
+
/**
|
|
24238
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
24239
|
+
*/
|
|
24240
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
24241
|
+
};
|
|
24242
|
+
url: '/human-design/centers/{id}';
|
|
24243
|
+
};
|
|
24244
|
+
export type GetHumanDesignCentersByIdErrors = {
|
|
24245
|
+
/**
|
|
24246
|
+
* Validation error. `issues[]` lists every failed field.
|
|
24247
|
+
*/
|
|
24248
|
+
400: {
|
|
24249
|
+
/**
|
|
24250
|
+
* First issue summary.
|
|
24251
|
+
*/
|
|
24252
|
+
error: string;
|
|
24253
|
+
code: 'validation_error';
|
|
24254
|
+
/**
|
|
24255
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
24256
|
+
*/
|
|
24257
|
+
issues: Array<{
|
|
24258
|
+
/**
|
|
24259
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
24260
|
+
*/
|
|
24261
|
+
path: string;
|
|
24262
|
+
message: string;
|
|
24263
|
+
/**
|
|
24264
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
24265
|
+
*/
|
|
24266
|
+
code?: string;
|
|
24267
|
+
/**
|
|
24268
|
+
* Expected type for invalid_type.
|
|
24269
|
+
*/
|
|
24270
|
+
expected?: string;
|
|
24271
|
+
/**
|
|
24272
|
+
* Minimum bound for too_small issues.
|
|
24273
|
+
*/
|
|
24274
|
+
minimum?: number | string;
|
|
24275
|
+
/**
|
|
24276
|
+
* Maximum bound for too_big issues.
|
|
24277
|
+
*/
|
|
24278
|
+
maximum?: number | string;
|
|
24279
|
+
inclusive?: boolean;
|
|
24280
|
+
/**
|
|
24281
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
24282
|
+
*/
|
|
24283
|
+
format?: string;
|
|
24284
|
+
/**
|
|
24285
|
+
* Regex pattern when format is regex.
|
|
24286
|
+
*/
|
|
24287
|
+
pattern?: string;
|
|
24288
|
+
}>;
|
|
24289
|
+
};
|
|
24290
|
+
/**
|
|
24291
|
+
* Invalid or missing API key
|
|
24292
|
+
*/
|
|
24293
|
+
401: {
|
|
24294
|
+
/**
|
|
24295
|
+
* Human-readable error message. May change wording.
|
|
24296
|
+
*/
|
|
24297
|
+
error: string;
|
|
24298
|
+
/**
|
|
24299
|
+
* Machine-readable error code. Stable identifier.
|
|
24300
|
+
*/
|
|
24301
|
+
code: string;
|
|
24302
|
+
};
|
|
24303
|
+
/**
|
|
24304
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
24305
|
+
*/
|
|
24306
|
+
405: {
|
|
24307
|
+
error: string;
|
|
24308
|
+
code: 'method_not_allowed';
|
|
24309
|
+
/**
|
|
24310
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
24311
|
+
*/
|
|
24312
|
+
allow: Array<string>;
|
|
24313
|
+
/**
|
|
24314
|
+
* Link to the product page for this domain.
|
|
24315
|
+
*/
|
|
24316
|
+
docs?: string;
|
|
24317
|
+
};
|
|
24318
|
+
/**
|
|
24319
|
+
* Monthly rate limit exceeded
|
|
24320
|
+
*/
|
|
24321
|
+
429: {
|
|
24322
|
+
/**
|
|
24323
|
+
* Human-readable error message. May change wording.
|
|
24324
|
+
*/
|
|
24325
|
+
error: string;
|
|
24326
|
+
/**
|
|
24327
|
+
* Machine-readable error code. Stable identifier.
|
|
24328
|
+
*/
|
|
24329
|
+
code: string;
|
|
24330
|
+
};
|
|
24331
|
+
/**
|
|
24332
|
+
* Internal server error
|
|
24333
|
+
*/
|
|
24334
|
+
500: {
|
|
24335
|
+
/**
|
|
24336
|
+
* Human-readable error message. May change wording.
|
|
24337
|
+
*/
|
|
24338
|
+
error: string;
|
|
24339
|
+
/**
|
|
24340
|
+
* Machine-readable error code. Stable identifier.
|
|
24341
|
+
*/
|
|
24342
|
+
code: string;
|
|
24343
|
+
};
|
|
24344
|
+
};
|
|
24345
|
+
export type GetHumanDesignCentersByIdError = GetHumanDesignCentersByIdErrors[keyof GetHumanDesignCentersByIdErrors];
|
|
24346
|
+
export type GetHumanDesignCentersByIdResponses = {
|
|
24347
|
+
/**
|
|
24348
|
+
* Center reference data with defined and undefined meanings
|
|
24349
|
+
*/
|
|
24350
|
+
200: {
|
|
24351
|
+
/**
|
|
24352
|
+
* Center identifier.
|
|
24353
|
+
*/
|
|
24354
|
+
id: string;
|
|
24355
|
+
/**
|
|
24356
|
+
* Display name of the center.
|
|
24357
|
+
*/
|
|
24358
|
+
name: string;
|
|
24359
|
+
/**
|
|
24360
|
+
* Whether this is a motor center.
|
|
24361
|
+
*/
|
|
24362
|
+
motor: boolean;
|
|
24363
|
+
/**
|
|
24364
|
+
* Whether this is an awareness center.
|
|
24365
|
+
*/
|
|
24366
|
+
awareness: boolean;
|
|
24367
|
+
/**
|
|
24368
|
+
* What this center means when defined: a consistent, reliable energy or awareness.
|
|
24369
|
+
*/
|
|
24370
|
+
definedMeaning: string;
|
|
24371
|
+
/**
|
|
24372
|
+
* What this center means when undefined and open: a place of conditioning and learning.
|
|
24373
|
+
*/
|
|
24374
|
+
undefinedMeaning: string;
|
|
24375
|
+
};
|
|
24376
|
+
};
|
|
24377
|
+
export type GetHumanDesignCentersByIdResponse = GetHumanDesignCentersByIdResponses[keyof GetHumanDesignCentersByIdResponses];
|
|
24378
|
+
export type PostHumanDesignProfileData = {
|
|
24379
|
+
body?: {
|
|
24380
|
+
/**
|
|
24381
|
+
* 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.
|
|
24382
|
+
*/
|
|
24383
|
+
date: string;
|
|
24384
|
+
/**
|
|
24385
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
24386
|
+
*/
|
|
24387
|
+
time: string;
|
|
24388
|
+
/**
|
|
24389
|
+
* 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.
|
|
24390
|
+
*/
|
|
24391
|
+
timezone: number | string;
|
|
24392
|
+
/**
|
|
24393
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
24394
|
+
*/
|
|
24395
|
+
latitude?: number;
|
|
24396
|
+
/**
|
|
24397
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
24398
|
+
*/
|
|
24399
|
+
longitude?: number;
|
|
24400
|
+
};
|
|
24401
|
+
path?: never;
|
|
24402
|
+
query?: {
|
|
24403
|
+
/**
|
|
24404
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
24405
|
+
*/
|
|
24406
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
24407
|
+
};
|
|
24408
|
+
url: '/human-design/profile';
|
|
24409
|
+
};
|
|
24410
|
+
export type PostHumanDesignProfileErrors = {
|
|
24411
|
+
/**
|
|
24412
|
+
* Validation error. `issues[]` lists every failed field.
|
|
24413
|
+
*/
|
|
24414
|
+
400: {
|
|
24415
|
+
/**
|
|
24416
|
+
* First issue summary.
|
|
24417
|
+
*/
|
|
24418
|
+
error: string;
|
|
24419
|
+
code: 'validation_error';
|
|
24420
|
+
/**
|
|
24421
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
24422
|
+
*/
|
|
24423
|
+
issues: Array<{
|
|
24424
|
+
/**
|
|
24425
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
24426
|
+
*/
|
|
24427
|
+
path: string;
|
|
24428
|
+
message: string;
|
|
24429
|
+
/**
|
|
24430
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
24431
|
+
*/
|
|
24432
|
+
code?: string;
|
|
24433
|
+
/**
|
|
24434
|
+
* Expected type for invalid_type.
|
|
24435
|
+
*/
|
|
24436
|
+
expected?: string;
|
|
24437
|
+
/**
|
|
24438
|
+
* Minimum bound for too_small issues.
|
|
24439
|
+
*/
|
|
24440
|
+
minimum?: number | string;
|
|
24441
|
+
/**
|
|
24442
|
+
* Maximum bound for too_big issues.
|
|
24443
|
+
*/
|
|
24444
|
+
maximum?: number | string;
|
|
24445
|
+
inclusive?: boolean;
|
|
24446
|
+
/**
|
|
24447
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
24448
|
+
*/
|
|
24449
|
+
format?: string;
|
|
24450
|
+
/**
|
|
24451
|
+
* Regex pattern when format is regex.
|
|
24452
|
+
*/
|
|
24453
|
+
pattern?: string;
|
|
24454
|
+
}>;
|
|
24455
|
+
};
|
|
24456
|
+
/**
|
|
24457
|
+
* Invalid or missing API key
|
|
24458
|
+
*/
|
|
24459
|
+
401: {
|
|
24460
|
+
/**
|
|
24461
|
+
* Human-readable error message. May change wording.
|
|
24462
|
+
*/
|
|
24463
|
+
error: string;
|
|
24464
|
+
/**
|
|
24465
|
+
* Machine-readable error code. Stable identifier.
|
|
24466
|
+
*/
|
|
24467
|
+
code: string;
|
|
24468
|
+
};
|
|
24469
|
+
/**
|
|
24470
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
24471
|
+
*/
|
|
24472
|
+
405: {
|
|
24473
|
+
error: string;
|
|
24474
|
+
code: 'method_not_allowed';
|
|
24475
|
+
/**
|
|
24476
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
24477
|
+
*/
|
|
24478
|
+
allow: Array<string>;
|
|
24479
|
+
/**
|
|
24480
|
+
* Link to the product page for this domain.
|
|
24481
|
+
*/
|
|
24482
|
+
docs?: string;
|
|
24483
|
+
};
|
|
24484
|
+
/**
|
|
24485
|
+
* Monthly rate limit exceeded
|
|
24486
|
+
*/
|
|
24487
|
+
429: {
|
|
24488
|
+
/**
|
|
24489
|
+
* Human-readable error message. May change wording.
|
|
24490
|
+
*/
|
|
24491
|
+
error: string;
|
|
24492
|
+
/**
|
|
24493
|
+
* Machine-readable error code. Stable identifier.
|
|
24494
|
+
*/
|
|
24495
|
+
code: string;
|
|
24496
|
+
};
|
|
24497
|
+
/**
|
|
24498
|
+
* Internal server error
|
|
24499
|
+
*/
|
|
24500
|
+
500: {
|
|
24501
|
+
/**
|
|
24502
|
+
* Human-readable error message. May change wording.
|
|
24503
|
+
*/
|
|
24504
|
+
error: string;
|
|
24505
|
+
/**
|
|
24506
|
+
* Machine-readable error code. Stable identifier.
|
|
24507
|
+
*/
|
|
24508
|
+
code: string;
|
|
24509
|
+
};
|
|
24510
|
+
};
|
|
24511
|
+
export type PostHumanDesignProfileError = PostHumanDesignProfileErrors[keyof PostHumanDesignProfileErrors];
|
|
24512
|
+
export type PostHumanDesignProfileResponses = {
|
|
24513
|
+
/**
|
|
24514
|
+
* Profile string, the two line numbers, and line keynotes
|
|
24515
|
+
*/
|
|
24516
|
+
200: {
|
|
24517
|
+
/**
|
|
24518
|
+
* Profile in conscious/unconscious form, the Personality Sun line over the Design Sun line.
|
|
24519
|
+
*/
|
|
24520
|
+
profile: string;
|
|
24521
|
+
/**
|
|
24522
|
+
* Line number from 1 to 6 of the conscious Personality Sun.
|
|
24523
|
+
*/
|
|
24524
|
+
personalityLine: number;
|
|
24525
|
+
/**
|
|
24526
|
+
* Line number from 1 to 6 of the unconscious Design Sun.
|
|
24527
|
+
*/
|
|
24528
|
+
designLine: number;
|
|
24529
|
+
/**
|
|
24530
|
+
* Keynote of the Personality line, the conscious half of the profile.
|
|
24531
|
+
*/
|
|
24532
|
+
personalityKeynote: string;
|
|
24533
|
+
/**
|
|
24534
|
+
* Keynote of the Design line, the unconscious half of the profile.
|
|
24535
|
+
*/
|
|
24536
|
+
designKeynote: string;
|
|
24537
|
+
};
|
|
24538
|
+
};
|
|
24539
|
+
export type PostHumanDesignProfileResponse = PostHumanDesignProfileResponses[keyof PostHumanDesignProfileResponses];
|
|
24540
|
+
export type PostHumanDesignVariablesData = {
|
|
24541
|
+
body?: {
|
|
24542
|
+
/**
|
|
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.
|
|
24544
|
+
*/
|
|
24545
|
+
date: string;
|
|
24546
|
+
/**
|
|
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.
|
|
24548
|
+
*/
|
|
24549
|
+
time: string;
|
|
24550
|
+
/**
|
|
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.
|
|
24552
|
+
*/
|
|
24553
|
+
timezone: number | string;
|
|
24554
|
+
/**
|
|
24555
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
24556
|
+
*/
|
|
24557
|
+
latitude?: number;
|
|
24558
|
+
/**
|
|
24559
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
24560
|
+
*/
|
|
24561
|
+
longitude?: number;
|
|
24562
|
+
};
|
|
24563
|
+
path?: never;
|
|
24564
|
+
query?: {
|
|
24565
|
+
/**
|
|
24566
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
24567
|
+
*/
|
|
24568
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
24569
|
+
};
|
|
24570
|
+
url: '/human-design/variables';
|
|
24571
|
+
};
|
|
24572
|
+
export type PostHumanDesignVariablesErrors = {
|
|
24573
|
+
/**
|
|
24574
|
+
* Validation error. `issues[]` lists every failed field.
|
|
24575
|
+
*/
|
|
24576
|
+
400: {
|
|
24577
|
+
/**
|
|
24578
|
+
* First issue summary.
|
|
24579
|
+
*/
|
|
24580
|
+
error: string;
|
|
24581
|
+
code: 'validation_error';
|
|
24582
|
+
/**
|
|
24583
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
24584
|
+
*/
|
|
24585
|
+
issues: Array<{
|
|
24586
|
+
/**
|
|
24587
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
24588
|
+
*/
|
|
24589
|
+
path: string;
|
|
24590
|
+
message: string;
|
|
24591
|
+
/**
|
|
24592
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
24593
|
+
*/
|
|
24594
|
+
code?: string;
|
|
24595
|
+
/**
|
|
24596
|
+
* Expected type for invalid_type.
|
|
24597
|
+
*/
|
|
24598
|
+
expected?: string;
|
|
24599
|
+
/**
|
|
24600
|
+
* Minimum bound for too_small issues.
|
|
24601
|
+
*/
|
|
24602
|
+
minimum?: number | string;
|
|
24603
|
+
/**
|
|
24604
|
+
* Maximum bound for too_big issues.
|
|
24605
|
+
*/
|
|
24606
|
+
maximum?: number | string;
|
|
24607
|
+
inclusive?: boolean;
|
|
24608
|
+
/**
|
|
24609
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
24610
|
+
*/
|
|
24611
|
+
format?: string;
|
|
24612
|
+
/**
|
|
24613
|
+
* Regex pattern when format is regex.
|
|
24614
|
+
*/
|
|
24615
|
+
pattern?: string;
|
|
24616
|
+
}>;
|
|
24617
|
+
};
|
|
24618
|
+
/**
|
|
24619
|
+
* Invalid or missing API key
|
|
24620
|
+
*/
|
|
24621
|
+
401: {
|
|
24622
|
+
/**
|
|
24623
|
+
* Human-readable error message. May change wording.
|
|
24624
|
+
*/
|
|
24625
|
+
error: string;
|
|
24626
|
+
/**
|
|
24627
|
+
* Machine-readable error code. Stable identifier.
|
|
24628
|
+
*/
|
|
24629
|
+
code: string;
|
|
24630
|
+
};
|
|
24631
|
+
/**
|
|
24632
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
24633
|
+
*/
|
|
24634
|
+
405: {
|
|
24635
|
+
error: string;
|
|
24636
|
+
code: 'method_not_allowed';
|
|
24637
|
+
/**
|
|
24638
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
24639
|
+
*/
|
|
24640
|
+
allow: Array<string>;
|
|
24641
|
+
/**
|
|
24642
|
+
* Link to the product page for this domain.
|
|
24643
|
+
*/
|
|
24644
|
+
docs?: string;
|
|
24645
|
+
};
|
|
24646
|
+
/**
|
|
24647
|
+
* Monthly rate limit exceeded
|
|
24648
|
+
*/
|
|
24649
|
+
429: {
|
|
24650
|
+
/**
|
|
24651
|
+
* Human-readable error message. May change wording.
|
|
24652
|
+
*/
|
|
24653
|
+
error: string;
|
|
24654
|
+
/**
|
|
24655
|
+
* Machine-readable error code. Stable identifier.
|
|
24656
|
+
*/
|
|
24657
|
+
code: string;
|
|
24658
|
+
};
|
|
24659
|
+
/**
|
|
24660
|
+
* Internal server error
|
|
24661
|
+
*/
|
|
24662
|
+
500: {
|
|
24663
|
+
/**
|
|
24664
|
+
* Human-readable error message. May change wording.
|
|
24665
|
+
*/
|
|
24666
|
+
error: string;
|
|
24667
|
+
/**
|
|
24668
|
+
* Machine-readable error code. Stable identifier.
|
|
24669
|
+
*/
|
|
24670
|
+
code: string;
|
|
24671
|
+
};
|
|
24672
|
+
};
|
|
24673
|
+
export type PostHumanDesignVariablesError = PostHumanDesignVariablesErrors[keyof PostHumanDesignVariablesErrors];
|
|
24674
|
+
export type PostHumanDesignVariablesResponses = {
|
|
24675
|
+
/**
|
|
24676
|
+
* The four Variable arrows with substructure numbers, labels, and confidence flags
|
|
24677
|
+
*/
|
|
24678
|
+
200: {
|
|
24679
|
+
/**
|
|
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.
|
|
24681
|
+
*/
|
|
24682
|
+
arrows: Array<{
|
|
24683
|
+
/**
|
|
24684
|
+
* Stable arrow identifier. One of determination, environment, perspective, motivation.
|
|
24685
|
+
*/
|
|
24686
|
+
key: string;
|
|
24687
|
+
/**
|
|
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.
|
|
24689
|
+
*/
|
|
24690
|
+
name: string;
|
|
24691
|
+
/**
|
|
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.
|
|
24693
|
+
*/
|
|
24694
|
+
layer: string;
|
|
24695
|
+
/**
|
|
24696
|
+
* Position of the arrow at the head of the bodygraph. One of Top left, Bottom left, Top right, Bottom right.
|
|
24697
|
+
*/
|
|
24698
|
+
position: string;
|
|
24699
|
+
/**
|
|
24700
|
+
* The single activation, body and chart side, that this arrow is derived from.
|
|
24701
|
+
*/
|
|
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
|
+
/**
|
|
24955
|
+
* First day of the resolved forecast window.
|
|
24956
|
+
*/
|
|
24957
|
+
startDate: string;
|
|
24958
|
+
/**
|
|
24959
|
+
* Last day of the resolved forecast window after the horizon clamp.
|
|
24960
|
+
*/
|
|
24961
|
+
endDate: string;
|
|
24962
|
+
/**
|
|
24963
|
+
* Number of events in the timeline after deduplication, filtering, and the event cap.
|
|
24964
|
+
*/
|
|
24965
|
+
count: number;
|
|
24966
|
+
/**
|
|
24967
|
+
* The merged, time-ordered forecast events across the requested domains.
|
|
24968
|
+
*/
|
|
24969
|
+
events: Array<{
|
|
24970
|
+
/**
|
|
24971
|
+
* Calendar date of the event in YYYY-MM-DD (UTC).
|
|
24972
|
+
*/
|
|
24973
|
+
date: string;
|
|
24974
|
+
/**
|
|
24975
|
+
* 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.
|
|
24976
|
+
*/
|
|
24977
|
+
datetime: string;
|
|
24978
|
+
/**
|
|
24979
|
+
* 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.
|
|
24980
|
+
*/
|
|
24981
|
+
domain: 'western' | 'vedic' | 'biorhythm';
|
|
24982
|
+
/**
|
|
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.
|
|
24984
|
+
*/
|
|
24985
|
+
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
|
|
24986
|
+
/**
|
|
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.
|
|
24988
|
+
*/
|
|
24989
|
+
body: string;
|
|
24990
|
+
/**
|
|
24991
|
+
* For a transit-aspect, the natal body the transit aspects. For a sign-ingress, the zodiac sign entered. Absent for other event types.
|
|
24992
|
+
*/
|
|
24993
|
+
target?: string;
|
|
24994
|
+
/**
|
|
24995
|
+
* For a transit-aspect, the angular relationship. One of conjunction, sextile, square, trine, opposition. Absent for other event types.
|
|
24996
|
+
*/
|
|
24997
|
+
aspect?: string;
|
|
24998
|
+
/**
|
|
24999
|
+
* 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.
|
|
25000
|
+
*/
|
|
25001
|
+
orb?: number;
|
|
25002
|
+
/**
|
|
25003
|
+
* For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
|
|
25004
|
+
*/
|
|
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;
|
|
25014
|
+
/**
|
|
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.
|
|
25016
|
+
*/
|
|
25017
|
+
description: string;
|
|
25018
|
+
/**
|
|
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.
|
|
25020
|
+
*/
|
|
25021
|
+
significance: number;
|
|
25022
|
+
}>;
|
|
25023
|
+
};
|
|
25024
|
+
};
|
|
25025
|
+
export type PostForecastTimelineResponse = PostForecastTimelineResponses[keyof PostForecastTimelineResponses];
|
|
25026
|
+
export type PostForecastTransitsData = {
|
|
25027
|
+
body?: {
|
|
25028
|
+
/**
|
|
25029
|
+
* The single birth subject this transit forecast is built for. One object only, never an array.
|
|
25030
|
+
*/
|
|
25031
|
+
birthData: {
|
|
25032
|
+
/**
|
|
25033
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
25034
|
+
*/
|
|
25035
|
+
date: string;
|
|
25036
|
+
/**
|
|
25037
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
25038
|
+
*/
|
|
25039
|
+
time: string;
|
|
25040
|
+
/**
|
|
25041
|
+
* 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.
|
|
25042
|
+
*/
|
|
25043
|
+
timezone: number | string;
|
|
25044
|
+
/**
|
|
25045
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25046
|
+
*/
|
|
25047
|
+
latitude?: number;
|
|
25048
|
+
/**
|
|
25049
|
+
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25050
|
+
*/
|
|
25051
|
+
longitude?: number;
|
|
25052
|
+
};
|
|
25053
|
+
/**
|
|
25054
|
+
* First day of the transit window in YYYY-MM-DD format. Defaults to today in UTC.
|
|
25055
|
+
*/
|
|
25056
|
+
startDate?: string;
|
|
25057
|
+
/**
|
|
25058
|
+
* Last day of the transit window in YYYY-MM-DD format. Defaults to startDate plus 30 days. Clamped to a maximum of 90 days from startDate.
|
|
25059
|
+
*/
|
|
25060
|
+
endDate?: string;
|
|
25061
|
+
/**
|
|
25062
|
+
* Drop transit events scoring below this significance threshold from 0 to 100. Defaults to 0.
|
|
25063
|
+
*/
|
|
25064
|
+
minSignificance?: number;
|
|
25065
|
+
};
|
|
25066
|
+
path?: never;
|
|
25067
|
+
query?: {
|
|
25068
|
+
/**
|
|
25069
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
25070
|
+
*/
|
|
25071
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
25072
|
+
};
|
|
25073
|
+
url: '/forecast/transits';
|
|
25074
|
+
};
|
|
25075
|
+
export type PostForecastTransitsErrors = {
|
|
25076
|
+
/**
|
|
25077
|
+
* Validation error. `issues[]` lists every failed field.
|
|
25078
|
+
*/
|
|
25079
|
+
400: {
|
|
25080
|
+
/**
|
|
25081
|
+
* First issue summary.
|
|
25082
|
+
*/
|
|
25083
|
+
error: string;
|
|
25084
|
+
code: 'validation_error';
|
|
25085
|
+
/**
|
|
25086
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
25087
|
+
*/
|
|
25088
|
+
issues: Array<{
|
|
25089
|
+
/**
|
|
25090
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
25091
|
+
*/
|
|
25092
|
+
path: string;
|
|
25093
|
+
message: string;
|
|
25094
|
+
/**
|
|
25095
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
25096
|
+
*/
|
|
25097
|
+
code?: string;
|
|
25098
|
+
/**
|
|
25099
|
+
* Expected type for invalid_type.
|
|
25100
|
+
*/
|
|
25101
|
+
expected?: string;
|
|
25102
|
+
/**
|
|
25103
|
+
* Minimum bound for too_small issues.
|
|
25104
|
+
*/
|
|
25105
|
+
minimum?: number | string;
|
|
25106
|
+
/**
|
|
25107
|
+
* Maximum bound for too_big issues.
|
|
25108
|
+
*/
|
|
25109
|
+
maximum?: number | string;
|
|
25110
|
+
inclusive?: boolean;
|
|
25111
|
+
/**
|
|
25112
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
25113
|
+
*/
|
|
25114
|
+
format?: string;
|
|
25115
|
+
/**
|
|
25116
|
+
* Regex pattern when format is regex.
|
|
25117
|
+
*/
|
|
25118
|
+
pattern?: string;
|
|
25119
|
+
}>;
|
|
25120
|
+
};
|
|
25121
|
+
/**
|
|
25122
|
+
* Invalid or missing API key
|
|
25123
|
+
*/
|
|
25124
|
+
401: {
|
|
25125
|
+
/**
|
|
25126
|
+
* Human-readable error message. May change wording.
|
|
25127
|
+
*/
|
|
25128
|
+
error: string;
|
|
25129
|
+
/**
|
|
25130
|
+
* Machine-readable error code. Stable identifier.
|
|
25131
|
+
*/
|
|
25132
|
+
code: string;
|
|
25133
|
+
};
|
|
25134
|
+
/**
|
|
25135
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
25136
|
+
*/
|
|
25137
|
+
405: {
|
|
25138
|
+
error: string;
|
|
25139
|
+
code: 'method_not_allowed';
|
|
25140
|
+
/**
|
|
25141
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
25142
|
+
*/
|
|
25143
|
+
allow: Array<string>;
|
|
25144
|
+
/**
|
|
25145
|
+
* Link to the product page for this domain.
|
|
25146
|
+
*/
|
|
25147
|
+
docs?: string;
|
|
25148
|
+
};
|
|
25149
|
+
/**
|
|
25150
|
+
* Monthly rate limit exceeded
|
|
25151
|
+
*/
|
|
25152
|
+
429: {
|
|
25153
|
+
/**
|
|
25154
|
+
* Human-readable error message. May change wording.
|
|
25155
|
+
*/
|
|
25156
|
+
error: string;
|
|
25157
|
+
/**
|
|
25158
|
+
* Machine-readable error code. Stable identifier.
|
|
25159
|
+
*/
|
|
25160
|
+
code: string;
|
|
25161
|
+
};
|
|
25162
|
+
/**
|
|
25163
|
+
* Internal server error
|
|
25164
|
+
*/
|
|
25165
|
+
500: {
|
|
25166
|
+
/**
|
|
25167
|
+
* Human-readable error message. May change wording.
|
|
25168
|
+
*/
|
|
25169
|
+
error: string;
|
|
25170
|
+
/**
|
|
25171
|
+
* Machine-readable error code. Stable identifier.
|
|
25172
|
+
*/
|
|
25173
|
+
code: string;
|
|
25174
|
+
};
|
|
25175
|
+
};
|
|
25176
|
+
export type PostForecastTransitsError = PostForecastTransitsErrors[keyof PostForecastTransitsErrors];
|
|
25177
|
+
export type PostForecastTransitsResponses = {
|
|
25178
|
+
/**
|
|
25179
|
+
* Time-ordered western transit events: aspects, ingresses, and stations
|
|
25180
|
+
*/
|
|
25181
|
+
200: {
|
|
25182
|
+
/**
|
|
25183
|
+
* Echo of the birth subject this forecast was built for.
|
|
25184
|
+
*/
|
|
25185
|
+
birthData: {
|
|
25186
|
+
/**
|
|
25187
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
25188
|
+
*/
|
|
25189
|
+
date: string;
|
|
25190
|
+
/**
|
|
25191
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
25192
|
+
*/
|
|
25193
|
+
time: string;
|
|
25194
|
+
/**
|
|
25195
|
+
* 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.
|
|
25196
|
+
*/
|
|
25197
|
+
timezone: number | string;
|
|
25198
|
+
/**
|
|
25199
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25200
|
+
*/
|
|
25201
|
+
latitude?: number;
|
|
25202
|
+
/**
|
|
25203
|
+
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25204
|
+
*/
|
|
25205
|
+
longitude?: number;
|
|
25206
|
+
};
|
|
25207
|
+
/**
|
|
25208
|
+
* First day of the resolved forecast window.
|
|
25209
|
+
*/
|
|
25210
|
+
startDate: string;
|
|
25211
|
+
/**
|
|
25212
|
+
* Last day of the resolved forecast window after the horizon clamp.
|
|
25213
|
+
*/
|
|
25214
|
+
endDate: string;
|
|
25215
|
+
/**
|
|
25216
|
+
* Number of events in the timeline after deduplication, filtering, and the event cap.
|
|
25217
|
+
*/
|
|
25218
|
+
count: number;
|
|
25219
|
+
/**
|
|
25220
|
+
* The merged, time-ordered forecast events across the requested domains.
|
|
25221
|
+
*/
|
|
25222
|
+
events: Array<{
|
|
25223
|
+
/**
|
|
25224
|
+
* Calendar date of the event in YYYY-MM-DD (UTC).
|
|
25225
|
+
*/
|
|
25226
|
+
date: string;
|
|
25227
|
+
/**
|
|
25228
|
+
* 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.
|
|
25229
|
+
*/
|
|
25230
|
+
datetime: string;
|
|
25231
|
+
/**
|
|
25232
|
+
* 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.
|
|
25233
|
+
*/
|
|
25234
|
+
domain: 'western' | 'vedic' | 'biorhythm';
|
|
25235
|
+
/**
|
|
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.
|
|
25237
|
+
*/
|
|
25238
|
+
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
|
|
25239
|
+
/**
|
|
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.
|
|
25241
|
+
*/
|
|
25242
|
+
body: string;
|
|
25243
|
+
/**
|
|
25244
|
+
* For a transit-aspect, the natal body the transit aspects. For a sign-ingress, the zodiac sign entered. Absent for other event types.
|
|
25245
|
+
*/
|
|
25246
|
+
target?: string;
|
|
25247
|
+
/**
|
|
25248
|
+
* For a transit-aspect, the angular relationship. One of conjunction, sextile, square, trine, opposition. Absent for other event types.
|
|
25249
|
+
*/
|
|
25250
|
+
aspect?: string;
|
|
25251
|
+
/**
|
|
25252
|
+
* 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.
|
|
25253
|
+
*/
|
|
25254
|
+
orb?: number;
|
|
25255
|
+
/**
|
|
25256
|
+
* For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
|
|
25257
|
+
*/
|
|
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;
|
|
25267
|
+
/**
|
|
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.
|
|
25269
|
+
*/
|
|
25270
|
+
description: string;
|
|
25271
|
+
/**
|
|
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.
|
|
25273
|
+
*/
|
|
25274
|
+
significance: number;
|
|
25275
|
+
}>;
|
|
25276
|
+
};
|
|
25277
|
+
};
|
|
25278
|
+
export type PostForecastTransitsResponse = PostForecastTransitsResponses[keyof PostForecastTransitsResponses];
|
|
25279
|
+
export type PostForecastSignificantDatesData = {
|
|
25280
|
+
body?: {
|
|
25281
|
+
/**
|
|
25282
|
+
* The single birth subject this forecast is built for. One object only, never an array.
|
|
25283
|
+
*/
|
|
25284
|
+
birthData: {
|
|
25285
|
+
/**
|
|
25286
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
25287
|
+
*/
|
|
25288
|
+
date: string;
|
|
25289
|
+
/**
|
|
25290
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
25291
|
+
*/
|
|
25292
|
+
time: string;
|
|
25293
|
+
/**
|
|
25294
|
+
* 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.
|
|
25295
|
+
*/
|
|
25296
|
+
timezone: number | string;
|
|
25297
|
+
/**
|
|
25298
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25299
|
+
*/
|
|
25300
|
+
latitude?: number;
|
|
25301
|
+
/**
|
|
25302
|
+
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25303
|
+
*/
|
|
25304
|
+
longitude?: number;
|
|
25305
|
+
};
|
|
25306
|
+
/**
|
|
25307
|
+
* First day of the window in YYYY-MM-DD format. Defaults to today in UTC.
|
|
25308
|
+
*/
|
|
25309
|
+
startDate?: string;
|
|
25310
|
+
/**
|
|
25311
|
+
* Last day of the window in YYYY-MM-DD format. Defaults to startDate plus 30 days. Clamped to a maximum of 90 days from startDate.
|
|
25312
|
+
*/
|
|
25313
|
+
endDate?: string;
|
|
25314
|
+
/**
|
|
25315
|
+
* Which forecast domains to consider before filtering by significance. Defaults to all three.
|
|
25316
|
+
*/
|
|
25317
|
+
domains?: Array<'western' | 'vedic' | 'biorhythm'>;
|
|
25318
|
+
/**
|
|
25319
|
+
* Significance floor from 0 to 100 for what counts as a significant date. Defaults to 70.
|
|
25320
|
+
*/
|
|
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
|
+
};
|
|
25339
|
+
};
|
|
25340
|
+
path?: never;
|
|
25341
|
+
query?: {
|
|
25342
|
+
/**
|
|
25343
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
25344
|
+
*/
|
|
25345
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
25346
|
+
};
|
|
25347
|
+
url: '/forecast/significant-dates';
|
|
25348
|
+
};
|
|
25349
|
+
export type PostForecastSignificantDatesErrors = {
|
|
25350
|
+
/**
|
|
25351
|
+
* Validation error. `issues[]` lists every failed field.
|
|
25352
|
+
*/
|
|
25353
|
+
400: {
|
|
25354
|
+
/**
|
|
25355
|
+
* First issue summary.
|
|
25356
|
+
*/
|
|
25357
|
+
error: string;
|
|
25358
|
+
code: 'validation_error';
|
|
25359
|
+
/**
|
|
25360
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
25361
|
+
*/
|
|
25362
|
+
issues: Array<{
|
|
25363
|
+
/**
|
|
25364
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
25365
|
+
*/
|
|
25366
|
+
path: string;
|
|
25367
|
+
message: string;
|
|
25368
|
+
/**
|
|
25369
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
25370
|
+
*/
|
|
25371
|
+
code?: string;
|
|
25372
|
+
/**
|
|
25373
|
+
* Expected type for invalid_type.
|
|
25374
|
+
*/
|
|
25375
|
+
expected?: string;
|
|
25376
|
+
/**
|
|
25377
|
+
* Minimum bound for too_small issues.
|
|
25378
|
+
*/
|
|
25379
|
+
minimum?: number | string;
|
|
25380
|
+
/**
|
|
25381
|
+
* Maximum bound for too_big issues.
|
|
25382
|
+
*/
|
|
25383
|
+
maximum?: number | string;
|
|
25384
|
+
inclusive?: boolean;
|
|
25385
|
+
/**
|
|
25386
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
25387
|
+
*/
|
|
25388
|
+
format?: string;
|
|
25389
|
+
/**
|
|
25390
|
+
* Regex pattern when format is regex.
|
|
25391
|
+
*/
|
|
25392
|
+
pattern?: string;
|
|
25393
|
+
}>;
|
|
25394
|
+
};
|
|
25395
|
+
/**
|
|
25396
|
+
* Invalid or missing API key
|
|
25397
|
+
*/
|
|
25398
|
+
401: {
|
|
25399
|
+
/**
|
|
25400
|
+
* Human-readable error message. May change wording.
|
|
25401
|
+
*/
|
|
25402
|
+
error: string;
|
|
25403
|
+
/**
|
|
25404
|
+
* Machine-readable error code. Stable identifier.
|
|
25405
|
+
*/
|
|
25406
|
+
code: string;
|
|
25407
|
+
};
|
|
25408
|
+
/**
|
|
25409
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
25410
|
+
*/
|
|
25411
|
+
405: {
|
|
25412
|
+
error: string;
|
|
25413
|
+
code: 'method_not_allowed';
|
|
25414
|
+
/**
|
|
25415
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
25416
|
+
*/
|
|
25417
|
+
allow: Array<string>;
|
|
25418
|
+
/**
|
|
25419
|
+
* Link to the product page for this domain.
|
|
25420
|
+
*/
|
|
25421
|
+
docs?: string;
|
|
25422
|
+
};
|
|
25423
|
+
/**
|
|
25424
|
+
* Monthly rate limit exceeded
|
|
25425
|
+
*/
|
|
25426
|
+
429: {
|
|
25427
|
+
/**
|
|
25428
|
+
* Human-readable error message. May change wording.
|
|
25429
|
+
*/
|
|
25430
|
+
error: string;
|
|
25431
|
+
/**
|
|
25432
|
+
* Machine-readable error code. Stable identifier.
|
|
25433
|
+
*/
|
|
25434
|
+
code: string;
|
|
25435
|
+
};
|
|
25436
|
+
/**
|
|
25437
|
+
* Internal server error
|
|
25438
|
+
*/
|
|
25439
|
+
500: {
|
|
25440
|
+
/**
|
|
25441
|
+
* Human-readable error message. May change wording.
|
|
25442
|
+
*/
|
|
25443
|
+
error: string;
|
|
25444
|
+
/**
|
|
25445
|
+
* Machine-readable error code. Stable identifier.
|
|
25446
|
+
*/
|
|
25447
|
+
code: string;
|
|
25448
|
+
};
|
|
25449
|
+
};
|
|
25450
|
+
export type PostForecastSignificantDatesError = PostForecastSignificantDatesErrors[keyof PostForecastSignificantDatesErrors];
|
|
25451
|
+
export type PostForecastSignificantDatesResponses = {
|
|
25452
|
+
/**
|
|
25453
|
+
* High-significance forecast events across the requested domains
|
|
25454
|
+
*/
|
|
25455
|
+
200: {
|
|
25456
|
+
/**
|
|
25457
|
+
* Echo of the birth subject this forecast was built for.
|
|
25458
|
+
*/
|
|
25459
|
+
birthData: {
|
|
25460
|
+
/**
|
|
25461
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
25462
|
+
*/
|
|
25463
|
+
date: string;
|
|
25464
|
+
/**
|
|
25465
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
25466
|
+
*/
|
|
25467
|
+
time: string;
|
|
25468
|
+
/**
|
|
25469
|
+
* 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.
|
|
25470
|
+
*/
|
|
25471
|
+
timezone: number | string;
|
|
25472
|
+
/**
|
|
25473
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25474
|
+
*/
|
|
25475
|
+
latitude?: number;
|
|
25476
|
+
/**
|
|
25477
|
+
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25478
|
+
*/
|
|
25479
|
+
longitude?: number;
|
|
25480
|
+
};
|
|
25481
|
+
/**
|
|
25482
|
+
* First day of the resolved forecast window.
|
|
25483
|
+
*/
|
|
25484
|
+
startDate: string;
|
|
25485
|
+
/**
|
|
25486
|
+
* Last day of the resolved forecast window after the horizon clamp.
|
|
25487
|
+
*/
|
|
25488
|
+
endDate: string;
|
|
25489
|
+
/**
|
|
25490
|
+
* Number of events in the timeline after deduplication, filtering, and the event cap.
|
|
25491
|
+
*/
|
|
25492
|
+
count: number;
|
|
25493
|
+
/**
|
|
25494
|
+
* The merged, time-ordered forecast events across the requested domains.
|
|
25495
|
+
*/
|
|
25496
|
+
events: Array<{
|
|
25497
|
+
/**
|
|
25498
|
+
* Calendar date of the event in YYYY-MM-DD (UTC).
|
|
25499
|
+
*/
|
|
25500
|
+
date: string;
|
|
25501
|
+
/**
|
|
25502
|
+
* 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.
|
|
25503
|
+
*/
|
|
25504
|
+
datetime: string;
|
|
25505
|
+
/**
|
|
25506
|
+
* 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.
|
|
25507
|
+
*/
|
|
25508
|
+
domain: 'western' | 'vedic' | 'biorhythm';
|
|
25509
|
+
/**
|
|
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.
|
|
25511
|
+
*/
|
|
25512
|
+
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
|
|
25513
|
+
/**
|
|
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.
|
|
25515
|
+
*/
|
|
25516
|
+
body: string;
|
|
25517
|
+
/**
|
|
25518
|
+
* For a transit-aspect, the natal body the transit aspects. For a sign-ingress, the zodiac sign entered. Absent for other event types.
|
|
25519
|
+
*/
|
|
25520
|
+
target?: string;
|
|
25521
|
+
/**
|
|
25522
|
+
* For a transit-aspect, the angular relationship. One of conjunction, sextile, square, trine, opposition. Absent for other event types.
|
|
25523
|
+
*/
|
|
25524
|
+
aspect?: string;
|
|
25525
|
+
/**
|
|
25526
|
+
* 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.
|
|
25527
|
+
*/
|
|
25528
|
+
orb?: number;
|
|
25529
|
+
/**
|
|
25530
|
+
* For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
|
|
25531
|
+
*/
|
|
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;
|
|
25541
|
+
/**
|
|
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.
|
|
25543
|
+
*/
|
|
25544
|
+
description: string;
|
|
25545
|
+
/**
|
|
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.
|
|
25547
|
+
*/
|
|
25548
|
+
significance: number;
|
|
25549
|
+
}>;
|
|
25550
|
+
};
|
|
25551
|
+
};
|
|
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];
|
|
22238
26226
|
export type PostBiorhythmReadingData = {
|
|
22239
26227
|
body?: {
|
|
22240
26228
|
/**
|