@roxyapi/sdk 1.2.1 → 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;
@@ -7249,7 +7283,12 @@ export type GetAstrologyHoroscopeBySignDailyResponse = GetAstrologyHoroscopeBySi
7249
7283
  export type GetAstrologyHoroscopeDailyData = {
7250
7284
  body?: never;
7251
7285
  path?: never;
7252
- query?: never;
7286
+ query?: {
7287
+ /**
7288
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
7289
+ */
7290
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
7291
+ };
7253
7292
  url: '/astrology/horoscope/daily';
7254
7293
  };
7255
7294
 
@@ -8754,7 +8793,12 @@ export type PostVedicAstrologyDashaMajorData = {
8754
8793
  timezone?: number;
8755
8794
  };
8756
8795
  path?: never;
8757
- query?: never;
8796
+ query?: {
8797
+ /**
8798
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
8799
+ */
8800
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
8801
+ };
8758
8802
  url: '/vedic-astrology/dasha/major';
8759
8803
  };
8760
8804
 
@@ -8916,7 +8960,12 @@ export type PostVedicAstrologyDashaSubByMahadashaData = {
8916
8960
  */
8917
8961
  mahadasha: 'Ketu' | 'Venus' | 'Sun' | 'Moon' | 'Mars' | 'Rahu' | 'Jupiter' | 'Saturn' | 'Mercury';
8918
8962
  };
8919
- query?: never;
8963
+ query?: {
8964
+ /**
8965
+ * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
8966
+ */
8967
+ lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
8968
+ };
8920
8969
  url: '/vedic-astrology/dasha/sub/{mahadasha}';
8921
8970
  };
8922
8971
 
