apifreaks 1.0.3 → 1.0.4

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.
data/reference.md CHANGED
@@ -105,6 +105,116 @@ client.geolocation_lookup(api_key: "apiKey")
105
105
  </dl>
106
106
 
107
107
 
108
+ </dd>
109
+ </dl>
110
+ </details>
111
+
112
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">geolocation_lookup_v2</a>() -> Apifreaks::Types::GeolocationLookupResponse</code></summary>
113
+ <dl>
114
+ <dd>
115
+
116
+ #### 📝 Description
117
+
118
+ <dl>
119
+ <dd>
120
+
121
+ <dl>
122
+ <dd>
123
+
124
+ Get detailed geolocation data for an IP address using the `v2.0/geolocation/lookup` endpoint including country, city, timezone, currency, and optional security and user-agent information
125
+ </dd>
126
+ </dl>
127
+ </dd>
128
+ </dl>
129
+
130
+ #### 🔌 Usage
131
+
132
+ <dl>
133
+ <dd>
134
+
135
+ <dl>
136
+ <dd>
137
+
138
+ ```ruby
139
+ client.geolocation_lookup_v2(api_key: "apiKey")
140
+ ```
141
+ </dd>
142
+ </dl>
143
+ </dd>
144
+ </dl>
145
+
146
+ #### ⚙️ Parameters
147
+
148
+ <dl>
149
+ <dd>
150
+
151
+ <dl>
152
+ <dd>
153
+
154
+ **api_key:** `String` — Your API key
155
+
156
+ </dd>
157
+ </dl>
158
+
159
+ <dl>
160
+ <dd>
161
+
162
+ **format:** `Apifreaks::Types::GeolocationLookupRequestFormat` — Format of the response.
163
+
164
+ </dd>
165
+ </dl>
166
+
167
+ <dl>
168
+ <dd>
169
+
170
+ **ip:** `String` — IPv4, IPv6, or hostname for geolocation lookup
171
+
172
+ </dd>
173
+ </dl>
174
+
175
+ <dl>
176
+ <dd>
177
+
178
+ **lang:** `Apifreaks::Types::GeolocationLookupRequestLang` — Response language for location fields
179
+
180
+ </dd>
181
+ </dl>
182
+
183
+ <dl>
184
+ <dd>
185
+
186
+ **fields:** `String` — Comma separated list of fields to include in response
187
+
188
+ </dd>
189
+ </dl>
190
+
191
+ <dl>
192
+ <dd>
193
+
194
+ **excludes:** `String` — Comma separated list of fields to exclude from response
195
+
196
+ </dd>
197
+ </dl>
198
+
199
+ <dl>
200
+ <dd>
201
+
202
+ **include:** `String` — Additional data to include (location, network, security, currency, time_zone, user_agent, country_metadata , hostname, liveHostname, hostnameFallbackLivet)
203
+
204
+ </dd>
205
+ </dl>
206
+
207
+ <dl>
208
+ <dd>
209
+
210
+ **request_options:** `Apifreaks::RequestOptions`
211
+
212
+ </dd>
213
+ </dl>
214
+ </dd>
215
+ </dl>
216
+
217
+
108
218
  </dd>
109
219
  </dl>
110
220
  </details>
