@roxyapi/sdk 1.2.13 → 1.2.15
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 +22 -8
- package/README.md +14 -12
- package/dist/factory.cjs +268 -268
- package/dist/factory.js +268 -268
- package/dist/sdk.gen.d.ts +118 -118
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +4378 -4378
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/package.json +1 -1
- package/src/sdk.gen.ts +284 -284
- package/src/types.gen.ts +4323 -4323
- package/src/version.ts +1 -1
package/src/sdk.gen.ts
CHANGED
|
@@ -1070,170 +1070,6 @@ export class VedicAstrology extends HeyApiClient {
|
|
|
1070
1070
|
}
|
|
1071
1071
|
}
|
|
1072
1072
|
|
|
1073
|
-
export class Tarot extends HeyApiClient {
|
|
1074
|
-
/**
|
|
1075
|
-
* List all 78 tarot cards
|
|
1076
|
-
*
|
|
1077
|
-
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards: 22 Major Arcana (numbered 0-21, representing life lessons, spiritual themes, and karmic influences like The Fool, Death, The Tower) plus 56 Minor Arcana (4 suits × 14 cards each for daily situations and practical matters). Filter by arcana type (major for spiritual guidance, minor for everyday concerns), suit (cups for emotions and relationships, wands for creativity and passion, swords for intellect and conflict, pentacles for material wealth and finances), or card number (Ace=1 for new beginnings, 2-10 for progression, Page=11 for messages, Knight=12 for action, Queen=13 for mastery, King=14 for authority). Returns lightweight basic card data - use GET /cards/:id for full upright and reversed interpretations with keywords. Perfect for building tarot reference libraries, card databases, learning applications, or browsing the complete traditional deck used by professional tarot readers worldwide.
|
|
1078
|
-
*/
|
|
1079
|
-
public listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>) {
|
|
1080
|
-
return (options?.client ?? this.client).get<GetTarotCardsResponses, GetTarotCardsErrors, ThrowOnError>({
|
|
1081
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1082
|
-
url: '/tarot/cards',
|
|
1083
|
-
...options
|
|
1084
|
-
});
|
|
1085
|
-
}
|
|
1086
|
-
|
|
1087
|
-
/**
|
|
1088
|
-
* Get detailed tarot card information
|
|
1089
|
-
*
|
|
1090
|
-
* Retrieve comprehensive details for a specific tarot card from the traditional Rider-Waite-Smith deck including complete upright meanings (card drawn normally) and reversed meanings (inverted/upside down interpretations for nuanced guidance). Each card provides keywords for quick reference, full interpretations (400+ words each for upright and reversed orientations), and guidance across life domains: love and relationships, career and professional growth, finances and material success, health and wellbeing, spirituality and personal development. Major Arcana cards (0-21) reveal deep spiritual lessons and life-changing themes. Minor Arcana cards (Ace through King in Cups, Wands, Swords, Pentacles) address practical daily situations and specific challenges. Use card ID in kebab-case format: Major Arcana like "fool", "magician", "death", "tower", or Minor Arcana like "ace-of-cups", "seven-of-wands", "queen-of-swords", "king-of-pentacles". Essential for detailed tarot study, reading interpretations, divination apps, fortune-telling platforms, spiritual guidance tools, and professional tarot learning applications.
|
|
1091
|
-
*/
|
|
1092
|
-
public getCard<ThrowOnError extends boolean = false>(options: Options<GetTarotCardsByIdData, ThrowOnError>) {
|
|
1093
|
-
return (options.client ?? this.client).get<GetTarotCardsByIdResponses, GetTarotCardsByIdErrors, ThrowOnError>({
|
|
1094
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1095
|
-
url: '/tarot/cards/{id}',
|
|
1096
|
-
...options
|
|
1097
|
-
});
|
|
1098
|
-
}
|
|
1099
|
-
|
|
1100
|
-
/**
|
|
1101
|
-
* Draw random tarot cards with reproducible results
|
|
1102
|
-
*
|
|
1103
|
-
* Draw 1-78 tarot cards from the complete Rider-Waite-Smith deck with seeded reproducibility for consistent personalized readings. Provide an optional seed string (like "user123-2025-12-27" or "readingId") to ensure the same seed always returns identical cards in the exact same order - essential for daily tarot features, personalized user experiences, shareable readings, or reproducible testing. Omit seed for true random draws each time. Control card reversals (upright vs reversed/inverted orientations - reversed cards provide alternative meanings when drawn upside down) and duplicates (traditional deck draws each of 78 cards once, or oracle-style allows repeating same card). Each drawn card includes position number, reversal state (boolean), keywords for quick interpretation, full meaning text (400+ words), authentic Rider-Waite imagery, and card metadata. Perfect for custom spread builders, random card generators, automated tarot reading platforms, daily card features, meditation apps, journaling prompts, divination tools, and any application requiring reproducible or random tarot draws from the industry-standard 78-card deck (22 Major Arcana spiritual lessons + 56 Minor Arcana practical guidance across 4 suits).
|
|
1104
|
-
*/
|
|
1105
|
-
public drawCards<ThrowOnError extends boolean = false>(options: Options<PostTarotDrawData, ThrowOnError>) {
|
|
1106
|
-
return (options.client ?? this.client).post<PostTarotDrawResponses, PostTarotDrawErrors, ThrowOnError>({
|
|
1107
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1108
|
-
url: '/tarot/draw',
|
|
1109
|
-
...options,
|
|
1110
|
-
headers: {
|
|
1111
|
-
'Content-Type': 'application/json',
|
|
1112
|
-
...options.headers
|
|
1113
|
-
}
|
|
1114
|
-
});
|
|
1115
|
-
}
|
|
1116
|
-
|
|
1117
|
-
/**
|
|
1118
|
-
* Get daily tarot card reading
|
|
1119
|
-
*
|
|
1120
|
-
* Receive a single tarot card for daily guidance and reflection. This endpoint uses seeded randomness to ensure the same seed gets the same card on the same day - perfect for "Card of the Day" features. Provide a seed (userId, email hash, session token) for reproducible consistency, or omit for anonymous daily draws. Returns card with keywords, full meaning, and a daily message summary. Great for tarot apps, wellness platforms, morning ritual apps, and journaling tools.
|
|
1121
|
-
*/
|
|
1122
|
-
public getDailyCard<ThrowOnError extends boolean = false>(options?: Options<PostTarotDailyData, ThrowOnError>) {
|
|
1123
|
-
return (options?.client ?? this.client).post<PostTarotDailyResponses, PostTarotDailyErrors, ThrowOnError>({
|
|
1124
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1125
|
-
url: '/tarot/daily',
|
|
1126
|
-
...options,
|
|
1127
|
-
headers: {
|
|
1128
|
-
'Content-Type': 'application/json',
|
|
1129
|
-
...options?.headers
|
|
1130
|
-
}
|
|
1131
|
-
});
|
|
1132
|
-
}
|
|
1133
|
-
|
|
1134
|
-
/**
|
|
1135
|
-
* Get yes/no answer to your question
|
|
1136
|
-
*
|
|
1137
|
-
* Ask a specific question and receive a yes, no, or maybe answer based on a single tarot card draw. Upright cards indicate "Yes" with positive energy, reversed cards indicate "No" with caution, and certain inherently ambiguous cards (The Hanged Man, Wheel of Fortune, Temperance, Two of Swords, Four of Swords) return "Maybe" regardless of orientation since their energy signals pause, reflection, or shifting circumstances. Major Arcana cards give strong definitive answers, Minor Arcana cards give qualified nuanced answers. Returns the answer, strength level, drawn card details, and a contextual interpretation explaining why. Perfect for decision-making apps, quick guidance tools, fortune-telling chatbots, and interactive tarot experiences. Optionally provide a seed for reproducible answers.
|
|
1138
|
-
*/
|
|
1139
|
-
public castYesNo<ThrowOnError extends boolean = false>(options: Options<PostTarotYesNoData, ThrowOnError>) {
|
|
1140
|
-
return (options.client ?? this.client).post<PostTarotYesNoResponses, PostTarotYesNoErrors, ThrowOnError>({
|
|
1141
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1142
|
-
url: '/tarot/yes-no',
|
|
1143
|
-
...options,
|
|
1144
|
-
headers: {
|
|
1145
|
-
'Content-Type': 'application/json',
|
|
1146
|
-
...options.headers
|
|
1147
|
-
}
|
|
1148
|
-
});
|
|
1149
|
-
}
|
|
1150
|
-
|
|
1151
|
-
/**
|
|
1152
|
-
* Three-Card Spread: Past, Present, Future
|
|
1153
|
-
*
|
|
1154
|
-
* Perform the classic three-card tarot spread revealing Past (what led to this situation), Present (current energy and circumstances), and Future (likely outcome if current path continues). The most popular beginner-friendly spread, perfect for quick insights, daily guidance, or exploring specific questions. Each position includes a drawn card with reversal state, keywords, full meaning, and position-specific interpretation. Returns a summary connecting all three cards. Ideal for tarot reading apps, decision-making tools, and personal growth platforms. Optionally provide a seed for reproducible readings.
|
|
1155
|
-
*/
|
|
1156
|
-
public castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>) {
|
|
1157
|
-
return (options.client ?? this.client).post<PostTarotSpreadsThreeCardResponses, PostTarotSpreadsThreeCardErrors, ThrowOnError>({
|
|
1158
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1159
|
-
url: '/tarot/spreads/three-card',
|
|
1160
|
-
...options,
|
|
1161
|
-
headers: {
|
|
1162
|
-
'Content-Type': 'application/json',
|
|
1163
|
-
...options.headers
|
|
1164
|
-
}
|
|
1165
|
-
});
|
|
1166
|
-
}
|
|
1167
|
-
|
|
1168
|
-
/**
|
|
1169
|
-
* Celtic Cross Spread (10 cards)
|
|
1170
|
-
*
|
|
1171
|
-
* Perform the legendary Celtic Cross spread - the most comprehensive and detailed tarot reading available, used by professional tarot readers worldwide for over a century. This 10-card layout reveals the complete picture of any situation through distinct positions: Present Situation (what is happening now), Challenge (obstacles crossing your path), Distant Past (root causes), Recent Past (recent influences), Best Outcome (potential positive result), Near Future (what is approaching in weeks ahead), Your Approach (your attitude and self-perception), External Influences (environment and other people impact), Hopes and Fears (your desires and anxieties), and Final Outcome (where everything is headed). Perfect for life-changing decisions, complex relationship questions, career transitions, spiritual guidance, and deep self-discovery. Ideal for professional tarot apps, life coaching platforms, spiritual wellness websites, and divination tools requiring authoritative comprehensive readings. Each card position provides layered insight combining traditional tarot wisdom with modern psychological interpretation for actionable guidance.
|
|
1172
|
-
*/
|
|
1173
|
-
public castCelticCross<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCelticCrossData, ThrowOnError>) {
|
|
1174
|
-
return (options.client ?? this.client).post<PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCelticCrossErrors, ThrowOnError>({
|
|
1175
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1176
|
-
url: '/tarot/spreads/celtic-cross',
|
|
1177
|
-
...options,
|
|
1178
|
-
headers: {
|
|
1179
|
-
'Content-Type': 'application/json',
|
|
1180
|
-
...options.headers
|
|
1181
|
-
}
|
|
1182
|
-
});
|
|
1183
|
-
}
|
|
1184
|
-
|
|
1185
|
-
/**
|
|
1186
|
-
* Love Spread (5 cards)
|
|
1187
|
-
*
|
|
1188
|
-
* Perform a specialized 5-card relationship tarot spread analyzing romantic connections, emotional dynamics, and partnership potential. This love-focused reading examines five crucial relationship aspects: You (your current emotional state, needs, and what you bring to the relationship), Partner/Other (their emotional perspective, desires, and energy), Relationship Dynamic (the current energy and connection between you both), Challenge (obstacles needing attention, healing, or communication), and Outcome (where this romantic connection is naturally heading). Perfect for dating apps, relationship counseling platforms, matchmaking services, wellness apps, and romantic guidance tools. Provides deep insight into new relationships, existing partnerships, potential connections, breakup recovery, or self-love journeys. Ideal for understanding compatibility, resolving conflicts, strengthening bonds, or deciding whether to pursue or continue a relationship. Each position reveals emotional truths combining traditional tarot relationship wisdom with modern relationship psychology. Use for individual readings or couples readings to gain perspective on romantic situations from singleness to marriage.
|
|
1189
|
-
*/
|
|
1190
|
-
public castLoveSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsLoveData, ThrowOnError>) {
|
|
1191
|
-
return (options.client ?? this.client).post<PostTarotSpreadsLoveResponses, PostTarotSpreadsLoveErrors, ThrowOnError>({
|
|
1192
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1193
|
-
url: '/tarot/spreads/love',
|
|
1194
|
-
...options,
|
|
1195
|
-
headers: {
|
|
1196
|
-
'Content-Type': 'application/json',
|
|
1197
|
-
...options.headers
|
|
1198
|
-
}
|
|
1199
|
-
});
|
|
1200
|
-
}
|
|
1201
|
-
|
|
1202
|
-
/**
|
|
1203
|
-
* Career Spread (7 cards)
|
|
1204
|
-
*
|
|
1205
|
-
* Perform a comprehensive 7-card career tarot spread using SWOT analysis framework (Strengths, Weaknesses, Opportunities, Threats) for professional guidance, business decisions, and vocational clarity. This career-focused reading examines seven strategic business aspects: Current Situation (your present professional position and workplace energy), Strengths (your professional assets, talents, and competitive advantages), Weaknesses (areas needing development, skill gaps, or limiting beliefs), Opportunities (potential growth paths, new ventures, or doors opening), Threats (obstacles, competition, or external challenges), Advice (actionable guidance for navigating your career path), and Outcome (where your professional journey is heading if you follow the guidance). Perfect for career coaching platforms, professional development apps, business consulting tools, job search websites, entrepreneurship platforms, and executive coaching services. Use for career transitions, job offers evaluation, promotion decisions, starting a business, workplace conflicts, finding your calling, or strategic career planning. Combines traditional tarot wisdom with modern SWOT business analysis for practical professional insight. Ideal for employees, entrepreneurs, freelancers, career changers, and anyone seeking vocational direction.
|
|
1206
|
-
*/
|
|
1207
|
-
public castCareerSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCareerData, ThrowOnError>) {
|
|
1208
|
-
return (options.client ?? this.client).post<PostTarotSpreadsCareerResponses, PostTarotSpreadsCareerErrors, ThrowOnError>({
|
|
1209
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1210
|
-
url: '/tarot/spreads/career',
|
|
1211
|
-
...options,
|
|
1212
|
-
headers: {
|
|
1213
|
-
'Content-Type': 'application/json',
|
|
1214
|
-
...options.headers
|
|
1215
|
-
}
|
|
1216
|
-
});
|
|
1217
|
-
}
|
|
1218
|
-
|
|
1219
|
-
/**
|
|
1220
|
-
* Custom Spread Builder
|
|
1221
|
-
*
|
|
1222
|
-
* Build and perform your own custom tarot spread with personalized positions and interpretations (1-10 cards). This flexible endpoint lets you create unique spread layouts for any purpose - define your own position names, meanings, and card count to match your specific needs or therapeutic framework. Perfect for therapists using tarot in counseling, coaches creating signature spreads, app developers building custom reading features, spiritual practitioners with proprietary methods, or anyone wanting to design specialized layouts beyond traditional spreads. Create spreads for specific themes like chakra readings (7 cards), lunar phases (8 cards), elements (4 cards), goals setting (any count), shadow work, inner child healing, decision matrices, or creative problem-solving. Each position requires a name and interpretation - you define what each card position represents in your reading. The API draws the exact number of cards you specify and maps them to your custom positions. No pre-generated summary provided - you interpret the reading based on your framework. Ideal for innovative tarot apps, therapeutic tools, personal development platforms, spiritual coaching services, or experimental divination methods. Maximum 10 positions to maintain reading clarity and practical interpretation time.
|
|
1223
|
-
*/
|
|
1224
|
-
public castCustomSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCustomData, ThrowOnError>) {
|
|
1225
|
-
return (options.client ?? this.client).post<PostTarotSpreadsCustomResponses, PostTarotSpreadsCustomErrors, ThrowOnError>({
|
|
1226
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1227
|
-
url: '/tarot/spreads/custom',
|
|
1228
|
-
...options,
|
|
1229
|
-
headers: {
|
|
1230
|
-
'Content-Type': 'application/json',
|
|
1231
|
-
...options.headers
|
|
1232
|
-
}
|
|
1233
|
-
});
|
|
1234
|
-
}
|
|
1235
|
-
}
|
|
1236
|
-
|
|
1237
1073
|
export class Numerology extends HeyApiClient {
|
|
1238
1074
|
/**
|
|
1239
1075
|
* Calculate Life Path number - Most important numerology calculation
|
|
@@ -1504,68 +1340,197 @@ export class Numerology extends HeyApiClient {
|
|
|
1504
1340
|
}
|
|
1505
1341
|
}
|
|
1506
1342
|
|
|
1507
|
-
export class
|
|
1343
|
+
export class Tarot extends HeyApiClient {
|
|
1508
1344
|
/**
|
|
1509
|
-
* List
|
|
1345
|
+
* List all 78 tarot cards
|
|
1510
1346
|
*
|
|
1511
|
-
*
|
|
1347
|
+
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards: 22 Major Arcana (numbered 0-21, representing life lessons, spiritual themes, and karmic influences like The Fool, Death, The Tower) plus 56 Minor Arcana (4 suits × 14 cards each for daily situations and practical matters). Filter by arcana type (major for spiritual guidance, minor for everyday concerns), suit (cups for emotions and relationships, wands for creativity and passion, swords for intellect and conflict, pentacles for material wealth and finances), or card number (Ace=1 for new beginnings, 2-10 for progression, Page=11 for messages, Knight=12 for action, Queen=13 for mastery, King=14 for authority). Returns lightweight basic card data - use GET /cards/:id for full upright and reversed interpretations with keywords. Perfect for building tarot reference libraries, card databases, learning applications, or browsing the complete traditional deck used by professional tarot readers worldwide.
|
|
1512
1348
|
*/
|
|
1513
|
-
public
|
|
1514
|
-
return (options?.client ?? this.client).get<
|
|
1349
|
+
public listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>) {
|
|
1350
|
+
return (options?.client ?? this.client).get<GetTarotCardsResponses, GetTarotCardsErrors, ThrowOnError>({
|
|
1515
1351
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1516
|
-
url: '/
|
|
1352
|
+
url: '/tarot/cards',
|
|
1517
1353
|
...options
|
|
1518
1354
|
});
|
|
1519
1355
|
}
|
|
1520
1356
|
|
|
1521
1357
|
/**
|
|
1522
|
-
* Get
|
|
1358
|
+
* Get detailed tarot card information
|
|
1523
1359
|
*
|
|
1524
|
-
*
|
|
1360
|
+
* Retrieve comprehensive details for a specific tarot card from the traditional Rider-Waite-Smith deck including complete upright meanings (card drawn normally) and reversed meanings (inverted/upside down interpretations for nuanced guidance). Each card provides keywords for quick reference, full interpretations (400+ words each for upright and reversed orientations), and guidance across life domains: love and relationships, career and professional growth, finances and material success, health and wellbeing, spirituality and personal development. Major Arcana cards (0-21) reveal deep spiritual lessons and life-changing themes. Minor Arcana cards (Ace through King in Cups, Wands, Swords, Pentacles) address practical daily situations and specific challenges. Use card ID in kebab-case format: Major Arcana like "fool", "magician", "death", "tower", or Minor Arcana like "ace-of-cups", "seven-of-wands", "queen-of-swords", "king-of-pentacles". Essential for detailed tarot study, reading interpretations, divination apps, fortune-telling platforms, spiritual guidance tools, and professional tarot learning applications.
|
|
1525
1361
|
*/
|
|
1526
|
-
public
|
|
1527
|
-
return (options
|
|
1362
|
+
public getCard<ThrowOnError extends boolean = false>(options: Options<GetTarotCardsByIdData, ThrowOnError>) {
|
|
1363
|
+
return (options.client ?? this.client).get<GetTarotCardsByIdResponses, GetTarotCardsByIdErrors, ThrowOnError>({
|
|
1528
1364
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1529
|
-
url: '/
|
|
1365
|
+
url: '/tarot/cards/{id}',
|
|
1530
1366
|
...options
|
|
1531
1367
|
});
|
|
1532
1368
|
}
|
|
1533
1369
|
|
|
1534
1370
|
/**
|
|
1535
|
-
*
|
|
1371
|
+
* Draw random tarot cards with reproducible results
|
|
1536
1372
|
*
|
|
1537
|
-
*
|
|
1373
|
+
* Draw 1-78 tarot cards from the complete Rider-Waite-Smith deck with seeded reproducibility for consistent personalized readings. Provide an optional seed string (like "user123-2025-12-27" or "readingId") to ensure the same seed always returns identical cards in the exact same order - essential for daily tarot features, personalized user experiences, shareable readings, or reproducible testing. Omit seed for true random draws each time. Control card reversals (upright vs reversed/inverted orientations - reversed cards provide alternative meanings when drawn upside down) and duplicates (traditional deck draws each of 78 cards once, or oracle-style allows repeating same card). Each drawn card includes position number, reversal state (boolean), keywords for quick interpretation, full meaning text (400+ words), authentic Rider-Waite imagery, and card metadata. Perfect for custom spread builders, random card generators, automated tarot reading platforms, daily card features, meditation apps, journaling prompts, divination tools, and any application requiring reproducible or random tarot draws from the industry-standard 78-card deck (22 Major Arcana spiritual lessons + 56 Minor Arcana practical guidance across 4 suits).
|
|
1538
1374
|
*/
|
|
1539
|
-
public
|
|
1540
|
-
return (options
|
|
1375
|
+
public drawCards<ThrowOnError extends boolean = false>(options: Options<PostTarotDrawData, ThrowOnError>) {
|
|
1376
|
+
return (options.client ?? this.client).post<PostTarotDrawResponses, PostTarotDrawErrors, ThrowOnError>({
|
|
1377
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1378
|
+
url: '/tarot/draw',
|
|
1379
|
+
...options,
|
|
1380
|
+
headers: {
|
|
1381
|
+
'Content-Type': 'application/json',
|
|
1382
|
+
...options.headers
|
|
1383
|
+
}
|
|
1384
|
+
});
|
|
1385
|
+
}
|
|
1386
|
+
|
|
1387
|
+
/**
|
|
1388
|
+
* Get daily tarot card reading
|
|
1389
|
+
*
|
|
1390
|
+
* Receive a single tarot card for daily guidance and reflection. This endpoint uses seeded randomness to ensure the same seed gets the same card on the same day - perfect for "Card of the Day" features. Provide a seed (userId, email hash, session token) for reproducible consistency, or omit for anonymous daily draws. Returns card with keywords, full meaning, and a daily message summary. Great for tarot apps, wellness platforms, morning ritual apps, and journaling tools.
|
|
1391
|
+
*/
|
|
1392
|
+
public getDailyCard<ThrowOnError extends boolean = false>(options?: Options<PostTarotDailyData, ThrowOnError>) {
|
|
1393
|
+
return (options?.client ?? this.client).post<PostTarotDailyResponses, PostTarotDailyErrors, ThrowOnError>({
|
|
1394
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1395
|
+
url: '/tarot/daily',
|
|
1396
|
+
...options,
|
|
1397
|
+
headers: {
|
|
1398
|
+
'Content-Type': 'application/json',
|
|
1399
|
+
...options?.headers
|
|
1400
|
+
}
|
|
1401
|
+
});
|
|
1402
|
+
}
|
|
1403
|
+
|
|
1404
|
+
/**
|
|
1405
|
+
* Get yes/no answer to your question
|
|
1406
|
+
*
|
|
1407
|
+
* Ask a specific question and receive a yes, no, or maybe answer based on a single tarot card draw. Upright cards indicate "Yes" with positive energy, reversed cards indicate "No" with caution, and certain inherently ambiguous cards (The Hanged Man, Wheel of Fortune, Temperance, Two of Swords, Four of Swords) return "Maybe" regardless of orientation since their energy signals pause, reflection, or shifting circumstances. Major Arcana cards give strong definitive answers, Minor Arcana cards give qualified nuanced answers. Returns the answer, strength level, drawn card details, and a contextual interpretation explaining why. Perfect for decision-making apps, quick guidance tools, fortune-telling chatbots, and interactive tarot experiences. Optionally provide a seed for reproducible answers.
|
|
1408
|
+
*/
|
|
1409
|
+
public castYesNo<ThrowOnError extends boolean = false>(options: Options<PostTarotYesNoData, ThrowOnError>) {
|
|
1410
|
+
return (options.client ?? this.client).post<PostTarotYesNoResponses, PostTarotYesNoErrors, ThrowOnError>({
|
|
1411
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1412
|
+
url: '/tarot/yes-no',
|
|
1413
|
+
...options,
|
|
1414
|
+
headers: {
|
|
1415
|
+
'Content-Type': 'application/json',
|
|
1416
|
+
...options.headers
|
|
1417
|
+
}
|
|
1418
|
+
});
|
|
1419
|
+
}
|
|
1420
|
+
|
|
1421
|
+
/**
|
|
1422
|
+
* Three-Card Spread: Past, Present, Future
|
|
1423
|
+
*
|
|
1424
|
+
* Perform the classic three-card tarot spread revealing Past (what led to this situation), Present (current energy and circumstances), and Future (likely outcome if current path continues). The most popular beginner-friendly spread, perfect for quick insights, daily guidance, or exploring specific questions. Each position includes a drawn card with reversal state, keywords, full meaning, and position-specific interpretation. Returns a summary connecting all three cards. Ideal for tarot reading apps, decision-making tools, and personal growth platforms. Optionally provide a seed for reproducible readings.
|
|
1425
|
+
*/
|
|
1426
|
+
public castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>) {
|
|
1427
|
+
return (options.client ?? this.client).post<PostTarotSpreadsThreeCardResponses, PostTarotSpreadsThreeCardErrors, ThrowOnError>({
|
|
1428
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1429
|
+
url: '/tarot/spreads/three-card',
|
|
1430
|
+
...options,
|
|
1431
|
+
headers: {
|
|
1432
|
+
'Content-Type': 'application/json',
|
|
1433
|
+
...options.headers
|
|
1434
|
+
}
|
|
1435
|
+
});
|
|
1436
|
+
}
|
|
1437
|
+
|
|
1438
|
+
/**
|
|
1439
|
+
* Celtic Cross Spread (10 cards)
|
|
1440
|
+
*
|
|
1441
|
+
* Perform the legendary Celtic Cross spread - the most comprehensive and detailed tarot reading available, used by professional tarot readers worldwide for over a century. This 10-card layout reveals the complete picture of any situation through distinct positions: Present Situation (what is happening now), Challenge (obstacles crossing your path), Distant Past (root causes), Recent Past (recent influences), Best Outcome (potential positive result), Near Future (what is approaching in weeks ahead), Your Approach (your attitude and self-perception), External Influences (environment and other people impact), Hopes and Fears (your desires and anxieties), and Final Outcome (where everything is headed). Perfect for life-changing decisions, complex relationship questions, career transitions, spiritual guidance, and deep self-discovery. Ideal for professional tarot apps, life coaching platforms, spiritual wellness websites, and divination tools requiring authoritative comprehensive readings. Each card position provides layered insight combining traditional tarot wisdom with modern psychological interpretation for actionable guidance.
|
|
1442
|
+
*/
|
|
1443
|
+
public castCelticCross<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCelticCrossData, ThrowOnError>) {
|
|
1444
|
+
return (options.client ?? this.client).post<PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCelticCrossErrors, ThrowOnError>({
|
|
1445
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1446
|
+
url: '/tarot/spreads/celtic-cross',
|
|
1447
|
+
...options,
|
|
1448
|
+
headers: {
|
|
1449
|
+
'Content-Type': 'application/json',
|
|
1450
|
+
...options.headers
|
|
1451
|
+
}
|
|
1452
|
+
});
|
|
1453
|
+
}
|
|
1454
|
+
|
|
1455
|
+
/**
|
|
1456
|
+
* Love Spread (5 cards)
|
|
1457
|
+
*
|
|
1458
|
+
* Perform a specialized 5-card relationship tarot spread analyzing romantic connections, emotional dynamics, and partnership potential. This love-focused reading examines five crucial relationship aspects: You (your current emotional state, needs, and what you bring to the relationship), Partner/Other (their emotional perspective, desires, and energy), Relationship Dynamic (the current energy and connection between you both), Challenge (obstacles needing attention, healing, or communication), and Outcome (where this romantic connection is naturally heading). Perfect for dating apps, relationship counseling platforms, matchmaking services, wellness apps, and romantic guidance tools. Provides deep insight into new relationships, existing partnerships, potential connections, breakup recovery, or self-love journeys. Ideal for understanding compatibility, resolving conflicts, strengthening bonds, or deciding whether to pursue or continue a relationship. Each position reveals emotional truths combining traditional tarot relationship wisdom with modern relationship psychology. Use for individual readings or couples readings to gain perspective on romantic situations from singleness to marriage.
|
|
1459
|
+
*/
|
|
1460
|
+
public castLoveSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsLoveData, ThrowOnError>) {
|
|
1461
|
+
return (options.client ?? this.client).post<PostTarotSpreadsLoveResponses, PostTarotSpreadsLoveErrors, ThrowOnError>({
|
|
1462
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1463
|
+
url: '/tarot/spreads/love',
|
|
1464
|
+
...options,
|
|
1465
|
+
headers: {
|
|
1466
|
+
'Content-Type': 'application/json',
|
|
1467
|
+
...options.headers
|
|
1468
|
+
}
|
|
1469
|
+
});
|
|
1470
|
+
}
|
|
1471
|
+
|
|
1472
|
+
/**
|
|
1473
|
+
* Career Spread (7 cards)
|
|
1474
|
+
*
|
|
1475
|
+
* Perform a comprehensive 7-card career tarot spread using SWOT analysis framework (Strengths, Weaknesses, Opportunities, Threats) for professional guidance, business decisions, and vocational clarity. This career-focused reading examines seven strategic business aspects: Current Situation (your present professional position and workplace energy), Strengths (your professional assets, talents, and competitive advantages), Weaknesses (areas needing development, skill gaps, or limiting beliefs), Opportunities (potential growth paths, new ventures, or doors opening), Threats (obstacles, competition, or external challenges), Advice (actionable guidance for navigating your career path), and Outcome (where your professional journey is heading if you follow the guidance). Perfect for career coaching platforms, professional development apps, business consulting tools, job search websites, entrepreneurship platforms, and executive coaching services. Use for career transitions, job offers evaluation, promotion decisions, starting a business, workplace conflicts, finding your calling, or strategic career planning. Combines traditional tarot wisdom with modern SWOT business analysis for practical professional insight. Ideal for employees, entrepreneurs, freelancers, career changers, and anyone seeking vocational direction.
|
|
1476
|
+
*/
|
|
1477
|
+
public castCareerSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCareerData, ThrowOnError>) {
|
|
1478
|
+
return (options.client ?? this.client).post<PostTarotSpreadsCareerResponses, PostTarotSpreadsCareerErrors, ThrowOnError>({
|
|
1479
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1480
|
+
url: '/tarot/spreads/career',
|
|
1481
|
+
...options,
|
|
1482
|
+
headers: {
|
|
1483
|
+
'Content-Type': 'application/json',
|
|
1484
|
+
...options.headers
|
|
1485
|
+
}
|
|
1486
|
+
});
|
|
1487
|
+
}
|
|
1488
|
+
|
|
1489
|
+
/**
|
|
1490
|
+
* Custom Spread Builder
|
|
1491
|
+
*
|
|
1492
|
+
* Build and perform your own custom tarot spread with personalized positions and interpretations (1-10 cards). This flexible endpoint lets you create unique spread layouts for any purpose - define your own position names, meanings, and card count to match your specific needs or therapeutic framework. Perfect for therapists using tarot in counseling, coaches creating signature spreads, app developers building custom reading features, spiritual practitioners with proprietary methods, or anyone wanting to design specialized layouts beyond traditional spreads. Create spreads for specific themes like chakra readings (7 cards), lunar phases (8 cards), elements (4 cards), goals setting (any count), shadow work, inner child healing, decision matrices, or creative problem-solving. Each position requires a name and interpretation - you define what each card position represents in your reading. The API draws the exact number of cards you specify and maps them to your custom positions. No pre-generated summary provided - you interpret the reading based on your framework. Ideal for innovative tarot apps, therapeutic tools, personal development platforms, spiritual coaching services, or experimental divination methods. Maximum 10 positions to maintain reading clarity and practical interpretation time.
|
|
1493
|
+
*/
|
|
1494
|
+
public castCustomSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCustomData, ThrowOnError>) {
|
|
1495
|
+
return (options.client ?? this.client).post<PostTarotSpreadsCustomResponses, PostTarotSpreadsCustomErrors, ThrowOnError>({
|
|
1541
1496
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1542
|
-
url: '/
|
|
1543
|
-
...options
|
|
1497
|
+
url: '/tarot/spreads/custom',
|
|
1498
|
+
...options,
|
|
1499
|
+
headers: {
|
|
1500
|
+
'Content-Type': 'application/json',
|
|
1501
|
+
...options.headers
|
|
1502
|
+
}
|
|
1544
1503
|
});
|
|
1545
1504
|
}
|
|
1546
|
-
|
|
1505
|
+
}
|
|
1506
|
+
|
|
1507
|
+
export class Biorhythm extends HeyApiClient {
|
|
1547
1508
|
/**
|
|
1548
|
-
* Get
|
|
1509
|
+
* Get biorhythm reading - Complete cycle analysis for any date
|
|
1549
1510
|
*
|
|
1550
|
-
*
|
|
1511
|
+
* Calculate a complete biorhythm reading for a given birth date and target date. Returns all 10 cycle values (physical, emotional, intellectual, intuitive, aesthetic, awareness, spiritual, passion, mastery, wisdom), phase detection with 8 distinct states, energy rating (1-10), overall phase assessment, editorial-grade interpretation, actionable advice, and critical day alerts. Perfect for wellness apps, dating platforms, productivity tools, and AI chatbot integrations that need structured biorhythm data.
|
|
1551
1512
|
*/
|
|
1552
|
-
public
|
|
1553
|
-
return (options
|
|
1513
|
+
public getReading<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmReadingData, ThrowOnError>) {
|
|
1514
|
+
return (options?.client ?? this.client).post<PostBiorhythmReadingResponses, PostBiorhythmReadingErrors, ThrowOnError>({
|
|
1554
1515
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1555
|
-
url: '/
|
|
1556
|
-
...options
|
|
1516
|
+
url: '/biorhythm/reading',
|
|
1517
|
+
...options,
|
|
1518
|
+
headers: {
|
|
1519
|
+
'Content-Type': 'application/json',
|
|
1520
|
+
...options?.headers
|
|
1521
|
+
}
|
|
1557
1522
|
});
|
|
1558
1523
|
}
|
|
1559
1524
|
|
|
1560
1525
|
/**
|
|
1561
|
-
* Get
|
|
1526
|
+
* Get biorhythm forecast - Multi-day cycle predictions with best and worst days
|
|
1562
1527
|
*
|
|
1563
|
-
*
|
|
1528
|
+
* Generate a biorhythm forecast for a date range up to 90 days. Returns daily cycle values for physical, emotional, intellectual, and intuitive cycles, daily energy ratings, critical day identification, and a summary with best day, worst day, average energy, and period-level guidance. Ideal for wellness apps, productivity planners, scheduling tools, and calendar integrations that need forward-looking biorhythm data.
|
|
1564
1529
|
*/
|
|
1565
|
-
public
|
|
1566
|
-
return (options?.client ?? this.client).post<
|
|
1530
|
+
public getForecast<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmForecastData, ThrowOnError>) {
|
|
1531
|
+
return (options?.client ?? this.client).post<PostBiorhythmForecastResponses, PostBiorhythmForecastErrors, ThrowOnError>({
|
|
1567
1532
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1568
|
-
url: '/
|
|
1533
|
+
url: '/biorhythm/forecast',
|
|
1569
1534
|
...options,
|
|
1570
1535
|
headers: {
|
|
1571
1536
|
'Content-Type': 'application/json',
|
|
@@ -1573,57 +1538,67 @@ export class Dreams extends HeyApiClient {
|
|
|
1573
1538
|
}
|
|
1574
1539
|
});
|
|
1575
1540
|
}
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
export class AngelNumbers extends HeyApiClient {
|
|
1541
|
+
|
|
1579
1542
|
/**
|
|
1580
|
-
*
|
|
1543
|
+
* Find critical days - Zero crossing detection for any date range
|
|
1581
1544
|
*
|
|
1582
|
-
*
|
|
1545
|
+
* Find all critical days (zero crossings) within a date range up to 180 days. Returns each critical day with cycle name, period, direction (ascending or descending), severity (single, double, or triple), and advisory text. Highlights rare double critical days where two primary cycles cross zero simultaneously and extremely rare triple critical days where all three primary cycles cross zero on the same date. Ideal for calendar integrations, push notification systems, alert engines, and wellness scheduling tools.
|
|
1583
1546
|
*/
|
|
1584
|
-
public
|
|
1585
|
-
return (options?.client ?? this.client).
|
|
1547
|
+
public getCriticalDays<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCriticalDaysData, ThrowOnError>) {
|
|
1548
|
+
return (options?.client ?? this.client).post<PostBiorhythmCriticalDaysResponses, PostBiorhythmCriticalDaysErrors, ThrowOnError>({
|
|
1586
1549
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1587
|
-
url: '/
|
|
1588
|
-
...options
|
|
1550
|
+
url: '/biorhythm/critical-days',
|
|
1551
|
+
...options,
|
|
1552
|
+
headers: {
|
|
1553
|
+
'Content-Type': 'application/json',
|
|
1554
|
+
...options?.headers
|
|
1555
|
+
}
|
|
1589
1556
|
});
|
|
1590
1557
|
}
|
|
1591
1558
|
|
|
1592
1559
|
/**
|
|
1593
|
-
*
|
|
1560
|
+
* Calculate compatibility - Biorhythm alignment between two people
|
|
1594
1561
|
*
|
|
1595
|
-
*
|
|
1562
|
+
* Calculate biorhythm compatibility between two people by overlaying their cycle profiles on a target date. Returns per-cycle alignment scores (0-100) for physical, emotional, and intellectual cycles, an overall compatibility score, relationship rating, strengths, challenges, practical advice, and a daily sync snapshot showing the absolute difference in each primary cycle. Perfect for dating apps, relationship platforms, team-building tools, and couples coaching applications.
|
|
1596
1563
|
*/
|
|
1597
|
-
public
|
|
1598
|
-
return (options
|
|
1564
|
+
public calculateBioCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCompatibilityData, ThrowOnError>) {
|
|
1565
|
+
return (options?.client ?? this.client).post<PostBiorhythmCompatibilityResponses, PostBiorhythmCompatibilityErrors, ThrowOnError>({
|
|
1599
1566
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1600
|
-
url: '/
|
|
1601
|
-
...options
|
|
1567
|
+
url: '/biorhythm/compatibility',
|
|
1568
|
+
...options,
|
|
1569
|
+
headers: {
|
|
1570
|
+
'Content-Type': 'application/json',
|
|
1571
|
+
...options?.headers
|
|
1572
|
+
}
|
|
1602
1573
|
});
|
|
1603
1574
|
}
|
|
1604
1575
|
|
|
1605
1576
|
/**
|
|
1606
|
-
*
|
|
1577
|
+
* Get phase info - Lightweight cycle status for dashboards and widgets
|
|
1607
1578
|
*
|
|
1608
|
-
*
|
|
1579
|
+
* Get current phase information for all 10 biorhythm cycles without the full interpretation payload. Returns value, phase name, phase label, day position within cycle, cycle period, days until next critical crossing, and short-term trend for each cycle. Includes a compact summary string. Designed as a lightweight endpoint for dashboards, widgets, status bars, and quick-check interfaces that need biorhythm phase data without editorial text.
|
|
1609
1580
|
*/
|
|
1610
|
-
public
|
|
1611
|
-
return (options
|
|
1581
|
+
public getPhases<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmPhasesData, ThrowOnError>) {
|
|
1582
|
+
return (options?.client ?? this.client).post<PostBiorhythmPhasesResponses, PostBiorhythmPhasesErrors, ThrowOnError>({
|
|
1612
1583
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1613
|
-
url: '/
|
|
1614
|
-
...options
|
|
1584
|
+
url: '/biorhythm/phases',
|
|
1585
|
+
...options,
|
|
1586
|
+
headers: {
|
|
1587
|
+
'Content-Type': 'application/json',
|
|
1588
|
+
...options?.headers
|
|
1589
|
+
}
|
|
1615
1590
|
});
|
|
1616
1591
|
}
|
|
1617
1592
|
|
|
1618
1593
|
/**
|
|
1619
|
-
*
|
|
1594
|
+
* Get daily biorhythm - Seeded reading for daily check-in features
|
|
1620
1595
|
*
|
|
1621
|
-
* Get
|
|
1596
|
+
* Get a daily biorhythm reading with seeded randomness for consistent "biorhythm of the day" features. Same seed and same date always produce the same reading, perfect for daily push notifications, morning briefings, and wellness app check-ins. Returns energy rating, overall phase, a spotlight on one featured cycle, quick-read values for all three primary cycles, a daily message, and actionable advice. The spotlight cycle is deterministically selected by the seed, creating variety across users while maintaining consistency for each individual.
|
|
1622
1597
|
*/
|
|
1623
|
-
public
|
|
1624
|
-
return (options?.client ?? this.client).post<
|
|
1598
|
+
public getDailyBiorhythm<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmDailyData, ThrowOnError>) {
|
|
1599
|
+
return (options?.client ?? this.client).post<PostBiorhythmDailyResponses, PostBiorhythmDailyErrors, ThrowOnError>({
|
|
1625
1600
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1626
|
-
url: '/
|
|
1601
|
+
url: '/biorhythm/daily',
|
|
1627
1602
|
...options,
|
|
1628
1603
|
headers: {
|
|
1629
1604
|
'Content-Type': 'application/json',
|
|
@@ -1922,84 +1897,68 @@ export class Crystals extends HeyApiClient {
|
|
|
1922
1897
|
}
|
|
1923
1898
|
}
|
|
1924
1899
|
|
|
1925
|
-
export class
|
|
1900
|
+
export class Dreams extends HeyApiClient {
|
|
1926
1901
|
/**
|
|
1927
|
-
*
|
|
1902
|
+
* List and search dream symbols
|
|
1928
1903
|
*
|
|
1929
|
-
*
|
|
1904
|
+
* Browse and search our complete dream interpretation dictionary containing 2,000+ dream symbols with psychological meanings. Find dream meanings for animals (snake dreams, spider dreams, dog dreams), common scenarios (falling dreams, flying dreams, being chased, drowning), people (dreams about mother, father, baby, ex), objects (car, house, water, fire), emotions (fear, anxiety, love), body parts (teeth falling out, hair, eyes), colors, numbers, and abstract concepts. Filter by starting letter for A-Z navigation or search by keyword to find what your dreams mean.
|
|
1930
1905
|
*/
|
|
1931
|
-
public
|
|
1932
|
-
return (options?.client ?? this.client).
|
|
1906
|
+
public searchDreamSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsData, ThrowOnError>) {
|
|
1907
|
+
return (options?.client ?? this.client).get<GetDreamsSymbolsResponses, GetDreamsSymbolsErrors, ThrowOnError>({
|
|
1933
1908
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1934
|
-
url: '/
|
|
1935
|
-
...options
|
|
1936
|
-
headers: {
|
|
1937
|
-
'Content-Type': 'application/json',
|
|
1938
|
-
...options?.headers
|
|
1939
|
-
}
|
|
1909
|
+
url: '/dreams/symbols',
|
|
1910
|
+
...options
|
|
1940
1911
|
});
|
|
1941
1912
|
}
|
|
1942
1913
|
|
|
1943
1914
|
/**
|
|
1944
|
-
* Get
|
|
1915
|
+
* Get random dream symbols
|
|
1945
1916
|
*
|
|
1946
|
-
*
|
|
1917
|
+
* Discover random dream symbols and their interpretations for daily dream insights and exploration. Each request returns different symbols from the 2,000+ dream meaning database - perfect for dream of the day features, dream journaling prompts, meditation on subconscious themes, or exploring what different dreams mean. Get one or multiple random dream interpretations with full psychological meanings.
|
|
1947
1918
|
*/
|
|
1948
|
-
public
|
|
1949
|
-
return (options?.client ?? this.client).
|
|
1919
|
+
public getRandomSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsRandomData, ThrowOnError>) {
|
|
1920
|
+
return (options?.client ?? this.client).get<GetDreamsSymbolsRandomResponses, GetDreamsSymbolsRandomErrors, ThrowOnError>({
|
|
1950
1921
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1951
|
-
url: '/
|
|
1952
|
-
...options
|
|
1953
|
-
headers: {
|
|
1954
|
-
'Content-Type': 'application/json',
|
|
1955
|
-
...options?.headers
|
|
1956
|
-
}
|
|
1922
|
+
url: '/dreams/symbols/random',
|
|
1923
|
+
...options
|
|
1957
1924
|
});
|
|
1958
1925
|
}
|
|
1959
1926
|
|
|
1960
1927
|
/**
|
|
1961
|
-
*
|
|
1928
|
+
* Get symbol counts by letter
|
|
1962
1929
|
*
|
|
1963
|
-
*
|
|
1930
|
+
* Get the count of dream symbols available for each letter A-Z. Build alphabetical dream dictionary navigation to help users browse dream interpretations by letter - from abandonment dreams to zodiac dreams. See how many dream meanings exist for each starting letter.
|
|
1964
1931
|
*/
|
|
1965
|
-
public
|
|
1966
|
-
return (options?.client ?? this.client).
|
|
1932
|
+
public getSymbolLetterCounts<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsLettersData, ThrowOnError>) {
|
|
1933
|
+
return (options?.client ?? this.client).get<GetDreamsSymbolsLettersResponses, GetDreamsSymbolsLettersErrors, ThrowOnError>({
|
|
1967
1934
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1968
|
-
url: '/
|
|
1969
|
-
...options
|
|
1970
|
-
headers: {
|
|
1971
|
-
'Content-Type': 'application/json',
|
|
1972
|
-
...options?.headers
|
|
1973
|
-
}
|
|
1935
|
+
url: '/dreams/symbols/letters',
|
|
1936
|
+
...options
|
|
1974
1937
|
});
|
|
1975
1938
|
}
|
|
1976
1939
|
|
|
1977
1940
|
/**
|
|
1978
|
-
*
|
|
1941
|
+
* Get dream symbol details
|
|
1979
1942
|
*
|
|
1980
|
-
*
|
|
1943
|
+
* Get the complete dream interpretation for a specific symbol. Understand what your dream means with detailed psychological analysis covering subconscious symbolism, emotional significance, and connections to your waking life. Covers all major dream themes: snake dreams (hidden fears, transformation), falling dreams (loss of control, anxiety), water dreams (emotions, cleansing), death dreams (endings, transformation), teeth falling out (self-image, communication anxiety), being chased (avoidance, confronting fears), flying dreams (freedom, ambition), and thousands more dream meanings.
|
|
1981
1944
|
*/
|
|
1982
|
-
public
|
|
1983
|
-
return (options
|
|
1945
|
+
public getDreamSymbol<ThrowOnError extends boolean = false>(options: Options<GetDreamsSymbolsByIdData, ThrowOnError>) {
|
|
1946
|
+
return (options.client ?? this.client).get<GetDreamsSymbolsByIdResponses, GetDreamsSymbolsByIdErrors, ThrowOnError>({
|
|
1984
1947
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1985
|
-
url: '/
|
|
1986
|
-
...options
|
|
1987
|
-
headers: {
|
|
1988
|
-
'Content-Type': 'application/json',
|
|
1989
|
-
...options?.headers
|
|
1990
|
-
}
|
|
1948
|
+
url: '/dreams/symbols/{id}',
|
|
1949
|
+
...options
|
|
1991
1950
|
});
|
|
1992
1951
|
}
|
|
1993
1952
|
|
|
1994
1953
|
/**
|
|
1995
|
-
* Get
|
|
1954
|
+
* Get daily dream symbol
|
|
1996
1955
|
*
|
|
1997
|
-
*
|
|
1956
|
+
* Receive a single dream symbol for daily reflection and subconscious exploration. Uses seeded randomness so the same seed gets the same symbol on the same day, perfect for "Dream Symbol of the Day" features. Provide a seed (userId, email hash, session token) for reproducible consistency, or omit for date-based daily symbols. Returns the symbol with full psychological interpretation. Great for dream journal apps, wellness platforms, morning ritual apps, and meditation tools.
|
|
1998
1957
|
*/
|
|
1999
|
-
public
|
|
2000
|
-
return (options?.client ?? this.client).post<
|
|
1958
|
+
public getDailyDreamSymbol<ThrowOnError extends boolean = false>(options?: Options<PostDreamsDailyData, ThrowOnError>) {
|
|
1959
|
+
return (options?.client ?? this.client).post<PostDreamsDailyResponses, PostDreamsDailyErrors, ThrowOnError>({
|
|
2001
1960
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2002
|
-
url: '/
|
|
1961
|
+
url: '/dreams/daily',
|
|
2003
1962
|
...options,
|
|
2004
1963
|
headers: {
|
|
2005
1964
|
'Content-Type': 'application/json',
|
|
@@ -2007,16 +1966,57 @@ export class Biorhythm extends HeyApiClient {
|
|
|
2007
1966
|
}
|
|
2008
1967
|
});
|
|
2009
1968
|
}
|
|
1969
|
+
}
|
|
1970
|
+
|
|
1971
|
+
export class AngelNumbers extends HeyApiClient {
|
|
1972
|
+
/**
|
|
1973
|
+
* List All Angel Numbers
|
|
1974
|
+
*
|
|
1975
|
+
* Retrieve the complete database of angel numbers with summary information. Returns all 43 angel numbers covering root digits (0-9), master numbers (11, 22, 33), double digits (44-99), triple repeating (111-999), quad repeating (1111-9999), mirror patterns (1212), and sequential numbers (1234). Supports optional type filtering. Perfect for building angel number explorer apps, reference guides, and spiritual databases.
|
|
1976
|
+
*/
|
|
1977
|
+
public listAngelNumbers<ThrowOnError extends boolean = false>(options?: Options<GetAngelNumbersNumbersData, ThrowOnError>) {
|
|
1978
|
+
return (options?.client ?? this.client).get<GetAngelNumbersNumbersResponses, GetAngelNumbersNumbersErrors, ThrowOnError>({
|
|
1979
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
1980
|
+
url: '/angel-numbers/numbers',
|
|
1981
|
+
...options
|
|
1982
|
+
});
|
|
1983
|
+
}
|
|
2010
1984
|
|
|
2011
1985
|
/**
|
|
2012
|
-
* Get
|
|
1986
|
+
* Get Angel Number Meaning
|
|
2013
1987
|
*
|
|
2014
|
-
* Get
|
|
1988
|
+
* Get the complete, authoritative meaning and interpretation for a specific angel number. Returns detailed spiritual, love, career, and twin flame interpretations along with keywords, affirmation, and actionable steps. Covers 43 angel numbers including 111, 222, 333, 444, 555, 666, 777, 888, 999, 1111, 1212, 1234, and more. Authoritative interpretations covering all major angel number patterns.
|
|
2015
1989
|
*/
|
|
2016
|
-
public
|
|
2017
|
-
return (options
|
|
1990
|
+
public getAngelNumber<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersNumbersByNumberData, ThrowOnError>) {
|
|
1991
|
+
return (options.client ?? this.client).get<GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersByNumberErrors, ThrowOnError>({
|
|
2018
1992
|
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2019
|
-
url: '/
|
|
1993
|
+
url: '/angel-numbers/numbers/{number}',
|
|
1994
|
+
...options
|
|
1995
|
+
});
|
|
1996
|
+
}
|
|
1997
|
+
|
|
1998
|
+
/**
|
|
1999
|
+
* Analyze Any Number Sequence
|
|
2000
|
+
*
|
|
2001
|
+
* Smart angel number analysis that works for ANY number sequence, not just known angel numbers. Automatically classifies the pattern type (repeating, sequential, mirror, master, root), calculates the numerology digit root, checks the database for a known meaning, and provides the foundational digit root interpretation as a fallback. Perfect for synchronicity tracking apps where users enter arbitrary number sequences they encounter.
|
|
2002
|
+
*/
|
|
2003
|
+
public analyzeNumberSequence<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersLookupData, ThrowOnError>) {
|
|
2004
|
+
return (options.client ?? this.client).get<GetAngelNumbersLookupResponses, GetAngelNumbersLookupErrors, ThrowOnError>({
|
|
2005
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2006
|
+
url: '/angel-numbers/lookup',
|
|
2007
|
+
...options
|
|
2008
|
+
});
|
|
2009
|
+
}
|
|
2010
|
+
|
|
2011
|
+
/**
|
|
2012
|
+
* Daily Angel Number
|
|
2013
|
+
*
|
|
2014
|
+
* Get the angel number of the day with full meaning and interpretation. Returns a deterministic angel number based on the current date (or a provided seed date), ensuring all users see the same number for any given day. Includes complete spiritual, love, career, and twin flame interpretations. Perfect for daily guidance features, push notifications, content generation, and angel number widget integrations.
|
|
2015
|
+
*/
|
|
2016
|
+
public getDailyAngelNumber<ThrowOnError extends boolean = false>(options?: Options<PostAngelNumbersDailyData, ThrowOnError>) {
|
|
2017
|
+
return (options?.client ?? this.client).post<PostAngelNumbersDailyResponses, PostAngelNumbersDailyErrors, ThrowOnError>({
|
|
2018
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }],
|
|
2019
|
+
url: '/angel-numbers/daily',
|
|
2020
2020
|
...options,
|
|
2021
2021
|
headers: {
|
|
2022
2022
|
'Content-Type': 'application/json',
|
|
@@ -2103,24 +2103,19 @@ export class Roxy extends HeyApiClient {
|
|
|
2103
2103
|
return this._vedicAstrology ??= new VedicAstrology({ client: this.client });
|
|
2104
2104
|
}
|
|
2105
2105
|
|
|
2106
|
-
private _tarot?: Tarot;
|
|
2107
|
-
get tarot(): Tarot {
|
|
2108
|
-
return this._tarot ??= new Tarot({ client: this.client });
|
|
2109
|
-
}
|
|
2110
|
-
|
|
2111
2106
|
private _numerology?: Numerology;
|
|
2112
2107
|
get numerology(): Numerology {
|
|
2113
2108
|
return this._numerology ??= new Numerology({ client: this.client });
|
|
2114
2109
|
}
|
|
2115
2110
|
|
|
2116
|
-
private
|
|
2117
|
-
get
|
|
2118
|
-
return this.
|
|
2111
|
+
private _tarot?: Tarot;
|
|
2112
|
+
get tarot(): Tarot {
|
|
2113
|
+
return this._tarot ??= new Tarot({ client: this.client });
|
|
2119
2114
|
}
|
|
2120
2115
|
|
|
2121
|
-
private
|
|
2122
|
-
get
|
|
2123
|
-
return this.
|
|
2116
|
+
private _biorhythm?: Biorhythm;
|
|
2117
|
+
get biorhythm(): Biorhythm {
|
|
2118
|
+
return this._biorhythm ??= new Biorhythm({ client: this.client });
|
|
2124
2119
|
}
|
|
2125
2120
|
|
|
2126
2121
|
private _iching?: Iching;
|
|
@@ -2133,9 +2128,14 @@ export class Roxy extends HeyApiClient {
|
|
|
2133
2128
|
return this._crystals ??= new Crystals({ client: this.client });
|
|
2134
2129
|
}
|
|
2135
2130
|
|
|
2136
|
-
private
|
|
2137
|
-
get
|
|
2138
|
-
return this.
|
|
2131
|
+
private _dreams?: Dreams;
|
|
2132
|
+
get dreams(): Dreams {
|
|
2133
|
+
return this._dreams ??= new Dreams({ client: this.client });
|
|
2134
|
+
}
|
|
2135
|
+
|
|
2136
|
+
private _angelNumbers?: AngelNumbers;
|
|
2137
|
+
get angelNumbers(): AngelNumbers {
|
|
2138
|
+
return this._angelNumbers ??= new AngelNumbers({ client: this.client });
|
|
2139
2139
|
}
|
|
2140
2140
|
|
|
2141
2141
|
private _location?: Location;
|