@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.
@@ -3267,6 +3267,14 @@ export type GetAngelNumbersNumbersData = {
3267
3267
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
3268
3268
  */
3269
3269
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
3270
+ /**
3271
+ * Maximum items to return per page. Range: 1-50, default 20.
3272
+ */
3273
+ limit?: number;
3274
+ /**
3275
+ * Number of items to skip for pagination. Default 0.
3276
+ */
3277
+ offset?: number;
3270
3278
  /**
3271
3279
  * 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.
3272
3280
  */
@@ -3333,36 +3341,53 @@ export type GetAngelNumbersNumbersResponses = {
3333
3341
  /**
3334
3342
  * List of angel numbers with summary information
3335
3343
  */
3336
- 200: Array<{
3337
- /**
3338
- * 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).
3339
- */
3340
- number: string;
3341
- /**
3342
- * Short descriptive title capturing the core theme and spiritual significance of this angel number.
3343
- */
3344
- title: string;
3345
- /**
3346
- * One to two sentence summary of the divine message. Ideal for push notifications, daily guidance widgets, and quick reference lookups.
3347
- */
3348
- coreMessage: string;
3344
+ 200: {
3349
3345
  /**
3350
- * 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).
3346
+ * Total number of angel numbers matching the applied filters. 43 for the full set, fewer when filtered by type.
3351
3347
  */
3352
- type: string;
3348
+ total: number;
3353
3349
  /**
3354
- * 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.
3350
+ * Maximum items returned per page.
3355
3351
  */
3356
- digitRoot: number;
3352
+ limit: number;
3357
3353
  /**
3358
- * Five to eight keywords capturing the spiritual themes and energy of this angel number. Useful for search, filtering, and content generation.
3354
+ * Number of items skipped from the start of the result set.
3359
3355
  */
3360
- keywords: Array<string>;
3356
+ offset: number;
3361
3357
  /**
3362
- * 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.
3358
+ * Array of angel number summaries for the current page.
3363
3359
  */
3364
- energy: string;
3365
- }>;
3360
+ numbers: Array<{
3361
+ /**
3362
+ * 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).
3363
+ */
3364
+ number: string;
3365
+ /**
3366
+ * Short descriptive title capturing the core theme and spiritual significance of this angel number.
3367
+ */
3368
+ title: string;
3369
+ /**
3370
+ * One to two sentence summary of the divine message. Ideal for push notifications, daily guidance widgets, and quick reference lookups.
3371
+ */
3372
+ coreMessage: string;
3373
+ /**
3374
+ * 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).
3375
+ */
3376
+ type: string;
3377
+ /**
3378
+ * 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.
3379
+ */
3380
+ digitRoot: number;
3381
+ /**
3382
+ * Five to eight keywords capturing the spiritual themes and energy of this angel number. Useful for search, filtering, and content generation.
3383
+ */
3384
+ keywords: Array<string>;
3385
+ /**
3386
+ * 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.
3387
+ */
3388
+ energy: string;
3389
+ }>;
3390
+ };
3366
3391
  };
3367
3392
  export type GetAngelNumbersNumbersResponse = GetAngelNumbersNumbersResponses[keyof GetAngelNumbersNumbersResponses];
3368
3393
  export type GetAngelNumbersNumbersByNumberData = {
@@ -3684,22 +3709,27 @@ export type GetAngelNumbersLookupResponses = {
3684
3709
  };
3685
3710
  };
3686
3711
  export type GetAngelNumbersLookupResponse = GetAngelNumbersLookupResponses[keyof GetAngelNumbersLookupResponses];
3687
- export type GetAngelNumbersDailyData = {
3688
- body?: never;
3712
+ export type PostAngelNumbersDailyData = {
3713
+ body?: {
3714
+ /**
3715
+ * 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.
3716
+ */
3717
+ seed?: string;
3718
+ /**
3719
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
3720
+ */
3721
+ date?: string;
3722
+ };
3689
3723
  path?: never;
3690
3724
  query?: {
3691
3725
  /**
3692
3726
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
3693
3727
  */
3694
3728
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
3695
- /**
3696
- * 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.
3697
- */
3698
- seed?: string;
3699
3729
  };
3700
3730
  url: '/angel-numbers/daily';
3701
3731
  };
3702
- export type GetAngelNumbersDailyErrors = {
3732
+ export type PostAngelNumbersDailyErrors = {
3703
3733
  /**
3704
3734
  * Validation error (missing or invalid parameters)
3705
3735
  */
@@ -3753,8 +3783,8 @@ export type GetAngelNumbersDailyErrors = {
3753
3783
  code: string;
3754
3784
  };
3755
3785
  };
3756
- export type GetAngelNumbersDailyError = GetAngelNumbersDailyErrors[keyof GetAngelNumbersDailyErrors];
3757
- export type GetAngelNumbersDailyResponses = {
3786
+ export type PostAngelNumbersDailyError = PostAngelNumbersDailyErrors[keyof PostAngelNumbersDailyErrors];
3787
+ export type PostAngelNumbersDailyResponses = {
3758
3788
  /**
3759
3789
  * Daily angel number with complete interpretation
3760
3790
  */
@@ -3763,6 +3793,10 @@ export type GetAngelNumbersDailyResponses = {
3763
3793
  * The date used for angel number selection (UTC).
3764
3794
  */
3765
3795
  date: string;
3796
+ /**
3797
+ * Computed seed used for this reading. Same seed always produces the same angel number.
3798
+ */
3799
+ seed: string;
3766
3800
  /**
3767
3801
  * Angel number sequence selected for today. Three or more digit repeating, sequential, or mirror pattern (e.g., 111, 444, 1212).
3768
3802
  */
@@ -3822,7 +3856,7 @@ export type GetAngelNumbersDailyResponses = {
3822
3856
  actionSteps: Array<string>;
3823
3857
  };
3824
3858
  };
3825
- export type GetAngelNumbersDailyResponse = GetAngelNumbersDailyResponses[keyof GetAngelNumbersDailyResponses];
3859
+ export type PostAngelNumbersDailyResponse = PostAngelNumbersDailyResponses[keyof PostAngelNumbersDailyResponses];
3826
3860
  export type GetAstrologySignsData = {
3827
3861
  body?: never;
3828
3862
  path?: never;
@@ -3930,13 +3964,13 @@ export type GetAstrologySignsResponses = {
3930
3964
  }>;
3931
3965
  };
3932
3966
  export type GetAstrologySignsResponse = GetAstrologySignsResponses[keyof GetAstrologySignsResponses];
3933
- export type GetAstrologySignsByIdentifierData = {
3967
+ export type GetAstrologySignsByIdData = {
3934
3968
  body?: never;
3935
3969
  path: {
3936
3970
  /**
3937
3971
  * Sign ID (lowercase, e.g., aries, taurus) or display name (case-insensitive, e.g., Aries, TAURUS).
3938
3972
  */
3939
- identifier: string;
3973
+ id: string;
3940
3974
  };
3941
3975
  query?: {
3942
3976
  /**
@@ -3944,9 +3978,9 @@ export type GetAstrologySignsByIdentifierData = {
3944
3978
  */
3945
3979
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
3946
3980
  };
3947
- url: '/astrology/signs/{identifier}';
3981
+ url: '/astrology/signs/{id}';
3948
3982
  };
3949
- export type GetAstrologySignsByIdentifierErrors = {
3983
+ export type GetAstrologySignsByIdErrors = {
3950
3984
  /**
3951
3985
  * Validation error (missing or invalid parameters)
3952
3986
  */
@@ -4013,8 +4047,8 @@ export type GetAstrologySignsByIdentifierErrors = {
4013
4047
  code: string;
4014
4048
  };
4015
4049
  };
4016
- export type GetAstrologySignsByIdentifierError = GetAstrologySignsByIdentifierErrors[keyof GetAstrologySignsByIdentifierErrors];
4017
- export type GetAstrologySignsByIdentifierResponses = {
4050
+ export type GetAstrologySignsByIdError = GetAstrologySignsByIdErrors[keyof GetAstrologySignsByIdErrors];
4051
+ export type GetAstrologySignsByIdResponses = {
4018
4052
  /**
4019
4053
  * Successfully retrieved zodiac sign
4020
4054
  */
@@ -4103,7 +4137,7 @@ export type GetAstrologySignsByIdentifierResponses = {
4103
4137
  weapon?: string;
4104
4138
  };
4105
4139
  };
4106
- export type GetAstrologySignsByIdentifierResponse = GetAstrologySignsByIdentifierResponses[keyof GetAstrologySignsByIdentifierResponses];
4140
+ export type GetAstrologySignsByIdResponse = GetAstrologySignsByIdResponses[keyof GetAstrologySignsByIdResponses];
4107
4141
  export type GetAstrologyPlanetMeaningsData = {
4108
4142
  body?: never;
4109
4143
  path?: never;
@@ -4206,13 +4240,13 @@ export type GetAstrologyPlanetMeaningsResponses = {
4206
4240
  }>;
4207
4241
  };
4208
4242
  export type GetAstrologyPlanetMeaningsResponse = GetAstrologyPlanetMeaningsResponses[keyof GetAstrologyPlanetMeaningsResponses];
4209
- export type GetAstrologyPlanetMeaningsByIdentifierData = {
4243
+ export type GetAstrologyPlanetMeaningsByIdData = {
4210
4244
  body?: never;
4211
4245
  path: {
4212
4246
  /**
4213
4247
  * Planet ID (lowercase, e.g., sun, moon, mercury) or display name (case-insensitive, e.g., Sun, MOON).
4214
4248
  */
4215
- identifier: string;
4249
+ id: string;
4216
4250
  };
4217
4251
  query?: {
4218
4252
  /**
@@ -4220,9 +4254,9 @@ export type GetAstrologyPlanetMeaningsByIdentifierData = {
4220
4254
  */
4221
4255
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
4222
4256
  };
4223
- url: '/astrology/planet-meanings/{identifier}';
4257
+ url: '/astrology/planet-meanings/{id}';
4224
4258
  };
4225
- export type GetAstrologyPlanetMeaningsByIdentifierErrors = {
4259
+ export type GetAstrologyPlanetMeaningsByIdErrors = {
4226
4260
  /**
4227
4261
  * Validation error (missing or invalid parameters)
4228
4262
  */
@@ -4289,8 +4323,8 @@ export type GetAstrologyPlanetMeaningsByIdentifierErrors = {
4289
4323
  code: string;
4290
4324
  };
4291
4325
  };
4292
- export type GetAstrologyPlanetMeaningsByIdentifierError = GetAstrologyPlanetMeaningsByIdentifierErrors[keyof GetAstrologyPlanetMeaningsByIdentifierErrors];
4293
- export type GetAstrologyPlanetMeaningsByIdentifierResponses = {
4326
+ export type GetAstrologyPlanetMeaningsByIdError = GetAstrologyPlanetMeaningsByIdErrors[keyof GetAstrologyPlanetMeaningsByIdErrors];
4327
+ export type GetAstrologyPlanetMeaningsByIdResponses = {
4294
4328
  /**
4295
4329
  * Successfully retrieved planet meaning
4296
4330
  */
@@ -4371,7 +4405,7 @@ export type GetAstrologyPlanetMeaningsByIdentifierResponses = {
4371
4405
  };
4372
4406
  };
4373
4407
  };
4374
- export type GetAstrologyPlanetMeaningsByIdentifierResponse = GetAstrologyPlanetMeaningsByIdentifierResponses[keyof GetAstrologyPlanetMeaningsByIdentifierResponses];
4408
+ export type GetAstrologyPlanetMeaningsByIdResponse = GetAstrologyPlanetMeaningsByIdResponses[keyof GetAstrologyPlanetMeaningsByIdResponses];
4375
4409
  export type PostAstrologyNatalChartData = {
4376
4410
  body?: NatalChartRequest;
4377
4411
  path?: never;
@@ -12729,6 +12763,14 @@ export type GetTarotCardsData = {
12729
12763
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
12730
12764
  */
12731
12765
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
12766
+ /**
12767
+ * Maximum items to return per page. Range: 1-100, default 20.
12768
+ */
12769
+ limit?: number;
12770
+ /**
12771
+ * Number of items to skip for pagination. Default 0.
12772
+ */
12773
+ offset?: number;
12732
12774
  /**
12733
12775
  * 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.
12734
12776
  */
@@ -12808,6 +12850,14 @@ export type GetTarotCardsResponses = {
12808
12850
  * 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.
12809
12851
  */
12810
12852
  total: number;
12853
+ /**
12854
+ * Maximum items returned per page.
12855
+ */
12856
+ limit: number;
12857
+ /**
12858
+ * Number of items skipped from the start of the result set.
12859
+ */
12860
+ offset: number;
12811
12861
  /**
12812
12862
  * Array of tarot cards with basic metadata. Use GET /cards/:id for full upright and reversed interpretations.
12813
12863
  */
@@ -13008,11 +13058,11 @@ export type PostTarotDrawResponse = PostTarotDrawResponses[keyof PostTarotDrawRe
13008
13058
  export type PostTarotDailyData = {
13009
13059
  body?: {
13010
13060
  /**
13011
- * 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.
13061
+ * 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.
13012
13062
  */
13013
13063
  seed?: string;
13014
13064
  /**
13015
- * 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.
13065
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
13016
13066
  */
13017
13067
  date?: string;
13018
13068
  };
@@ -16138,7 +16188,7 @@ export type PostNumerologyDailyData = {
16138
16188
  */
16139
16189
  seed?: string;
16140
16190
  /**
16141
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily numbers or pre-generating future readings.
16191
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
16142
16192
  */
16143
16193
  date?: string;
16144
16194
  };
@@ -16275,7 +16325,7 @@ export type GetDreamsSymbolsData = {
16275
16325
  /**
16276
16326
  * Search query to match against symbol names and meanings. Case-insensitive.
16277
16327
  */
16278
- search?: string;
16328
+ q?: string;
16279
16329
  /**
16280
16330
  * Filter symbols by starting letter (a-z). Case-insensitive.
16281
16331
  */
@@ -16613,11 +16663,11 @@ export type GetDreamsSymbolsByIdResponse = GetDreamsSymbolsByIdResponses[keyof G
16613
16663
  export type PostDreamsDailyData = {
16614
16664
  body?: {
16615
16665
  /**
16616
- * 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.
16666
+ * 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.
16617
16667
  */
16618
16668
  seed?: string;
16619
16669
  /**
16620
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily symbols or pre-generating future ones.
16670
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
16621
16671
  */
16622
16672
  date?: string;
16623
16673
  };
@@ -16721,11 +16771,11 @@ export type PostDreamsDailyResponse = PostDreamsDailyResponses[keyof PostDreamsD
16721
16771
  export type PostIchingDailyData = {
16722
16772
  body?: {
16723
16773
  /**
16724
- * 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.
16774
+ * 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.
16725
16775
  */
16726
16776
  seed?: string;
16727
16777
  /**
16728
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily hexagrams or pre-generating future readings.
16778
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
16729
16779
  */
16730
16780
  date?: string;
16731
16781
  };
@@ -16879,11 +16929,11 @@ export type PostIchingDailyResponse = PostIchingDailyResponses[keyof PostIchingD
16879
16929
  export type PostIchingDailyCastData = {
16880
16930
  body?: {
16881
16931
  /**
16882
- * 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.
16932
+ * 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.
16883
16933
  */
16884
16934
  seed?: string;
16885
16935
  /**
16886
- * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily hexagrams or pre-generating future readings.
16936
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
16887
16937
  */
16888
16938
  date?: string;
16889
16939
  };
@@ -17643,13 +17693,13 @@ export type GetIchingTrigramsResponses = {
17643
17693
  };
17644
17694
  };
17645
17695
  export type GetIchingTrigramsResponse = GetIchingTrigramsResponses[keyof GetIchingTrigramsResponses];
17646
- export type GetIchingTrigramsByIdentifierData = {
17696
+ export type GetIchingTrigramsByIdData = {
17647
17697
  body?: never;
17648
17698
  path: {
17649
17699
  /**
17650
17700
  * Trigram number (1-8) or English name (Heaven, Earth, Thunder, Wind, Water, Fire, Mountain, Lake).
17651
17701
  */
17652
- identifier: string;
17702
+ id: string;
17653
17703
  };
17654
17704
  query?: {
17655
17705
  /**
@@ -17657,9 +17707,9 @@ export type GetIchingTrigramsByIdentifierData = {
17657
17707
  */
17658
17708
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
17659
17709
  };
17660
- url: '/iching/trigrams/{identifier}';
17710
+ url: '/iching/trigrams/{id}';
17661
17711
  };
17662
- export type GetIchingTrigramsByIdentifierErrors = {
17712
+ export type GetIchingTrigramsByIdErrors = {
17663
17713
  /**
17664
17714
  * Validation error (missing or invalid parameters)
17665
17715
  */
@@ -17726,14 +17776,14 @@ export type GetIchingTrigramsByIdentifierErrors = {
17726
17776
  code: string;
17727
17777
  };
17728
17778
  };
17729
- export type GetIchingTrigramsByIdentifierError = GetIchingTrigramsByIdentifierErrors[keyof GetIchingTrigramsByIdentifierErrors];
17730
- export type GetIchingTrigramsByIdentifierResponses = {
17779
+ export type GetIchingTrigramsByIdError = GetIchingTrigramsByIdErrors[keyof GetIchingTrigramsByIdErrors];
17780
+ export type GetIchingTrigramsByIdResponses = {
17731
17781
  /**
17732
17782
  * Trigram details.
17733
17783
  */
17734
17784
  200: Trigram;
17735
17785
  };
17736
- export type GetIchingTrigramsByIdentifierResponse = GetIchingTrigramsByIdentifierResponses[keyof GetIchingTrigramsByIdentifierResponses];
17786
+ export type GetIchingTrigramsByIdResponse = GetIchingTrigramsByIdResponses[keyof GetIchingTrigramsByIdResponses];
17737
17787
  export type GetCrystalsZodiacBySignData = {
17738
17788
  body?: never;
17739
17789
  path: {
@@ -17748,7 +17798,7 @@ export type GetCrystalsZodiacBySignData = {
17748
17798
  */
17749
17799
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
17750
17800
  /**
17751
- * Maximum items to return per page. Range: 1-100, default 20.
17801
+ * Maximum items to return per page. Range: 1-30, default 20.
17752
17802
  */
17753
17803
  limit?: number;
17754
17804
  /**
@@ -17835,7 +17885,7 @@ export type GetCrystalsZodiacBySignResponses = {
17835
17885
  */
17836
17886
  offset: number;
17837
17887
  /**
17838
- * Crystal summaries for this zodiac sign. Call /crystals/:slug for full healing properties.
17888
+ * Crystal summaries for this zodiac sign. Call /crystals/:id for full healing properties.
17839
17889
  */
17840
17890
  crystals: Array<{
17841
17891
  /**
@@ -17845,7 +17895,7 @@ export type GetCrystalsZodiacBySignResponses = {
17845
17895
  /**
17846
17896
  * URL-safe crystal identifier for detail lookup.
17847
17897
  */
17848
- slug: string;
17898
+ id: string;
17849
17899
  /**
17850
17900
  * URL to crystal photograph for visual identification.
17851
17901
  */
@@ -17872,7 +17922,7 @@ export type GetCrystalsChakraByChakraData = {
17872
17922
  */
17873
17923
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
17874
17924
  /**
17875
- * Maximum items to return per page. Range: 1-100, default 20.
17925
+ * Maximum items to return per page. Range: 1-30, default 20.
17876
17926
  */
17877
17927
  limit?: number;
17878
17928
  /**
@@ -17959,7 +18009,7 @@ export type GetCrystalsChakraByChakraResponses = {
17959
18009
  */
17960
18010
  offset: number;
17961
18011
  /**
17962
- * Crystal summaries for this chakra. Call /crystals/:slug for full healing properties.
18012
+ * Crystal summaries for this chakra. Call /crystals/:id for full healing properties.
17963
18013
  */
17964
18014
  crystals: Array<{
17965
18015
  /**
@@ -17969,7 +18019,7 @@ export type GetCrystalsChakraByChakraResponses = {
17969
18019
  /**
17970
18020
  * URL-safe crystal identifier for detail lookup.
17971
18021
  */
17972
- slug: string;
18022
+ id: string;
17973
18023
  /**
17974
18024
  * URL to crystal photograph for visual identification.
17975
18025
  */
@@ -17996,7 +18046,7 @@ export type GetCrystalsElementByElementData = {
17996
18046
  */
17997
18047
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
17998
18048
  /**
17999
- * Maximum items to return per page. Range: 1-100, default 20.
18049
+ * Maximum items to return per page. Range: 1-30, default 20.
18000
18050
  */
18001
18051
  limit?: number;
18002
18052
  /**
@@ -18083,7 +18133,7 @@ export type GetCrystalsElementByElementResponses = {
18083
18133
  */
18084
18134
  offset: number;
18085
18135
  /**
18086
- * Crystal summaries for this element. Call /crystals/:slug for full healing properties.
18136
+ * Crystal summaries for this element. Call /crystals/:id for full healing properties.
18087
18137
  */
18088
18138
  crystals: Array<{
18089
18139
  /**
@@ -18093,7 +18143,7 @@ export type GetCrystalsElementByElementResponses = {
18093
18143
  /**
18094
18144
  * URL-safe crystal identifier for detail lookup.
18095
18145
  */
18096
- slug: string;
18146
+ id: string;
18097
18147
  /**
18098
18148
  * URL to crystal photograph for visual identification.
18099
18149
  */
@@ -18193,9 +18243,9 @@ export type GetCrystalsBirthstoneByMonthResponses = {
18193
18243
  /**
18194
18244
  * Number of birthstone crystals for this month.
18195
18245
  */
18196
- count: number;
18246
+ total: number;
18197
18247
  /**
18198
- * Birthstone crystals for this month. Call /crystals/:slug for full healing properties.
18248
+ * Birthstone crystals for this month. Call /crystals/:id for full healing properties.
18199
18249
  */
18200
18250
  crystals: Array<{
18201
18251
  /**
@@ -18205,9 +18255,9 @@ export type GetCrystalsBirthstoneByMonthResponses = {
18205
18255
  /**
18206
18256
  * URL-safe crystal identifier for detail lookup.
18207
18257
  */
18208
- slug: string;
18258
+ id: string;
18209
18259
  /**
18210
- * URL to crystal photograph.
18260
+ * URL to crystal photograph for visual identification.
18211
18261
  */
18212
18262
  imageUrl: string;
18213
18263
  /**
@@ -18231,7 +18281,7 @@ export type GetCrystalsSearchData = {
18231
18281
  */
18232
18282
  q: string;
18233
18283
  /**
18234
- * Maximum items to return per page. Range: 1-100, default 20.
18284
+ * Maximum items to return per page. Range: 1-50, default 20.
18235
18285
  */
18236
18286
  limit?: number;
18237
18287
  /**
@@ -18318,7 +18368,7 @@ export type GetCrystalsSearchResponses = {
18318
18368
  */
18319
18369
  offset: number;
18320
18370
  /**
18321
- * Matching crystal summaries. Call /crystals/:slug for full healing properties.
18371
+ * Matching crystal summaries. Call /crystals/:id for full healing properties.
18322
18372
  */
18323
18373
  crystals: Array<{
18324
18374
  /**
@@ -18328,9 +18378,9 @@ export type GetCrystalsSearchResponses = {
18328
18378
  /**
18329
18379
  * URL-safe crystal identifier for detail lookup.
18330
18380
  */
18331
- slug: string;
18381
+ id: string;
18332
18382
  /**
18333
- * URL to crystal photograph.
18383
+ * URL to crystal photograph for visual identification.
18334
18384
  */
18335
18385
  imageUrl: string;
18336
18386
  /**
@@ -18341,13 +18391,13 @@ export type GetCrystalsSearchResponses = {
18341
18391
  };
18342
18392
  };
18343
18393
  export type GetCrystalsSearchResponse = GetCrystalsSearchResponses[keyof GetCrystalsSearchResponses];
18344
- export type GetCrystalsPairingsBySlugData = {
18394
+ export type GetCrystalsPairingsByIdData = {
18345
18395
  body?: never;
18346
18396
  path: {
18347
18397
  /**
18348
18398
  * URL-safe crystal identifier to find pairings for (e.g., "amethyst", "rose-quartz").
18349
18399
  */
18350
- slug: string;
18400
+ id: string;
18351
18401
  };
18352
18402
  query?: {
18353
18403
  /**
@@ -18355,9 +18405,9 @@ export type GetCrystalsPairingsBySlugData = {
18355
18405
  */
18356
18406
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18357
18407
  };
18358
- url: '/crystals/pairings/{slug}';
18408
+ url: '/crystals/pairings/{id}';
18359
18409
  };
18360
- export type GetCrystalsPairingsBySlugErrors = {
18410
+ export type GetCrystalsPairingsByIdErrors = {
18361
18411
  /**
18362
18412
  * Validation error (missing or invalid parameters)
18363
18413
  */
@@ -18424,14 +18474,14 @@ export type GetCrystalsPairingsBySlugErrors = {
18424
18474
  code: string;
18425
18475
  };
18426
18476
  };
18427
- export type GetCrystalsPairingsBySlugError = GetCrystalsPairingsBySlugErrors[keyof GetCrystalsPairingsBySlugErrors];
18428
- export type GetCrystalsPairingsBySlugResponses = {
18477
+ export type GetCrystalsPairingsByIdError = GetCrystalsPairingsByIdErrors[keyof GetCrystalsPairingsByIdErrors];
18478
+ export type GetCrystalsPairingsByIdResponses = {
18429
18479
  /**
18430
18480
  * Crystal pairing recommendations
18431
18481
  */
18432
18482
  200: {
18433
18483
  /**
18434
- * The crystal slug that pairings were requested for.
18484
+ * The crystal identifier that pairings were requested for.
18435
18485
  */
18436
18486
  crystal: string;
18437
18487
  /**
@@ -18453,7 +18503,7 @@ export type GetCrystalsPairingsBySlugResponses = {
18453
18503
  /**
18454
18504
  * URL-safe identifier for the paired crystal.
18455
18505
  */
18456
- slug: string;
18506
+ id: string;
18457
18507
  /**
18458
18508
  * URL to paired crystal photograph.
18459
18509
  */
@@ -18473,23 +18523,28 @@ export type GetCrystalsPairingsBySlugResponses = {
18473
18523
  }>;
18474
18524
  };
18475
18525
  };
18476
- export type GetCrystalsPairingsBySlugResponse = GetCrystalsPairingsBySlugResponses[keyof GetCrystalsPairingsBySlugResponses];
18477
- export type GetCrystalsDailyData = {
18478
- body?: never;
18526
+ export type GetCrystalsPairingsByIdResponse = GetCrystalsPairingsByIdResponses[keyof GetCrystalsPairingsByIdResponses];
18527
+ export type PostCrystalsDailyData = {
18528
+ body?: {
18529
+ /**
18530
+ * 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.
18531
+ */
18532
+ seed?: string;
18533
+ /**
18534
+ * Date for the reading in YYYY-MM-DD format. Defaults to today (UTC). Useful for viewing past daily readings or pre-generating future ones.
18535
+ */
18536
+ date?: string;
18537
+ };
18479
18538
  path?: never;
18480
18539
  query?: {
18481
18540
  /**
18482
18541
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
18483
18542
  */
18484
18543
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18485
- /**
18486
- * Date seed in YYYY-MM-DD format for deterministic selection. If omitted, uses the current UTC date. Same seed always returns the same crystal.
18487
- */
18488
- seed?: string;
18489
18544
  };
18490
18545
  url: '/crystals/daily';
18491
18546
  };
18492
- export type GetCrystalsDailyErrors = {
18547
+ export type PostCrystalsDailyErrors = {
18493
18548
  /**
18494
18549
  * Validation error (missing or invalid parameters)
18495
18550
  */
@@ -18543,8 +18598,8 @@ export type GetCrystalsDailyErrors = {
18543
18598
  code: string;
18544
18599
  };
18545
18600
  };
18546
- export type GetCrystalsDailyError = GetCrystalsDailyErrors[keyof GetCrystalsDailyErrors];
18547
- export type GetCrystalsDailyResponses = {
18601
+ export type PostCrystalsDailyError = PostCrystalsDailyErrors[keyof PostCrystalsDailyErrors];
18602
+ export type PostCrystalsDailyResponses = {
18548
18603
  /**
18549
18604
  * Daily crystal teaser with summary information
18550
18605
  */
@@ -18553,14 +18608,18 @@ export type GetCrystalsDailyResponses = {
18553
18608
  * The date used for crystal selection (UTC).
18554
18609
  */
18555
18610
  date: string;
18611
+ /**
18612
+ * Computed seed used for this reading. Same seed always produces the same crystal.
18613
+ */
18614
+ seed: string;
18556
18615
  /**
18557
18616
  * Display name of the crystal selected for this date.
18558
18617
  */
18559
18618
  name: string;
18560
18619
  /**
18561
- * URL-safe identifier. Call /crystals/:slug for full healing properties.
18620
+ * URL-safe identifier. Call /crystals/:id for full healing properties.
18562
18621
  */
18563
- slug: string;
18622
+ id: string;
18564
18623
  /**
18565
18624
  * URL to crystal photograph. Use for daily crystal card display and visual features.
18566
18625
  */
@@ -18583,7 +18642,7 @@ export type GetCrystalsDailyResponses = {
18583
18642
  affirmation: string;
18584
18643
  };
18585
18644
  };
18586
- export type GetCrystalsDailyResponse = GetCrystalsDailyResponses[keyof GetCrystalsDailyResponses];
18645
+ export type PostCrystalsDailyResponse = PostCrystalsDailyResponses[keyof PostCrystalsDailyResponses];
18587
18646
  export type GetCrystalsRandomData = {
18588
18647
  body?: never;
18589
18648
  path?: never;
@@ -18660,9 +18719,9 @@ export type GetCrystalsRandomResponses = {
18660
18719
  */
18661
18720
  name: string;
18662
18721
  /**
18663
- * URL-safe identifier. Call /crystals/:slug for full healing properties.
18722
+ * URL-safe identifier. Call /crystals/:id for full healing properties.
18664
18723
  */
18665
- slug: string;
18724
+ id: string;
18666
18725
  /**
18667
18726
  * URL to crystal photograph for visual display.
18668
18727
  */
@@ -18956,36 +19015,36 @@ export type GetCrystalsResponses = {
18956
19015
  */
18957
19016
  crystals: Array<{
18958
19017
  /**
18959
- * Display name of the crystal or healing stone.
19018
+ * Crystal display name.
18960
19019
  */
18961
19020
  name: string;
18962
19021
  /**
18963
- * URL-safe identifier for the crystal. Use this value in the detail endpoint path to retrieve full healing properties.
19022
+ * URL-safe crystal identifier for detail lookup.
18964
19023
  */
18965
- slug: string;
19024
+ id: string;
18966
19025
  /**
18967
- * URL to a high-quality crystal photograph. Use for visual crystal guides, product listings, and crystal identification features.
19026
+ * URL to crystal photograph for visual identification.
18968
19027
  */
18969
19028
  imageUrl: string;
18970
19029
  /**
18971
- * Chakra energy centers this crystal resonates with. One of: Root, Sacral, Solar Plexus, Heart, Throat, Third Eye, Crown.
19030
+ * Primary colors of this crystal variety. Null when color data is unavailable.
18972
19031
  */
18973
- chakras: Array<string>;
19032
+ colors: Array<string>;
18974
19033
  /**
18975
- * Primary colors of this crystal variety. Null when color data is unavailable. Useful for color-based crystal selection and visual display.
19034
+ * Chakra energy centers this crystal resonates with. One of: Root, Sacral, Solar Plexus, Heart, Throat, Third Eye, Crown.
18976
19035
  */
18977
- colors: Array<string>;
19036
+ chakras: Array<string>;
18978
19037
  }>;
18979
19038
  };
18980
19039
  };
18981
19040
  export type GetCrystalsResponse = GetCrystalsResponses[keyof GetCrystalsResponses];
18982
- export type GetCrystalsBySlugData = {
19041
+ export type GetCrystalsByIdData = {
18983
19042
  body?: never;
18984
19043
  path: {
18985
19044
  /**
18986
19045
  * URL-safe crystal identifier (e.g., "amethyst", "rose-quartz", "black-tourmaline"). Must match an entry in the database.
18987
19046
  */
18988
- slug: string;
19047
+ id: string;
18989
19048
  };
18990
19049
  query?: {
18991
19050
  /**
@@ -18993,9 +19052,9 @@ export type GetCrystalsBySlugData = {
18993
19052
  */
18994
19053
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18995
19054
  };
18996
- url: '/crystals/{slug}';
19055
+ url: '/crystals/{id}';
18997
19056
  };
18998
- export type GetCrystalsBySlugErrors = {
19057
+ export type GetCrystalsByIdErrors = {
18999
19058
  /**
19000
19059
  * Validation error (missing or invalid parameters)
19001
19060
  */
@@ -19062,8 +19121,8 @@ export type GetCrystalsBySlugErrors = {
19062
19121
  code: string;
19063
19122
  };
19064
19123
  };
19065
- export type GetCrystalsBySlugError = GetCrystalsBySlugErrors[keyof GetCrystalsBySlugErrors];
19066
- export type GetCrystalsBySlugResponses = {
19124
+ export type GetCrystalsByIdError = GetCrystalsByIdErrors[keyof GetCrystalsByIdErrors];
19125
+ export type GetCrystalsByIdResponses = {
19067
19126
  /**
19068
19127
  * Complete crystal healing properties with all associations
19069
19128
  */
@@ -19075,7 +19134,7 @@ export type GetCrystalsBySlugResponses = {
19075
19134
  /**
19076
19135
  * URL-safe identifier for the crystal.
19077
19136
  */
19078
- slug: string;
19137
+ id: string;
19079
19138
  /**
19080
19139
  * URL to a high-quality crystal photograph. Use for visual crystal guides, product listings, and crystal identification features.
19081
19140
  */
@@ -19142,12 +19201,12 @@ export type GetCrystalsBySlugResponses = {
19142
19201
  */
19143
19202
  affirmation: string;
19144
19203
  /**
19145
- * Crystal slugs that pair well with this stone for enhanced healing combinations. Use for crystal grid and pairing recommendations.
19204
+ * Crystal identifiers that pair well with this stone for enhanced healing combinations. Use for crystal grid and pairing recommendations.
19146
19205
  */
19147
19206
  pairsWith: Array<string>;
19148
19207
  };
19149
19208
  };
19150
- export type GetCrystalsBySlugResponse = GetCrystalsBySlugResponses[keyof GetCrystalsBySlugResponses];
19209
+ export type GetCrystalsByIdResponse = GetCrystalsByIdResponses[keyof GetCrystalsByIdResponses];
19151
19210
  export type GetLocationSearchData = {
19152
19211
  body?: never;
19153
19212
  path?: never;
@@ -19160,6 +19219,10 @@ export type GetLocationSearchData = {
19160
19219
  * Maximum items to return per page. Range: 1-50, default 10.
19161
19220
  */
19162
19221
  limit?: number;
19222
+ /**
19223
+ * Number of items to skip for pagination. Default 0.
19224
+ */
19225
+ offset?: number;
19163
19226
  };
19164
19227
  url: '/location/search';
19165
19228
  };
@@ -19222,50 +19285,76 @@ export type GetLocationSearchResponses = {
19222
19285
  /**
19223
19286
  * Matching cities sorted by relevance (prefix match first) then population
19224
19287
  */
19225
- 200: Array<{
19226
- /**
19227
- * City name as commonly used. Matches the local or internationally recognized name for the location.
19228
- */
19229
- city: string;
19230
- /**
19231
- * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
19232
- */
19233
- province: string;
19234
- /**
19235
- * Full country name in English.
19236
- */
19237
- country: string;
19238
- /**
19239
- * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
19240
- */
19241
- iso2: string;
19242
- /**
19243
- * 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.
19244
- */
19245
- latitude: number;
19288
+ 200: {
19246
19289
  /**
19247
- * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
19290
+ * Total number of cities matching the search query.
19248
19291
  */
19249
- longitude: number;
19292
+ total: number;
19250
19293
  /**
19251
- * 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.
19294
+ * Page size used for this response.
19252
19295
  */
19253
- timezone: string;
19296
+ limit: number;
19254
19297
  /**
19255
- * 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.
19298
+ * Number of cities skipped. Use with limit for pagination.
19256
19299
  */
19257
- utcOffset: number;
19300
+ offset: number;
19258
19301
  /**
19259
- * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
19302
+ * City results for the current page, sorted by relevance (prefix match first) then population.
19260
19303
  */
19261
- population: number;
19262
- }>;
19304
+ cities: Array<{
19305
+ /**
19306
+ * City name as commonly used. Matches the local or internationally recognized name for the location.
19307
+ */
19308
+ city: string;
19309
+ /**
19310
+ * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
19311
+ */
19312
+ province: string;
19313
+ /**
19314
+ * Full country name in English.
19315
+ */
19316
+ country: string;
19317
+ /**
19318
+ * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
19319
+ */
19320
+ iso2: string;
19321
+ /**
19322
+ * 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.
19323
+ */
19324
+ latitude: number;
19325
+ /**
19326
+ * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
19327
+ */
19328
+ longitude: number;
19329
+ /**
19330
+ * 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.
19331
+ */
19332
+ timezone: string;
19333
+ /**
19334
+ * 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.
19335
+ */
19336
+ utcOffset: number;
19337
+ /**
19338
+ * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
19339
+ */
19340
+ population: number;
19341
+ }>;
19342
+ };
19263
19343
  };
19264
19344
  export type GetLocationSearchResponse = GetLocationSearchResponses[keyof GetLocationSearchResponses];
19265
19345
  export type GetLocationCountriesData = {
19266
19346
  body?: never;
19267
19347
  path?: never;
19268
- query?: never;
19348
+ query?: {
19349
+ /**
19350
+ * Maximum items to return per page. Range: 1-50, default 50.
19351
+ */
19352
+ limit?: number;
19353
+ /**
19354
+ * Number of items to skip for pagination. Default 0.
19355
+ */
19356
+ offset?: number;
19357
+ };
19269
19358
  url: '/location/countries';
19270
19359
  };
19271
19360
  export type GetLocationCountriesErrors = {
@@ -19327,24 +19416,41 @@ export type GetLocationCountriesResponses = {
19327
19416
  /**
19328
19417
  * Alphabetically sorted list of all 227 countries with ISO codes and city counts
19329
19418
  */
19330
- 200: Array<{
19419
+ 200: {
19331
19420
  /**
19332
- * Full country name in English. Use for display in location pickers and dropdown menus.
19421
+ * Total number of countries available.
19333
19422
  */
19334
- name: string;
19423
+ total: number;
19335
19424
  /**
19336
- * ISO 3166-1 alpha-2 country code. Use as the identifier when fetching cities for a specific country via the /countries/{iso2} endpoint.
19425
+ * Page size used for this response.
19337
19426
  */
19338
- iso2: string;
19427
+ limit: number;
19339
19428
  /**
19340
- * ISO 3166-1 alpha-3 country code. Three-letter standard used in international data exchange.
19429
+ * Number of countries skipped. Use with limit for pagination.
19341
19430
  */
19342
- iso3: string;
19431
+ offset: number;
19343
19432
  /**
19344
- * 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.
19433
+ * Countries for the current page, sorted alphabetically by name.
19345
19434
  */
19346
- cityCount: number;
19347
- }>;
19435
+ countries: Array<{
19436
+ /**
19437
+ * Full country name in English. Use for display in location pickers and dropdown menus.
19438
+ */
19439
+ name: string;
19440
+ /**
19441
+ * ISO 3166-1 alpha-2 country code. Use as the identifier when fetching cities for a specific country via the /countries/{iso2} endpoint.
19442
+ */
19443
+ iso2: string;
19444
+ /**
19445
+ * ISO 3166-1 alpha-3 country code. Three-letter standard used in international data exchange.
19446
+ */
19447
+ iso3: string;
19448
+ /**
19449
+ * 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.
19450
+ */
19451
+ cityCount: number;
19452
+ }>;
19453
+ };
19348
19454
  };
19349
19455
  export type GetLocationCountriesResponse = GetLocationCountriesResponses[keyof GetLocationCountriesResponses];
19350
19456
  export type GetLocationCountriesByIso2Data = {
@@ -19360,6 +19466,10 @@ export type GetLocationCountriesByIso2Data = {
19360
19466
  * Maximum items to return per page. Range: 1-200, default 50.
19361
19467
  */
19362
19468
  limit?: number;
19469
+ /**
19470
+ * Number of items to skip for pagination. Default 0.
19471
+ */
19472
+ offset?: number;
19363
19473
  };
19364
19474
  url: '/location/countries/{iso2}';
19365
19475
  };
@@ -19422,44 +19532,61 @@ export type GetLocationCountriesByIso2Responses = {
19422
19532
  /**
19423
19533
  * Cities in the specified country, sorted by population (largest first)
19424
19534
  */
19425
- 200: Array<{
19426
- /**
19427
- * City name as commonly used. Matches the local or internationally recognized name for the location.
19428
- */
19429
- city: string;
19430
- /**
19431
- * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
19432
- */
19433
- province: string;
19434
- /**
19435
- * Full country name in English.
19436
- */
19437
- country: string;
19438
- /**
19439
- * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
19440
- */
19441
- iso2: string;
19442
- /**
19443
- * 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.
19444
- */
19445
- latitude: number;
19535
+ 200: {
19446
19536
  /**
19447
- * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
19537
+ * Total number of cities available for this country.
19448
19538
  */
19449
- longitude: number;
19539
+ total: number;
19450
19540
  /**
19451
- * 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.
19541
+ * Page size used for this response.
19452
19542
  */
19453
- timezone: string;
19543
+ limit: number;
19454
19544
  /**
19455
- * 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.
19545
+ * Number of cities skipped. Use with limit for pagination.
19456
19546
  */
19457
- utcOffset: number;
19547
+ offset: number;
19458
19548
  /**
19459
- * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
19549
+ * Cities for the current page, sorted by population (largest first).
19460
19550
  */
19461
- population: number;
19462
- }>;
19551
+ cities: Array<{
19552
+ /**
19553
+ * City name as commonly used. Matches the local or internationally recognized name for the location.
19554
+ */
19555
+ city: string;
19556
+ /**
19557
+ * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
19558
+ */
19559
+ province: string;
19560
+ /**
19561
+ * Full country name in English.
19562
+ */
19563
+ country: string;
19564
+ /**
19565
+ * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
19566
+ */
19567
+ iso2: string;
19568
+ /**
19569
+ * 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.
19570
+ */
19571
+ latitude: number;
19572
+ /**
19573
+ * Geographic longitude in decimal degrees (-180 to 180). Pass directly to astrology, horoscope, and panchang API endpoints alongside latitude.
19574
+ */
19575
+ longitude: number;
19576
+ /**
19577
+ * 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.
19578
+ */
19579
+ timezone: string;
19580
+ /**
19581
+ * 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.
19582
+ */
19583
+ utcOffset: number;
19584
+ /**
19585
+ * City population estimate from geographic databases. Larger cities rank higher in search results, ensuring major metropolitan areas appear first in autocomplete suggestions.
19586
+ */
19587
+ population: number;
19588
+ }>;
19589
+ };
19463
19590
  };
19464
19591
  export type GetLocationCountriesByIso2Response = GetLocationCountriesByIso2Responses[keyof GetLocationCountriesByIso2Responses];
19465
19592
  export type GetUsageData = {