@roxyapi/sdk 1.2.2 → 1.2.3

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/src/types.gen.ts CHANGED
@@ -3329,6 +3329,14 @@ export type GetAngelNumbersNumbersData = {
3329
3329
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
3330
3330
  */
3331
3331
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
3332
+ /**
3333
+ * Maximum items to return per page. Range: 1-50, default 20.
3334
+ */
3335
+ limit?: number;
3336
+ /**
3337
+ * Number of items to skip for pagination. Default 0.
3338
+ */
3339
+ offset?: number;
3332
3340
  /**
3333
3341
  * Filter results by angel number pattern type. "repeating" returns numbers like 111, 444, 7777. "sequential" returns patterns like 1234. "mirror" returns palindrome patterns like 1212. "master" returns 11, 22, 33. "root" returns single digits 0-9.
3334
3342
  */
@@ -3398,36 +3406,53 @@ export type GetAngelNumbersNumbersResponses = {
3398
3406
  /**
3399
3407
  * List of angel numbers with summary information
3400
3408
  */
3401
- 200: Array<{
3402
- /**
3403
- * Angel number sequence as a string. Common patterns include triple repeating (111-999), quad repeating (1111-9999), master numbers (11, 22, 33), mirror patterns (1212), and sequential numbers (1234).
3404
- */
3405
- number: string;
3406
- /**
3407
- * Short descriptive title capturing the core theme and spiritual significance of this angel number.
3408
- */
3409
- title: string;
3410
- /**
3411
- * One to two sentence summary of the divine message. Ideal for push notifications, daily guidance widgets, and quick reference lookups.
3412
- */
3413
- coreMessage: string;
3409
+ 200: {
3414
3410
  /**
3415
- * Pattern classification of the angel number. "repeating" means all digits are the same (111, 4444). "sequential" means consecutive digits (1234). "mirror" means palindrome or alternating pattern (1212, 1221). "master" means numerology master number (11, 22, 33). "root" means single digit (0-9).
3411
+ * Total number of angel numbers matching the applied filters. 43 for the full set, fewer when filtered by type.
3416
3412
  */
3417
- type: string;
3413
+ total: number;
3418
3414
  /**
3419
- * Numerology digit root calculated by summing all digits and reducing to a single digit. Links each angel number to foundational numerology meaning. Master numbers 11, 22, 33 are preserved without further reduction.
3415
+ * Maximum items returned per page.
3420
3416
  */
3421
- digitRoot: number;
3417
+ limit: number;
3422
3418
  /**
3423
- * Five to eight keywords capturing the spiritual themes and energy of this angel number. Useful for search, filtering, and content generation.
3419
+ * Number of items skipped from the start of the result set.
3424
3420
  */
3425
- keywords: Array<string>;
3421
+ offset: number;
3426
3422
  /**
3427
- * Overall energy classification. "positive" indicates encouraging, uplifting energy. "neutral" indicates transitional energy (neither purely positive nor cautionary). "cautionary" indicates a gentle warning to rebalance or pay attention.
3423
+ * Array of angel number summaries for the current page.
3428
3424
  */
3429
- energy: string;
3430
- }>;
3425
+ numbers: Array<{
3426
+ /**
3427
+ * Angel number sequence as a string. Common patterns include triple repeating (111-999), quad repeating (1111-9999), master numbers (11, 22, 33), mirror patterns (1212), and sequential numbers (1234).
3428
+ */
3429
+ number: string;
3430
+ /**
3431
+ * Short descriptive title capturing the core theme and spiritual significance of this angel number.
3432
+ */
3433
+ title: string;
3434
+ /**
3435
+ * One to two sentence summary of the divine message. Ideal for push notifications, daily guidance widgets, and quick reference lookups.
3436
+ */
3437
+ coreMessage: string;
3438
+ /**
3439
+ * Pattern classification of the angel number. "repeating" means all digits are the same (111, 4444). "sequential" means consecutive digits (1234). "mirror" means palindrome or alternating pattern (1212, 1221). "master" means numerology master number (11, 22, 33). "root" means single digit (0-9).
3440
+ */
3441
+ type: string;
3442
+ /**
3443
+ * Numerology digit root calculated by summing all digits and reducing to a single digit. Links each angel number to foundational numerology meaning. Master numbers 11, 22, 33 are preserved without further reduction.
3444
+ */
3445
+ digitRoot: number;
3446
+ /**
3447
+ * Five to eight keywords capturing the spiritual themes and energy of this angel number. Useful for search, filtering, and content generation.
3448
+ */
3449
+ keywords: Array<string>;
3450
+ /**
3451
+ * Overall energy classification. "positive" indicates encouraging, uplifting energy. "neutral" indicates transitional energy (neither purely positive nor cautionary). "cautionary" indicates a gentle warning to rebalance or pay attention.
3452
+ */
3453
+ energy: string;
3454
+ }>;
3455
+ };
3431
3456
  };
3432
3457
 
3433
3458
  export type GetAngelNumbersNumbersResponse = GetAngelNumbersNumbersResponses[keyof GetAngelNumbersNumbersResponses];
@@ -3761,23 +3786,28 @@ export type GetAngelNumbersLookupResponses = {
3761
3786
 
3762
3787
  export type GetAngelNumbersLookupResponse = GetAngelNumbersLookupResponses[keyof GetAngelNumbersLookupResponses];
3763
3788
 
3764
- export type GetAngelNumbersDailyData = {
3765
- body?: never;
3789
+ export type PostAngelNumbersDailyData = {
3790
+ body?: {
3791
+ /**
3792
+ * Optional seed for reproducible readings. Same seed + same date = same angel number every time. Pass any unique identifier (userId, email hash, session token). Omit for anonymous daily readings.
3793
+ */
3794
+ seed?: string;
3795
+ /**
3796
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
3797
+ */
3798
+ date?: string;
3799
+ };
3766
3800
  path?: never;
3767
3801
  query?: {
3768
3802
  /**
3769
3803
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
3770
3804
  */
3771
3805
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
3772
- /**
3773
- * Date seed in YYYY-MM-DD format for deterministic selection. If omitted, uses the current UTC date. Same seed always returns the same angel number.
3774
- */
3775
- seed?: string;
3776
3806
  };
3777
3807
  url: '/angel-numbers/daily';
3778
3808
  };
3779
3809
 
3780
- export type GetAngelNumbersDailyErrors = {
3810
+ export type PostAngelNumbersDailyErrors = {
3781
3811
  /**
3782
3812
  * Validation error (missing or invalid parameters)
3783
3813
  */
@@ -3832,9 +3862,9 @@ export type GetAngelNumbersDailyErrors = {
3832
3862
  };
3833
3863
  };
3834
3864
 
3835
- export type GetAngelNumbersDailyError = GetAngelNumbersDailyErrors[keyof GetAngelNumbersDailyErrors];
3865
+ export type PostAngelNumbersDailyError = PostAngelNumbersDailyErrors[keyof PostAngelNumbersDailyErrors];
3836
3866
 
3837
- export type GetAngelNumbersDailyResponses = {
3867
+ export type PostAngelNumbersDailyResponses = {
3838
3868
  /**
3839
3869
  * Daily angel number with complete interpretation
3840
3870
  */
@@ -3843,6 +3873,10 @@ export type GetAngelNumbersDailyResponses = {
3843
3873
  * The date used for angel number selection (UTC).
3844
3874
  */
3845
3875
  date: string;
3876
+ /**
3877
+ * Computed seed used for this reading. Same seed always produces the same angel number.
3878
+ */
3879
+ seed: string;
3846
3880
  /**
3847
3881
  * Angel number sequence selected for today. Three or more digit repeating, sequential, or mirror pattern (e.g., 111, 444, 1212).
3848
3882
  */
@@ -3903,7 +3937,7 @@ export type GetAngelNumbersDailyResponses = {
3903
3937
  };
3904
3938
  };
3905
3939
 
3906
- export type GetAngelNumbersDailyResponse = GetAngelNumbersDailyResponses[keyof GetAngelNumbersDailyResponses];
3940
+ export type PostAngelNumbersDailyResponse = PostAngelNumbersDailyResponses[keyof PostAngelNumbersDailyResponses];
3907
3941
 
3908
3942
  export type GetAstrologySignsData = {
3909
3943
  body?: never;
@@ -4017,13 +4051,13 @@ export type GetAstrologySignsResponses = {
4017
4051
 
4018
4052
  export type GetAstrologySignsResponse = GetAstrologySignsResponses[keyof GetAstrologySignsResponses];
4019
4053
 
4020
- export type GetAstrologySignsByIdentifierData = {
4054
+ export type GetAstrologySignsByIdData = {
4021
4055
  body?: never;
4022
4056
  path: {
4023
4057
  /**
4024
4058
  * Sign ID (lowercase, e.g., aries, taurus) or display name (case-insensitive, e.g., Aries, TAURUS).
4025
4059
  */
4026
- identifier: string;
4060
+ id: string;
4027
4061
  };
4028
4062
  query?: {
4029
4063
  /**
@@ -4031,10 +4065,10 @@ export type GetAstrologySignsByIdentifierData = {
4031
4065
  */
4032
4066
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
4033
4067
  };
4034
- url: '/astrology/signs/{identifier}';
4068
+ url: '/astrology/signs/{id}';
4035
4069
  };
4036
4070
 
4037
- export type GetAstrologySignsByIdentifierErrors = {
4071
+ export type GetAstrologySignsByIdErrors = {
4038
4072
  /**
4039
4073
  * Validation error (missing or invalid parameters)
4040
4074
  */
@@ -4102,9 +4136,9 @@ export type GetAstrologySignsByIdentifierErrors = {
4102
4136
  };
4103
4137
  };
4104
4138
 
4105
- export type GetAstrologySignsByIdentifierError = GetAstrologySignsByIdentifierErrors[keyof GetAstrologySignsByIdentifierErrors];
4139
+ export type GetAstrologySignsByIdError = GetAstrologySignsByIdErrors[keyof GetAstrologySignsByIdErrors];
4106
4140
 
4107
- export type GetAstrologySignsByIdentifierResponses = {
4141
+ export type GetAstrologySignsByIdResponses = {
4108
4142
  /**
4109
4143
  * Successfully retrieved zodiac sign
4110
4144
  */
@@ -4194,7 +4228,7 @@ export type GetAstrologySignsByIdentifierResponses = {
4194
4228
  };
4195
4229
  };
4196
4230
 
4197
- export type GetAstrologySignsByIdentifierResponse = GetAstrologySignsByIdentifierResponses[keyof GetAstrologySignsByIdentifierResponses];
4231
+ export type GetAstrologySignsByIdResponse = GetAstrologySignsByIdResponses[keyof GetAstrologySignsByIdResponses];
4198
4232
 
4199
4233
  export type GetAstrologyPlanetMeaningsData = {
4200
4234
  body?: never;
@@ -4303,13 +4337,13 @@ export type GetAstrologyPlanetMeaningsResponses = {
4303
4337
 
4304
4338
  export type GetAstrologyPlanetMeaningsResponse = GetAstrologyPlanetMeaningsResponses[keyof GetAstrologyPlanetMeaningsResponses];
4305
4339
 
4306
- export type GetAstrologyPlanetMeaningsByIdentifierData = {
4340
+ export type GetAstrologyPlanetMeaningsByIdData = {
4307
4341
  body?: never;
4308
4342
  path: {
4309
4343
  /**
4310
4344
  * Planet ID (lowercase, e.g., sun, moon, mercury) or display name (case-insensitive, e.g., Sun, MOON).
4311
4345
  */
4312
- identifier: string;
4346
+ id: string;
4313
4347
  };
4314
4348
  query?: {
4315
4349
  /**
@@ -4317,10 +4351,10 @@ export type GetAstrologyPlanetMeaningsByIdentifierData = {
4317
4351
  */
4318
4352
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
4319
4353
  };
4320
- url: '/astrology/planet-meanings/{identifier}';
4354
+ url: '/astrology/planet-meanings/{id}';
4321
4355
  };
4322
4356
 
4323
- export type GetAstrologyPlanetMeaningsByIdentifierErrors = {
4357
+ export type GetAstrologyPlanetMeaningsByIdErrors = {
4324
4358
  /**
4325
4359
  * Validation error (missing or invalid parameters)
4326
4360
  */
@@ -4388,9 +4422,9 @@ export type GetAstrologyPlanetMeaningsByIdentifierErrors = {
4388
4422
  };
4389
4423
  };
4390
4424
 
4391
- export type GetAstrologyPlanetMeaningsByIdentifierError = GetAstrologyPlanetMeaningsByIdentifierErrors[keyof GetAstrologyPlanetMeaningsByIdentifierErrors];
4425
+ export type GetAstrologyPlanetMeaningsByIdError = GetAstrologyPlanetMeaningsByIdErrors[keyof GetAstrologyPlanetMeaningsByIdErrors];
4392
4426
 
4393
- export type GetAstrologyPlanetMeaningsByIdentifierResponses = {
4427
+ export type GetAstrologyPlanetMeaningsByIdResponses = {
4394
4428
  /**
4395
4429
  * Successfully retrieved planet meaning
4396
4430
  */
@@ -4472,7 +4506,7 @@ export type GetAstrologyPlanetMeaningsByIdentifierResponses = {
4472
4506
  };
4473
4507
  };
4474
4508
 
4475
- export type GetAstrologyPlanetMeaningsByIdentifierResponse = GetAstrologyPlanetMeaningsByIdentifierResponses[keyof GetAstrologyPlanetMeaningsByIdentifierResponses];
4509
+ export type GetAstrologyPlanetMeaningsByIdResponse = GetAstrologyPlanetMeaningsByIdResponses[keyof GetAstrologyPlanetMeaningsByIdResponses];
4476
4510
 
4477
4511
  export type PostAstrologyNatalChartData = {
4478
4512
  body?: NatalChartRequest;
@@ -13136,6 +13170,14 @@ export type GetTarotCardsData = {
13136
13170
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
13137
13171
  */
13138
13172
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
13173
+ /**
13174
+ * Maximum items to return per page. Range: 1-100, default 20.
13175
+ */
13176
+ limit?: number;
13177
+ /**
13178
+ * Number of items to skip for pagination. Default 0.
13179
+ */
13180
+ offset?: number;
13139
13181
  /**
13140
13182
  * Filter by arcana type. Major arcana (0-21) represents life lessons and spiritual themes. Minor arcana (Ace-King in 4 suits) represents daily situations and practical matters.
13141
13183
  */
@@ -13218,6 +13260,14 @@ export type GetTarotCardsResponses = {
13218
13260
  * Total number of tarot cards matching the applied filters. 78 for the full deck, 22 for Major Arcana, 56 for Minor Arcana, 14 per suit.
13219
13261
  */
13220
13262
  total: number;
13263
+ /**
13264
+ * Maximum items returned per page.
13265
+ */
13266
+ limit: number;
13267
+ /**
13268
+ * Number of items skipped from the start of the result set.
13269
+ */
13270
+ offset: number;
13221
13271
  /**
13222
13272
  * Array of tarot cards with basic metadata. Use GET /cards/:id for full upright and reversed interpretations.
13223
13273
  */
@@ -13430,11 +13480,11 @@ export type PostTarotDrawResponse = PostTarotDrawResponses[keyof PostTarotDrawRe
13430
13480
  export type PostTarotDailyData = {
13431
13481
  body?: {
13432
13482
  /**
13433
- * Optional seed for reproducible daily readings. Same seed + same date = same card every time. Pass any unique identifier (userId, email hash, session token, device ID). Omit for anonymous daily cards.
13483
+ * Optional seed for reproducible readings. Same seed + same date = same card every time. Pass any unique identifier (userId, email hash, session token). Omit for anonymous daily readings.
13434
13484
  */
13435
13485
  seed?: string;
13436
13486
  /**
13437
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily cards or pre-generating future readings. Must be valid ISO date string.
13487
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
13438
13488
  */
13439
13489
  date?: string;
13440
13490
  };
@@ -16655,7 +16705,7 @@ export type PostNumerologyDailyData = {
16655
16705
  */
16656
16706
  seed?: string;
16657
16707
  /**
16658
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily numbers or pre-generating future readings.
16708
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
16659
16709
  */
16660
16710
  date?: string;
16661
16711
  };
@@ -16797,7 +16847,7 @@ export type GetDreamsSymbolsData = {
16797
16847
  /**
16798
16848
  * Search query to match against symbol names and meanings. Case-insensitive.
16799
16849
  */
16800
- search?: string;
16850
+ q?: string;
16801
16851
  /**
16802
16852
  * Filter symbols by starting letter (a-z). Case-insensitive.
16803
16853
  */
@@ -17155,11 +17205,11 @@ export type GetDreamsSymbolsByIdResponse = GetDreamsSymbolsByIdResponses[keyof G
17155
17205
  export type PostDreamsDailyData = {
17156
17206
  body?: {
17157
17207
  /**
17158
- * Optional seed for reproducible daily symbols. Same seed + same date = same symbol every time. Pass any unique identifier (userId, email hash, session token). Omit for anonymous daily symbols.
17208
+ * Optional seed for reproducible readings. Same seed + same date = same symbol every time. Pass any unique identifier (userId, email hash, session token). Omit for anonymous daily readings.
17159
17209
  */
17160
17210
  seed?: string;
17161
17211
  /**
17162
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily symbols or pre-generating future ones.
17212
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
17163
17213
  */
17164
17214
  date?: string;
17165
17215
  };
@@ -17268,11 +17318,11 @@ export type PostDreamsDailyResponse = PostDreamsDailyResponses[keyof PostDreamsD
17268
17318
  export type PostIchingDailyData = {
17269
17319
  body?: {
17270
17320
  /**
17271
- * Optional seed for reproducible readings. Same seed + same date = same hexagram every time. Pass any unique identifier (userId, email hash, session token, device ID). Omit for anonymous daily readings.
17321
+ * Optional seed for reproducible readings. Same seed + same date = same hexagram every time. Pass any unique identifier (userId, email hash, session token). Omit for anonymous daily readings.
17272
17322
  */
17273
17323
  seed?: string;
17274
17324
  /**
17275
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily hexagrams or pre-generating future readings.
17325
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
17276
17326
  */
17277
17327
  date?: string;
17278
17328
  };
@@ -17431,11 +17481,11 @@ export type PostIchingDailyResponse = PostIchingDailyResponses[keyof PostIchingD
17431
17481
  export type PostIchingDailyCastData = {
17432
17482
  body?: {
17433
17483
  /**
17434
- * Optional seed for reproducible readings. Same seed + same date = same hexagram every time. Pass any unique identifier (userId, email hash, session token, device ID). Omit for anonymous daily readings.
17484
+ * Optional seed for reproducible readings. Same seed + same date = same hexagram every time. Pass any unique identifier (userId, email hash, session token). Omit for anonymous daily readings.
17435
17485
  */
17436
17486
  seed?: string;
17437
17487
  /**
17438
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily hexagrams or pre-generating future readings.
17488
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
17439
17489
  */
17440
17490
  date?: string;
17441
17491
  };
@@ -18230,13 +18280,13 @@ export type GetIchingTrigramsResponses = {
18230
18280
 
18231
18281
  export type GetIchingTrigramsResponse = GetIchingTrigramsResponses[keyof GetIchingTrigramsResponses];
18232
18282
 
18233
- export type GetIchingTrigramsByIdentifierData = {
18283
+ export type GetIchingTrigramsByIdData = {
18234
18284
  body?: never;
18235
18285
  path: {
18236
18286
  /**
18237
18287
  * Trigram number (1-8) or English name (Heaven, Earth, Thunder, Wind, Water, Fire, Mountain, Lake).
18238
18288
  */
18239
- identifier: string;
18289
+ id: string;
18240
18290
  };
18241
18291
  query?: {
18242
18292
  /**
@@ -18244,10 +18294,10 @@ export type GetIchingTrigramsByIdentifierData = {
18244
18294
  */
18245
18295
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18246
18296
  };
18247
- url: '/iching/trigrams/{identifier}';
18297
+ url: '/iching/trigrams/{id}';
18248
18298
  };
18249
18299
 
18250
- export type GetIchingTrigramsByIdentifierErrors = {
18300
+ export type GetIchingTrigramsByIdErrors = {
18251
18301
  /**
18252
18302
  * Validation error (missing or invalid parameters)
18253
18303
  */
@@ -18315,16 +18365,16 @@ export type GetIchingTrigramsByIdentifierErrors = {
18315
18365
  };
18316
18366
  };
18317
18367
 
18318
- export type GetIchingTrigramsByIdentifierError = GetIchingTrigramsByIdentifierErrors[keyof GetIchingTrigramsByIdentifierErrors];
18368
+ export type GetIchingTrigramsByIdError = GetIchingTrigramsByIdErrors[keyof GetIchingTrigramsByIdErrors];
18319
18369
 
18320
- export type GetIchingTrigramsByIdentifierResponses = {
18370
+ export type GetIchingTrigramsByIdResponses = {
18321
18371
  /**
18322
18372
  * Trigram details.
18323
18373
  */
18324
18374
  200: Trigram;
18325
18375
  };
18326
18376
 
18327
- export type GetIchingTrigramsByIdentifierResponse = GetIchingTrigramsByIdentifierResponses[keyof GetIchingTrigramsByIdentifierResponses];
18377
+ export type GetIchingTrigramsByIdResponse = GetIchingTrigramsByIdResponses[keyof GetIchingTrigramsByIdResponses];
18328
18378
 
18329
18379
  export type GetCrystalsZodiacBySignData = {
18330
18380
  body?: never;
@@ -18340,7 +18390,7 @@ export type GetCrystalsZodiacBySignData = {
18340
18390
  */
18341
18391
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18342
18392
  /**
18343
- * Maximum items to return per page. Range: 1-100, default 20.
18393
+ * Maximum items to return per page. Range: 1-30, default 20.
18344
18394
  */
18345
18395
  limit?: number;
18346
18396
  /**
@@ -18430,7 +18480,7 @@ export type GetCrystalsZodiacBySignResponses = {
18430
18480
  */
18431
18481
  offset: number;
18432
18482
  /**
18433
- * Crystal summaries for this zodiac sign. Call /crystals/:slug for full healing properties.
18483
+ * Crystal summaries for this zodiac sign. Call /crystals/:id for full healing properties.
18434
18484
  */
18435
18485
  crystals: Array<{
18436
18486
  /**
@@ -18440,7 +18490,7 @@ export type GetCrystalsZodiacBySignResponses = {
18440
18490
  /**
18441
18491
  * URL-safe crystal identifier for detail lookup.
18442
18492
  */
18443
- slug: string;
18493
+ id: string;
18444
18494
  /**
18445
18495
  * URL to crystal photograph for visual identification.
18446
18496
  */
@@ -18469,7 +18519,7 @@ export type GetCrystalsChakraByChakraData = {
18469
18519
  */
18470
18520
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18471
18521
  /**
18472
- * Maximum items to return per page. Range: 1-100, default 20.
18522
+ * Maximum items to return per page. Range: 1-30, default 20.
18473
18523
  */
18474
18524
  limit?: number;
18475
18525
  /**
@@ -18559,7 +18609,7 @@ export type GetCrystalsChakraByChakraResponses = {
18559
18609
  */
18560
18610
  offset: number;
18561
18611
  /**
18562
- * Crystal summaries for this chakra. Call /crystals/:slug for full healing properties.
18612
+ * Crystal summaries for this chakra. Call /crystals/:id for full healing properties.
18563
18613
  */
18564
18614
  crystals: Array<{
18565
18615
  /**
@@ -18569,7 +18619,7 @@ export type GetCrystalsChakraByChakraResponses = {
18569
18619
  /**
18570
18620
  * URL-safe crystal identifier for detail lookup.
18571
18621
  */
18572
- slug: string;
18622
+ id: string;
18573
18623
  /**
18574
18624
  * URL to crystal photograph for visual identification.
18575
18625
  */
@@ -18598,7 +18648,7 @@ export type GetCrystalsElementByElementData = {
18598
18648
  */
18599
18649
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18600
18650
  /**
18601
- * Maximum items to return per page. Range: 1-100, default 20.
18651
+ * Maximum items to return per page. Range: 1-30, default 20.
18602
18652
  */
18603
18653
  limit?: number;
18604
18654
  /**
@@ -18688,7 +18738,7 @@ export type GetCrystalsElementByElementResponses = {
18688
18738
  */
18689
18739
  offset: number;
18690
18740
  /**
18691
- * Crystal summaries for this element. Call /crystals/:slug for full healing properties.
18741
+ * Crystal summaries for this element. Call /crystals/:id for full healing properties.
18692
18742
  */
18693
18743
  crystals: Array<{
18694
18744
  /**
@@ -18698,7 +18748,7 @@ export type GetCrystalsElementByElementResponses = {
18698
18748
  /**
18699
18749
  * URL-safe crystal identifier for detail lookup.
18700
18750
  */
18701
- slug: string;
18751
+ id: string;
18702
18752
  /**
18703
18753
  * URL to crystal photograph for visual identification.
18704
18754
  */
@@ -18803,9 +18853,9 @@ export type GetCrystalsBirthstoneByMonthResponses = {
18803
18853
  /**
18804
18854
  * Number of birthstone crystals for this month.
18805
18855
  */
18806
- count: number;
18856
+ total: number;
18807
18857
  /**
18808
- * Birthstone crystals for this month. Call /crystals/:slug for full healing properties.
18858
+ * Birthstone crystals for this month. Call /crystals/:id for full healing properties.
18809
18859
  */
18810
18860
  crystals: Array<{
18811
18861
  /**
@@ -18815,9 +18865,9 @@ export type GetCrystalsBirthstoneByMonthResponses = {
18815
18865
  /**
18816
18866
  * URL-safe crystal identifier for detail lookup.
18817
18867
  */
18818
- slug: string;
18868
+ id: string;
18819
18869
  /**
18820
- * URL to crystal photograph.
18870
+ * URL to crystal photograph for visual identification.
18821
18871
  */
18822
18872
  imageUrl: string;
18823
18873
  /**
@@ -18843,7 +18893,7 @@ export type GetCrystalsSearchData = {
18843
18893
  */
18844
18894
  q: string;
18845
18895
  /**
18846
- * Maximum items to return per page. Range: 1-100, default 20.
18896
+ * Maximum items to return per page. Range: 1-50, default 20.
18847
18897
  */
18848
18898
  limit?: number;
18849
18899
  /**
@@ -18933,7 +18983,7 @@ export type GetCrystalsSearchResponses = {
18933
18983
  */
18934
18984
  offset: number;
18935
18985
  /**
18936
- * Matching crystal summaries. Call /crystals/:slug for full healing properties.
18986
+ * Matching crystal summaries. Call /crystals/:id for full healing properties.
18937
18987
  */
18938
18988
  crystals: Array<{
18939
18989
  /**
@@ -18943,9 +18993,9 @@ export type GetCrystalsSearchResponses = {
18943
18993
  /**
18944
18994
  * URL-safe crystal identifier for detail lookup.
18945
18995
  */
18946
- slug: string;
18996
+ id: string;
18947
18997
  /**
18948
- * URL to crystal photograph.
18998
+ * URL to crystal photograph for visual identification.
18949
18999
  */
18950
19000
  imageUrl: string;
18951
19001
  /**
@@ -18958,13 +19008,13 @@ export type GetCrystalsSearchResponses = {
18958
19008
 
18959
19009
  export type GetCrystalsSearchResponse = GetCrystalsSearchResponses[keyof GetCrystalsSearchResponses];
18960
19010
 
18961
- export type GetCrystalsPairingsBySlugData = {
19011
+ export type GetCrystalsPairingsByIdData = {
18962
19012
  body?: never;
18963
19013
  path: {
18964
19014
  /**
18965
19015
  * URL-safe crystal identifier to find pairings for (e.g., "amethyst", "rose-quartz").
18966
19016
  */
18967
- slug: string;
19017
+ id: string;
18968
19018
  };
18969
19019
  query?: {
18970
19020
  /**
@@ -18972,10 +19022,10 @@ export type GetCrystalsPairingsBySlugData = {
18972
19022
  */
18973
19023
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18974
19024
  };
18975
- url: '/crystals/pairings/{slug}';
19025
+ url: '/crystals/pairings/{id}';
18976
19026
  };
18977
19027
 
18978
- export type GetCrystalsPairingsBySlugErrors = {
19028
+ export type GetCrystalsPairingsByIdErrors = {
18979
19029
  /**
18980
19030
  * Validation error (missing or invalid parameters)
18981
19031
  */
@@ -19043,15 +19093,15 @@ export type GetCrystalsPairingsBySlugErrors = {
19043
19093
  };
19044
19094
  };
19045
19095
 
19046
- export type GetCrystalsPairingsBySlugError = GetCrystalsPairingsBySlugErrors[keyof GetCrystalsPairingsBySlugErrors];
19096
+ export type GetCrystalsPairingsByIdError = GetCrystalsPairingsByIdErrors[keyof GetCrystalsPairingsByIdErrors];
19047
19097
 
19048
- export type GetCrystalsPairingsBySlugResponses = {
19098
+ export type GetCrystalsPairingsByIdResponses = {
19049
19099
  /**
19050
19100
  * Crystal pairing recommendations
19051
19101
  */
19052
19102
  200: {
19053
19103
  /**
19054
- * The crystal slug that pairings were requested for.
19104
+ * The crystal identifier that pairings were requested for.
19055
19105
  */
19056
19106
  crystal: string;
19057
19107
  /**
@@ -19073,7 +19123,7 @@ export type GetCrystalsPairingsBySlugResponses = {
19073
19123
  /**
19074
19124
  * URL-safe identifier for the paired crystal.
19075
19125
  */
19076
- slug: string;
19126
+ id: string;
19077
19127
  /**
19078
19128
  * URL to paired crystal photograph.
19079
19129
  */
@@ -19094,25 +19144,30 @@ export type GetCrystalsPairingsBySlugResponses = {
19094
19144
  };
19095
19145
  };
19096
19146
 
19097
- export type GetCrystalsPairingsBySlugResponse = GetCrystalsPairingsBySlugResponses[keyof GetCrystalsPairingsBySlugResponses];
19147
+ export type GetCrystalsPairingsByIdResponse = GetCrystalsPairingsByIdResponses[keyof GetCrystalsPairingsByIdResponses];
19098
19148
 
19099
- export type GetCrystalsDailyData = {
19100
- body?: never;
19149
+ export type PostCrystalsDailyData = {
19150
+ body?: {
19151
+ /**
19152
+ * Optional seed for reproducible readings. Same seed + same date = same crystal every time. Pass any unique identifier (userId, email hash, session token). Omit for anonymous daily readings.
19153
+ */
19154
+ seed?: string;
19155
+ /**
19156
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
19157
+ */
19158
+ date?: string;
19159
+ };
19101
19160
  path?: never;
19102
19161
  query?: {
19103
19162
  /**
19104
19163
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
19105
19164
  */
19106
19165
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
19107
- /**
19108
- * Date seed in YYYY-MM-DD format for deterministic selection. If omitted, uses the current UTC date. Same seed always returns the same crystal.
19109
- */
19110
- seed?: string;
19111
19166
  };
19112
19167
  url: '/crystals/daily';
19113
19168
  };
19114
19169
 
19115
- export type GetCrystalsDailyErrors = {
19170
+ export type PostCrystalsDailyErrors = {
19116
19171
  /**
19117
19172
  * Validation error (missing or invalid parameters)
19118
19173
  */
@@ -19167,9 +19222,9 @@ export type GetCrystalsDailyErrors = {
19167
19222
  };
19168
19223
  };
19169
19224
 
19170
- export type GetCrystalsDailyError = GetCrystalsDailyErrors[keyof GetCrystalsDailyErrors];
19225
+ export type PostCrystalsDailyError = PostCrystalsDailyErrors[keyof PostCrystalsDailyErrors];
19171
19226
 
19172
- export type GetCrystalsDailyResponses = {
19227
+ export type PostCrystalsDailyResponses = {
19173
19228
  /**
19174
19229
  * Daily crystal teaser with summary information
19175
19230
  */
@@ -19178,14 +19233,18 @@ export type GetCrystalsDailyResponses = {
19178
19233
  * The date used for crystal selection (UTC).
19179
19234
  */
19180
19235
  date: string;
19236
+ /**
19237
+ * Computed seed used for this reading. Same seed always produces the same crystal.
19238
+ */
19239
+ seed: string;
19181
19240
  /**
19182
19241
  * Display name of the crystal selected for this date.
19183
19242
  */
19184
19243
  name: string;
19185
19244
  /**
19186
- * URL-safe identifier. Call /crystals/:slug for full healing properties.
19245
+ * URL-safe identifier. Call /crystals/:id for full healing properties.
19187
19246
  */
19188
- slug: string;
19247
+ id: string;
19189
19248
  /**
19190
19249
  * URL to crystal photograph. Use for daily crystal card display and visual features.
19191
19250
  */
@@ -19209,7 +19268,7 @@ export type GetCrystalsDailyResponses = {
19209
19268
  };
19210
19269
  };
19211
19270
 
19212
- export type GetCrystalsDailyResponse = GetCrystalsDailyResponses[keyof GetCrystalsDailyResponses];
19271
+ export type PostCrystalsDailyResponse = PostCrystalsDailyResponses[keyof PostCrystalsDailyResponses];
19213
19272
 
19214
19273
  export type GetCrystalsRandomData = {
19215
19274
  body?: never;
@@ -19290,9 +19349,9 @@ export type GetCrystalsRandomResponses = {
19290
19349
  */
19291
19350
  name: string;
19292
19351
  /**
19293
- * URL-safe identifier. Call /crystals/:slug for full healing properties.
19352
+ * URL-safe identifier. Call /crystals/:id for full healing properties.
19294
19353
  */
19295
- slug: string;
19354
+ id: string;
19296
19355
  /**
19297
19356
  * URL to crystal photograph for visual display.
19298
19357
  */
@@ -19601,38 +19660,38 @@ export type GetCrystalsResponses = {
19601
19660
  */
19602
19661
  crystals: Array<{
19603
19662
  /**
19604
- * Display name of the crystal or healing stone.
19663
+ * Crystal display name.
19605
19664
  */
19606
19665
  name: string;
19607
19666
  /**
19608
- * URL-safe identifier for the crystal. Use this value in the detail endpoint path to retrieve full healing properties.
19667
+ * URL-safe crystal identifier for detail lookup.
19609
19668
  */
19610
- slug: string;
19669
+ id: string;
19611
19670
  /**
19612
- * URL to a high-quality crystal photograph. Use for visual crystal guides, product listings, and crystal identification features.
19671
+ * URL to crystal photograph for visual identification.
19613
19672
  */
19614
19673
  imageUrl: string;
19615
19674
  /**
19616
- * Chakra energy centers this crystal resonates with. One of: Root, Sacral, Solar Plexus, Heart, Throat, Third Eye, Crown.
19675
+ * Primary colors of this crystal variety. Null when color data is unavailable.
19617
19676
  */
19618
- chakras: Array<string>;
19677
+ colors: Array<string>;
19619
19678
  /**
19620
- * Primary colors of this crystal variety. Null when color data is unavailable. Useful for color-based crystal selection and visual display.
19679
+ * Chakra energy centers this crystal resonates with. One of: Root, Sacral, Solar Plexus, Heart, Throat, Third Eye, Crown.
19621
19680
  */
19622
- colors: Array<string>;
19681
+ chakras: Array<string>;
19623
19682
  }>;
19624
19683
  };
19625
19684
  };
19626
19685
 
19627
19686
  export type GetCrystalsResponse = GetCrystalsResponses[keyof GetCrystalsResponses];
19628
19687
 
19629
- export type GetCrystalsBySlugData = {
19688
+ export type GetCrystalsByIdData = {
19630
19689
  body?: never;
19631
19690
  path: {
19632
19691
  /**
19633
19692
  * URL-safe crystal identifier (e.g., "amethyst", "rose-quartz", "black-tourmaline"). Must match an entry in the database.
19634
19693
  */
19635
- slug: string;
19694
+ id: string;
19636
19695
  };
19637
19696
  query?: {
19638
19697
  /**
@@ -19640,10 +19699,10 @@ export type GetCrystalsBySlugData = {
19640
19699
  */
19641
19700
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
19642
19701
  };
19643
- url: '/crystals/{slug}';
19702
+ url: '/crystals/{id}';
19644
19703
  };
19645
19704
 
19646
- export type GetCrystalsBySlugErrors = {
19705
+ export type GetCrystalsByIdErrors = {
19647
19706
  /**
19648
19707
  * Validation error (missing or invalid parameters)
19649
19708
  */
@@ -19711,9 +19770,9 @@ export type GetCrystalsBySlugErrors = {
19711
19770
  };
19712
19771
  };
19713
19772
 
19714
- export type GetCrystalsBySlugError = GetCrystalsBySlugErrors[keyof GetCrystalsBySlugErrors];
19773
+ export type GetCrystalsByIdError = GetCrystalsByIdErrors[keyof GetCrystalsByIdErrors];
19715
19774
 
19716
- export type GetCrystalsBySlugResponses = {
19775
+ export type GetCrystalsByIdResponses = {
19717
19776
  /**
19718
19777
  * Complete crystal healing properties with all associations
19719
19778
  */
@@ -19725,7 +19784,7 @@ export type GetCrystalsBySlugResponses = {
19725
19784
  /**
19726
19785
  * URL-safe identifier for the crystal.
19727
19786
  */
19728
- slug: string;
19787
+ id: string;
19729
19788
  /**
19730
19789
  * URL to a high-quality crystal photograph. Use for visual crystal guides, product listings, and crystal identification features.
19731
19790
  */
@@ -19792,13 +19851,13 @@ export type GetCrystalsBySlugResponses = {
19792
19851
  */
19793
19852
  affirmation: string;
19794
19853
  /**
19795
- * Crystal slugs that pair well with this stone for enhanced healing combinations. Use for crystal grid and pairing recommendations.
19854
+ * Crystal identifiers that pair well with this stone for enhanced healing combinations. Use for crystal grid and pairing recommendations.
19796
19855
  */
19797
19856
  pairsWith: Array<string>;
19798
19857
  };
19799
19858
  };
19800
19859
 
19801
- export type GetCrystalsBySlugResponse = GetCrystalsBySlugResponses[keyof GetCrystalsBySlugResponses];
19860
+ export type GetCrystalsByIdResponse = GetCrystalsByIdResponses[keyof GetCrystalsByIdResponses];
19802
19861
 
19803
19862
  export type GetLocationSearchData = {
19804
19863
  body?: never;
@@ -19812,6 +19871,10 @@ export type GetLocationSearchData = {
19812
19871
  * Maximum items to return per page. Range: 1-50, default 10.
19813
19872
  */
19814
19873
  limit?: number;
19874
+ /**
19875
+ * Number of items to skip for pagination. Default 0.
19876
+ */
19877
+ offset?: number;
19815
19878
  };
19816
19879
  url: '/location/search';
19817
19880
  };
@@ -19877,44 +19940,61 @@ export type GetLocationSearchResponses = {
19877
19940
  /**
19878
19941
  * Matching cities sorted by relevance (prefix match first) then population
19879
19942
  */
19880
- 200: Array<{
19881
- /**
19882
- * City name as commonly used. Matches the local or internationally recognized name for the location.
19883
- */
19884
- city: string;
19885
- /**
19886
- * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
19887
- */
19888
- province: string;
19889
- /**
19890
- * Full country name in English.
19891
- */
19892
- country: string;
19893
- /**
19894
- * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
19895
- */
19896
- iso2: string;
19897
- /**
19898
- * Geographic latitude in decimal degrees (-90 to 90). Pass directly to birth chart, natal chart, horoscope, synastry, transit, kundli, and panchang API endpoints as the latitude parameter.
19899
- */
19900
- latitude: number;
19943
+ 200: {
19901
19944
  /**
19902
- * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
19945
+ * Total number of cities matching the search query.
19903
19946
  */
19904
- longitude: number;
19947
+ total: number;
19905
19948
  /**
19906
- * IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo). Use with JavaScript Date, Luxon, day.js, or any date library for accurate local time conversion.
19949
+ * Page size used for this response.
19907
19950
  */
19908
- timezone: string;
19951
+ limit: number;
19909
19952
  /**
19910
- * Current UTC offset in decimal hours, automatically adjusted for daylight saving time. Pass directly as the timezone parameter in astrology API endpoints. Examples: 1 for CET, 2 for CEST, -5 for EST, 5.5 for IST, 5.75 for Nepal.
19953
+ * Number of cities skipped. Use with limit for pagination.
19911
19954
  */
19912
- utcOffset: number;
19955
+ offset: number;
19913
19956
  /**
19914
- * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
19957
+ * City results for the current page, sorted by relevance (prefix match first) then population.
19915
19958
  */
19916
- population: number;
19917
- }>;
19959
+ cities: Array<{
19960
+ /**
19961
+ * City name as commonly used. Matches the local or internationally recognized name for the location.
19962
+ */
19963
+ city: string;
19964
+ /**
19965
+ * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
19966
+ */
19967
+ province: string;
19968
+ /**
19969
+ * Full country name in English.
19970
+ */
19971
+ country: string;
19972
+ /**
19973
+ * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
19974
+ */
19975
+ iso2: string;
19976
+ /**
19977
+ * Geographic latitude in decimal degrees (-90 to 90). Pass directly to birth chart, natal chart, horoscope, synastry, transit, kundli, and panchang API endpoints as the latitude parameter.
19978
+ */
19979
+ latitude: number;
19980
+ /**
19981
+ * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
19982
+ */
19983
+ longitude: number;
19984
+ /**
19985
+ * IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo). Use with JavaScript Date, Luxon, day.js, or any date library for accurate local time conversion.
19986
+ */
19987
+ timezone: string;
19988
+ /**
19989
+ * Current UTC offset in decimal hours, automatically adjusted for daylight saving time. Pass directly as the timezone parameter in astrology API endpoints. Examples: 1 for CET, 2 for CEST, -5 for EST, 5.5 for IST, 5.75 for Nepal.
19990
+ */
19991
+ utcOffset: number;
19992
+ /**
19993
+ * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
19994
+ */
19995
+ population: number;
19996
+ }>;
19997
+ };
19918
19998
  };
19919
19999
 
19920
20000
  export type GetLocationSearchResponse = GetLocationSearchResponses[keyof GetLocationSearchResponses];
@@ -19922,7 +20002,16 @@ export type GetLocationSearchResponse = GetLocationSearchResponses[keyof GetLoca
19922
20002
  export type GetLocationCountriesData = {
19923
20003
  body?: never;
19924
20004
  path?: never;
19925
- query?: never;
20005
+ query?: {
20006
+ /**
20007
+ * Maximum items to return per page. Range: 1-50, default 50.
20008
+ */
20009
+ limit?: number;
20010
+ /**
20011
+ * Number of items to skip for pagination. Default 0.
20012
+ */
20013
+ offset?: number;
20014
+ };
19926
20015
  url: '/location/countries';
19927
20016
  };
19928
20017
 
@@ -19987,24 +20076,41 @@ export type GetLocationCountriesResponses = {
19987
20076
  /**
19988
20077
  * Alphabetically sorted list of all 227 countries with ISO codes and city counts
19989
20078
  */
19990
- 200: Array<{
20079
+ 200: {
19991
20080
  /**
19992
- * Full country name in English. Use for display in location pickers and dropdown menus.
20081
+ * Total number of countries available.
19993
20082
  */
19994
- name: string;
20083
+ total: number;
19995
20084
  /**
19996
- * ISO 3166-1 alpha-2 country code. Use as the identifier when fetching cities for a specific country via the /countries/{iso2} endpoint.
20085
+ * Page size used for this response.
19997
20086
  */
19998
- iso2: string;
20087
+ limit: number;
19999
20088
  /**
20000
- * ISO 3166-1 alpha-3 country code. Three-letter standard used in international data exchange.
20089
+ * Number of countries skipped. Use with limit for pagination.
20001
20090
  */
20002
- iso3: string;
20091
+ offset: number;
20003
20092
  /**
20004
- * Number of searchable cities available for this country. Useful for showing coverage in UI or deciding whether to offer city search for a given country.
20093
+ * Countries for the current page, sorted alphabetically by name.
20005
20094
  */
20006
- cityCount: number;
20007
- }>;
20095
+ countries: Array<{
20096
+ /**
20097
+ * Full country name in English. Use for display in location pickers and dropdown menus.
20098
+ */
20099
+ name: string;
20100
+ /**
20101
+ * ISO 3166-1 alpha-2 country code. Use as the identifier when fetching cities for a specific country via the /countries/{iso2} endpoint.
20102
+ */
20103
+ iso2: string;
20104
+ /**
20105
+ * ISO 3166-1 alpha-3 country code. Three-letter standard used in international data exchange.
20106
+ */
20107
+ iso3: string;
20108
+ /**
20109
+ * Number of searchable cities available for this country. Useful for showing coverage in UI or deciding whether to offer city search for a given country.
20110
+ */
20111
+ cityCount: number;
20112
+ }>;
20113
+ };
20008
20114
  };
20009
20115
 
20010
20116
  export type GetLocationCountriesResponse = GetLocationCountriesResponses[keyof GetLocationCountriesResponses];
@@ -20022,6 +20128,10 @@ export type GetLocationCountriesByIso2Data = {
20022
20128
  * Maximum items to return per page. Range: 1-200, default 50.
20023
20129
  */
20024
20130
  limit?: number;
20131
+ /**
20132
+ * Number of items to skip for pagination. Default 0.
20133
+ */
20134
+ offset?: number;
20025
20135
  };
20026
20136
  url: '/location/countries/{iso2}';
20027
20137
  };
@@ -20087,44 +20197,61 @@ export type GetLocationCountriesByIso2Responses = {
20087
20197
  /**
20088
20198
  * Cities in the specified country, sorted by population (largest first)
20089
20199
  */
20090
- 200: Array<{
20091
- /**
20092
- * City name as commonly used. Matches the local or internationally recognized name for the location.
20093
- */
20094
- city: string;
20095
- /**
20096
- * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
20097
- */
20098
- province: string;
20099
- /**
20100
- * Full country name in English.
20101
- */
20102
- country: string;
20103
- /**
20104
- * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
20105
- */
20106
- iso2: string;
20107
- /**
20108
- * Geographic latitude in decimal degrees (-90 to 90). Pass directly to birth chart, natal chart, horoscope, synastry, transit, kundli, and panchang API endpoints as the latitude parameter.
20109
- */
20110
- latitude: number;
20200
+ 200: {
20111
20201
  /**
20112
- * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
20202
+ * Total number of cities available for this country.
20113
20203
  */
20114
- longitude: number;
20204
+ total: number;
20115
20205
  /**
20116
- * IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo). Use with JavaScript Date, Luxon, day.js, or any date library for accurate local time conversion.
20206
+ * Page size used for this response.
20117
20207
  */
20118
- timezone: string;
20208
+ limit: number;
20119
20209
  /**
20120
- * Current UTC offset in decimal hours, automatically adjusted for daylight saving time. Pass directly as the timezone parameter in astrology API endpoints. Examples: 1 for CET, 2 for CEST, -5 for EST, 5.5 for IST, 5.75 for Nepal.
20210
+ * Number of cities skipped. Use with limit for pagination.
20121
20211
  */
20122
- utcOffset: number;
20212
+ offset: number;
20123
20213
  /**
20124
- * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
20214
+ * Cities for the current page, sorted by population (largest first).
20125
20215
  */
20126
- population: number;
20127
- }>;
20216
+ cities: Array<{
20217
+ /**
20218
+ * City name as commonly used. Matches the local or internationally recognized name for the location.
20219
+ */
20220
+ city: string;
20221
+ /**
20222
+ * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
20223
+ */
20224
+ province: string;
20225
+ /**
20226
+ * Full country name in English.
20227
+ */
20228
+ country: string;
20229
+ /**
20230
+ * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
20231
+ */
20232
+ iso2: string;
20233
+ /**
20234
+ * Geographic latitude in decimal degrees (-90 to 90). Pass directly to birth chart, natal chart, horoscope, synastry, transit, kundli, and panchang API endpoints as the latitude parameter.
20235
+ */
20236
+ latitude: number;
20237
+ /**
20238
+ * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
20239
+ */
20240
+ longitude: number;
20241
+ /**
20242
+ * IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo). Use with JavaScript Date, Luxon, day.js, or any date library for accurate local time conversion.
20243
+ */
20244
+ timezone: string;
20245
+ /**
20246
+ * Current UTC offset in decimal hours, automatically adjusted for daylight saving time. Pass directly as the timezone parameter in astrology API endpoints. Examples: 1 for CET, 2 for CEST, -5 for EST, 5.5 for IST, 5.75 for Nepal.
20247
+ */
20248
+ utcOffset: number;
20249
+ /**
20250
+ * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
20251
+ */
20252
+ population: number;
20253
+ }>;
20254
+ };
20128
20255
  };
20129
20256
 
20130
20257
  export type GetLocationCountriesByIso2Response = GetLocationCountriesByIso2Responses[keyof GetLocationCountriesByIso2Responses];