@@ -219,6 +329,120 @@ client.bulk_geolocation_lookup(
219
329
  </dl>
220
330
 
221
331
 
332
+ </dd>
333
+ </dl>
334
+ </details>
335
+
336
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">bulk_geolocation_lookup_v2</a>(request) -> Internal::Types::Array[Apifreaks::Types::BulkGeolocationLookupResponseItem]</code></summary>
337
+ <dl>
338
+ <dd>
339
+
340
+ #### 📝 Description
341
+
342
+ <dl>
343
+ <dd>
344
+
345
+ <dl>
346
+ <dd>
347
+
348
+ Retrieve detailed geolocation data for multiple IP addresses in a single request using the `v2.0/geolocation/lookup` endpoint.
349
+ Supports up to `50,000` IP-addresses/host-names per request.
350
+ </dd>
351
+ </dl>
352
+ </dd>
353
+ </dl>
354
+
355
+ #### 🔌 Usage
356
+
357
+ <dl>
358
+ <dd>
359
+
360
+ <dl>
361
+ <dd>
362
+
363
+ ```ruby
364
+ client.bulk_geolocation_lookup_v2(
365
+ api_key: "apiKey",
366
+ ips: ["ips"]
367
+ )
368
+ ```
369
+ </dd>
370
+ </dl>
371
+ </dd>
372
+ </dl>
373
+
374
+ #### ⚙️ Parameters
375
+
376
+ <dl>
377
+ <dd>
378
+
379
+ <dl>
380
+ <dd>
381
+
382
+ **api_key:** `String` — Your API key
383
+
384
+ </dd>
385
+ </dl>
386
+
387
+ <dl>
388
+ <dd>
389
+
390
+ **format:** `Apifreaks::Types::BulkGeolocationLookupRequestFormat` — Format of the response.
391
+
392
+ </dd>
393
+ </dl>
394
+
395
+ <dl>
396
+ <dd>
397
+
398
+ **lang:** `String` — Language of the response.
399
+
400
+ </dd>
401
+ </dl>
402
+
403
+ <dl>
404
+ <dd>
405
+
406
+ **fields:** `String` — Comma-separated list of fields to include in the response. Can include "geo".
407
+
408
+ </dd>
409
+ </dl>
410
+
411
+ <dl>
412
+ <dd>
413
+
414
+ **excludes:** `String` — Comma-separated list of fields to exclude from the response (except "ip").
415
+
416
+ </dd>
417
+ </dl>
418
+
419
+ <dl>
420
+ <dd>
421
+
422
+ **include:** `String` — Comma-separated list of additional information to include in the response.
423
+
424
+ </dd>
425
+ </dl>
426
+
427
+ <dl>
428
+ <dd>
429
+
430
+ **ips:** `Internal::Types::Array[String]` — List of IP addresses or hostnames to lookup
431
+
432
+ </dd>
433
+ </dl>
434
+
435
+ <dl>
436
+ <dd>
437
+
438
+ **request_options:** `Apifreaks::RequestOptions`
439
+
440
+ </dd>
441
+ </dl>
442
+ </dd>
443
+ </dl>
444
+
445
+
222
446
  </dd>
223
447
  </dl>
224
448
  </details>
@@ -459,7 +683,153 @@ client.geocoder_search(
459
683
  <dl>
460
684
  <dd>
461
685
 
462
- **api_key:** `String` — Your API key
686
+ **api_key:** `String` — Your API key
687
+
688
+ </dd>
689
+ </dl>
690
+
691
+ <dl>
692
+ <dd>
693
+
694
+ **format:** `Apifreaks::Types::GeocoderSearchRequestFormat` — Format of the response.
695
+
696
+ </dd>
697
+ </dl>
698
+
699
+ <dl>
700
+ <dd>
701
+
702
+ **query:** `String` — Free-form search query, e.g. Wembley Stadium, London
703
+
704
+ </dd>
705
+ </dl>
706
+
707
+ <dl>
708
+ <dd>
709
+
710
+ **limit:** `Integer` — Max number of results to return (1–40). May return fewer if matches are weak.
711
+
712
+ </dd>
713
+ </dl>
714
+
715
+ <dl>
716
+ <dd>
717
+
718
+ **min_lat:** `Integer` — Minimum latitude for the viewbox. Must be ≤ max_lat and between -90 and 90.
719
+
720
+ </dd>
721
+ </dl>
722
+
723
+ <dl>
724
+ <dd>
725
+
726
+ **max_lat:** `Integer` — Maximum latitude for the viewbox. Must be ≥ min_lat and between -90 and 90.
727
+
728
+ </dd>
729
+ </dl>
730
+
731
+ <dl>
732
+ <dd>
733
+
734
+ **min_lon:** `Integer` — Minimum longitude for the viewbox. Must be ≤ max_lon and between -180 and 180.
735
+
736
+ </dd>
737
+ </dl>
738
+
739
+ <dl>
740
+ <dd>
741
+
742
+ **max_lon:** `Integer` — Maximum longitude for the viewbox. Must be ≥ min_lon and between -180 and 180.
743
+
744
+ </dd>
745
+ </dl>
746
+
747
+ <dl>
748
+ <dd>
749
+
750
+ **accept_language:** `String` — Preferred language order for showing search results. This may either be a simple comma-separated list of language codes or a single entry. The results will be in the 1st language which is matched from the header. As a fallback if the results are not supported in the given language, 'en' will be used.
751
+
752
+ </dd>
753
+ </dl>
754
+
755
+ <dl>
756
+ <dd>
757
+
758
+ **request_options:** `Apifreaks::RequestOptions`
759
+
760
+ </dd>
761
+ </dl>
762
+ </dd>
763
+ </dl>
764
+
765
+
766
+ </dd>
767
+ </dl>
768
+ </details>
769
+
770
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">geocoder_reverse</a>() -> Apifreaks::Types::GeocoderReverseResponse</code></summary>
771
+ <dl>
772
+ <dd>
773
+
774
+ #### 📝 Description
775
+
776
+ <dl>
777
+ <dd>
778
+
779
+ <dl>
780
+ <dd>
781
+
782
+ Convert geographic coordinates (latitude and longitude) into a human-readable address or place name.
783
+ </dd>
784
+ </dl>
785
+ </dd>
786
+ </dl>
787
+
788
+ #### 🔌 Usage
789
+
790
+ <dl>
791
+ <dd>
792
+
793
+ <dl>
794
+ <dd>
795
+
796
+ ```ruby
797
+ client.geocoder_reverse(
798
+ api_key: "apiKey",
799
+ lat: 1.1,
800
+ lon: 1.1
801
+ )
802
+ ```
803
+ </dd>
804
+ </dl>
805
+ </dd>
806
+ </dl>
807
+
808
+ #### ⚙️ Parameters
809
+
810
+ <dl>
811
+ <dd>
812
+
813
+ <dl>
814
+ <dd>
815
+
816
+ **api_key:** `String` — Your API key
817
+
818
+ </dd>
819
+ </dl>
820
+
821
+ <dl>
822
+ <dd>
823
+
824
+ **format:** `Apifreaks::Types::GeocoderReverseRequestFormat` — Format of the response.
825
+
826
+ </dd>
827
+ </dl>
828
+
829
+ <dl>
830
+ <dd>
831
+
832
+ **lat:** `Integer` — WGS84 latitude value ranging from -90 to 90.
463
833
 
464
834
  </dd>
465
835
  </dl>
@@ -467,7 +837,7 @@ client.geocoder_search(
467
837
  <dl>
468
838
  <dd>
469
839
 
470
- **format:** `Apifreaks::Types::GeocoderSearchRequestFormat` — Format of the response.
840
+ **lon:** `Integer` — WGS84 longitude value ranging from -180 to 180.
471
841
 
472
842
  </dd>
473
843
  </dl>
@@ -475,7 +845,7 @@ client.geocoder_search(
475
845
  <dl>
476
846
  <dd>
477
847
 
478
- **query:** `String` — Free-form search query, e.g. Wembley Stadium, London
848
+ **accept_language:** `String` — Preferred language order for showing search results. This may either be a simple comma-separated list of language codes or a single entry. The results will be in the 1st language which is matched from the header. As a fallback if the results are not supported in the given language, en will be used.
479
849
 
480
850
  </dd>
481
851
  </dl>
@@ -483,31 +853,66 @@ client.geocoder_search(
483
853
  <dl>
484
854
  <dd>
485
855
 
486
- **limit:** `Integer` — Max number of results to return (1–40). May return fewer if matches are weak.
856
+ **request_options:** `Apifreaks::RequestOptions`
487
857
 
488
858
  </dd>
489
859
  </dl>
860
+ </dd>
861
+ </dl>
862
+
863
+
864
+ </dd>
865
+ </dl>
866
+ </details>
867
+
868
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">domain_whois_lookup</a>() -> Apifreaks::Types::DomainWhoisLookupResponse</code></summary>
869
+ <dl>
870
+ <dd>
871
+
872
+ #### 📝 Description
490
873
 
491
874
  <dl>
492
875
  <dd>
493
876
 
494
- **min_lat:** `Integer` — Minimum latitude for the viewbox. Must be ≤ max_lat and between -90 and 90.
495
-
877
+ <dl>
878
+ <dd>
879
+
880
+ Retrieve current WHOIS information for a domain name.
881
+ This endpoint provides detailed registration information including registrar details,
882
+ dates, nameservers, and registrant information.
883
+ </dd>
884
+ </dl>
496
885
  </dd>
497
886
  </dl>
498
887
 
888
+ #### 🔌 Usage
889
+
499
890
  <dl>
500
891
  <dd>
501
892
 
502
- **max_lat:** `Integer` — Maximum latitude for the viewbox. Must be ≥ min_lat and between -90 and 90.
503
-
893
+ <dl>
894
+ <dd>
895
+
896
+ ```ruby
897
+ client.domain_whois_lookup(
898
+ api_key: "apiKey",
899
+ domain_name: "domainName"
900
+ )
901
+ ```
504
902
  </dd>
505
903
  </dl>
904
+ </dd>
905
+ </dl>
906
+
907
+ #### ⚙️ Parameters
506
908
 
507
909
  <dl>
508
910
  <dd>
509
911
 
510
- **min_lon:** `Integer` — Minimum longitude for the viewbox. Must be ≤ max_lon and between -180 and 180.
912
+ <dl>
913
+ <dd>
914
+
915
+ **api_key:** `String` — Your API key
511
916
 
512
917
  </dd>
513
918
  </dl>
@@ -515,7 +920,7 @@ client.geocoder_search(
515
920
  <dl>
516
921
  <dd>
517
922
 
518
- **max_lon:** `Integer` — Maximum longitude for the viewbox. Must be ≥ min_lon and between -180 and 180.
923
+ **format:** `Apifreaks::Types::DomainWhoisLookupRequestFormat` — Response format (defaults to json)
519
924
 
520
925
  </dd>
521
926
  </dl>
@@ -523,7 +928,7 @@ client.geocoder_search(
523
928
  <dl>
524
929
  <dd>
525
930
 
526
- **accept_language:** `String` — Preferred language order for showing search results. This may either be a simple comma-separated list of language codes or a single entry. The results will be in the 1st language which is matched from the header. As a fallback if the results are not supported in the given language, 'en' will be used.
931
+ **domain_name:** `String` — Domain name for WHOIS lookup
527
932
 
528
933
  </dd>
529
934
  </dl>
@@ -543,7 +948,7 @@ client.geocoder_search(
543
948
  </dl>
544
949
  </details>
545
950
 
546
- <details><summary><code>client.<a href="/lib/apifreaks/client.rb">geocoder_reverse</a>() -> Apifreaks::Types::GeocoderReverseResponse</code></summary>
951
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">domain_whois_lookup_v2</a>() -> Apifreaks::Types::DomainWhoisLookupResponse</code></summary>
547
952
  <dl>
548
953
  <dd>
549
954
 
@@ -555,7 +960,9 @@ client.geocoder_search(
555
960
  <dl>
556
961
  <dd>
557
962
 
558
- Convert geographic coordinates (latitude and longitude) into a human-readable address or place name.
963
+ Retrieve current WHOIS information for a domain name using the `v2.0/domain/whois/live` endpoint.
964
+ This endpoint provides detailed registration information including registrar details,
965
+ dates, nameservers, and registrant information.
559
966
  </dd>
560
967
  </dl>
561
968
  </dd>
@@ -570,10 +977,9 @@ Convert geographic coordinates (latitude and longitude) into a human-readable ad
570
977
  <dd>
571
978
 
572
979
  ```ruby
573
- client.geocoder_reverse(
980
+ client.domain_whois_lookup_v2(
574
981
  api_key: "apiKey",
575
- lat: 1.1,
576
- lon: 1.1
982
+ domain_name: "domainName"
577
983
  )
578
984
  ```
579
985
  </dd>
@@ -597,23 +1003,7 @@ client.geocoder_reverse(
597
1003
  <dl>
598
1004
  <dd>
599
1005
 
600
- **format:** `Apifreaks::Types::GeocoderReverseRequestFormat` — Format of the response.
601
-
602
- </dd>
603
- </dl>
604
-
605
- <dl>
606
- <dd>
607
-
608
- **lat:** `Integer` — WGS84 latitude value ranging from -90 to 90.
609
-
610
- </dd>
611
- </dl>
612
-
613
- <dl>
614
- <dd>
615
-
616
- **lon:** `Integer` — WGS84 longitude value ranging from -180 to 180.
1006
+ **format:** `Apifreaks::Types::DomainWhoisLookupRequestFormat` — Response format (defaults to json)
617
1007
 
618
1008
  </dd>
619
1009
  </dl>
@@ -621,7 +1011,7 @@ client.geocoder_reverse(
621
1011
  <dl>
622
1012
  <dd>
623
1013
 
624
- **accept_language:** `String` — Preferred language order for showing search results. This may either be a simple comma-separated list of language codes or a single entry. The results will be in the 1st language which is matched from the header. As a fallback if the results are not supported in the given language, en will be used.
1014
+ **domain_name:** `String` — Domain name for WHOIS lookup
625
1015
 
626
1016
  </dd>
627
1017
  </dl>
@@ -641,7 +1031,7 @@ client.geocoder_reverse(
641
1031
  </dl>
642
1032
  </details>
643
1033
 
644
- <details><summary><code>client.<a href="/lib/apifreaks/client.rb">domain_whois_lookup</a>() -> Apifreaks::Types::DomainWhoisLookupResponse</code></summary>
1034
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">bulk_domain_whois_lookup</a>(request) -> Apifreaks::Types::BulkDomainWhoisLookupResponse</code></summary>
645
1035
  <dl>
646
1036
  <dd>
647
1037
 
@@ -653,9 +1043,7 @@ client.geocoder_reverse(
653
1043
  <dl>
654
1044
  <dd>
655
1045
 
656
- Retrieve current WHOIS information for a domain name.
657
- This endpoint provides detailed registration information including registrar details,
658
- dates, nameservers, and registrant information.
1046
+ Retrieve WHOIS information for `100 Domains per Request`.
659
1047
  </dd>
660
1048
  </dl>
661
1049
  </dd>
@@ -670,9 +1058,9 @@ dates, nameservers, and registrant information.
670
1058
  <dd>
671
1059
 
672
1060
  ```ruby
673
- client.domain_whois_lookup(
1061
+ client.bulk_domain_whois_lookup(
674
1062
  api_key: "apiKey",
675
- domain_name: "domainName"
1063
+ domain_names: ["domainNames"]
676
1064
  )
677
1065
  ```
678
1066
  </dd>
@@ -696,7 +1084,7 @@ client.domain_whois_lookup(
696
1084
  <dl>
697
1085
  <dd>
698
1086
 
699
- **format:** `Apifreaks::Types::DomainWhoisLookupRequestFormat` — Response format (defaults to json)
1087
+ **format:** `Apifreaks::Types::BulkDomainWhoisLookupRequestFormat` — Format of the response.
700
1088
 
701
1089
  </dd>
702
1090
  </dl>
@@ -704,7 +1092,7 @@ client.domain_whois_lookup(
704
1092
  <dl>
705
1093
  <dd>
706
1094
 
707
- **domain_name:** `String` — Domain name for WHOIS lookup
1095
+ **domain_names:** `Internal::Types::Array[String]` — A list of domain names for which WHOIS data is requested.
708
1096
 
709
1097
  </dd>
710
1098
  </dl>
@@ -724,7 +1112,7 @@ client.domain_whois_lookup(
724
1112
  </dl>
725
1113
  </details>
726
1114
 
727
- <details><summary><code>client.<a href="/lib/apifreaks/client.rb">bulk_domain_whois_lookup</a>(request) -> Apifreaks::Types::BulkDomainWhoisLookupResponse</code></summary>
1115
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">bulk_domain_whois_lookup_v2</a>(request) -> Apifreaks::Types::BulkDomainWhoisLookupResponse</code></summary>
728
1116
  <dl>
729
1117
  <dd>
730
1118
 
@@ -736,7 +1124,7 @@ client.domain_whois_lookup(
736
1124
  <dl>
737
1125
  <dd>
738
1126
 
739
- Retrieve WHOIS information for `100 Domains per Request`.
1127
+ Retrieve WHOIS information for `100 Domains per Request` using the `v2.0/domain/whois/live` endpoint.
740
1128
  </dd>
741
1129
  </dl>
742
1130
  </dd>
@@ -751,7 +1139,7 @@ Retrieve WHOIS information for `100 Domains per Request`.
751
1139
  <dd>
752
1140
 
753
1141
  ```ruby
754
- client.bulk_domain_whois_lookup(
1142
+ client.bulk_domain_whois_lookup_v2(
755
1143
  api_key: "apiKey",
756
1144
  domain_names: ["domainNames"]
757
1145
  )
@@ -10413,7 +10801,166 @@ client.get_admin_unit_details(
10413
10801
  </dd>
10414
10802
  </dl>
10415
10803
 
10416
- #### ⚙️ Parameters
10804
+ #### ⚙️ Parameters
10805
+
10806
+ <dl>
10807
+ <dd>
10808
+
10809
+ <dl>
10810
+ <dd>
10811
+
10812
+ **api_key:** `String` — Your API key
10813
+
10814
+ </dd>
10815
+ </dl>
10816
+
10817
+ <dl>
10818
+ <dd>
10819
+
10820
+ **format:** `Apifreaks::Types::GetAdminUnitDetailsRequestFormat` — Format of the response.
10821
+
10822
+ </dd>
10823
+ </dl>
10824
+
10825
+ <dl>
10826
+ <dd>
10827
+
10828
+ **country:** `String` — Country code in ISO 3166-1 alpha-2 format.
10829
+
10830
+ </dd>
10831
+ </dl>
10832
+
10833
+ <dl>
10834
+ <dd>
10835
+
10836
+ **admin_unit:** `String` — Optional admin code to fetch details for a specific administrative unit.
10837
+
10838
+ </dd>
10839
+ </dl>
10840
+
10841
+ <dl>
10842
+ <dd>
10843
+
10844
+ **request_options:** `Apifreaks::RequestOptions`
10845
+
10846
+ </dd>
10847
+ </dl>
10848
+ </dd>
10849
+ </dl>
10850
+
10851
+
10852
+ </dd>
10853
+ </dl>
10854
+ </details>
10855
+
10856
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_cities</a>() -> Apifreaks::Types::GetCitiesResponse</code></summary>
10857
+ <dl>
10858
+ <dd>
10859
+
10860
+ #### 📝 Description
10861
+
10862
+ <dl>
10863
+ <dd>
10864
+
10865
+ <dl>
10866
+ <dd>
10867
+
10868
+ Retrieve a list of cities within a country, optionally filtered by an administrative unit code.
10869
+ </dd>
10870
+ </dl>
10871
+ </dd>
10872
+ </dl>
10873
+
10874
+ #### 🔌 Usage
10875
+
10876
+ <dl>
10877
+ <dd>
10878
+
10879
+ <dl>
10880
+ <dd>
10881
+
10882
+ ```ruby
10883
+ client.get_cities(
10884
+ api_key: "apiKey",
10885
+ country: "country"
10886
+ )
10887
+ ```
10888
+ </dd>
10889
+ </dl>
10890
+ </dd>
10891
+ </dl>
10892
+
10893
+ #### ⚙️ Parameters
10894
+
10895
+ <dl>
10896
+ <dd>
10897
+
10898
+ <dl>
10899
+ <dd>
10900
+
10901
+ **api_key:** `String` — Your API key
10902
+
10903
+ </dd>
10904
+ </dl>
10905
+
10906
+ <dl>
10907
+ <dd>
10908
+
10909
+ **format:** `Apifreaks::Types::GetCitiesRequestFormat` — Format of the response.
10910
+
10911
+ </dd>
10912
+ </dl>
10913
+
10914
+ <dl>
10915
+ <dd>
10916
+
10917
+ **country:** `String` — Country code in ISO 3166-1 alpha-2 format.
10918
+
10919
+ </dd>
10920
+ </dl>
10921
+
10922
+ <dl>
10923
+ <dd>
10924
+
10925
+ **admin_unit:** `String` — Administrative unit code used to filter cities within a specific region.
10926
+
10927
+ </dd>
10928
+ </dl>
10929
+
10930
+ <dl>
10931
+ <dd>
10932
+
10933
+ **request_options:** `Apifreaks::RequestOptions`
10934
+
10935
+ </dd>
10936
+ </dl>
10937
+ </dd>
10938
+ </dl>
10939
+
10940
+
10941
+ </dd>
10942
+ </dl>
10943
+ </details>
10944
+
10945
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_supported_flags</a>() -> Internal::Types::Array[Apifreaks::Types::GetSupportedFlagsResponseItem]</code></summary>
10946
+ <dl>
10947
+ <dd>
10948
+
10949
+ #### 📝 Description
10950
+
10951
+ <dl>
10952
+ <dd>
10953
+
10954
+ <dl>
10955
+ <dd>
10956
+
10957
+ Get list of all supported flags with their metadata
10958
+ </dd>
10959
+ </dl>
10960
+ </dd>
10961
+ </dl>
10962
+
10963
+ #### 🔌 Usage
10417
10964
 
10418
10965
  <dl>
10419
10966
  <dd>
@@ -10421,31 +10968,23 @@ client.get_admin_unit_details(
10421
10968
  <dl>
10422
10969
  <dd>
10423
10970
 
10424
- **api_key:** `String` — Your API key
10425
-
10971
+ ```ruby
10972
+ client.get_supported_flags(api_key: "apiKey")
10973
+ ```
10426
10974
  </dd>
10427
10975
  </dl>
10428
-
10429
- <dl>
10430
- <dd>
10431
-
10432
- **format:** `Apifreaks::Types::GetAdminUnitDetailsRequestFormat` — Format of the response.
10433
-
10434
10976
  </dd>
10435
10977
  </dl>
10436
10978
 
10979
+ #### ⚙️ Parameters
10980
+
10437
10981
  <dl>
10438
10982
  <dd>
10439
10983
 
10440
- **country:** `String` — Country code in ISO 3166-1 alpha-2 format.
10441
-
10442
- </dd>
10443
- </dl>
10444
-
10445
10984
  <dl>
10446
10985
  <dd>
10447
10986
 
10448
- **admin_unit:** `String` — Optional admin code to fetch details for a specific administrative unit.
10987
+ **api_key:** `String` — Your API key
10449
10988
 
10450
10989
  </dd>
10451
10990
  </dl>
@@ -10465,7 +11004,7 @@ client.get_admin_unit_details(
10465
11004
  </dl>
10466
11005
  </details>
10467
11006
 
10468
- <details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_cities</a>() -> Apifreaks::Types::GetCitiesResponse</code></summary>
11007
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_flags</a>() -> String</code></summary>
10469
11008
  <dl>
10470
11009
  <dd>
10471
11010
 
@@ -10477,7 +11016,7 @@ client.get_admin_unit_details(
10477
11016
  <dl>
10478
11017
  <dd>
10479
11018
 
10480
- Retrieve a list of cities within a country, optionally filtered by an administrative unit code.
11019
+ Retrieve the flag for a specific country
10481
11020
  </dd>
10482
11021
  </dl>
10483
11022
  </dd>
@@ -10492,9 +11031,11 @@ Retrieve a list of cities within a country, optionally filtered by an administra
10492
11031
  <dd>
10493
11032
 
10494
11033
  ```ruby
10495
- client.get_cities(
11034
+ client.get_flags(
10496
11035
  api_key: "apiKey",
10497
- country: "country"
11036
+ name: "name",
11037
+ shape: "flat",
11038
+ type: "country"
10498
11039
  )
10499
11040
  ```
10500
11041
  </dd>
@@ -10518,7 +11059,7 @@ client.get_cities(
10518
11059
  <dl>
10519
11060
  <dd>
10520
11061
 
10521
- **format:** `Apifreaks::Types::GetCitiesRequestFormat` — Format of the response.
11062
+ **name:** `String` — Country code in ISO 3166-1 alpha-2 format.
10522
11063
 
10523
11064
  </dd>
10524
11065
  </dl>
@@ -10526,7 +11067,7 @@ client.get_cities(
10526
11067
  <dl>
10527
11068
  <dd>
10528
11069
 
10529
- **country:** `String` — Country code in ISO 3166-1 alpha-2 format.
11070
+ **shape:** `Apifreaks::Types::GetFlagsRequestShape` — Flag shape. One of: `'flat'` or `'round'`.
10530
11071
 
10531
11072
  </dd>
10532
11073
  </dl>
@@ -10534,7 +11075,23 @@ client.get_cities(
10534
11075
  <dl>
10535
11076
  <dd>
10536
11077
 
10537
- **admin_unit:** `String` — Administrative unit code used to filter cities within a specific region.
11078
+ **format:** `Apifreaks::Types::GetFlagsRequestFormat` — Flag format. Applicable only for PNG or WEBP formats. Default is png.
11079
+
11080
+ </dd>
11081
+ </dl>
11082
+
11083
+ <dl>
11084
+ <dd>
11085
+
11086
+ **size:** `Apifreaks::Types::GetFlagsRequestSize` — Flag size in pixels. Valid options: `16px`, `24px`, `32px`, `48px`, `64px`. Applicable only for PNG or WEBP formats.
11087
+
11088
+ </dd>
11089
+ </dl>
11090
+
11091
+ <dl>
11092
+ <dd>
11093
+
11094
+ **type:** `Apifreaks::Types::GetFlagsRequestType` — Type of flag. One of: `country` or `organization`.
10538
11095
 
10539
11096
  </dd>
10540
11097
  </dl>
@@ -10554,7 +11111,7 @@ client.get_cities(
10554
11111
  </dl>
10555
11112
  </details>
10556
11113
 
10557
- <details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_supported_flags</a>() -> Internal::Types::Array[Apifreaks::Types::GetSupportedFlagsResponseItem]</code></summary>
11114
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">timezone_lookup</a>() -> Apifreaks::Types::TimezoneLookupResponse</code></summary>
10558
11115
  <dl>
10559
11116
  <dd>
10560
11117
 
@@ -10566,7 +11123,7 @@ client.get_cities(
10566
11123
  <dl>
10567
11124
  <dd>
10568
11125
 
10569
- Get list of all supported flags with their metadata
11126
+ Retrieve current time, date, and timezone-related information by specifying a timezone name, location address, location coordinates, IP address, or use the client IP address if no parameter is passed.
10570
11127
  </dd>
10571
11128
  </dl>
10572
11129
  </dd>
@@ -10581,7 +11138,7 @@ Get list of all supported flags with their metadata
10581
11138
  <dd>
10582
11139
 
10583
11140
  ```ruby
10584
- client.get_supported_flags(api_key: "apiKey")
11141
+ client.timezone_lookup(api_key: "apiKey")
10585
11142
  ```
10586
11143
  </dd>
10587
11144
  </dl>
@@ -10604,66 +11161,39 @@ client.get_supported_flags(api_key: "apiKey")
10604
11161
  <dl>
10605
11162
  <dd>
10606
11163
 
10607
- **request_options:** `Apifreaks::RequestOptions`
11164
+ **format:** `Apifreaks::Types::TimezoneLookupRequestFormat` — Format of the response
10608
11165
 
10609
11166
  </dd>
10610
11167
  </dl>
10611
- </dd>
10612
- </dl>
10613
-
10614
-
10615
- </dd>
10616
- </dl>
10617
- </details>
10618
11168
 
10619
- <details><summary><code>client.<a href="/lib/apifreaks/client.rb">get_flags</a>() -> String</code></summary>
10620
11169
  <dl>
10621
11170
  <dd>
10622
11171
 
10623
- #### 📝 Description
10624
-
10625
- <dl>
10626
- <dd>
11172
+ **ip:** `String` — IPv4 or IPv6 address to extract timezone information.
11173
+
11174
+ </dd>
11175
+ </dl>
10627
11176
 
10628
11177
  <dl>
10629
11178
  <dd>
10630
11179
 
10631
- Retrieve the flag for a specific country
10632
- </dd>
10633
- </dl>
11180
+ **tz:** `String` Timezone name (e.g., "Asia/Kolkata") to retrieve information directly.
11181
+
10634
11182
  </dd>
10635
11183
  </dl>
10636
11184
 
10637
- #### 🔌 Usage
10638
-
10639
- <dl>
10640
- <dd>
10641
-
10642
11185
  <dl>
10643
11186
  <dd>
10644
11187
 
10645
- ```ruby
10646
- client.get_flags(
10647
- api_key: "apiKey",
10648
- name: "name",
10649
- shape: "flat",
10650
- type: "country"
10651
- )
10652
- ```
10653
- </dd>
10654
- </dl>
11188
+ **location:** `String` — Location string (preferably city and country) to extract timezone.
11189
+
10655
11190
  </dd>
10656
11191
  </dl>
10657
11192
 
10658
- #### ⚙️ Parameters
10659
-
10660
- <dl>
10661
- <dd>
10662
-
10663
11193
  <dl>
10664
11194
  <dd>
10665
11195
 
10666
- **api_key:** `String` — Your API key
11196
+ **lat:** `Integer` — Latitude for geolocation lookup.
10667
11197
 
10668
11198
  </dd>
10669
11199
  </dl>
@@ -10671,7 +11201,7 @@ client.get_flags(
10671
11201
  <dl>
10672
11202
  <dd>
10673
11203
 
10674
- **name:** `String` — Country code in ISO 3166-1 alpha-2 format.
11204
+ **long:** `Integer` — Longitude for geolocation lookup.
10675
11205
 
10676
11206
  </dd>
10677
11207
  </dl>
@@ -10679,7 +11209,7 @@ client.get_flags(
10679
11209
  <dl>
10680
11210
  <dd>
10681
11211
 
10682
- **shape:** `Apifreaks::Types::GetFlagsRequestShape` — Flag shape. One of: `'flat'` or `'round'`.
11212
+ **lang:** `Apifreaks::Types::TimezoneLookupRequestLang` — Language code for response localization (default is "en").
10683
11213
 
10684
11214
  </dd>
10685
11215
  </dl>
@@ -10687,7 +11217,7 @@ client.get_flags(
10687
11217
  <dl>
10688
11218
  <dd>
10689
11219
 
10690
- **format:** `Apifreaks::Types::GetFlagsRequestFormat` — Flag format. Applicable only for PNG or WEBP formats. Default is png.
11220
+ **iata_code:** `String` — 3-letter IATA airport code (e.g., JFK).
10691
11221
 
10692
11222
  </dd>
10693
11223
  </dl>
@@ -10695,7 +11225,7 @@ client.get_flags(
10695
11225
  <dl>
10696
11226
  <dd>
10697
11227
 
10698
- **size:** `Apifreaks::Types::GetFlagsRequestSize` — Flag size in pixels. Valid options: `16px`, `24px`, `32px`, `48px`, `64px`. Applicable only for PNG or WEBP formats.
11228
+ **icao_code:** `String` — 4-letter ICAO airport code (e.g., KJFK).
10699
11229
 
10700
11230
  </dd>
10701
11231
  </dl>
@@ -10703,7 +11233,7 @@ client.get_flags(
10703
11233
  <dl>
10704
11234
  <dd>
10705
11235
 
10706
- **type:** `Apifreaks::Types::GetFlagsRequestType` — Type of flag. One of: `country` or `organization`.
11236
+ **lo_code:** `String` — 5-letter UN/LO city code.
10707
11237
 
10708
11238
  </dd>
10709
11239
  </dl>
@@ -10723,7 +11253,7 @@ client.get_flags(
10723
11253
  </dl>
10724
11254
  </details>
10725
11255
 
10726
- <details><summary><code>client.<a href="/lib/apifreaks/client.rb">timezone_lookup</a>() -> Apifreaks::Types::TimezoneLookupResponse</code></summary>
11256
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">timezone_lookup_v2</a>() -> Apifreaks::Types::TimezoneLookupResponse</code></summary>
10727
11257
  <dl>
10728
11258
  <dd>
10729
11259
 
@@ -10735,7 +11265,7 @@ client.get_flags(
10735
11265
  <dl>
10736
11266
  <dd>
10737
11267
 
10738
- Retrieve current time, date, and timezone-related information by specifying a timezone name, location address, location coordinates, IP address, or use the client IP address if no parameter is passed.
11268
+ Retrieve current time, date, and timezone-related information using the `v2.0/geolocation/timezone` endpoint by specifying a timezone name, location address, location coordinates, IP address, or use the client IP address if no parameter is passed.
10739
11269
  </dd>
10740
11270
  </dl>
10741
11271
  </dd>
@@ -10750,7 +11280,7 @@ Retrieve current time, date, and timezone-related information by specifying a ti
10750
11280
  <dd>
10751
11281
 
10752
11282
  ```ruby
10753
- client.timezone_lookup(api_key: "apiKey")
11283
+ client.timezone_lookup_v2(api_key: "apiKey")
10754
11284
  ```
10755
11285
  </dd>
10756
11286
  </dl>
@@ -11810,3 +12340,137 @@ client.astronomy_lookup(api_key: "apiKey")
11810
12340
  </dl>
11811
12341
  </details>
11812
12342
 
12343
+ <details><summary><code>client.<a href="/lib/apifreaks/client.rb">astronomy_lookup_v2</a>() -> Apifreaks::Types::AstronomyLookupResponse</code></summary>
12344
+ <dl>
12345
+ <dd>
12346
+
12347
+ #### 📝 Description
12348
+
12349
+ <dl>
12350
+ <dd>
12351
+
12352
+ <dl>
12353
+ <dd>
12354
+
12355
+ Retrieve sunrise and sunset times, current position of the moon, and other related information using the `v2.0/geolocation/astronomy` endpoint by specifying a location address, location coordinates, IP address, or using the client IP address if no parameter is passed.
12356
+ </dd>
12357
+ </dl>
12358
+ </dd>
12359
+ </dl>
12360
+
12361
+ #### 🔌 Usage
12362
+
12363
+ <dl>
12364
+ <dd>
12365
+
12366
+ <dl>
12367
+ <dd>
12368
+
12369
+ ```ruby
12370
+ client.astronomy_lookup_v2(api_key: "apiKey")
12371
+ ```
12372
+ </dd>
12373
+ </dl>
12374
+ </dd>
12375
+ </dl>
12376
+
12377
+ #### ⚙️ Parameters
12378
+
12379
+ <dl>
12380
+ <dd>
12381
+
12382
+ <dl>
12383
+ <dd>
12384
+
12385
+ **api_key:** `String` — Your API key
12386
+
12387
+ </dd>
12388
+ </dl>
12389
+
12390
+ <dl>
12391
+ <dd>
12392
+
12393
+ **format:** `Apifreaks::Types::AstronomyLookupRequestFormat` — Format of the response.
12394
+
12395
+ </dd>
12396
+ </dl>
12397
+
12398
+ <dl>
12399
+ <dd>
12400
+
12401
+ **location:** `String` — Location name or address
12402
+
12403
+ </dd>
12404
+ </dl>
12405
+
12406
+ <dl>
12407
+ <dd>
12408
+
12409
+ **lat:** `Integer` — Latitude for location coordinates
12410
+
12411
+ </dd>
12412
+ </dl>
12413
+
12414
+ <dl>
12415
+ <dd>
12416
+
12417
+ **long:** `Integer` — Longitude for location coordinates
12418
+
12419
+ </dd>
12420
+ </dl>
12421
+
12422
+ <dl>
12423
+ <dd>
12424
+
12425
+ **ip:** `String` — IP address for location detection
12426
+
12427
+ </dd>
12428
+ </dl>
12429
+
12430
+ <dl>
12431
+ <dd>
12432
+
12433
+ **lang:** `String`
12434
+
12435
+ </dd>
12436
+ </dl>
12437
+
12438
+ <dl>
12439
+ <dd>
12440
+
12441
+ **date:** `String` — Date for astronomy data (YYYY-MM-DD)
12442
+
12443
+ </dd>
12444
+ </dl>
12445
+
12446
+ <dl>
12447
+ <dd>
12448
+
12449
+ **elevation:** `Integer` — Timezone of the location for which astronomy data is required
12450
+
12451
+ </dd>
12452
+ </dl>
12453
+
12454
+ <dl>
12455
+ <dd>
12456
+
12457
+ **time_zone:** `String` —
12458
+
12459
+ </dd>
12460
+ </dl>
12461
+
12462
+ <dl>
12463
+ <dd>
12464
+
12465
+ **request_options:** `Apifreaks::RequestOptions`
12466
+
12467
+ </dd>
12468
+ </dl>
12469
+ </dd>
12470
+ </dl>
12471
+
12472
+
12473
+ </dd>
12474
+ </dl>
12475
+ </details>
12476
+