-
Notifications
You must be signed in to change notification settings - Fork 44
/
index.d.ts
2357 lines (2138 loc) · 86.6 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
declare module "pokeapi-js-wrapper" {
interface APIResource {
/** The URL of the referenced resource. */
url: string;
[property: string]: any;
}
interface EndpointsList {
ability: string;
berry: string;
"berry-firmness": string;
"berry-flavor": string;
characteristic: string;
"contest-effect": string;
"contest-type": string;
"egg-group": string;
"encounter-condition": string;
"encounter-condition-value": string;
"encounter-method": string;
"evolution-chain": string;
"evolution-trigger": string;
gender: string;
generation: string;
"growth-rate": string;
item: string;
"item-attribute": string;
"item-category": string;
"item-fling-effect": string;
"item-pocket": string;
language: string;
location: string;
"location-area": string;
machine: string;
move: string;
"move-ailment": string;
"move-battle-style": string;
"move-category": string;
"move-damage-class": string;
"move-learn-method": string;
"move-target": string;
nature: string;
"pal-park-area": string;
"pokeathlon-stat": string;
pokedex: string;
pokemon: string;
"pokemon-color": string;
"pokemon-form": string;
"pokemon-habitat": string;
"pokemon-shape": string;
"pokemon-species": string;
region: string;
stat: string;
"super-contest-effect": string;
type: string;
version: string;
"version-group": string;
}
interface APIResourceList {
count: number;
next: null | string;
previous: null | string;
results: APIResource[];
[property: string]: any;
}
interface NamedAPIResource {
/** The name of the referenced resource. */
name: string;
/** The URL of the referenced resource. */
url: string;
[property: string]: any;
}
interface NamedAPIResourceList {
/** The total number of resources available from this API. */
count: number;
/** The URL for the next page in the list. */
next: null | string;
/** The URL for the previous page in the list. */
previous: null | string;
/** A list of named API resources. */
results: NamedAPIResource[];
[property: string]: any;
}
/** Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. */
interface Ability {
/** The list of previous effects this ability has had across version groups. */
effect_changes: AbilityEffectChange[];
/** The effect of this ability listed in different languages. */
effect_entries: AbilityEffectEntry[];
/** The flavor text of this ability listed in different languages. */
flavor_text_entries: AbilityFlavorTextEntry[];
/** The generation this ability originated in. */
generation: NamedAPIResource;
/** The identifier for this resource. */
id: number;
/** Whether or not this ability originated in the main series of the video games. */
is_main_series: boolean;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: AbilityName[];
/** A list of Pokémon that could potentially have this ability. */
pokemon: AbilityPokemon[];
[property: string]: any;
}
interface AbilityEffectChange {
/** The previous effect of this ability listed in different languages. */
effect_entries: PurpleEffectEntry[];
/** The version group in which the previous effect of this ability originated. */
version_group: NamedAPIResource;
[property: string]: any;
}
interface PurpleEffectEntry {
effect: string;
language: NamedAPIResource;
[property: string]: any;
}
interface AbilityEffectEntry {
effect: string;
language: NamedAPIResource;
short_effect: string;
[property: string]: any;
}
interface AbilityFlavorTextEntry {
flavor_text: string;
language: NamedAPIResource;
version_group: NamedAPIResource;
[property: string]: any;
}
interface AbilityName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
interface AbilityPokemon {
/** Whether or not this a hidden ability for the referenced Pokémon. */
is_hidden: boolean;
/** The Pokémon this ability could belong to. */
pokemon: NamedAPIResource;
/** Pokémon have 3 ability 'slots' which hold references to possible abilities they could have. This is the slot of this ability for the referenced pokemon. */
slot: number;
[property: string]: any;
}
/** Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. */
interface Berry {
/** The firmness of this berry, used in making Pokéblocks or Poffins. */
firmness: NamedAPIResource;
/** A list of references to each flavor a berry can have and the potency of each of those flavors in regard to this berry. */
flavors: Flavor[];
/** Time it takes the tree to grow one stage, in hours. Berry trees go through four of these growth stages before they can be picked. */
growth_time: number;
/** The identifier for this resource. */
id: number;
/** Berries are actually items. This is a reference to the item specific data for this berry. */
item: NamedAPIResource;
/** The maximum number of these berries that can grow on one tree in Generation IV. */
max_harvest: number;
/** The name for this resource. */
name: string;
/** The power of the move "Natural Gift" when used with this Berry. */
natural_gift_power: number;
/** The type inherited by "Natural Gift" when used with this Berry. */
natural_gift_type: NamedAPIResource;
/** The size of this Berry, in millimeters. */
size: number;
/** The smoothness of this Berry, used in making Pokéblocks or Poffins. */
smoothness: number;
/** The speed at which this Berry dries out the soil as it grows. A higher rate means the soil dries more quickly. */
soil_dryness: number;
[property: string]: any;
}
interface Flavor {
flavor: NamedAPIResource;
potency: number;
[property: string]: any;
}
/** Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. */
interface BerryFirmness {
/** A list of the berries with this firmness. */
berries: NamedAPIResource[];
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: BerryFirmnessName[];
[property: string]: any;
}
interface BerryFirmnessName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their [nature](#natures). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. */
interface BerryFlavor {
/** A list of the berries with this flavor. */
berries: BerryElement[];
/** The contest type that correlates with this berry flavor. */
contest_type: NamedAPIResource;
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: BerryFlavorName[];
[property: string]: any;
}
interface BerryElement {
berry: NamedAPIResource;
potency: number;
[property: string]: any;
}
interface BerryFlavorName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. */
interface Characteristic {
/** The descriptions of this characteristic listed in different languages. */
descriptions: CharacteristicDescription[];
/** The remainder of the highest stat/IV divided by 5. */
gene_modulo: number;
/** The stat which results in this characteristic. */
highest_stat: NamedAPIResource;
/** The identifier for this resource. */
id: number;
/** The possible values of the highest stat that would result in a Pokémon recieving this characteristic when divided by 5. */
possible_values: number[];
[property: string]: any;
}
interface CharacteristicDescription {
description: string;
language: NamedAPIResource;
[property: string]: any;
}
interface SuperContestEffectList {
count: number;
next: null | string;
previous: null | string;
results: APIResource[];
[property: string]: any;
}
/** Contest effects refer to the effects of moves when used in contests. */
interface ContestEffect {
/** The base number of hearts the user of this move gets. */
appeal: number;
/** The result of this contest effect listed in different languages. */
effect_entries: ContestEffectEffectEntry[];
/** The flavor text of this contest effect listed in different languages. */
flavor_text_entries: ContestEffectFlavorTextEntry[];
/** The identifier for this resource. */
id: number;
/** The base number of hearts the user's opponent loses. */
jam: number;
[property: string]: any;
}
interface ContestEffectEffectEntry {
effect: string;
language: NamedAPIResource;
[property: string]: any;
}
interface ContestEffectFlavorTextEntry {
flavor_text: string;
language: NamedAPIResource;
[property: string]: any;
}
/** Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. */
interface ContestType {
/** The berry flavor that correlates with this contest type. */
berry_flavor: NamedAPIResource;
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this contest type listed in different languages. */
names: ContestTypeName[];
[property: string]: any;
}
interface ContestTypeName {
color: string;
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. */
interface EggGroup {
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: EggGroupName[];
/** A list of all Pokémon species that are members of this egg group. */
pokemon_species: NamedAPIResource[];
[property: string]: any;
}
interface EggGroupName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Conditions which affect what pokemon might appear in the wild, e.g., day or night. */
interface EncounterCondition {
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: EncounterConditionName[];
/** A list of possible values for this encounter condition. */
values: NamedAPIResource[];
[property: string]: any;
}
interface EncounterConditionName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night. */
interface EncounterConditionValue {
/** The condition this encounter condition value pertains to. */
condition: NamedAPIResource;
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: EncounterConditionValueName[];
[property: string]: any;
}
interface EncounterConditionValueName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Wild_Pok%C3%A9mon) for greater detail. */
interface EncounterMethod {
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: EncounterMethodName[];
/** A good value for sorting. */
order: number;
[property: string]: any;
}
interface EncounterMethodName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy. */
interface EvolutionChain {
/** The item that a Pokémon would be holding when mating that would trigger the egg hatching a baby Pokémon rather than a basic Pokémon. */
baby_trigger_item: null | NamedAPIResource;
/** The base chain link object. Each link contains evolution details for a Pokémon in the chain. Each link references the next Pokémon in the natural evolution order. */
chain: Chain;
/** The identifier for this resource. */
id: number;
[property: string]: any;
}
interface Chain {
evolution_details: any[];
evolves_to: ChainEvolvesTo[];
is_baby: boolean;
species: NamedAPIResource;
[property: string]: any;
}
interface ChainEvolvesTo {
evolution_details: PurpleEvolutionDetail[];
evolves_to: EvolvesToEvolvesTo[];
is_baby: boolean;
species: NamedAPIResource;
[property: string]: any;
}
interface PurpleEvolutionDetail {
/** The id of the gender of the evolving Pokémon species must be in order to evolve into this Pokémon species. */
gender: number | null;
/** The item the evolving Pokémon species must be holding during the evolution trigger event to evolve into this Pokémon species. */
held_item: null | NamedAPIResource;
/** The item required to cause evolution this into Pokémon species. */
item: null | NamedAPIResource;
/** The move that must be known by the evolving Pokémon species during the evolution trigger event in order to evolve into this Pokémon species. */
known_move: null | NamedAPIResource;
/** The evolving Pokémon species must know a move with this type during the evolution trigger event in order to evolve into this Pokémon species. */
known_move_type: null | NamedAPIResource;
/** The location the evolution must be triggered at. */
location: null | NamedAPIResource;
/** The minimum required level of affection the evolving Pokémon species to evolve into this Pokémon species. */
min_affection: number | null;
/** The minimum required level of beauty the evolving Pokémon species to evolve into this Pokémon species. */
min_beauty: number | null;
/** The minimum required level of happiness the evolving Pokémon species to evolve into this Pokémon species. */
min_happiness: number | null;
/** The minimum required level of the evolving Pokémon species to evolve into this Pokémon species. */
min_level: number | null;
/** Whether or not it must be raining in the overworld to cause evolution this Pokémon species. */
needs_overworld_rain: boolean;
/** The Pokémon species that must be in the players party in order for the evolving Pokémon species to evolve into this Pokémon species. */
party_species: null | NamedAPIResource;
/** The player must have a Pokémon of this type in their party during the evolution trigger event in order for the evolving Pokémon species to evolve into this Pokémon species. */
party_type: null | NamedAPIResource;
/** The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense. */
relative_physical_stats: number | null;
/** The required time of day. Day or night. */
time_of_day: string;
/** Pokémon species for which this one must be traded. */
trade_species: null | NamedAPIResource;
/** The type of event that triggers evolution into this Pokémon species. */
trigger: NamedAPIResource;
/** Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up. */
turn_upside_down: boolean;
[property: string]: any;
}
interface EvolvesToEvolvesTo {
evolution_details: FluffyEvolutionDetail[];
evolves_to: any[];
is_baby: boolean;
species: NamedAPIResource;
[property: string]: any;
}
interface FluffyEvolutionDetail {
/** The id of the gender of the evolving Pokémon species must be in order to evolve into this Pokémon species. */
gender: number | null;
/** The item the evolving Pokémon species must be holding during the evolution trigger event to evolve into this Pokémon species. */
held_item: null | NamedAPIResource;
/** The item required to cause evolution this into Pokémon species. */
item: null | NamedAPIResource;
/** The move that must be known by the evolving Pokémon species during the evolution trigger event in order to evolve into this Pokémon species. */
known_move: null | NamedAPIResource;
/** The evolving Pokémon species must know a move with this type during the evolution trigger event in order to evolve into this Pokémon species. */
known_move_type: null;
/** The location the evolution must be triggered at. */
location: null | NamedAPIResource;
/** The minimum required level of affection the evolving Pokémon species to evolve into this Pokémon species. */
min_affection: null;
/** The minimum required level of beauty the evolving Pokémon species to evolve into this Pokémon species. */
min_beauty: null;
/** The minimum required level of happiness the evolving Pokémon species to evolve into this Pokémon species. */
min_happiness: number | null;
/** The minimum required level of the evolving Pokémon species to evolve into this Pokémon species. */
min_level: number | null;
/** Whether or not it must be raining in the overworld to cause evolution this Pokémon species. */
needs_overworld_rain: boolean;
/** The Pokémon species that must be in the players party in order for the evolving Pokémon species to evolve into this Pokémon species. */
party_species: null;
/** The player must have a Pokémon of this type in their party during the evolution trigger event in order for the evolving Pokémon species to evolve into this Pokémon species. */
party_type: null;
/** The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense. */
relative_physical_stats: null;
/** The required time of day. Day or night. */
time_of_day: string;
/** Pokémon species for which this one must be traded. */
trade_species: null;
/** The type of event that triggers evolution into this Pokémon species. */
trigger: NamedAPIResource;
/** Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up. */
turn_upside_down: boolean;
[property: string]: any;
}
/** Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail. */
interface EvolutionTrigger {
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: EvolutionTriggerName[];
/** A list of pokemon species that result from this evolution trigger. */
pokemon_species: NamedAPIResource[];
[property: string]: any;
}
interface EvolutionTriggerName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail. */
interface Gender {
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** A list of Pokémon species that can be this gender and how likely it is that they will be. */
pokemon_species_details: PokemonSpeciesDetail[];
/** A list of Pokémon species that required this gender in order for a Pokémon to evolve into them. */
required_for_evolution: NamedAPIResource[];
[property: string]: any;
}
interface PokemonSpeciesDetail {
pokemon_species: NamedAPIResource;
rate: number;
[property: string]: any;
}
/** A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released. */
interface Generation {
/** A list of abilities that were introduced in this generation. */
abilities: NamedAPIResource[];
/** The identifier for this resource. */
id: number;
/** The main region travelled in this generation. */
main_region: NamedAPIResource;
/** A list of moves that were introduced in this generation. */
moves: NamedAPIResource[];
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: GenerationName[];
/** A list of Pokémon species that were introduced in this generation. */
pokemon_species: NamedAPIResource[];
/** A list of types that were introduced in this generation. */
types: NamedAPIResource[];
/** A list of version groups that were introduced in this generation. */
version_groups: NamedAPIResource[];
[property: string]: any;
}
interface GenerationName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. */
interface GrowthRate {
/** The descriptions of this characteristic listed in different languages. */
descriptions: GrowthRateDescription[];
/** The formula used to calculate the rate at which the Pokémon species gains level. */
formula: string;
/** The identifier for this resource. */
id: number;
/** A list of levels and the amount of experienced needed to atain them based on this growth rate. */
levels: Level[];
/** The name for this resource. */
name: string;
/** A list of Pokémon species that gain levels at this growth rate. */
pokemon_species: NamedAPIResource[];
[property: string]: any;
}
interface GrowthRateDescription {
description: string;
language: NamedAPIResource;
[property: string]: any;
}
interface Level {
experience: number;
level: number;
[property: string]: any;
}
/** An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. */
interface Item {
/** A list of attributes this item has. */
attributes: NamedAPIResource[];
/** An evolution chain this item requires to produce a bay during mating. */
baby_trigger_for: null | APIResource;
/** The category of items this item falls into. */
category: NamedAPIResource;
/** The price of this item in stores. */
cost: number;
/** The effect of this ability listed in different languages. */
effect_entries: ItemEffectEntry[];
/** The flavor text of this ability listed in different languages. */
flavor_text_entries: ItemFlavorTextEntry[];
/** The effect of the move Fling when used with this item. */
fling_effect: null | NamedAPIResource;
/** The power of the move Fling when used with this item. */
fling_power: number | null;
/** A list of game indices relevent to this item by generation. */
game_indices: ItemGameIndex[];
/** A list of Pokémon that might be found in the wild holding this item. */
held_by_pokemon: HeldByPokemon[];
/** The identifier for this resource. */
id: number;
/** A list of the machines related to this item. */
machines: ItemMachine[];
/** The name for this resource. */
name: string;
/** The name of this item listed in different languages. */
names: ItemName[];
/** A set of sprites used to depict this item in the game. */
sprites: ItemSprites;
[property: string]: any;
}
interface ItemEffectEntry {
effect: string;
language: NamedAPIResource;
short_effect: string;
[property: string]: any;
}
interface ItemFlavorTextEntry {
language: NamedAPIResource;
text: string;
version_group: NamedAPIResource;
[property: string]: any;
}
interface ItemGameIndex {
game_index: number;
generation: NamedAPIResource;
[property: string]: any;
}
interface HeldByPokemon {
pokemon: NamedAPIResource;
version_details: HeldByPokemonVersionDetail[];
[property: string]: any;
}
interface HeldByPokemonVersionDetail {
rarity: number;
version: NamedAPIResource;
[property: string]: any;
}
interface ItemMachine {
machine: APIResource;
version_group: NamedAPIResource;
[property: string]: any;
}
interface ItemName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
interface ItemSprites {
/** The default depiction of this item. */
default: null | string;
[property: string]: any;
}
/** Item attributes define particular aspects of items, e.g. "usable in battle" or "consumable". */
interface ItemAttribute {
/** The description of this item attribute listed in different languages. */
descriptions: ItemAttributeDescription[];
/** The identifier for this resource. */
id: number;
/** A list of items that have this attribute. */
items: NamedAPIResource[];
/** The name for this resource. */
name: string;
/** The name of this item attribute listed in different languages. */
names: ItemAttributeName[];
[property: string]: any;
}
interface ItemAttributeDescription {
description: string;
language: NamedAPIResource;
[property: string]: any;
}
interface ItemAttributeName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Item categories determine where items will be placed in the players bag. */
interface ItemCategory {
/** The identifier for this resource. */
id: number;
/** A list of items that are a part of this category. */
items: NamedAPIResource[];
/** The name for this resource. */
name: string;
/** The name of this item category listed in different languages. */
names: ItemCategoryName[];
/** The pocket items in this category would be put in. */
pocket: NamedAPIResource;
[property: string]: any;
}
interface ItemCategoryName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** The various effects of the move "Fling" when used with different items. */
interface ItemFlingEffect {
/** The result of this fling effect listed in different languages. */
effect_entries: ItemFlingEffectEffectEntry[];
/** The identifier for this resource. */
id: number;
/** A list of items that have this fling effect. */
items: NamedAPIResource[];
/** The name for this resource. */
name: string;
[property: string]: any;
}
interface ItemFlingEffectEffectEntry {
effect: string;
language: NamedAPIResource;
[property: string]: any;
}
/** Pockets within the players bag used for storing items by category. */
interface ItemPocket {
/** A list of item categories that are relevant to this item pocket. */
categories: NamedAPIResource[];
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: ItemPocketName[];
[property: string]: any;
}
interface ItemPocketName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Languages for translations of API resource information. */
interface Language {
/** The identifier for this resource. */
id: number;
/** The two-letter code of the language. Note that it is not unique. */
iso3166: string;
/** The two-letter code of the country where this language is spoken. Note that it is not unique. */
iso639: string;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: LanguageName[];
/** Whether or not the games are published in this language. */
official: boolean;
[property: string]: any;
}
interface LanguageName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. */
interface Location {
/** Areas that can be found within this location. */
areas: NamedAPIResource[];
/** A list of game indices relevent to this location by generation. */
game_indices: LocationGameIndex[];
/** The identifier for this resource. */
id: number;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: LocationName[];
/** The region this location can be found in. */
region: null | NamedAPIResource;
[property: string]: any;
}
interface LocationGameIndex {
game_index: number;
generation: NamedAPIResource;
[property: string]: any;
}
interface LocationName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
/** Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters. */
interface LocationArea {
/** A list of methods in which Pokémon may be encountered in this area and how likely the method will occur depending on the version of the game. */
encounter_method_rates: EncounterMethodRate[];
/** The internal id of an API resource within game data. */
game_index: number;
/** The identifier for this resource. */
id: number;
/** The region this location area can be found in. */
location: NamedAPIResource;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: LocationAreaName[];
/** A list of Pokémon that can be encountered in this area along with version specific details about the encounter. */
pokemon_encounters: LocationAreaPokemonEncounter[];
[property: string]: any;
}
interface EncounterMethodRate {
/** The method in which Pokémon may be encountered in an area.. */
encounter_method: NamedAPIResource;
/** The chance of the encounter to occur on a version of the game. */
version_details: EncounterMethodRateVersionDetail[];
[property: string]: any;
}
interface EncounterMethodRateVersionDetail {
rate: number;
version: NamedAPIResource;
[property: string]: any;
}
interface LocationAreaName {
language: NamedAPIResource;
name: string;
[property: string]: any;
}
interface LocationAreaPokemonEncounter {
/** The Pokémon being encountered. */
pokemon: NamedAPIResource;
/** A list of versions and encounters with Pokémon that might happen in the referenced location area. */
version_details: PokemonEncounterVersionDetail[];
[property: string]: any;
}
interface PokemonEncounterVersionDetail {
encounter_details: PurpleEncounterDetail[];
max_chance: number;
version: NamedAPIResource;
[property: string]: any;
}
interface PurpleEncounterDetail {
chance: number;
condition_values: NamedAPIResource[];
max_level: number;
method: NamedAPIResource;
min_level: number;
[property: string]: any;
}
/** Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. */
interface Machine {
/** The identifier for this resource. */
id: number;
/** The TM or HM item that corresponds to this machine. */
item: NamedAPIResource;
/** The move that is taught by this machine. */
move: NamedAPIResource;
/** The version group that this machine applies to. */
version_group: NamedAPIResource;
[property: string]: any;
}
/** Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. */
interface Move {
/** The percent value of how likely this move is to be successful. */
accuracy: number | null;
/** A detail of normal and super contest combos that require this move. */
contest_combos: null | ContestCombos;
/** The effect the move has when used in a contest. */
contest_effect: null | APIResource;
/** The type of appeal this move gives a Pokémon when used in a contest. */
contest_type: null | NamedAPIResource;
/** The type of damage the move inflicts on the target, e.g. physical. */
damage_class: NamedAPIResource;
/** The percent value of how likely it is this moves effect will happen. */
effect_chance: number | null;
/** The list of previous effects this move has had across version groups of the games. */
effect_changes: MoveEffectChange[];
/** The effect of this move listed in different languages. */
effect_entries: MoveEffectEntry[];
/** The flavor text of this move listed in different languages. */
flavor_text_entries: MoveFlavorTextEntry[];
/** The generation in which this move was introduced. */
generation: NamedAPIResource;
/** The identifier for this resource. */
id: number;
/** List of Pokemon that can learn the move */
learned_by_pokemon: NamedAPIResource[];
/** A list of the machines that teach this move. */
machines: MoveMachine[];
/** Metadata about this move */
meta: null | Meta;
/** The name for this resource. */
name: string;
/** The name of this resource listed in different languages. */
names: MoveName[];
/** A list of move resource value changes across version groups of the game. */
past_values: PastValue[];
/** The base power of this move with a value of 0 if it does not have a base power. */
power: number | null;
/** Power points. The number of times this move can be used. */
pp: number | null;
/** A value between -8 and 8. Sets the order in which moves are executed during battle. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Priority) for greater detail. */
priority: number;
/** A list of stats this moves effects and how much it effects them. */
stat_changes: StatChange[];
/** The effect the move has when used in a super contest. */
super_contest_effect: null | APIResource;
/** The type of target that will receive the effects of the attack. */
target: NamedAPIResource;
/** The elemental type of this move. */
type: NamedAPIResource;
[property: string]: any;
}
interface ContestCombos {
normal: Normal;
super: Super;
[property: string]: any;
}
interface Normal {
use_after: NamedAPIResource[] | null;
use_before: NamedAPIResource[] | null;
[property: string]: any;
}
interface Super {
use_after: NamedAPIResource[] | null;
use_before: NamedAPIResource[] | null;
[property: string]: any;
}
interface MoveEffectChange {
effect_entries: FluffyEffectEntry[];
version_group: NamedAPIResource;
[property: string]: any;
}
interface FluffyEffectEntry {
effect: string;
language: NamedAPIResource;
[property: string]: any;
}
interface MoveEffectEntry {
effect: string;
language: NamedAPIResource;
short_effect: string;
[property: string]: any;
}
interface MoveFlavorTextEntry {
flavor_text: string;
language: NamedAPIResource;
version_group: NamedAPIResource;
[property: string]: any;
}
interface MoveMachine {
machine: APIResource;
version_group: NamedAPIResource;
[property: string]: any;
}
interface Meta {