@@ -13121,6 +13170,14 @@ export type GetTarotCardsData = {
13121
13170
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
13122
13171
  */
13123
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;
13124
13181
  /**
13125
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.
13126
13183
  */
@@ -13203,6 +13260,14 @@ export type GetTarotCardsResponses = {
13203
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.
13204
13261
  */
13205
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;
13206
13271
  /**
13207
13272
  * Array of tarot cards with basic metadata. Use GET /cards/:id for full upright and reversed interpretations.
13208
13273
  */
@@ -13415,11 +13480,11 @@ export type PostTarotDrawResponse = PostTarotDrawResponses[keyof PostTarotDrawRe
13415
13480
  export type PostTarotDailyData = {
13416
13481
  body?: {
13417
13482
  /**
13418
- * 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.
13419
13484
  */
13420
13485
  seed?: string;
13421
13486
  /**
13422
- * 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.
13423
13488
  */
13424
13489
  date?: string;
13425
13490
  };
@@ -16640,7 +16705,7 @@ export type PostNumerologyDailyData = {
16640
16705
  */
16641
16706
  seed?: string;
16642
16707
  /**
16643
- * 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.
16644
16709
  */
16645
16710
  date?: string;
16646
16711
  };
@@ -16782,7 +16847,7 @@ export type GetDreamsSymbolsData = {
16782
16847
  /**
16783
16848
  * Search query to match against symbol names and meanings. Case-insensitive.
16784
16849
  */
16785
- search?: string;
16850
+ q?: string;
16786
16851
  /**
16787
16852
  * Filter symbols by starting letter (a-z). Case-insensitive.
16788
16853
  */
@@ -17140,11 +17205,11 @@ export type GetDreamsSymbolsByIdResponse = GetDreamsSymbolsByIdResponses[keyof G
17140
17205
  export type PostDreamsDailyData = {
17141
17206
  body?: {
17142
17207
  /**
17143
- * 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.
17144
17209
  */
17145
17210
  seed?: string;
17146
17211
  /**
17147
- * 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.
17148
17213
  */
17149
17214
  date?: string;
17150
17215
  };
@@ -17253,11 +17318,11 @@ export type PostDreamsDailyResponse = PostDreamsDailyResponses[keyof PostDreamsD
17253
17318
  export type PostIchingDailyData = {
17254
17319
  body?: {
17255
17320
  /**
17256
- * 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.
17257
17322
  */
17258
17323
  seed?: string;
17259
17324
  /**
17260
- * 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.
17261
17326
  */
17262
17327
  date?: string;
17263
17328
  };
@@ -17416,11 +17481,11 @@ export type PostIchingDailyResponse = PostIchingDailyResponses[keyof PostIchingD
17416
17481
  export type PostIchingDailyCastData = {
17417
17482
  body?: {
17418
17483
  /**
17419
- * 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.
17420
17485
  */
17421
17486
  seed?: string;
17422
17487
  /**
17423
- * 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.
17424
17489
  */
17425
17490
  date?: string;
17426
17491
  };
@@ -18215,13 +18280,13 @@ export type GetIchingTrigramsResponses = {
18215
18280
 
18216
18281
  export type GetIchingTrigramsResponse = GetIchingTrigramsResponses[keyof GetIchingTrigramsResponses];
18217
18282
 
18218
- export type GetIchingTrigramsByIdentifierData = {
18283
+ export type GetIchingTrigramsByIdData = {
18219
18284
  body?: never;
18220
18285
  path: {
18221
18286
  /**
18222
18287
  * Trigram number (1-8) or English name (Heaven, Earth, Thunder, Wind, Water, Fire, Mountain, Lake).
18223
18288
  */
18224
- identifier: string;
18289
+ id: string;
18225
18290
  };
18226
18291
  query?: {
18227
18292
  /**
@@ -18229,10 +18294,10 @@ export type GetIchingTrigramsByIdentifierData = {
18229
18294
  */
18230
18295
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18231
18296
  };
18232
- url: '/iching/trigrams/{identifier}';
18297
+ url: '/iching/trigrams/{id}';
18233
18298
  };
18234
18299
 
18235
- export type GetIchingTrigramsByIdentifierErrors = {
18300
+ export type GetIchingTrigramsByIdErrors = {
18236
18301
  /**
18237
18302
  * Validation error (missing or invalid parameters)
18238
18303
  */
@@ -18300,16 +18365,16 @@ export type GetIchingTrigramsByIdentifierErrors = {
18300
18365
  };
18301
18366
  };
18302
18367
 
18303
- export type GetIchingTrigramsByIdentifierError = GetIchingTrigramsByIdentifierErrors[keyof GetIchingTrigramsByIdentifierErrors];
18368
+ export type GetIchingTrigramsByIdError = GetIchingTrigramsByIdErrors[keyof GetIchingTrigramsByIdErrors];
18304
18369
 
18305
- export type GetIchingTrigramsByIdentifierResponses = {
18370
+ export type GetIchingTrigramsByIdResponses = {
18306
18371
  /**
18307
18372
  * Trigram details.
18308
18373
  */
18309
18374
  200: Trigram;
18310
18375
  };
18311
18376
 
18312
- export type GetIchingTrigramsByIdentifierResponse = GetIchingTrigramsByIdentifierResponses[keyof GetIchingTrigramsByIdentifierResponses];
18377
+ export type GetIchingTrigramsByIdResponse = GetIchingTrigramsByIdResponses[keyof GetIchingTrigramsByIdResponses];
18313
18378
 
18314
18379
  export type GetCrystalsZodiacBySignData = {
18315
18380
  body?: never;
@@ -18325,7 +18390,7 @@ export type GetCrystalsZodiacBySignData = {
18325
18390
  */
18326
18391
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18327
18392
  /**
18328
- * Maximum items to return per page. Range: 1-100, default 20.
18393
+ * Maximum items to return per page. Range: 1-30, default 20.
18329
18394
  */
18330
18395
  limit?: number;
18331
18396
  /**
@@ -18415,7 +18480,7 @@ export type GetCrystalsZodiacBySignResponses = {
18415
18480
  */
18416
18481
  offset: number;
18417
18482
  /**
18418
- * 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.
18419
18484
  */
18420
18485
  crystals: Array<{
18421
18486
  /**
@@ -18425,7 +18490,7 @@ export type GetCrystalsZodiacBySignResponses = {
18425
18490
  /**
18426
18491
  * URL-safe crystal identifier for detail lookup.
18427
18492
  */
18428
- slug: string;
18493
+ id: string;
18429
18494
  /**
18430
18495
  * URL to crystal photograph for visual identification.
18431
18496
  */
@@ -18454,7 +18519,7 @@ export type GetCrystalsChakraByChakraData = {
18454
18519
  */
18455
18520
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18456
18521
  /**
18457
- * Maximum items to return per page. Range: 1-100, default 20.
18522
+ * Maximum items to return per page. Range: 1-30, default 20.
18458
18523
  */
18459
18524
  limit?: number;
18460
18525
  /**
@@ -18544,7 +18609,7 @@ export type GetCrystalsChakraByChakraResponses = {
18544
18609
  */
18545
18610
  offset: number;
18546
18611
  /**
18547
- * 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.
18548
18613
  */
18549
18614
  crystals: Array<{
18550
18615
  /**
@@ -18554,7 +18619,7 @@ export type GetCrystalsChakraByChakraResponses = {
18554
18619
  /**
18555
18620
  * URL-safe crystal identifier for detail lookup.
18556
18621
  */
18557
- slug: string;
18622
+ id: string;
18558
18623
  /**
18559
18624
  * URL to crystal photograph for visual identification.
18560
18625
  */
@@ -18583,7 +18648,7 @@ export type GetCrystalsElementByElementData = {
18583
18648
  */
18584
18649
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18585
18650
  /**
18586
- * Maximum items to return per page. Range: 1-100, default 20.
18651
+ * Maximum items to return per page. Range: 1-30, default 20.
18587
18652
  */
18588
18653
  limit?: number;
18589
18654
  /**
@@ -18673,7 +18738,7 @@ export type GetCrystalsElementByElementResponses = {
18673
18738
  */
18674
18739
  offset: number;
18675
18740
  /**
18676
- * 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.
18677
18742
  */
18678
18743
  crystals: Array<{
18679
18744
  /**
@@ -18683,7 +18748,7 @@ export type GetCrystalsElementByElementResponses = {
18683
18748
  /**
18684
18749
  * URL-safe crystal identifier for detail lookup.
18685
18750
  */
18686
- slug: string;
18751
+ id: string;
18687
18752
  /**
18688
18753
  * URL to crystal photograph for visual identification.
18689
18754
  */
@@ -18788,9 +18853,9 @@ export type GetCrystalsBirthstoneByMonthResponses = {
18788
18853
  /**
18789
18854
  * Number of birthstone crystals for this month.
18790
18855
  */
18791
- count: number;
18856
+ total: number;
18792
18857
  /**
18793
- * 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.
18794
18859
  */
18795
18860
  crystals: Array<{
18796
18861
  /**
@@ -18800,9 +18865,9 @@ export type GetCrystalsBirthstoneByMonthResponses = {
18800
18865
  /**
18801
18866
  * URL-safe crystal identifier for detail lookup.
18802
18867
  */
18803
- slug: string;
18868
+ id: string;
18804
18869
  /**
18805
- * URL to crystal photograph.
18870
+ * URL to crystal photograph for visual identification.
18806
18871
  */
18807
18872
  imageUrl: string;
18808
18873
  /**
@@ -18828,7 +18893,7 @@ export type GetCrystalsSearchData = {
18828
18893
  */
18829
18894
  q: string;
18830
18895
  /**
18831
- * Maximum items to return per page. Range: 1-100, default 20.
18896
+ * Maximum items to return per page. Range: 1-50, default 20.
18832
18897
  */
18833
18898
  limit?: number;
18834
18899
  /**
@@ -18918,7 +18983,7 @@ export type GetCrystalsSearchResponses = {
18918
18983
  */
18919
18984
  offset: number;
18920
18985
  /**
18921
- * Matching crystal summaries. Call /crystals/:slug for full healing properties.
18986
+ * Matching crystal summaries. Call /crystals/:id for full healing properties.
18922
18987
  */
18923
18988
  crystals: Array<{
18924
18989
  /**
@@ -18928,9 +18993,9 @@ export type GetCrystalsSearchResponses = {
18928
18993
  /**
18929
18994
  * URL-safe crystal identifier for detail lookup.
18930
18995
  */
18931
- slug: string;
18996
+ id: string;
18932
18997
  /**
18933
- * URL to crystal photograph.
18998
+ * URL to crystal photograph for visual identification.
18934
18999
  */
18935
19000
  imageUrl: string;
18936
19001
  /**
@@ -18943,13 +19008,13 @@ export type GetCrystalsSearchResponses = {
18943
19008
 
18944
19009
  export type GetCrystalsSearchResponse = GetCrystalsSearchResponses[keyof GetCrystalsSearchResponses];
18945
19010
 
18946
- export type GetCrystalsPairingsBySlugData = {
19011
+ export type GetCrystalsPairingsByIdData = {
18947
19012
  body?: never;
18948
19013
  path: {
18949
19014
  /**
18950
19015
  * URL-safe crystal identifier to find pairings for (e.g., "amethyst", "rose-quartz").
18951
19016
  */
18952
- slug: string;
19017
+ id: string;
18953
19018
  };
18954
19019
  query?: {
18955
19020
  /**
@@ -18957,10 +19022,10 @@ export type GetCrystalsPairingsBySlugData = {
18957
19022
  */
18958
19023
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
18959
19024
  };
18960
- url: '/crystals/pairings/{slug}';
19025
+ url: '/crystals/pairings/{id}';
18961
19026
  };
18962
19027
 
18963
- export type GetCrystalsPairingsBySlugErrors = {
19028
+ export type GetCrystalsPairingsByIdErrors = {
18964
19029
  /**
18965
19030
  * Validation error (missing or invalid parameters)
18966
19031
  */
@@ -19028,15 +19093,15 @@ export type GetCrystalsPairingsBySlugErrors = {
19028
19093
  };
19029
19094
  };
19030
19095
 
19031
- export type GetCrystalsPairingsBySlugError = GetCrystalsPairingsBySlugErrors[keyof GetCrystalsPairingsBySlugErrors];
19096
+ export type GetCrystalsPairingsByIdError = GetCrystalsPairingsByIdErrors[keyof GetCrystalsPairingsByIdErrors];
19032
19097
 
19033
- export type GetCrystalsPairingsBySlugResponses = {
19098
+ export type GetCrystalsPairingsByIdResponses = {
19034
19099
  /**
19035
19100
  * Crystal pairing recommendations
19036
19101
  */
19037
19102
  200: {
19038
19103
  /**
19039
- * The crystal slug that pairings were requested for.
19104
+ * The crystal identifier that pairings were requested for.
19040
19105
  */
19041
19106
  crystal: string;
19042
19107
  /**
@@ -19058,7 +19123,7 @@ export type GetCrystalsPairingsBySlugResponses = {
19058
19123
  /**
19059
19124
  * URL-safe identifier for the paired crystal.
19060
19125
  */
19061
- slug: string;
19126
+ id: string;
19062
19127
  /**
19063
19128
  * URL to paired crystal photograph.
19064
19129
  */
@@ -19079,25 +19144,30 @@ export type GetCrystalsPairingsBySlugResponses = {
19079
19144
  };
19080
19145
  };
19081
19146
 
19082
- export type GetCrystalsPairingsBySlugResponse = GetCrystalsPairingsBySlugResponses[keyof GetCrystalsPairingsBySlugResponses];
19147
+ export type GetCrystalsPairingsByIdResponse = GetCrystalsPairingsByIdResponses[keyof GetCrystalsPairingsByIdResponses];
19083
19148
 
19084
- export type GetCrystalsDailyData = {
19085
- 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
+ };
19086
19160
  path?: never;
19087
19161
  query?: {
19088
19162
  /**
19089
19163
  * Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
19090
19164
  */
19091
19165
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
19092
- /**
19093
- * Date seed in YYYY-MM-DD format for deterministic selection. If omitted, uses the current UTC date. Same seed always returns the same crystal.
19094
- */
19095
- seed?: string;
19096
19166
  };
19097
19167
  url: '/crystals/daily';
19098
19168
  };
19099
19169
 
19100
- export type GetCrystalsDailyErrors = {
19170
+ export type PostCrystalsDailyErrors = {
19101
19171
  /**
19102
19172
  * Validation error (missing or invalid parameters)
19103
19173
  */
@@ -19152,9 +19222,9 @@ export type GetCrystalsDailyErrors = {
19152
19222
  };
19153
19223
  };
19154
19224
 
19155
- export type GetCrystalsDailyError = GetCrystalsDailyErrors[keyof GetCrystalsDailyErrors];
19225
+ export type PostCrystalsDailyError = PostCrystalsDailyErrors[keyof PostCrystalsDailyErrors];
19156
19226
 
19157
- export type GetCrystalsDailyResponses = {
19227
+ export type PostCrystalsDailyResponses = {
19158
19228
  /**
19159
19229
  * Daily crystal teaser with summary information
19160
19230
  */
@@ -19163,14 +19233,18 @@ export type GetCrystalsDailyResponses = {
19163
19233
  * The date used for crystal selection (UTC).
19164
19234
  */
19165
19235
  date: string;
19236
+ /**
19237
+ * Computed seed used for this reading. Same seed always produces the same crystal.
19238
+ */
19239
+ seed: string;
19166
19240
  /**
19167
19241
  * Display name of the crystal selected for this date.
19168
19242
  */
19169
19243
  name: string;
19170
19244
  /**
19171
- * URL-safe identifier. Call /crystals/:slug for full healing properties.
19245
+ * URL-safe identifier. Call /crystals/:id for full healing properties.
19172
19246
  */
19173
- slug: string;
19247
+ id: string;
19174
19248
  /**
19175
19249
  * URL to crystal photograph. Use for daily crystal card display and visual features.
19176
19250
  */
@@ -19194,7 +19268,7 @@ export type GetCrystalsDailyResponses = {
19194
19268
  };
19195
19269
  };
19196
19270
 
19197
- export type GetCrystalsDailyResponse = GetCrystalsDailyResponses[keyof GetCrystalsDailyResponses];
19271
+ export type PostCrystalsDailyResponse = PostCrystalsDailyResponses[keyof PostCrystalsDailyResponses];
19198
19272
 
19199
19273
  export type GetCrystalsRandomData = {
19200
19274
  body?: never;
@@ -19275,9 +19349,9 @@ export type GetCrystalsRandomResponses = {
19275
19349
  */
19276
19350
  name: string;
19277
19351
  /**
19278
- * URL-safe identifier. Call /crystals/:slug for full healing properties.
19352
+ * URL-safe identifier. Call /crystals/:id for full healing properties.
19279
19353
  */
19280
- slug: string;
19354
+ id: string;
19281
19355
  /**
19282
19356
  * URL to crystal photograph for visual display.
19283
19357
  */
@@ -19586,38 +19660,38 @@ export type GetCrystalsResponses = {
19586
19660
  */
19587
19661
  crystals: Array<{
19588
19662
  /**
19589
- * Display name of the crystal or healing stone.
19663
+ * Crystal display name.
19590
19664
  */
19591
19665
  name: string;
19592
19666
  /**
19593
- * 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.
19594
19668
  */
19595
- slug: string;
19669
+ id: string;
19596
19670
  /**
19597
- * 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.
19598
19672
  */
19599
19673
  imageUrl: string;
19600
19674
  /**
19601
- * 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.
19602
19676
  */
19603
- chakras: Array<string>;
19677
+ colors: Array<string>;
19604
19678
  /**
19605
- * 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.
19606
19680
  */
19607
- colors: Array<string>;
19681
+ chakras: Array<string>;
19608
19682
  }>;
19609
19683
  };
19610
19684
  };
19611
19685
 
19612
19686
  export type GetCrystalsResponse = GetCrystalsResponses[keyof GetCrystalsResponses];
19613
19687
 
19614
- export type GetCrystalsBySlugData = {
19688
+ export type GetCrystalsByIdData = {
19615
19689
  body?: never;
19616
19690
  path: {
19617
19691
  /**
19618
19692
  * URL-safe crystal identifier (e.g., "amethyst", "rose-quartz", "black-tourmaline"). Must match an entry in the database.
19619
19693
  */
19620
- slug: string;
19694
+ id: string;
19621
19695
  };
19622
19696
  query?: {
19623
19697
  /**
@@ -19625,10 +19699,10 @@ export type GetCrystalsBySlugData = {
19625
19699
  */
19626
19700
  lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
19627
19701
  };
19628
- url: '/crystals/{slug}';
19702
+ url: '/crystals/{id}';
19629
19703
  };
19630
19704
 
19631
- export type GetCrystalsBySlugErrors = {
19705
+ export type GetCrystalsByIdErrors = {
19632
19706
  /**
19633
19707
  * Validation error (missing or invalid parameters)
19634
19708
  */
@@ -19696,9 +19770,9 @@ export type GetCrystalsBySlugErrors = {
19696
19770
  };
19697
19771
  };
19698
19772
 
19699
- export type GetCrystalsBySlugError = GetCrystalsBySlugErrors[keyof GetCrystalsBySlugErrors];
19773
+ export type GetCrystalsByIdError = GetCrystalsByIdErrors[keyof GetCrystalsByIdErrors];
19700
19774
 
19701
- export type GetCrystalsBySlugResponses = {
19775
+ export type GetCrystalsByIdResponses = {
19702
19776
  /**
19703
19777
  * Complete crystal healing properties with all associations
19704
19778
  */
@@ -19710,7 +19784,7 @@ export type GetCrystalsBySlugResponses = {
19710
19784
  /**
19711
19785
  * URL-safe identifier for the crystal.
19712
19786
  */
19713
- slug: string;
19787
+ id: string;
19714
19788
  /**
19715
19789
  * URL to a high-quality crystal photograph. Use for visual crystal guides, product listings, and crystal identification features.
19716
19790
  */
@@ -19777,13 +19851,13 @@ export type GetCrystalsBySlugResponses = {
19777
19851
  */
19778
19852
  affirmation: string;
19779
19853
  /**
19780
- * 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.
19781
19855
  */
19782
19856
  pairsWith: Array<string>;
19783
19857
  };
19784
19858
  };
19785
19859
 
19786
- export type GetCrystalsBySlugResponse = GetCrystalsBySlugResponses[keyof GetCrystalsBySlugResponses];
19860
+ export type GetCrystalsByIdResponse = GetCrystalsByIdResponses[keyof GetCrystalsByIdResponses];
19787
19861
 
19788
19862
  export type GetLocationSearchData = {
19789
19863
  body?: never;
@@ -19797,6 +19871,10 @@ export type GetLocationSearchData = {
19797
19871
  * Maximum items to return per page. Range: 1-50, default 10.
19798
19872
  */
19799
19873
  limit?: number;
19874
+ /**
19875
+ * Number of items to skip for pagination. Default 0.
19876
+ */
19877
+ offset?: number;
19800
19878
  };
19801
19879
  url: '/location/search';
19802
19880
  };
@@ -19862,44 +19940,61 @@ export type GetLocationSearchResponses = {
19862
19940
  /**
19863
19941
  * Matching cities sorted by relevance (prefix match first) then population
19864
19942
  */
19865
- 200: Array<{
19866
- /**
19867
- * City name as commonly used. Matches the local or internationally recognized name for the location.
19868
- */
19869
- city: string;
19870
- /**
19871
- * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
19872
- */
19873
- province: string;
19874
- /**
19875
- * Full country name in English.
19876
- */
19877
- country: string;
19878
- /**
19879
- * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
19880
- */
19881
- iso2: string;
19882
- /**
19883
- * 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.
19884
- */
19885
- latitude: number;
19943
+ 200: {
19886
19944
  /**
19887
- * 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.
19888
19946
  */
19889
- longitude: number;
19947
+ total: number;
19890
19948
  /**
19891
- * 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.
19892
19950
  */
19893
- timezone: string;
19951
+ limit: number;
19894
19952
  /**
19895
- * 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.
19896
19954
  */
19897
- utcOffset: number;
19955
+ offset: number;
19898
19956
  /**
19899
- * 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.
19900
19958
  */
19901
- population: number;
19902
- }>;
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
+ };
19903
19998
  };
19904
19999
 
19905
20000
  export type GetLocationSearchResponse = GetLocationSearchResponses[keyof GetLocationSearchResponses];
@@ -19907,7 +20002,16 @@ export type GetLocationSearchResponse = GetLocationSearchResponses[keyof GetLoca
19907
20002
  export type GetLocationCountriesData = {
19908
20003
  body?: never;
19909
20004
  path?: never;
19910
- 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
+ };
19911
20015
  url: '/location/countries';
19912
20016
  };
19913
20017
 
@@ -19972,24 +20076,41 @@ export type GetLocationCountriesResponses = {
19972
20076
  /**
19973
20077
  * Alphabetically sorted list of all 227 countries with ISO codes and city counts
19974
20078
  */
19975
- 200: Array<{
20079
+ 200: {
19976
20080
  /**
19977
- * Full country name in English. Use for display in location pickers and dropdown menus.
20081
+ * Total number of countries available.
19978
20082
  */
19979
- name: string;
20083
+ total: number;
19980
20084
  /**
19981
- * 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.
19982
20086
  */
19983
- iso2: string;
20087
+ limit: number;
19984
20088
  /**
19985
- * 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.
19986
20090
  */
19987
- iso3: string;
20091
+ offset: number;
19988
20092
  /**
19989
- * 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.
19990
20094
  */
19991
- cityCount: number;
19992
- }>;
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
+ };
19993
20114
  };
19994
20115
 
19995
20116
  export type GetLocationCountriesResponse = GetLocationCountriesResponses[keyof GetLocationCountriesResponses];
@@ -20007,6 +20128,10 @@ export type GetLocationCountriesByIso2Data = {
20007
20128
  * Maximum items to return per page. Range: 1-200, default 50.
20008
20129
  */
20009
20130
  limit?: number;
20131
+ /**
20132
+ * Number of items to skip for pagination. Default 0.
20133
+ */
20134
+ offset?: number;
20010
20135
  };
20011
20136
  url: '/location/countries/{iso2}';
20012
20137
  };
@@ -20072,44 +20197,61 @@ export type GetLocationCountriesByIso2Responses = {
20072
20197
  /**
20073
20198
  * Cities in the specified country, sorted by population (largest first)
20074
20199
  */
20075
- 200: Array<{
20076
- /**
20077
- * City name as commonly used. Matches the local or internationally recognized name for the location.
20078
- */
20079
- city: string;
20080
- /**
20081
- * State, province, canton, or administrative region. Helps disambiguate cities with the same name across regions (e.g. Springfield IL vs Springfield MO).
20082
- */
20083
- province: string;
20084
- /**
20085
- * Full country name in English.
20086
- */
20087
- country: string;
20088
- /**
20089
- * ISO 3166-1 alpha-2 country code. Use for filtering cities by country or building country-specific location pickers.
20090
- */
20091
- iso2: string;
20092
- /**
20093
- * 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.
20094
- */
20095
- latitude: number;
20200
+ 200: {
20096
20201
  /**
20097
- * 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.
20098
20203
  */
20099
- longitude: number;
20204
+ total: number;
20100
20205
  /**
20101
- * 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.
20102
20207
  */
20103
- timezone: string;
20208
+ limit: number;
20104
20209
  /**
20105
- * 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.
20106
20211
  */
20107
- utcOffset: number;
20212
+ offset: number;
20108
20213
  /**
20109
- * 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).
20110
20215
  */
20111
- population: number;
20112
- }>;
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
+ };
20113
20255
  };
20114
20256
 
20115
20257
  export type GetLocationCountriesByIso2Response = GetLocationCountriesByIso2Responses[keyof GetLocationCountriesByIso2Responses];