pokenode-ts 1.17.0 → 1.18.0

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.
Files changed (87) hide show
  1. package/README.md +0 -11
  2. package/lib/index.d.ts +4106 -0
  3. package/lib/index.global.js +133 -0
  4. package/lib/index.js +14 -0
  5. package/lib/index.mjs +14 -0
  6. package/package.json +71 -58
  7. package/CHANGELOG.md +0 -7
  8. package/dist/clients/berry.client.js +0 -156
  9. package/dist/clients/contest.client.js +0 -133
  10. package/dist/clients/encounter.client.js +0 -163
  11. package/dist/clients/evolution.client.js +0 -103
  12. package/dist/clients/game.client.js +0 -210
  13. package/dist/clients/index.js +0 -15
  14. package/dist/clients/item.client.js +0 -257
  15. package/dist/clients/location.client.js +0 -210
  16. package/dist/clients/machine.client.js +0 -54
  17. package/dist/clients/main.client.js +0 -48
  18. package/dist/clients/move.client.js +0 -351
  19. package/dist/clients/pokemon.client.js +0 -728
  20. package/dist/clients/utility.client.js +0 -82
  21. package/dist/config/logger.js +0 -28
  22. package/dist/constants/base.js +0 -7
  23. package/dist/constants/berries.js +0 -88
  24. package/dist/constants/contests.js +0 -11
  25. package/dist/constants/encounters.js +0 -88
  26. package/dist/constants/endpoints.js +0 -58
  27. package/dist/constants/evolutions.js +0 -16
  28. package/dist/constants/games.js +0 -114
  29. package/dist/constants/index.js +0 -15
  30. package/dist/constants/items.js +0 -88
  31. package/dist/constants/locations.js +0 -23
  32. package/dist/constants/moves.js +0 -88
  33. package/dist/constants/pokemons.js +0 -148
  34. package/dist/constants/utilities.js +0 -19
  35. package/dist/index.d.ts +0 -3933
  36. package/dist/index.js +0 -9
  37. package/dist/models/Berry/berry.js +0 -2
  38. package/dist/models/Berry/index.js +0 -4
  39. package/dist/models/Common/description.js +0 -2
  40. package/dist/models/Common/effect.js +0 -2
  41. package/dist/models/Common/encounter.js +0 -2
  42. package/dist/models/Common/flavor-text.js +0 -2
  43. package/dist/models/Common/generation.js +0 -2
  44. package/dist/models/Common/index.js +0 -14
  45. package/dist/models/Common/language.js +0 -2
  46. package/dist/models/Common/machine.js +0 -2
  47. package/dist/models/Common/name.js +0 -2
  48. package/dist/models/Common/resource.js +0 -2
  49. package/dist/models/Common/verbose.js +0 -2
  50. package/dist/models/Common/version.js +0 -2
  51. package/dist/models/Contest/contest.js +0 -2
  52. package/dist/models/Contest/index.js +0 -4
  53. package/dist/models/Encounter/encounter.js +0 -2
  54. package/dist/models/Encounter/index.js +0 -4
  55. package/dist/models/Evolution/evolution.js +0 -2
  56. package/dist/models/Evolution/index.js +0 -4
  57. package/dist/models/Game/generation.js +0 -2
  58. package/dist/models/Game/index.js +0 -7
  59. package/dist/models/Game/pokedex.js +0 -2
  60. package/dist/models/Game/pokemon-entry.js +0 -2
  61. package/dist/models/Game/version.js +0 -2
  62. package/dist/models/Item/index.js +0 -4
  63. package/dist/models/Item/item.js +0 -2
  64. package/dist/models/Location/encounter.js +0 -2
  65. package/dist/models/Location/index.js +0 -7
  66. package/dist/models/Location/location.js +0 -2
  67. package/dist/models/Location/palpark.js +0 -2
  68. package/dist/models/Location/region.js +0 -2
  69. package/dist/models/Machine/index.js +0 -4
  70. package/dist/models/Machine/machine.js +0 -2
  71. package/dist/models/Moves/index.js +0 -4
  72. package/dist/models/Moves/moves.js +0 -2
  73. package/dist/models/Pokemon/ability.js +0 -2
  74. package/dist/models/Pokemon/characteristics.js +0 -2
  75. package/dist/models/Pokemon/egg-group.js +0 -2
  76. package/dist/models/Pokemon/gender.js +0 -2
  77. package/dist/models/Pokemon/growth-rates.js +0 -2
  78. package/dist/models/Pokemon/index.js +0 -13
  79. package/dist/models/Pokemon/nature.js +0 -2
  80. package/dist/models/Pokemon/pokeathlon-stat.js +0 -2
  81. package/dist/models/Pokemon/pokemon.js +0 -2
  82. package/dist/models/Pokemon/stats.js +0 -2
  83. package/dist/models/Pokemon/type.js +0 -2
  84. package/dist/models/index.js +0 -14
  85. package/dist/structures/base.js +0 -29
  86. package/dist/structures/index.js +0 -4
  87. package/jest.config.js +0 -25
package/dist/index.d.ts DELETED
@@ -1,3933 +0,0 @@
1
- // Generated by dts-bundle-generator v6.12.0
2
-
3
- import { AxiosInstance } from 'axios';
4
- import { IAxiosCacheAdapterOptions } from 'axios-cache-adapter';
5
- import pino from 'pino';
6
-
7
- /**
8
- * The name and the URL of the referenced resource
9
- */
10
- export interface NamedAPIResource {
11
- /** The name of the referenced resource */
12
- name: string;
13
- /** The URL of the referenced resource */
14
- url: string;
15
- }
16
- /**
17
- * Calling any API endpoint without a resource ID or name will return a paginated list of available resources for that API.
18
- * By default, a list "page" will contain up to 20 resources. If you would like to change this just add a 'limit' query parameter
19
- * to the GET request, e.g. ?=60. You can use 'offset' to move to the next page, e.g. ?limit=60&offset=60
20
- */
21
- export interface NamedAPIResourceList {
22
- /** The total number of resources available from this API */
23
- count: number;
24
- /** The URL for the next page in the list */
25
- next: string | null;
26
- /** The URL for the previous page in the list */
27
- previous: string | null;
28
- /** A list of named API resources */
29
- results: NamedAPIResource[];
30
- }
31
- /** An URL for another resource in the API */
32
- export interface APIResource {
33
- /** The URL of the referenced resource */
34
- url: string;
35
- }
36
- /**
37
- * The localized name for an API resource in a specific language
38
- */
39
- export interface Name {
40
- /** The localized name for an API resource in a specific language */
41
- name: string;
42
- /** The language this name is in */
43
- language: NamedAPIResource;
44
- }
45
- /**
46
- * Languages for translations of API resource information
47
- */
48
- export interface Language {
49
- /** The identifier for this resource */
50
- id: number;
51
- /** The name for this resource */
52
- name: string;
53
- /** Whether or not the games are published in this language */
54
- official: boolean;
55
- /** The two-letter code of the country where this language is spoken. Note that it is not unique */
56
- iso639: string;
57
- /** The two-letter code of the language. Note that it is not unique */
58
- iso3166: string;
59
- /** The name of this resource listed in different languages */
60
- names: Name[];
61
- }
62
- /**
63
- * The localized description for an API resource in a specific language
64
- */
65
- export interface Description {
66
- /** The localized description for an API resource in a specific language. */
67
- description: string;
68
- /** The language this name is in */
69
- language: NamedAPIResource;
70
- }
71
- /**
72
- * The localized effect text for an API resource in a specific language
73
- */
74
- export interface Effect {
75
- /** The localized effect text for an API resource in a specific language. */
76
- effect: string;
77
- /** The language this effect is in */
78
- language: NamedAPIResource;
79
- }
80
- /** Information of a pokemon encounter */
81
- export interface Encounter {
82
- /** The lowest level the Pokémon could be encountered at */
83
- min_level: number;
84
- /** The highest level the Pokémon could be encountered at */
85
- max_level: number;
86
- /** A list of condition values that must be in effect for this encounter to occur */
87
- condition_values: NamedAPIResource[];
88
- /** Percent chance that this encounter will occur */
89
- chance: number;
90
- /** The method by which this encounter happens */
91
- method: NamedAPIResource;
92
- }
93
- /**
94
- * The localized flavor text for an API resource in a specific language
95
- */
96
- export interface FlavorText {
97
- /** The localized flavor text for an API resource in a specific language */
98
- flavor_text: string;
99
- /** The language this name is in */
100
- language: NamedAPIResource;
101
- }
102
- /**
103
- * The generation relevent to this game index
104
- */
105
- export interface GenerationGameIndex {
106
- /** The internal id of an API resource within game data */
107
- game_index: number;
108
- /** The generation relevent to this game index */
109
- generation: NamedAPIResource;
110
- }
111
- /**
112
- * The machine that teaches a move from an item
113
- */
114
- export interface MachineVersionDetail {
115
- /** The machine that teaches a move from an item */
116
- machine: APIResource;
117
- /** The version group of this specific machine */
118
- version_group: NamedAPIResource;
119
- }
120
- /**
121
- * The localized effect for an API resource
122
- */
123
- export interface VerboseEffect {
124
- /** The localized effect text for an API resource in a specific language */
125
- effect: string;
126
- /** The localized effect text in brief */
127
- short_effect: string;
128
- /** The language this effect is in */
129
- language: NamedAPIResource;
130
- }
131
- /**
132
- * Encounters and their specifics details
133
- */
134
- export interface VersionEncounterDetail {
135
- /** The game version this encounter happens in */
136
- version: NamedAPIResource;
137
- /** The total percentage of all encounter potential */
138
- max_chance: number;
139
- /** A list of encounters and their specifics */
140
- encounter_details: Encounter[];
141
- }
142
- /**
143
- * The internal id and version of an API resource
144
- */
145
- export interface VersionGameIndex {
146
- /** The internal id of an API resource within game data */
147
- game_index: number;
148
- /** The version relevent to this game index */
149
- version: NamedAPIResource;
150
- }
151
- /**
152
- * The flavor text of an API resource
153
- */
154
- export interface VersionGroupFlavorText {
155
- /** The localized name for an API resource in a specific language */
156
- text: string;
157
- /** The language this name is in */
158
- language: NamedAPIResource;
159
- /** The version group which uses this flavor text */
160
- version_group: NamedAPIResource;
161
- }
162
- /**
163
- * ## Berry
164
- * Berries are small fruits that can provide HP and status condition restoration,
165
- * stat enhancement, and even damage negation when eaten by Pokémon.
166
- *
167
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail
168
- */
169
- export interface Berry {
170
- /** The identifier for this resource */
171
- id: number;
172
- /** The name for this resource */
173
- name: string;
174
- /** 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 */
175
- growth_time: number;
176
- /** The maximum number of these berries that can grow on one tree in Generation IV */
177
- max_harvest: number;
178
- /** The power of the move "Natural Gift" when used with this Berry */
179
- natural_gift_power: number;
180
- /** The size of this Berry, in millimeters */
181
- size: number;
182
- /** The smoothness of this Berry, used in making Pokéblocks or Poffins */
183
- smoothness: number;
184
- /** The speed at which this Berry dries out the soil as it grows. A higher rate means the soil dries more quickly */
185
- soil_dryness: number;
186
- /** The firmness of this berry, used in making Pokéblocks or Poffins */
187
- firmness: NamedAPIResource;
188
- /** A list of references to each flavor a berry can have and the potency of each of those flavors in regard to this berry */
189
- flavors: BerryFlavorMap[];
190
- /** Berries are actually items. This is a reference to the item specific data for this berry */
191
- item: NamedAPIResource;
192
- /** The type inherited by "Natural Gift" when used with this Berry */
193
- natural_gift_type: NamedAPIResource;
194
- }
195
- /**
196
- * Reference to the flavor a berry can have and the potency of each of those flavors in regard to this berry
197
- */
198
- export interface BerryFlavorMap {
199
- /** How powerful the referenced flavor is for this berry */
200
- potency: number;
201
- /** The referenced berry flavor */
202
- flavor: NamedAPIResource;
203
- }
204
- /**
205
- * ## Berry Flavor
206
- * Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their nature.
207
- *
208
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail.
209
- */
210
- export interface BerryFlavor {
211
- /** The identifier for this resource */
212
- id: number;
213
- /** The name for this resource */
214
- name: "spicy" | "dry" | "sweet" | "bitter" | "sour";
215
- /** A list of the berries with this flavor */
216
- berries: FlavorBerryMap[];
217
- /** The contest type that correlates with this berry flavor */
218
- contest_type: NamedAPIResource;
219
- /** The name of this resource listed in different languages */
220
- names: Name[];
221
- }
222
- /**
223
- * Berry with the given flavor
224
- */
225
- export interface FlavorBerryMap {
226
- /** How powerful the referenced flavor is for this berry */
227
- potency: number;
228
- /** The berry with the referenced flavor */
229
- berry: NamedAPIResource;
230
- }
231
- /**
232
- * ## Berry Firmness
233
- * Berries can be soft, very soft, hard, super hard or very hard.
234
- *
235
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail
236
- */
237
- export interface BerryFirmness {
238
- /** The identifier for this resource */
239
- id: number;
240
- /** The name for this resource */
241
- name: "very-soft" | "soft" | "hard" | "very-hard" | "super-hard";
242
- /** A list of the berries with this firmness */
243
- berries: NamedAPIResource[];
244
- /** The name of this resource listed in different languages */
245
- names: Name[];
246
- }
247
- /**
248
- * ## Contest Type
249
- * Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests.
250
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail
251
- */
252
- export interface ContestType {
253
- /** The identifier for this resource */
254
- id: number;
255
- /** The name for this resource */
256
- name: "cool" | "beauty" | "cute" | "smart" | "tough";
257
- /** The berry flavor that correlates with this contest type */
258
- berry_flavor: NamedAPIResource;
259
- /** The name of this contest type listed in different languages */
260
- names: ContestName[];
261
- }
262
- /**
263
- * The name of the given contest type
264
- */
265
- export interface ContestName {
266
- /** The name for this contest */
267
- name: string;
268
- /** The color associated with this contest's name */
269
- color: string;
270
- /** The language that this name is in */
271
- language: NamedAPIResource;
272
- }
273
- /**
274
- * ## Contest Effect
275
- * Contest effects refer to the effects of moves when used in contests
276
- */
277
- export interface ContestEffect {
278
- /** The identifier for this resource */
279
- id: number;
280
- /** The base number of hearts the user of this move gets */
281
- appeal: number;
282
- /** The base number of hearts the user's opponent loses */
283
- jam: number;
284
- /** The result of this contest effect listed in different languages */
285
- effect_entries: Effect[];
286
- /** The flavor text of this contest effect listed in different languages */
287
- flavor_text_entries: FlavorText[];
288
- }
289
- /**
290
- * ## Super Contest Effect
291
- * Super contest effects refer to the effects of moves when used in super contests.
292
- * A Pokémon Super Contest is an expanded format of the [Pokémon Contests](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Contest)
293
- * for the Generation IV games,
294
- * specifically in [Diamond, Pearl](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Diamond_and_Pearl_Versions),
295
- * and [Platinum](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Platinum_Version).
296
- * In it, Pokémon are rated on their appearance and performance, rather than strength.
297
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Super_Contest)
298
- */
299
- export interface SuperContestEffect {
300
- /** The identifier for this resource */
301
- id: number;
302
- /** The level of appeal this super contest effect has */
303
- appeal: number;
304
- /** The flavor text of this super contest effect listed in different languages */
305
- flavor_text_entries: FlavorText[];
306
- /** A list of moves that have the effect when used in super contests */
307
- moves: NamedAPIResource[];
308
- }
309
- /**
310
- * ## Encounter Method
311
- * Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass.
312
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Wild_Pok%C3%A9mon) for greater detail.
313
- */
314
- export interface EncounterMethod {
315
- /** The identifier for this resource */
316
- id: number;
317
- /** The name for this resource */
318
- name: string;
319
- /** A good value for sorting */
320
- order: number;
321
- /** The name of this resource listed in different languages */
322
- names: Name[];
323
- }
324
- /**
325
- * ## Encounter Condition
326
- * Conditions which affect what pokemon might appear in the wild, e.g., day or night.
327
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Time)
328
- */
329
- export interface EncounterCondition {
330
- /** The identifier for this resource */
331
- id: number;
332
- /** The name for this resource */
333
- name: string;
334
- /** The name of this resource listed in different languages */
335
- names: Name[];
336
- /** A list of possible values for this encounter condition */
337
- values: NamedAPIResource[];
338
- }
339
- /**
340
- * ## Encounter Condition Value
341
- * Encounter condition values are the various states that an encounter
342
- * condition can have, i.e., time of day can be either **day** or **night**
343
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Time)
344
- */
345
- export interface EncounterConditionValue {
346
- /** The identifier for this resource */
347
- id: number;
348
- /** The name for this resource */
349
- name: string;
350
- /** The condition this encounter condition value pertains to */
351
- condition: NamedAPIResource;
352
- /** The name of this resource listed in different languages */
353
- names: Name[];
354
- }
355
- /**
356
- * Evolution Detail
357
- * All details regarding the specific details of the referenced Pokémon species evolution.
358
- */
359
- export interface EvolutionDetail {
360
- /** The item required to cause evolution this into Pokémon species. */
361
- item: NamedAPIResource | null;
362
- /** The type of event that triggers evolution into this Pokémon species. */
363
- trigger: NamedAPIResource;
364
- /** The id of the gender of the evolving Pokémon species must be in order to evolve into this Pokémon species. */
365
- gender: number | null;
366
- /** The item the evolving Pokémon species must be holding during the evolution trigger event to evolve into this Pokémon species. */
367
- held_item: NamedAPIResource | null;
368
- /** 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. */
369
- known_move: NamedAPIResource | null;
370
- /** 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. */
371
- known_move_type: NamedAPIResource | null;
372
- /** The location the evolution must be triggered at. */
373
- location: NamedAPIResource | null;
374
- /** The minimum required level of the evolving Pokémon species to evolve into this Pokémon species. */
375
- min_level: number | null;
376
- /** The minimum required level of happiness the evolving Pokémon species to evolve into this Pokémon species. */
377
- min_happiness: number | null;
378
- /** The minimum required level of beauty the evolving Pokémon species to evolve into this Pokémon species. */
379
- min_beauty: number | null;
380
- /** The minimum required level of affection the evolving Pokémon species to evolve into this Pokémon species. */
381
- min_affection: number | null;
382
- /** Whether or not it must be raining in the overworld to cause evolution this Pokémon species. */
383
- needs_overworld_rain: boolean;
384
- /** 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. */
385
- party_species: NamedAPIResource | null;
386
- /**
387
- * The player must have a Pokémon of this type in their party during the evolution trigger event
388
- * in order for the evolving Pokémon species to evolve into this Pokémon species.
389
- */
390
- party_type: NamedAPIResource | null;
391
- /** The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense. */
392
- relative_physical_stats: 1 | 0 | -1 | null;
393
- /** The required time of day. Day or night. */
394
- time_of_day: "Day" | "Night" | "";
395
- /** Pokémon species for which this one must be traded. */
396
- trade_species: NamedAPIResource | null;
397
- /** Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up. */
398
- turn_upside_down: boolean;
399
- }
400
- /**
401
- * ## Chain Link
402
- * Contains evolution details for a Pokémon in the chain.
403
- * Each link references the next Pokémon in the natural evolution order
404
- */
405
- export interface ChainLink {
406
- /** Whether or not this link is for a baby Pokémon. This would only ever be true on the base link */
407
- is_baby: boolean;
408
- /** The Pokémon species at this point in the evolution chain */
409
- species: NamedAPIResource;
410
- /** All details regarding the specific details of the referenced Pokémon species evolution */
411
- evolution_details: EvolutionDetail[];
412
- /** A List of chain objects */
413
- evolves_to: ChainLink[];
414
- }
415
- /**
416
- * ## Evolution Chain
417
- * Evolution chains are essentially family trees.
418
- * They start with the lowest stage within a family and detail
419
- * evolution conditions for each as well as Pokémon they can evolve
420
- * into up through the hierarchy.
421
- */
422
- export interface EvolutionChain {
423
- /** The identifier for this resource */
424
- id: number;
425
- /**
426
- * The item that a Pokémon would be holding when mating that would trigger
427
- * the egg hatching a baby Pokémon rather than a basic Pokémon
428
- */
429
- baby_trigger_item: NamedAPIResource | null;
430
- /**
431
- * The base chain link object. Each link contains evolution details for a Pokémon in the chain.
432
- * Each link references the next Pokémon in the natural evolution order
433
- */
434
- chain: ChainLink;
435
- }
436
- /**
437
- * ## Evolution Trigger
438
- * Evolution triggers are the events and conditions that cause a Pokémon to evolve.
439
- * There are numerous methods of evolution which define how and when Pokémon evolve.
440
- * Most Pokémon will evolve by leveling up while others evolve through specific means,
441
- * such as being traded, achieving a certain amount of friendship or leveling at certain times, among others.
442
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail.
443
- */
444
- export interface EvolutionTrigger {
445
- /** The identifier for this resource. */
446
- id: number;
447
- /** The name for this resource. */
448
- name: "level-up" | "trade" | "use-item" | "shed" | "other";
449
- /** The name of this resource listed in different languages. */
450
- names: Name[];
451
- /** A list of pokemon species that result from this evolution trigger. */
452
- pokemon_species: NamedAPIResource[];
453
- }
454
- /**
455
- * ## Generation
456
- * A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include.
457
- * In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.
458
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Generation) for greater details.
459
- */
460
- export interface Generation {
461
- /** The identifier for this resource */
462
- id: number;
463
- /** The name for this resource */
464
- name: string;
465
- /** A list of abilities that were introduced in this generation */
466
- abilities: NamedAPIResource[];
467
- /** The name of this resource listed in different languages */
468
- names: Name[];
469
- /** The main region travelled in this generation */
470
- main_region: NamedAPIResource;
471
- /** A list of moves that were introduced in this generation */
472
- moves: NamedAPIResource[];
473
- /** A list of Pokémon species that were introduced in this generation */
474
- pokemon_species: NamedAPIResource[];
475
- /** A list of types that were introduced in this generation */
476
- types: NamedAPIResource[];
477
- /** A list of version groups that were introduced in this generation */
478
- version_groups: NamedAPIResource[];
479
- }
480
- /**
481
- * Catalogued pokémon for pokedex
482
- */
483
- export interface PokemonEntry {
484
- /** The index of this Pokémon species entry within the Pokédex */
485
- entry_number: number;
486
- /** The Pokémon species being encountered */
487
- pokemon_species: NamedAPIResource;
488
- }
489
- /**
490
- * ## Pokedex
491
- * A Pokédex is a handheld electronic encyclopedia device;
492
- * one which is capable of recording and retaining information of the various Pokémon in a given region
493
- * with the exception of the national dex and some smaller dexes related to portions of a region.
494
- * - See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9dex) for greater detail
495
- */
496
- export interface Pokedex {
497
- /** The identifier for this resource */
498
- id: number;
499
- /** The name for this resource */
500
- name: string;
501
- /** Whether or not this Pokédex originated in the main series of the video games */
502
- is_main_series: boolean;
503
- /** The description of this resource listed in different languages */
504
- descriptions: Description[];
505
- /** The name of this resource listed in different languages */
506
- names: Name[];
507
- /** A list of Pokémon catalogued in this Pokédex and their indexes */
508
- pokemon_entries: PokemonEntry[];
509
- /** The region this Pokédex catalogues Pokémon for */
510
- region: NamedAPIResource | null;
511
- /** A list of version groups this Pokédex is relevant to */
512
- version_groups: NamedAPIResource[];
513
- }
514
- /**
515
- * ## Version
516
- * Versions of the games, e.g., Red, Blue or Yellow,
517
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Core_series) for greater details.
518
- */
519
- export interface Version {
520
- /** The identifier for this resource */
521
- id: number;
522
- /** The name for this resource */
523
- name: string;
524
- /** The name of this resource listed in different languages */
525
- names: Name[];
526
- /** The version group this version belongs to */
527
- version_group: NamedAPIResource;
528
- }
529
- /**
530
- * ## Version Group
531
- * Version groups categorize highly similar versions of the games
532
- */
533
- export interface VersionGroup {
534
- /** The identifier for this resource */
535
- id: number;
536
- /** The name for this resource */
537
- name: string;
538
- /** Order for sorting. Almost by date of release, except similar versions are grouped together */
539
- order: number;
540
- /** The generation this version was introduced in */
541
- generation: NamedAPIResource;
542
- /** A list of methods in which Pokémon can learn moves in this version group */
543
- move_learn_methods: NamedAPIResource[];
544
- /** A list of Pokédexes introduces in this version group */
545
- pokedexes: NamedAPIResource[];
546
- /** A list of regions that can be visited in this version group */
547
- regions: NamedAPIResource[];
548
- /** The versions this version group owns */
549
- versions: NamedAPIResource[];
550
- }
551
- /**
552
- * Sprites used to depict the given item in the game
553
- */
554
- export interface ItemSprites {
555
- /** The default depiction of this item */
556
- default: string;
557
- }
558
- /**
559
- * Pokémon that might be found in the wild holding the given item
560
- */
561
- export interface ItemHolderPokemon {
562
- /** The Pokémon that holds this item */
563
- pokemon: NamedAPIResource;
564
- /** The details for the version that this item is held in by the Pokémon */
565
- version_details: ItemHolderPokemonVersionDetail[];
566
- }
567
- /**
568
- * The details for the version that the given item is held in by the Pokémon
569
- */
570
- export interface ItemHolderPokemonVersionDetail {
571
- /** How often this Pokémon holds this item in this version */
572
- rarity: number;
573
- /** The version that this item is held in by the Pokémon */
574
- version: NamedAPIResource;
575
- }
576
- /**
577
- * ## Item Attribute
578
- * Item attributes define particular aspects of items, e.g. "usable in battle" or "consumable"
579
- */
580
- export interface ItemAttribute {
581
- /** The identifier for this resource */
582
- id: number;
583
- /** The name for this resource */
584
- name: string;
585
- /** A list of items that have this attribute */
586
- items: NamedAPIResource[];
587
- /** The name of this item attribute listed in different languages */
588
- names: Name[];
589
- /** The description of this item attribute listed in different languages */
590
- descriptions: Description[];
591
- }
592
- /**
593
- * ## Item Category
594
- * Item categories determine where items will be placed in the players bag
595
- */
596
- export interface ItemCategory {
597
- /** The identifier for this resource */
598
- id: number;
599
- /** The name for this resource */
600
- name: string;
601
- /** A list of items that are a part of this category */
602
- items: NamedAPIResource[];
603
- /** The name of this item category listed in different languages */
604
- names: Name[];
605
- /** The pocket items in this category would be put in */
606
- pocket: NamedAPIResource;
607
- }
608
- /**
609
- * ## Item Fling Effect
610
- * The various effects of the move "Fling" when used with different items
611
- */
612
- export interface ItemFlingEffect {
613
- /** The identifier for this resource */
614
- id: number;
615
- /** The name for this resource */
616
- name: string;
617
- /** The result of this fling effect listed in different languages */
618
- effect_entries: Effect[];
619
- /** A list of items that have this fling effect */
620
- items: NamedAPIResource[];
621
- }
622
- /**
623
- * ## Item Pocket
624
- * Pockets within the players bag used for storing items by category
625
- */
626
- export interface ItemPocket {
627
- /** The identifier for this resource */
628
- id: number;
629
- /** The name for this resource */
630
- name: string;
631
- /** A list of item categories that are relevant to this item pocket */
632
- categories: NamedAPIResource[];
633
- /** The name of this resource listed in different languages */
634
- names: Name[];
635
- }
636
- /**
637
- * ## Item
638
- * An item is an object in the games which the player can pick up, keep in their bag, and use in some manner.
639
- * They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area.
640
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Item)
641
- */
642
- export interface Item {
643
- /** The identifier for this resource */
644
- id: number;
645
- /** The name for this resource */
646
- name: string;
647
- /** The price of this item in stores */
648
- cost: number;
649
- /** The power of the move Fling when used with this item. */
650
- fling_power: number | null;
651
- /** The effect of the move Fling when used with this item */
652
- fling_effect: NamedAPIResource | null;
653
- /** A list of attributes this item has */
654
- attributes: NamedAPIResource[];
655
- /** The category of items this item falls into */
656
- category: NamedAPIResource;
657
- /** The effect of this ability listed in different languages */
658
- effect_entries: VerboseEffect[];
659
- /** The flavor text of this ability listed in different languages */
660
- flavor_text_entries: VersionGroupFlavorText[];
661
- /** A list of game indices relevent to this item by generation */
662
- game_indices: GenerationGameIndex[];
663
- /** The name of this item listed in different languages */
664
- names: Name[];
665
- /** A set of sprites used to depict this item in the game */
666
- sprites: ItemSprites;
667
- /** A list of Pokémon that might be found in the wild holding this item */
668
- held_by_pokemon: ItemHolderPokemon[];
669
- /** An evolution chain this item requires to produce a bay during mating */
670
- baby_trigger_for: APIResource | null;
671
- /** A list of the machines related to this item */
672
- machines: MachineVersionDetail[];
673
- }
674
- /**
675
- * Method in which Pokémon may be encountered in the given area
676
- * and how likely the method will occur depending on the version of the game
677
- */
678
- export interface EncounterMethodRate {
679
- /** The method in which Pokémon may be encountered in an area */
680
- encounter_method: NamedAPIResource;
681
- /** The chance of the encounter to occur on a version of the game */
682
- version_details: EncounterVersionDetails[];
683
- }
684
- /**
685
- * The chance of the encounter to occur on a version of the game
686
- */
687
- export interface EncounterVersionDetails {
688
- /** The chance of an encounter to occur */
689
- rate: number;
690
- /** The version of the game in which the encounter can occur with the given chance */
691
- version: NamedAPIResource;
692
- }
693
- /**
694
- * Describes a pokémon encounter in a given area
695
- */
696
- export interface PokemonEncounter {
697
- /** The Pokémon being encountered */
698
- pokemon: NamedAPIResource;
699
- /** A list of versions and encounters with Pokémon that might happen in the referenced location area */
700
- version_details: VersionEncounterDetail[];
701
- }
702
- /**
703
- * ## Location
704
- * Locations that can be visited within the games.
705
- * Locations make up sizable portions of regions, like cities or routes.
706
- * - Check the [List of Locations](https://bulbapedia.bulbagarden.net/wiki/List_of_locations_by_name)
707
- */
708
- export interface Location {
709
- /** The identifier for this resource */
710
- id: number;
711
- /** The name for this resource */
712
- name: string;
713
- /** The region this location can be found in */
714
- region: NamedAPIResource | null;
715
- /** The name of this resource listed in different languages */
716
- names: Name[];
717
- /** A list of game indices relevent to this location by generation */
718
- game_indices: GenerationGameIndex[];
719
- /** Areas that can be found within this location */
720
- areas: NamedAPIResource[];
721
- }
722
- /**
723
- * ## Location Area
724
- * Location areas are sections of areas, such as floors in a building or cave.
725
- * Each area has its own set of possible Pokémon encounters.
726
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Area) for more details.
727
- */
728
- export interface LocationArea {
729
- /** The identifier for this resource */
730
- id: number;
731
- /** The name for this resource */
732
- name: string;
733
- /** The internal id of an API resource within game data */
734
- game_index: number;
735
- /** 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 */
736
- encounter_method_rates: EncounterMethodRate[];
737
- /** The region this location area can be found in */
738
- location: NamedAPIResource;
739
- /** The name of this resource listed in different languages */
740
- names: Name[];
741
- /** A list of Pokémon that can be encountered in this area along with version specific details about the encounter */
742
- pokemon_encounters: PokemonEncounter[];
743
- }
744
- /**
745
- * ## Pal Park Area
746
- * Areas used for grouping Pokémon encounters in Pal Park.
747
- * They're like habitats that are specific to Pal Park.
748
- * Pal Park is divided into five separate areas:
749
- * ---
750
- * - [Field](https://bulbapedia.bulbagarden.net/wiki/List_of_Pok%C3%A9mon_by_Pal_Park_location#Field)
751
- * - [Forest](https://bulbapedia.bulbagarden.net/wiki/List_of_Pok%C3%A9mon_by_Pal_Park_location#Forest)
752
- * - [Mountain](https://bulbapedia.bulbagarden.net/wiki/List_of_Pok%C3%A9mon_by_Pal_Park_location#Mountain)
753
- * - [Pond](https://bulbapedia.bulbagarden.net/wiki/List_of_Pok%C3%A9mon_by_Pal_Park_location#Pound)
754
- * - [Sea](https://bulbapedia.bulbagarden.net/wiki/List_of_Pok%C3%A9mon_by_Pal_Park_location#Sea)
755
- * - [Trivia](https://bulbapedia.bulbagarden.net/wiki/List_of_Pok%C3%A9mon_by_Pal_Park_location#Trivia)
756
- * ---
757
- * Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Pal_Park) for greater details.
758
- */
759
- export interface PalParkArea {
760
- /** The identifier for this resource */
761
- id: number;
762
- /** The name for this resource */
763
- name: string;
764
- /** The name of this resource listed in different languages */
765
- names: Name[];
766
- /** A list of Pokémon encountered in thi pal park area along with details */
767
- pokemon_encounters: PalParkEncounterSpecies[];
768
- }
769
- /**
770
- * Detais of a Pokémon encountered in thi Pal Park area
771
- */
772
- export interface PalParkEncounterSpecies {
773
- /** The base score given to the player when this Pokémon is caught during a pal park run */
774
- base_score: number;
775
- /** The base rate for encountering this Pokémon in this pal park area */
776
- rate: number;
777
- /** The Pokémon species being encountered */
778
- pokemon_species: NamedAPIResource;
779
- }
780
- /**
781
- * ## Region
782
- * A region is an organized area of the Pokémon world.
783
- * Most often, the main difference between regions is
784
- * the species of Pokémon that can be encountered within them.
785
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Region) for greater details.
786
- */
787
- export interface Region {
788
- /** The identifier for this resource */
789
- id: number;
790
- /** A list of locations that can be found in this region */
791
- locations: NamedAPIResource[];
792
- /** The name for this resource */
793
- name: string;
794
- /** The name of this resource listed in different languages */
795
- names: Name[];
796
- /** The generation this region was introduced in */
797
- main_generation: NamedAPIResource;
798
- /** A list of pokédexes that catalogue Pokémon in this region */
799
- pokedexes: NamedAPIResource[];
800
- /** A list of version groups where this region can be visited */
801
- version_groups: NamedAPIResource[];
802
- }
803
- /**
804
- * ## Machine
805
- * Machines are the representation of items that teach moves to Pokémon.
806
- * They vary from version to version, so it is not certain that one specific
807
- * [TM (Technical Machine)](https://bulbapedia.bulbagarden.net/wiki/TM) or
808
- * [HM (Hidden Machine)](https://bulbapedia.bulbagarden.net/wiki/HM) corresponds to a single Machine.
809
- */
810
- export interface Machine {
811
- /** The identifier for this resource */
812
- id: number;
813
- /** The TM or HM item that corresponds to this machine */
814
- item: NamedAPIResource;
815
- /** The move that is taught by this machine */
816
- move: NamedAPIResource;
817
- /** The version group that this machine applies to */
818
- version_group: NamedAPIResource;
819
- }
820
- /**
821
- * ## Ability
822
- * Abilities provide passive effects for Pokémon in battle or in the overworld.
823
- * Pokémon have multiple possible abilities but can have only one ability at a time.
824
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail.
825
- */
826
- export interface Ability {
827
- /** The identifier for this resource */
828
- id: number;
829
- /** The name for this resource */
830
- name: string;
831
- /** Whether or not this ability originated in the main series of the video games */
832
- is_main_series: boolean;
833
- /** The generation this ability originated in */
834
- generation: NamedAPIResource;
835
- /** The name of this resource listed in different languages */
836
- names: Name[];
837
- /** The effect of this ability listed in different languages */
838
- effect_entries: VerboseEffect[];
839
- /** The list of previous effects this ability has had across version groups */
840
- effect_changes: AbilityEffectChange[];
841
- /** The flavor text of this ability listed in different languages */
842
- flavor_text_entries: AbilityFlavorText[];
843
- /** A list of Pokémon that could potentially have this ability */
844
- pokemon: AbilityPokemon[];
845
- }
846
- /**
847
- * Previous effects an ability has had across version groups
848
- */
849
- export interface AbilityEffectChange {
850
- /** The previous effect of this ability listed in different languages */
851
- effect_entries: Effect[];
852
- /** The version group in which the previous effect of this ability originated */
853
- version_group: NamedAPIResource;
854
- }
855
- /**
856
- * The flavor text of an ability
857
- */
858
- export interface AbilityFlavorText {
859
- /** The localized name for an API resource in a specific language */
860
- flavor_text: string;
861
- /** The language this text resource is in */
862
- language: NamedAPIResource;
863
- /** The version group that uses this flavor text */
864
- version_group: NamedAPIResource;
865
- }
866
- /**
867
- * Pokémon that could potentially have the given ability
868
- */
869
- export interface AbilityPokemon {
870
- /** Whether or not this a hidden ability for the referenced Pokémon */
871
- is_hidden: boolean;
872
- /**
873
- * Pokémon have 3 ability 'slots' which hold references to possible abilities they could have.
874
- * This is the slot of this ability for the referenced pokemon
875
- */
876
- slot: number;
877
- /** The Pokémon this ability could belong to */
878
- pokemon: NamedAPIResource;
879
- }
880
- /**
881
- * ## Characteristic
882
- * Characteristics indicate which stat contains a Pokémon's highest IV.
883
- * A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo).
884
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail
885
- */
886
- export interface Characteristic {
887
- /** The identifier for this resource */
888
- id: number;
889
- /** The remainder of the highest stat/IV divided by 5 */
890
- gene_modulo: number;
891
- /** The possible values of the highest stat that would result in a Pokémon recieving this characteristic when divided by 5 */
892
- possible_values: number[];
893
- /** The highest stat for the referenced characteristic */
894
- highest_stat: NamedAPIResource;
895
- /** Descriptions for the referenced characteristic */
896
- descriptions: Description[];
897
- }
898
- /**
899
- * ## Egg Group
900
- * Egg Groups are categories which determine which Pokémon are able to interbreed.
901
- * Pokémon may belong to either one or two Egg Groups.
902
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater details.
903
- */
904
- export interface EggGroup {
905
- /** The identifier for this resource */
906
- id: number;
907
- /** The name for this resource */
908
- name: "monster" | "water1" | "water2" | "water3" | "bug" | "flying" | "ground" | "fairy" | "plant" | "humanshape" | "mineral" | "indeterminate" | "ditto" | "dragon" | "no-eggs";
909
- /** The name of this resource listed in different languages */
910
- names: Name[];
911
- /** A list of all Pokémon species that are members of this egg group */
912
- pokemon_species: NamedAPIResource[];
913
- }
914
- /**
915
- * ## Gender
916
- * Genders were introduced in Generation II for the purposes of breeding Pokémon
917
- * but can also result in visual differences or even different evolutionary lines.
918
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Gender) for greater details.
919
- */
920
- export interface Gender {
921
- /** The identifier for this resource */
922
- id: number;
923
- /** The name for this resource */
924
- name: "male" | "female" | "genderless";
925
- /** A list of Pokémon species that can be this gender and how likely it is that they will be */
926
- pokemon_species_details: PokemonSpeciesGender[];
927
- /** A list of Pokémon species that required this gender in order for a Pokémon to evolve into them */
928
- required_for_evolution: NamedAPIResource[];
929
- }
930
- /**
931
- * Pokémon species that can be this gender and how likely it is that they will be
932
- */
933
- export interface PokemonSpeciesGender {
934
- /** The chance of this Pokémon being female, in eighths; or -1 for genderless */
935
- rate: number;
936
- /** A Pokémon species that can be the referenced gender */
937
- pokemon_species: NamedAPIResource;
938
- }
939
- /**
940
- * Levels and the amount of experienced needed to atain them based on the given growth rate.
941
- */
942
- export interface GrowthRateExperienceLevel {
943
- /** The level gained. */
944
- level: number;
945
- /** The amount of experience required to reach the referenced level. */
946
- experience: number;
947
- }
948
- /**
949
- * ## Growth Rate
950
- * Growth rates are the speed with which Pokémon gain levels through experience.
951
- * - Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Experience) for greater details.
952
- */
953
- export interface GrowthRate {
954
- /** The identifier for this resource */
955
- id: number;
956
- /** The name for this resource */
957
- name: "slow" | "medium" | "fast" | "medium-slow" | "slow-then-very-fast" | "fast-then-very-slow";
958
- /** The formula used to calculate the rate at which the Pokémon species gains level */
959
- formula: string;
960
- /** The descriptions of this characteristic listed in different languages */
961
- descriptions: Description[];
962
- /** A list of levels and the amount of experienced needed to atain them based on this growth rate. */
963
- levels: GrowthRateExperienceLevel[];
964
- /** A list of Pokémon species that gain levels at this growth rate */
965
- pokemon_species: NamedAPIResource[];
966
- }
967
- /**
968
- * ## Nature
969
- * Natures influence how a Pokémon's stats grow.
970
- * - See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail
971
- */
972
- export interface Nature {
973
- /** The identifier for this resource */
974
- id: number;
975
- /** The name for this resource */
976
- name: string;
977
- /** The stat decreased by 10% in Pokémon with this nature */
978
- decreased_stat: NamedAPIResource | null;
979
- /** The stat increased by 10% in Pokémon with this nature */
980
- increased_stat: NamedAPIResource | null;
981
- /** The flavor hated by Pokémon with this nature */
982
- hates_flavor: NamedAPIResource | null;
983
- /** The flavor liked by Pokémon with this nature */
984
- likes_flavor: NamedAPIResource | null;
985
- /** A list of Pokéathlon stats this nature effects and how much it effects them */
986
- pokeathlon_stat_changes: NatureStatChange[];
987
- /** A list of battle styles and how likely a Pokémon with this nature is to use them in the Battle Palace or Battle Tent */
988
- move_battle_style_preferences: MoveBattleStylePreference[];
989
- /** The name of this resource listed in different languages */
990
- names: Name[];
991
- }
992
- /**
993
- * Pokéathlon stats a nature effects and how much it effects it
994
- */
995
- export interface NatureStatChange {
996
- /** The amount of change */
997
- max_change: -1 | 1 | -2 | 2;
998
- /** The stat being affected */
999
- pokeathlon_stat: NamedAPIResource;
1000
- }
1001
- /**
1002
- * Battle Style and how likely a Pokémon with the given nature is to use them
1003
- * in the Battle Palace or Battle Tent
1004
- */
1005
- export interface MoveBattleStylePreference {
1006
- /** Chance of using the move, in percent, if HP is under one half */
1007
- low_hp_preference: number;
1008
- /** Chance of using the move, in percent, if HP is over one half */
1009
- high_hp_preference: number;
1010
- /** The move battle style */
1011
- move_battle_style: NamedAPIResource;
1012
- }
1013
- /**
1014
- * ## Pokeathlon Stat
1015
- * Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons.
1016
- * In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats.
1017
- * - See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater details.
1018
- */
1019
- export interface PokeathlonStat {
1020
- /** The identifier for this resource */
1021
- id: number;
1022
- /** The name for this resource */
1023
- name: "speed" | "power" | "skill" | "stamina" | "jump";
1024
- /** The name of this resource listed in different languages */
1025
- names: Name[];
1026
- /** A detail of natures which affect this Pokéathlon stat positively or negatively */
1027
- affecting_natures: NaturePokeathlonStatAffectSets;
1028
- }
1029
- /**
1030
- * A nature and how it change the referenced Pokéathlon stat
1031
- */
1032
- export interface NaturePokeathlonStatAffect {
1033
- /** The maximum amount of change to the referenced Pokéathlon stat. */
1034
- max_change: -1 | -2 | 1 | 2;
1035
- /** The nature causing the change */
1036
- nature: NamedAPIResource;
1037
- }
1038
- /**
1039
- * A detail of natures which affect this Pokéathlon stat positively or negatively
1040
- */
1041
- export interface NaturePokeathlonStatAffectSets {
1042
- /** A list of natures and how they change the referenced Pokéathlon stat */
1043
- increase: NaturePokeathlonStatAffect[];
1044
- /** A list of natures and how they change the referenced Pokéathlon stat */
1045
- decrease: NaturePokeathlonStatAffect[];
1046
- }
1047
- /**
1048
- * ## Stat
1049
- * Stats determine certain aspects of battles. Each Pokémon has a value for each stat
1050
- * which grows as they gain levels and can be altered momentarily by effects in battles
1051
- */
1052
- export interface Stat {
1053
- /** The identifier for this resource */
1054
- id: number;
1055
- /** The name for this resource */
1056
- name: "hp" | "attack" | "defense" | "special-attack" | "special-defense" | "speed" | "accuracy" | "evasion";
1057
- /** ID the games use for this stat */
1058
- game_index: number;
1059
- /** Whether this stat only exists within a battle */
1060
- is_battle_only: boolean;
1061
- /** A detail of moves which affect this stat positively or negatively */
1062
- affecting_moves: MoveStatAffectSets;
1063
- /** A detail of natures which affect this stat positively or negatively */
1064
- affecting_natures: NatureStatAffectSets;
1065
- /** A list of characteristics that are set on a Pokémon when its highest base stat is this stat */
1066
- characteristics: APIResource[];
1067
- /** The class of damage this stat is directly related to */
1068
- move_damage_class: NamedAPIResource | null;
1069
- /** The name of this resource listed in different languages */
1070
- names: Name[];
1071
- }
1072
- /**
1073
- * A detail of nature which affect the given stat stat positively or negatively
1074
- */
1075
- export interface NatureStatAffectSets {
1076
- /** A list of natures and how they change the referenced stat */
1077
- increase: NamedAPIResource[];
1078
- /** A list of nature sand how they change the referenced stat */
1079
- decrease: NamedAPIResource[];
1080
- }
1081
- /**
1082
- * Move and how it change the referenced stat
1083
- */
1084
- export interface MoveStatAffect {
1085
- /** The maximum amount of change to the referenced stat */
1086
- change: -1 | -2 | 1 | 2;
1087
- /** The move causing the change */
1088
- move: NamedAPIResource;
1089
- }
1090
- /**
1091
- * A detail of moves which affect an stat positively or negatively
1092
- */
1093
- export interface MoveStatAffectSets {
1094
- /** A list of moves and how they change the referenced stat */
1095
- increase: MoveStatAffect[];
1096
- /** A list of moves and how they change the referenced stat */
1097
- decrease: MoveStatAffect[];
1098
- }
1099
- /**
1100
- * Details of Pokémon for a specific type.
1101
- */
1102
- export interface TypePokemon {
1103
- /** The order the Pokémon's types are listed in */
1104
- slot: number;
1105
- /** The Pokémon that has the referenced type */
1106
- pokemon: NamedAPIResource;
1107
- }
1108
- /**
1109
- * Detail of how effective a type is toward others and vice versa
1110
- */
1111
- export interface TypeRelations {
1112
- /** A list of types this type has no effect on */
1113
- no_damage_to: NamedAPIResource[];
1114
- /** A list of types this type is not very effect against */
1115
- half_damage_to: NamedAPIResource[];
1116
- /** A list of types this type is very effect against */
1117
- double_damage_to: NamedAPIResource[];
1118
- /** A list of types that have no effect on this type */
1119
- no_damage_from: NamedAPIResource[];
1120
- /** A list of types that are not very effective against this type */
1121
- half_damage_from: NamedAPIResource[];
1122
- /** A list of types that are very effective against this type */
1123
- double_damage_from: NamedAPIResource[];
1124
- }
1125
- /**
1126
- * ## Type
1127
- * Types are properties for Pokémon and their moves.
1128
- * Each type has three properties: which types of Pokémon it is super effective against,
1129
- * which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against
1130
- */
1131
- export interface Type {
1132
- /** The identifier for this resource */
1133
- id: number;
1134
- /** The name for this resource */
1135
- name: string;
1136
- /** A detail of how effective this type is toward others and vice versa */
1137
- damage_relations: TypeRelations;
1138
- /** A list of game indices relevent to this item by generation */
1139
- game_indices: GenerationGameIndex[];
1140
- /** The generation this type was introduced in */
1141
- generation: NamedAPIResource;
1142
- /** The class of damage inflicted by this type */
1143
- move_damage_class: NamedAPIResource;
1144
- /** The name of this resource listed in different languages */
1145
- names: Name[];
1146
- /** A list of details of Pokémon that have this type */
1147
- pokemon: TypePokemon[];
1148
- /** A list of moves that have this type */
1149
- moves: NamedAPIResource[];
1150
- }
1151
- /**
1152
- * ## Pokemon
1153
- * Pokémon are the creatures that inhabit the world of the Pokémon games.
1154
- * They can be caught using Pokéballs and trained by battling with other Pokémon.
1155
- * Each Pokémon belongs to a specific species but may take on a variant
1156
- * which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings.
1157
- * - See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail.
1158
- */
1159
- export interface Pokemon {
1160
- /** The identifier for this resource */
1161
- id: number;
1162
- /** The name for this resource */
1163
- name: string;
1164
- /** The base experience gained for defeating this Pokémon */
1165
- base_experience: number;
1166
- /** The height of this Pokémon in decimetres */
1167
- height: number;
1168
- /** Set for exactly one Pokémon used as the default for each species */
1169
- is_default: boolean;
1170
- /** Order for sorting. Almost national order, except families are grouped together */
1171
- order: number;
1172
- /** The weight of this Pokémon in hectograms */
1173
- weight: number;
1174
- /** A list of abilities this Pokémon could potentially have */
1175
- abilities: PokemonAbility[];
1176
- /** A list of forms this Pokémon can take on */
1177
- forms: NamedAPIResource[];
1178
- /** A list of game indices relevent to Pokémon item by generation */
1179
- game_indices: VersionGameIndex[];
1180
- /** A list of items this Pokémon may be holding when encountered */
1181
- held_items: PokemonHeldItem[];
1182
- /** A link to a list of location areas, as well as encounter details pertaining to specific versions */
1183
- location_area_encounters: string;
1184
- /** A list of moves along with learn methods and level details pertaining to specific version groups */
1185
- moves: PokemonMove[];
1186
- /** A set of sprites used to depict this Pokémon in the game.
1187
- * A visual representation of the various sprites can be found at [PokeAPI/sprites](https://github.com/PokeAPI/sprites#sprites)
1188
- */
1189
- sprites: PokemonSprites;
1190
- /** The species this Pokémon belongs to */
1191
- species: NamedAPIResource;
1192
- /** A list of base stat values for this Pokémon */
1193
- stats: PokemonStat[];
1194
- /** A list of details showing types this Pokémon has */
1195
- types: PokemonType[];
1196
- /** Data describing a Pokemon's types in a previous generation. */
1197
- past_types: PokemonPastType[];
1198
- }
1199
- /**
1200
- * Abilities the given pokémon could potentially have
1201
- */
1202
- export interface PokemonAbility {
1203
- /** Whether or not this is a hidden ability */
1204
- is_hidden: boolean;
1205
- /** The slot this ability occupies in this Pokémon species */
1206
- slot: number;
1207
- /** The ability the Pokémon may have */
1208
- ability: NamedAPIResource;
1209
- }
1210
- /**
1211
- * Details showing types the given Pokémon has
1212
- */
1213
- export interface PokemonType {
1214
- /** The order the Pokémon's types are listed in */
1215
- slot: number;
1216
- /** The type the referenced Pokémon has */
1217
- type: NamedAPIResource;
1218
- }
1219
- /**
1220
- * Data describing a Pokemon's types in a previous generation.
1221
- */
1222
- export interface PokemonPastType {
1223
- /** The generation of this Pokémon Type. */
1224
- generation: NamedAPIResource;
1225
- /** Types this of this Pokémon in a previos generation. */
1226
- types: PokemonType[];
1227
- }
1228
- /**
1229
- * Items the given Pokémon may be holding when encountered
1230
- */
1231
- export interface PokemonHeldItem {
1232
- /** The item the referenced Pokémon holds */
1233
- item: NamedAPIResource;
1234
- /** The details of the different versions in which the item is held */
1235
- version_details: PokemonHeldItemVersion[];
1236
- }
1237
- /**
1238
- * The details of the different versions in which the item is held
1239
- */
1240
- export interface PokemonHeldItemVersion {
1241
- /** The version in which the item is held */
1242
- version: NamedAPIResource;
1243
- /** How often the item is held */
1244
- rarity: number;
1245
- }
1246
- /**
1247
- * A Move along with learn methods and level details pertaining to specific version groups
1248
- */
1249
- export interface PokemonMove {
1250
- /** The move the Pokémon can learn */
1251
- move: NamedAPIResource;
1252
- /** The details of the version in which the Pokémon can learn the move */
1253
- version_group_details: PokemonMoveVersion[];
1254
- }
1255
- /**
1256
- * The details of the version in which the Pokémon can learn the move
1257
- */
1258
- export interface PokemonMoveVersion {
1259
- /** The method by which the move is learned */
1260
- move_learn_method: NamedAPIResource;
1261
- /** The version group in which the move is learned */
1262
- version_group: NamedAPIResource;
1263
- /** The minimum level to learn the move */
1264
- level_learned_at: number;
1265
- }
1266
- /**
1267
- * Base stat values for the given Pokémon
1268
- */
1269
- export interface PokemonStat {
1270
- /** The stat the Pokémon has */
1271
- stat: NamedAPIResource;
1272
- /** The effort points (EV) the Pokémon has in the stat */
1273
- effort: number;
1274
- /** The base value of the stat */
1275
- base_stat: number;
1276
- }
1277
- /** Version Sprites */
1278
- export interface VersionSprites {
1279
- /** Generation-I Sprites of this Pokémon */
1280
- "generation-i": GenerationISprites;
1281
- /** Generation-II Sprites of this Pokémon */
1282
- "generation-ii": GenerationIISprites;
1283
- /** Generation-III Sprites of this Pokémon */
1284
- "generation-iii": GenerationIIISprites;
1285
- /** Generation-IV Sprites of this Pokémon */
1286
- "generation-iv": GenerationIVSprites;
1287
- /** Generation-V Sprites of this Pokémon */
1288
- "generation-v": GenerationVSprites;
1289
- /** Generation-VI Sprites of this Pokémon */
1290
- "generation-vi": GenerationVISprites;
1291
- /** Generation-VII Sprites of this Pokémon */
1292
- "generation-vii": GenerationVIISprites;
1293
- /** Generation-VIII Sprites of this Pokémon */
1294
- "generation-viii": GenerationVIIISprites;
1295
- }
1296
- /**
1297
- * A set of sprites used to depict this Pokémon in the game.
1298
- * A visual representation of the various sprites can be found at [PokeAPI/sprites](https://github.com/PokeAPI/sprites#sprites)
1299
- */
1300
- export interface PokemonSprites {
1301
- /** The default depiction of this Pokémon from the front in battle */
1302
- front_default: string | null;
1303
- /** The shiny depiction of this Pokémon from the front in battle */
1304
- front_shiny: string | null;
1305
- /** The female depiction of this Pokémon from the front in battle */
1306
- front_female: string | null;
1307
- /** The shiny female depiction of this Pokémon from the front in battle */
1308
- front_shiny_female: string | null;
1309
- /** The default depiction of this Pokémon from the back in battle */
1310
- back_default: string | null;
1311
- /** The shiny depiction of this Pokémon from the back in battle */
1312
- back_shiny: string | null;
1313
- /** The female depiction of this Pokémon from the back in battle */
1314
- back_female: string | null;
1315
- /** The shiny female depiction of this Pokémon from the back in battle */
1316
- back_shiny_female: string | null;
1317
- /** Dream World, Official Artwork and Home sprites */
1318
- other?: OtherPokemonSprites;
1319
- /** Version Sprites of this Pokémon */
1320
- versions: VersionSprites;
1321
- }
1322
- /** Other Pokemon Sprites (Dream World and Official Artwork sprites) */
1323
- export interface OtherPokemonSprites {
1324
- /** Dream World Sprites of this Pokémon */
1325
- dream_world: DreamWorld;
1326
- /** Official Artwork Sprites of this Pokémon */
1327
- "official-artwork": OfficialArtwork;
1328
- /** Home Artwork Sprites of this Pokémon */
1329
- home: Home;
1330
- }
1331
- /** Dream World sprites */
1332
- export interface DreamWorld {
1333
- /** The default depiction of this Pokémon from the front in battle */
1334
- front_default: string | null;
1335
- /** The female depiction of this Pokémon from the front in battle */
1336
- front_female: string | null;
1337
- }
1338
- /** Official Artwork sprites */
1339
- export interface OfficialArtwork {
1340
- /** The default depiction of this Pokémon from the front in battle */
1341
- front_default: string | null;
1342
- }
1343
- /** Home sprites */
1344
- export interface Home {
1345
- /** The default depiction of this Pokémon from the front in battle */
1346
- front_default: string | null;
1347
- /** The female depiction of this Pokémon from the front in battle */
1348
- front_female: string | null;
1349
- /** The shiny depiction of this Pokémon from the front in battle */
1350
- front_shiny: string | null;
1351
- /** The shiny female depiction of this Pokémon from the back in battle */
1352
- front_shiny_female: string | null;
1353
- }
1354
- /** Generation-I Srites */
1355
- export interface GenerationISprites {
1356
- /** Red-blue sprites of this Pokémon */
1357
- "red-blue": RedBlue;
1358
- /** Yellow sprites of this Pokémon */
1359
- yellow: Yellow;
1360
- }
1361
- /** Red/Blue Sprites */
1362
- export interface RedBlue {
1363
- /** The default depiction of this Pokémon from the back in battle */
1364
- back_default: string | null;
1365
- /** The gray depiction of this Pokémon from the back in battle */
1366
- back_gray: string | null;
1367
- /** The transparent depiction of this Pokémon from the back in battle */
1368
- back_transparent: string | null;
1369
- /** The default depiction of this Pokémon from the front in battle */
1370
- front_default: string | null;
1371
- /** The gray depiction of this Pokémon from the front in battle */
1372
- front_gray: string | null;
1373
- /** The transparent depiction of this Pokémon from the front in battle */
1374
- front_transparent: string | null;
1375
- }
1376
- /** Yellow sprites */
1377
- export interface Yellow {
1378
- /** The default depiction of this Pokémon from the back in battle */
1379
- back_default: string | null;
1380
- /** The gray depiction of this Pokémon from the back in battle */
1381
- back_gray: string | null;
1382
- /** The transparent depiction of this Pokémon from the back in battle */
1383
- back_transparent: string | null;
1384
- /** The default depiction of this Pokémon from the front in battle */
1385
- front_default: string | null;
1386
- /** The gray depiction of this Pokémon from the front in battle */
1387
- front_gray: string | null;
1388
- /** The transparent depiction of this Pokémon from the front in battle */
1389
- front_transparent: string | null;
1390
- }
1391
- /** Generation-II Sprites */
1392
- export interface GenerationIISprites {
1393
- /** Crystal sprites of this Pokémon */
1394
- crystal: Crystal;
1395
- /** Gold sprites of this Pokémon */
1396
- gold: Gold;
1397
- /** Silver sprites of this Pokémon */
1398
- silver: Silver;
1399
- }
1400
- /** Crystal sprites */
1401
- export interface Crystal {
1402
- /** The default depiction of this Pokémon from the back in battle */
1403
- back_default: string | null;
1404
- /** The shiny depiction of this Pokémon from the back in battle */
1405
- back_shiny: string | null;
1406
- /** The back shiny transparent depiction of this Pokémon from the back in battle */
1407
- back_shiny_transparent: string | null;
1408
- /** The transparent depiction of this Pokémon from the back in battle */
1409
- back_transparent: string | null;
1410
- /** The default depiction of this Pokémon from the front in battle */
1411
- front_default: string | null;
1412
- /** The shiny depiction of this Pokémon from the front in battle */
1413
- front_shiny: string | null;
1414
- /** The front shiny transparent depiction of this Pokémon from the front in battle */
1415
- front_shiny_transparent: string | null;
1416
- /** The transparent depiction of this Pokémon from the front in battle */
1417
- front_transparent: string | null;
1418
- }
1419
- export interface Gold {
1420
- /** The default depiction of this Pokémon from the back in battle */
1421
- back_default: string | null;
1422
- /** The shiny depiction of this Pokémon from the back in battle */
1423
- back_shiny: string | null;
1424
- /** The default depiction of this Pokémon from the front in battle */
1425
- front_default: string | null;
1426
- /** The shiny depiction of this Pokémon from the front in battle */
1427
- front_shiny: string | null;
1428
- /** The transparent depiction of this Pokémon from the front in battle */
1429
- front_transparent: string | null;
1430
- }
1431
- /** Silver sprites */
1432
- export interface Silver {
1433
- /** The default depiction of this Pokémon from the back in battle */
1434
- back_default: string | null;
1435
- /** The shiny depiction of this Pokémon from the back in battle */
1436
- back_shiny: string | null;
1437
- /** The default depiction of this Pokémon from the front in battle */
1438
- front_default: string | null;
1439
- /** The shiny depiction of this Pokémon from the front in battle */
1440
- front_shiny: string | null;
1441
- /** The transparent depiction of this Pokémon from the front in battle */
1442
- front_transparent: string | null;
1443
- }
1444
- /** Generation-III Sprites */
1445
- export interface GenerationIIISprites {
1446
- /** Emerald sprites of this Pokémon */
1447
- emerald: Emerald;
1448
- /** Firered-Leafgreen sprites of this Pokémon */
1449
- "firered-leafgreen": FireredLeafgreen;
1450
- /** Ruby-Sapphire sprites of this Pokémon */
1451
- "ruby-sapphire": RubySapphire;
1452
- }
1453
- /** Emerald sprites */
1454
- export interface Emerald {
1455
- /** The default depiction of this Pokémon from the front in battle */
1456
- front_default: string | null;
1457
- /** The shiny depiction of this Pokémon from the front in battle */
1458
- front_shiny: string | null;
1459
- }
1460
- /** FireRead LeafGreen sprites */
1461
- export interface FireredLeafgreen {
1462
- /** The default depiction of this Pokémon from the back in battle */
1463
- back_default: string | null;
1464
- /** The shiny depiction of this Pokémon from the back in battle */
1465
- back_shiny: string | null;
1466
- /** The default depiction of this Pokémon from the front in battle */
1467
- front_default: string | null;
1468
- /** The shiny depiction of this Pokémon from the front in battle */
1469
- front_shiny: string | null;
1470
- }
1471
- /** Ruby/Sapphire sprites */
1472
- export interface RubySapphire {
1473
- /** The default depiction of this Pokémon from the back in battle */
1474
- back_default: string | null;
1475
- /** The shiny depiction of this Pokémon from the back in battle */
1476
- back_shiny: string | null;
1477
- /** The default depiction of this Pokémon from the front in battle */
1478
- front_default: string | null;
1479
- /** The shiny depiction of this Pokémon from the front in battle */
1480
- front_shiny: string | null;
1481
- }
1482
- /** Generation-IV Sprites */
1483
- export interface GenerationIVSprites {
1484
- /** Diamond-pearl Generation sprites of this Pokémon */
1485
- "diamond-pearl": DiamondPearl;
1486
- /** Heartgold-Soulsilver sprites of this Pokémon */
1487
- "heartgold-soulsilver": HeartgoldSoulsilver;
1488
- /** Platinum sprites of this Pokémon */
1489
- platinum: Platinum;
1490
- }
1491
- export interface DiamondPearl {
1492
- /** The default depiction of this Pokémon from the back in battle */
1493
- back_default: string | null;
1494
- /** The shiny depiction of this Pokémon from the back in battle */
1495
- back_shiny: string | null;
1496
- /** The female depiction of this Pokémon from the back in battle */
1497
- back_female: string | null;
1498
- /** The default depiction of this Pokémon from the front in battle */
1499
- front_default: string | null;
1500
- /** The shiny depiction of this Pokémon from the front in battle */
1501
- front_shiny: string | null;
1502
- /** The shiny female depiction of this Pokémon from the back in battle */
1503
- back_shiny_female: string | null;
1504
- /** The female depiction of this Pokémon from the front in battle */
1505
- front_female: string | null;
1506
- /** The shiny female depiction of this Pokémon from the back in battle */
1507
- front_shiny_female: string | null;
1508
- }
1509
- export interface HeartgoldSoulsilver {
1510
- /** The default depiction of this Pokémon from the back in battle */
1511
- back_default: string | null;
1512
- /** The shiny depiction of this Pokémon from the back in battle */
1513
- back_shiny: string | null;
1514
- /** The female depiction of this Pokémon from the back in battle */
1515
- back_female: string | null;
1516
- /** The default depiction of this Pokémon from the front in battle */
1517
- front_default: string | null;
1518
- /** The shiny depiction of this Pokémon from the front in battle */
1519
- front_shiny: string | null;
1520
- /** The shiny female depiction of this Pokémon from the back in battle */
1521
- back_shiny_female: string | null;
1522
- /** The female depiction of this Pokémon from the front in battle */
1523
- front_female: string | null;
1524
- /** The shiny female depiction of this Pokémon from the back in battle */
1525
- front_shiny_female: string | null;
1526
- }
1527
- export interface Platinum {
1528
- /** The default depiction of this Pokémon from the back in battle */
1529
- back_default: string | null;
1530
- /** The shiny depiction of this Pokémon from the back in battle */
1531
- back_shiny: string | null;
1532
- /** The female depiction of this Pokémon from the back in battle */
1533
- back_female: string | null;
1534
- /** The default depiction of this Pokémon from the front in battle */
1535
- front_default: string | null;
1536
- /** The shiny depiction of this Pokémon from the front in battle */
1537
- front_shiny: string | null;
1538
- /** The shiny female depiction of this Pokémon from the back in battle */
1539
- back_shiny_female: string | null;
1540
- /** The female depiction of this Pokémon from the front in battle */
1541
- front_female: string | null;
1542
- /** The shiny female depiction of this Pokémon from the back in battle */
1543
- front_shiny_female: string | null;
1544
- }
1545
- /** Generation-V Sprites */
1546
- export interface GenerationVSprites {
1547
- /** Black-white sprites of this Pokémon */
1548
- "black-white": BlackWhite;
1549
- }
1550
- /** Black/White sprites */
1551
- export interface BlackWhite {
1552
- /** The animated sprite of this pokémon */
1553
- animated: Animated;
1554
- /** The default depiction of this Pokémon from the back in battle */
1555
- back_default: string | null;
1556
- /** The shiny depiction of this Pokémon from the back in battle */
1557
- back_shiny: string | null;
1558
- /** The female depiction of this Pokémon from the back in battle */
1559
- back_female: string | null;
1560
- /** The default depiction of this Pokémon from the front in battle */
1561
- front_default: string | null;
1562
- /** The shiny depiction of this Pokémon from the front in battle */
1563
- front_shiny: string | null;
1564
- /** The shiny female depiction of this Pokémon from the back in battle */
1565
- back_shiny_female: string | null;
1566
- /** The female depiction of this Pokémon from the front in battle */
1567
- front_female: string | null;
1568
- /** The shiny female depiction of this Pokémon from the back in battle */
1569
- front_shiny_female: string | null;
1570
- }
1571
- export interface Animated {
1572
- /** The default depiction of this Pokémon from the back in battle */
1573
- back_default: string | null;
1574
- /** The shiny depiction of this Pokémon from the back in battle */
1575
- back_shiny: string | null;
1576
- /** The female depiction of this Pokémon from the back in battle */
1577
- back_female: string | null;
1578
- /** The default depiction of this Pokémon from the front in battle */
1579
- front_default: string | null;
1580
- /** The shiny depiction of this Pokémon from the front in battle */
1581
- front_shiny: string | null;
1582
- /** The shiny female depiction of this Pokémon from the back in battle */
1583
- back_shiny_female: string | null;
1584
- /** The female depiction of this Pokémon from the front in battle */
1585
- front_female: string | null;
1586
- /** The shiny female depiction of this Pokémon from the back in battle */
1587
- front_shiny_female: string | null;
1588
- }
1589
- /** Generation-VI Sprites */
1590
- export interface GenerationVISprites {
1591
- /** Omegaruby-Alphasapphire sprites of this Pokémon */
1592
- "omegaruby-alphasapphire": OmegarubyAlphasapphire;
1593
- /** X-Y sprites of this Pokémon */
1594
- "x-y": XY;
1595
- }
1596
- /** Omega/Ruby Alpha/Sapphire sprites */
1597
- export interface OmegarubyAlphasapphire {
1598
- /** The default depiction of this Pokémon from the front in battle */
1599
- front_default: string | null;
1600
- /** The female depiction of this Pokémon from the front in battle */
1601
- front_female: string | null;
1602
- /** The shiny depiction of this Pokémon from the front in battle */
1603
- front_shiny: string | null;
1604
- /** The shiny female depiction of this Pokémon from the back in battle */
1605
- front_shiny_female: string | null;
1606
- }
1607
- /** XY sprites */
1608
- export interface XY {
1609
- /** The default depiction of this Pokémon from the front in battle */
1610
- front_default: string | null;
1611
- /** The female depiction of this Pokémon from the front in battle */
1612
- front_female: string | null;
1613
- /** The shiny depiction of this Pokémon from the front in battle */
1614
- front_shiny: string | null;
1615
- /** The shiny female depiction of this Pokémon from the back in battle */
1616
- front_shiny_female: string | null;
1617
- }
1618
- /** Generation-VII Sprites */
1619
- export interface GenerationVIISprites {
1620
- /** Icon sprites of this Pokémon */
1621
- icons: GenerationViiIcons;
1622
- /** Ultra-sun-ultra-moon sprites of this Pokémon */
1623
- "ultra-sun-ultra-moon": UltraSunUltraMoon;
1624
- }
1625
- /** Generation VII icons */
1626
- export interface GenerationViiIcons {
1627
- /** The default depiction of this Pokémon from the front in battle */
1628
- front_default: string | null;
1629
- /** The female depiction of this Pokémon from the front in battle */
1630
- front_female: string | null;
1631
- }
1632
- /** Ultra Sun Ultra Moon sprites */
1633
- export interface UltraSunUltraMoon {
1634
- /** The default depiction of this Pokémon from the front in battle */
1635
- front_default: string | null;
1636
- /** The female depiction of this Pokémon from the front in battle */
1637
- front_female: string | null;
1638
- /** The shiny depiction of this Pokémon from the front in battle */
1639
- front_shiny: string | null;
1640
- /** The shiny female depiction of this Pokémon from the back in battle */
1641
- front_shiny_female: string | null;
1642
- }
1643
- /** Generation-VIII Sprites */
1644
- export interface GenerationVIIISprites {
1645
- /** Icon sprites of this Pokémon */
1646
- icons: GenerationViiiIcons;
1647
- }
1648
- /** Generation VIII icons */
1649
- export interface GenerationViiiIcons {
1650
- /** The default depiction of this Pokémon from the front in battle */
1651
- front_default: string | null;
1652
- /** The female depiction of this Pokémon from the front in battle */
1653
- front_female: string | null;
1654
- }
1655
- /**
1656
- * ## Location Area Encounter
1657
- * Pokémon location areas where Pokémon can be found
1658
- */
1659
- export interface LocationAreaEncounter {
1660
- /** The location area the referenced Pokémon can be encountered in */
1661
- location_area: NamedAPIResource;
1662
- /** A list of versions and encounters with the referenced Pokémon that might happen */
1663
- version_details: VersionEncounterDetail[];
1664
- }
1665
- /**
1666
- * ## Pokemon Colors
1667
- * Colors used for sorting Pokémon in a Pokédex.
1668
- * The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body.
1669
- * No orange category exists; Pokémon that are primarily orange are listed as red or brown.
1670
- */
1671
- export interface PokemonColor {
1672
- /** The identifier for this resource */
1673
- id: number;
1674
- /** The name for this resource */
1675
- name: "black" | "blue" | "brown" | "gray" | "green" | "pink" | "purple" | "red" | "white" | "yellow";
1676
- /** The name of this resource listed in different languages */
1677
- names: Name[];
1678
- /** A list of the Pokémon species that have this color */
1679
- pokemon_species: NamedAPIResource[];
1680
- }
1681
- /**
1682
- * ## Pokemon Form
1683
- * Some Pokémon may appear in one of multiple, visually different forms.
1684
- * These differences are purely cosmetic. For variations within a Pokémon species,
1685
- * which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety.
1686
- */
1687
- export interface PokemonForm {
1688
- /** The identifier for this resource */
1689
- id: number;
1690
- /** The name for this resource */
1691
- name: string;
1692
- /** The order in which forms should be sorted within all forms.
1693
- * Multiple forms may have equal order, in which case they should fall back on sorting by name
1694
- */
1695
- order: number;
1696
- /** The order in which forms should be sorted within a species' forms */
1697
- form_order: number;
1698
- /** True for exactly one form used as the default for each Pokémon */
1699
- is_default: boolean;
1700
- /** Whether or not this form can only happen during battle */
1701
- is_battle_only: boolean;
1702
- /** Whether or not this form requires mega evolution */
1703
- is_mega: boolean;
1704
- /** The name of this form */
1705
- form_name: string;
1706
- /** The Pokémon that can take on this form */
1707
- pokemon: NamedAPIResource;
1708
- /** A set of sprites used to depict this Pokémon form in the game */
1709
- sprites: PokemonFormSprites;
1710
- /** The version group this Pokémon form was introduced in */
1711
- version_group: NamedAPIResource;
1712
- /** The form specific full name of this Pokémon form, or empty if the form does not have a specific name */
1713
- names: Name[];
1714
- /** The form specific form name of this Pokémon form, or empty if the form does not have a specific name */
1715
- form_names: Name[];
1716
- /** A list of details showing types this Pokémon has */
1717
- types: PokemonType[];
1718
- }
1719
- /**
1720
- * Sprites used to depict this Pokémon form in the game
1721
- */
1722
- export interface PokemonFormSprites {
1723
- /** The default depiction of this Pokémon form from the front in battle */
1724
- front_default: string | null;
1725
- /** The female depiction of this Pokémon form from the front in battle */
1726
- front_female: string | null;
1727
- /** The shiny depiction of this Pokémon form from the front in battle */
1728
- front_shiny: string | null;
1729
- /** The shiny female depiction of this Pokémon form from the front in battle */
1730
- front_shiny_female: string | null;
1731
- /** The default depiction of this Pokémon form from the back in battle */
1732
- back_default: string | null;
1733
- /** The female depiction of this Pokémon form from the back in battle */
1734
- back_female: string | null;
1735
- /** The shiny depiction of this Pokémon form from the back in battle */
1736
- back_shiny: string | null;
1737
- /** The shiny female depiction of this Pokémon form from the back in battle */
1738
- back_shiny_female: string | null;
1739
- }
1740
- /**
1741
- * ## Pokemon Habitat
1742
- * Habitats are generally different terrain Pokémon can be found in
1743
- * but can also be areas designated for rare or legendary Pokémon
1744
- */
1745
- export interface PokemonHabitat {
1746
- /** The identifier for this resource */
1747
- id: number;
1748
- /** The name for this resource */
1749
- name: "cave" | "forest" | "grassland" | "mountain" | "rare" | "rough-terrain" | "sea" | "urban" | "waters-edge";
1750
- /** The name of this resource listed in different languages */
1751
- names: Name[];
1752
- /** A list of the Pokémon species that can be found in this habitat */
1753
- pokemon_species: NamedAPIResource[];
1754
- }
1755
- /**
1756
- * ## Pokemon Shape
1757
- * Shapes used for sorting Pokémon in a Pokédex
1758
- */
1759
- export interface PokemonShape {
1760
- /** The identifier for this resource */
1761
- id: number;
1762
- /** The name for this resource */
1763
- name: string;
1764
- /** The "scientific" name of this Pokémon shape listed in different languages */
1765
- awesome_names: AwesomeName[];
1766
- /** The name of this resource listed in different languages */
1767
- names: Name[];
1768
- /** A list of the Pokémon species that have this shape */
1769
- pokemon_species: NamedAPIResource[];
1770
- }
1771
- /**
1772
- * The "scientific" name of the Pokémon shape listed in different languages
1773
- */
1774
- export interface AwesomeName {
1775
- /** The localized "scientific" name for an API resource in a specific language */
1776
- awesome_name: string;
1777
- /** The language this "scientific" name is in */
1778
- language: NamedAPIResource;
1779
- }
1780
- /**
1781
- * ## Pokemon Species
1782
- * A Pokémon Species forms the basis for at least one Pokémon.
1783
- * Attributes of a Pokémon species are shared across all varieties of Pokémon within the species.
1784
- * A good example is Wormadam; Wormadam is the species which can be found in three different varieties,
1785
- * Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant */
1786
- export interface PokemonSpecies {
1787
- /** The identifier for this resource */
1788
- id: number;
1789
- /** The name for this resource */
1790
- name: string;
1791
- /** The order in which species should be sorted. Based on National Dex order, except families are grouped together and sorted by stage */
1792
- order: number;
1793
- /** The chance of this Pokémon being female, in eighths; or -1 for genderless */
1794
- gender_rate: number;
1795
- /** The base capture rate; up to 255. The higher the number, the easier the catch */
1796
- capture_rate: number;
1797
- /** The happiness when caught by a normal Pokéball; up to 255. The higher the number, the happier the Pokémon */
1798
- base_happiness: number;
1799
- /** Whether or not this is a baby Pokémon */
1800
- is_baby: boolean;
1801
- /** Whether or not this is a legendary Pokémon */
1802
- is_legendary: boolean;
1803
- /** Whether or not this is a mythical Pokémon */
1804
- is_mythical: boolean;
1805
- /** Initial hatch counter: one must walk 255 × (hatch_counter + 1) steps before this Pokémon's egg hatches, unless utilizing bonuses like Flame Body's */
1806
- hatch_counter: number;
1807
- /** Whether or not this Pokémon has visual gender differences */
1808
- has_gender_differences: boolean;
1809
- /** Whether or not this Pokémon has multiple forms and can switch between them */
1810
- forms_switchable: boolean;
1811
- /** The rate at which this Pokémon species gains levels */
1812
- growth_rate: NamedAPIResource;
1813
- /** A list of Pokedexes and the indexes reserved within them for this Pokémon species */
1814
- pokedex_numbers: PokemonSpeciesDexEntry[];
1815
- /** A list of egg groups this Pokémon species is a member of */
1816
- egg_groups: NamedAPIResource[];
1817
- /** The color of this Pokémon for Pokédex search */
1818
- color: NamedAPIResource;
1819
- /** The shape of this Pokémon for Pokédex search */
1820
- shape: NamedAPIResource;
1821
- /** The Pokémon species that evolves into this Pokemon_species */
1822
- evolves_from_species: NamedAPIResource;
1823
- /** The evolution chain this Pokémon species is a member of */
1824
- evolution_chain: APIResource;
1825
- /** The habitat this Pokémon species can be encountered in */
1826
- habitat: NamedAPIResource;
1827
- /** The generation this Pokémon species was introduced in */
1828
- generation: NamedAPIResource;
1829
- /** The name of this resource listed in different languages */
1830
- names: Name[];
1831
- /** A list of encounters that can be had with this Pokémon species in pal park */
1832
- pal_park_encounters: PalParkEncounterArea[];
1833
- /** A list of flavor text entries for this Pokémon species */
1834
- flavor_text_entries: FlavorText[];
1835
- /** Descriptions of different forms Pokémon take on within the Pokémon species */
1836
- form_descriptions: Description[];
1837
- /** The genus of this Pokémon species listed in multiple languages */
1838
- genera: Genus[];
1839
- /** A list of the Pokémon that exist within this Pokémon species */
1840
- varieties: PokemonSpeciesVariety[];
1841
- }
1842
- /**
1843
- * The genus of the given Pokémon species listed in multiple languages
1844
- */
1845
- export interface Genus {
1846
- /** The localized genus for the referenced Pokémon species */
1847
- genus: string;
1848
- /** The language this genus is in */
1849
- language: NamedAPIResource;
1850
- }
1851
- /** Pokedexes and the indexes reserved within them for the given Pokémon species */
1852
- export interface PokemonSpeciesDexEntry {
1853
- /** The index number within the Pokédex */
1854
- entry_number: number;
1855
- /** The Pokédex the referenced Pokémon species can be found in */
1856
- pokedex: NamedAPIResource;
1857
- }
1858
- /**
1859
- * Encounter that can be had with the given Pokémon species in pal park
1860
- */
1861
- export interface PalParkEncounterArea {
1862
- /** The base score given to the player when the referenced Pokémon is caught during a pal park run */
1863
- base_score: number;
1864
- /** The base rate for encountering the referenced Pokémon in this pal park area */
1865
- rate: number;
1866
- /** The pal park area where this encounter happens */
1867
- area: NamedAPIResource;
1868
- }
1869
- /**
1870
- * Pokémons that exist within this Pokémon species
1871
- */
1872
- export interface PokemonSpeciesVariety {
1873
- /** Whether this variety is the default variety */
1874
- is_default: boolean;
1875
- /** The Pokémon variety */
1876
- pokemon: NamedAPIResource;
1877
- }
1878
- /**
1879
- * ## Move Target
1880
- * Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves.
1881
- */
1882
- export interface MoveTarget {
1883
- /** The identifier for this resource. */
1884
- id: number;
1885
- /** The name for this resource. */
1886
- name: string;
1887
- /** The description of this resource listed in different languages. */
1888
- descriptions: Description[];
1889
- /** A list of moves that that are directed at this target. */
1890
- moves: NamedAPIResource[];
1891
- /** The name of this resource listed in different languages. */
1892
- names: Name[];
1893
- }
1894
- /**
1895
- * ## Move Learn Method
1896
- * Methods by which Pokémon can learn moves.
1897
- */
1898
- export interface MoveLearnMethod {
1899
- /** The identifier for this resource. */
1900
- id: number;
1901
- /** The name for this resource. */
1902
- name: string;
1903
- /** The description of this resource listed in different languages. */
1904
- descriptions: Description[];
1905
- /** The name of this resource listed in different languages. */
1906
- names: Name[];
1907
- /** A list of version groups where moves can be learned through this method. */
1908
- version_groups: NamedAPIResource[];
1909
- }
1910
- /**
1911
- * ## Move Damage Class
1912
- * Damage classes moves can have, e.g. physical, special, or non-damaging.
1913
- */
1914
- export interface MoveDamageClass {
1915
- /** The identifier for this resource. */
1916
- id: number;
1917
- /** The name for this resource. */
1918
- name: string;
1919
- /** The description of this resource listed in different languages. */
1920
- descriptions: Description[];
1921
- /** A list of moves that fall into this damage class. */
1922
- moves: NamedAPIResource[];
1923
- /** The name of this resource listed in different languages. */
1924
- names: Name[];
1925
- }
1926
- /**
1927
- * ## Move Category
1928
- * Very general categories that loosely group move effects.
1929
- */
1930
- export interface MoveCategory {
1931
- /** The identifier for this resource. */
1932
- id: number;
1933
- /** The name for this resource. */
1934
- name: string;
1935
- /** A list of moves that fall into this category. */
1936
- moves: NamedAPIResource[];
1937
- /** The description of this resource listed in different languages. */
1938
- descriptions: Description[];
1939
- }
1940
- /**
1941
- * ## Move Battle Style
1942
- * Styles of moves when used in the Battle Palace.
1943
- * - See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater details.
1944
- */
1945
- export interface MoveBattleStyle {
1946
- /** The identifier for this resource. */
1947
- id: number;
1948
- /** The name for this resource. */
1949
- name: "attack" | "defense" | "support";
1950
- /** The name of this resource listed in different languages. */
1951
- names: Name[];
1952
- }
1953
- /**
1954
- * ## Move Ailment
1955
- * Move Ailments are status conditions caused by moves used during battle.
1956
- * - See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater details.
1957
- */
1958
- export interface MoveAilment {
1959
- /** The identifier for this resource. */
1960
- id: number;
1961
- /** The name for this resource. */
1962
- name: string;
1963
- /** A list of moves that cause this ailment. */
1964
- moves: NamedAPIResource[];
1965
- /** The name of this resource listed in different languages. */
1966
- names: Name[];
1967
- }
1968
- export interface PastMoveStatValues {
1969
- /** The percent value of how likely this move is to be successful. */
1970
- accuracy: number | null;
1971
- /** The percent value of how likely it is this moves effect will take effect. */
1972
- effect_chance: number | null;
1973
- /** The base power of this move with a value of 0 if it does not have a base power. */
1974
- power: number | null;
1975
- /** Power points. The number of times this move can be used. */
1976
- pp: number | null;
1977
- /** The effect of this move listed in different languages. */
1978
- effect_entries: VerboseEffect[];
1979
- /** The elemental type of this move. */
1980
- type: NamedAPIResource | null;
1981
- /** The version group in which these move stat values were in effect. */
1982
- version_group: NamedAPIResource;
1983
- }
1984
- /** */
1985
- export interface MoveStatChange {
1986
- /** The amount of change. */
1987
- change: number;
1988
- /** The stat being affected. */
1989
- stat: NamedAPIResource;
1990
- }
1991
- /**
1992
- * Metadata about this move
1993
- */
1994
- export interface MoveMetaData {
1995
- /** The status ailment this move inflicts on its target. */
1996
- ailment: NamedAPIResource;
1997
- /** The category of move this move falls under, e.g. damage or ailment. */
1998
- category: NamedAPIResource;
1999
- /** The minimum number of times this move hits. Null if it always only hits once. */
2000
- min_hits: number | null;
2001
- /** The maximum number of times this move hits. Null if it always only hits once. */
2002
- max_hits: number | null;
2003
- /** The minimum number of turns this move continues to take effect. Null if it always only lasts one turn. */
2004
- min_turns: number | null;
2005
- /** The maximum number of turns this move continues to take effect. Null if it always only lasts one turn. */
2006
- max_turns: number | null;
2007
- /** HP drain (if positive) or Recoil damage (if negative), in percent of damage done. */
2008
- drain: number;
2009
- /** The amount of hp gained by the attacking Pokemon, in percent of it's maximum HP. */
2010
- healing: number;
2011
- /** Critical hit rate bonus. */
2012
- crit_rate: number;
2013
- /** The likelihood this attack will cause an ailment. */
2014
- ailment_chance: number;
2015
- /** The likelihood this attack will cause the target Pokémon to flinch. */
2016
- flinch_chance: number;
2017
- /** The likelihood this attack will cause a stat change in the target Pokémon. */
2018
- stat_chance: number;
2019
- }
2020
- /**
2021
- * The flavor text of this move.
2022
- */
2023
- export interface MoveFlavorText {
2024
- /** The localized flavor text for an api resource in a specific language. */
2025
- flavor_text: string;
2026
- /** The language this name is in. */
2027
- language: NamedAPIResource;
2028
- /** The version group that uses this flavor text. */
2029
- version_group: NamedAPIResource;
2030
- }
2031
- /**
2032
- * A detail of moves this move can be used before or after, granting additional appeal points in super contests.
2033
- */
2034
- export interface ContestComboDetail {
2035
- /** A list of moves to use before this move. */
2036
- use_before: NamedAPIResource[] | null;
2037
- /** A list of moves to use after this move. */
2038
- use_after: NamedAPIResource[] | null;
2039
- }
2040
- /**
2041
- * A detail of normal and super contest combos that require this move.
2042
- */
2043
- export interface ContestComboSets {
2044
- /** A detail of moves this move can be used before or after, granting additional appeal points in contests. */
2045
- normal: ContestComboDetail;
2046
- /** A detail of moves this move can be used before or after, granting additional appeal points in super contests. */
2047
- super: ContestComboDetail;
2048
- }
2049
- /**
2050
- * ## Move
2051
- * Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn.
2052
- * Some moves (including those learned by Hidden Machine) can be used outside of battle as well,
2053
- * usually for the purpose of removing obstacles or exploring new areas.
2054
- * - See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Move) for greater detaill
2055
- */
2056
- export interface Move {
2057
- /** The identifier for this resource */
2058
- id: number;
2059
- /** The name for this resource */
2060
- name: string;
2061
- /** The percent value of how likely this move is to be successful */
2062
- accuracy: number | null;
2063
- /** The percent value of how likely it is this moves effect will happen */
2064
- effect_chance: number | null;
2065
- /** Power points. The number of times this move can be used */
2066
- pp: number | null;
2067
- /**
2068
- * A value between -8 and 8. Sets the order in which moves are executed during battle.
2069
- * See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Priority) for greater detail
2070
- */
2071
- priority: -8 | -7 | -6 | -5 | -4 | -3 | -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
2072
- /** The base power of this move with a value of 0 if it does not have a base power */
2073
- power: number | null;
2074
- /** A detail of normal and super contest combos that require this move */
2075
- contest_combos: ContestComboSets | null;
2076
- /** The type of appeal this move gives a Pokémon when used in a contest */
2077
- contest_types: NamedAPIResource | null;
2078
- /** The effect the move has when used in a contest */
2079
- contest_effect: APIResource | null;
2080
- /** The type of damage the move inflicts on the target, e.g. physical */
2081
- damage_class: NamedAPIResource | null;
2082
- /** The effect of this move listed in different languages */
2083
- effect_entries: VerboseEffect[];
2084
- /** The list of previous effects this move has had across version groups of the games */
2085
- effect_changes: AbilityEffectChange[];
2086
- /** The flavor text of this move listed in different languages */
2087
- flavor_text_entries: MoveFlavorText[];
2088
- /** The generation in which this move was introduced */
2089
- generation: NamedAPIResource;
2090
- /** A list of the machines that teach this move */
2091
- machines: MachineVersionDetail[];
2092
- /** Metadata about this move */
2093
- meta: MoveMetaData | null;
2094
- /** The name of this resource listed in different languages */
2095
- names: Name[];
2096
- /** A list of move resource value changes across version groups of the game */
2097
- past_values: PastMoveStatValues[];
2098
- /** A list of stats this moves effects and how much it effects them */
2099
- stat_changes: MoveStatChange[];
2100
- /** The effect the move has when used in a super contest */
2101
- super_contest_effect: APIResource | null;
2102
- /** The type of target that will receive the effects of the attack */
2103
- target: NamedAPIResource;
2104
- /** The elemental type of this move */
2105
- type: NamedAPIResource;
2106
- /** A list of Pokémons that learned this move */
2107
- learned_by_pokemon: NamedAPIResource[];
2108
- }
2109
- /**
2110
- * ## Client Args
2111
- * Used to pass optional configuration for logging and cache to the clients.
2112
- */
2113
- export interface ClientArgs {
2114
- /**
2115
- * ## Logger Options
2116
- * Options for the client logger.
2117
- * @see https://getpino.io/#/docs/api?id=options
2118
- */
2119
- logOptions?: pino.LoggerOptions;
2120
- /**
2121
- * ## Axios Cache Options
2122
- * Options for cache.
2123
- * @see https://github.com/RasCarlito/axios-cache-adapter
2124
- */
2125
- cacheOptions?: IAxiosCacheAdapterOptions;
2126
- /**
2127
- * ## Base URL
2128
- * Location of the PokéAPI. Leave empty to use the official PokéAPI instance.
2129
- */
2130
- baseURL?: string;
2131
- }
2132
- /**
2133
- * ### Base Client
2134
- */
2135
- export declare class BaseClient {
2136
- api: AxiosInstance;
2137
- logger: pino.Logger;
2138
- /**
2139
- *
2140
- */
2141
- constructor(clientOptions?: ClientArgs);
2142
- }
2143
- /**
2144
- * ### Berry Client
2145
- *
2146
- * Client used to access the Berry Endpoints:
2147
- * - [Berries](https://pokeapi.co/docs/v2#berries)
2148
- * - [Berry Firmnesses](https://pokeapi.co/docs/v2#berry-firmnesses)
2149
- * - [Berry Flavors](https://pokeapi.co/docs/v2#berry-flavors)
2150
- * ---
2151
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#berries-section)
2152
- */
2153
- export declare class BerryClient extends BaseClient {
2154
- constructor(clientOptions?: ClientArgs);
2155
- /**
2156
- * Get a Berry by it's name
2157
- * @param name The berry name
2158
- * @returns A Berry
2159
- */
2160
- getBerryByName(name: string): Promise<Berry>;
2161
- /**
2162
- * Get a Berry by it's ID
2163
- * @param id The Berry ID
2164
- * @returns A Berry
2165
- */
2166
- getBerryById(id: number): Promise<Berry>;
2167
- /**
2168
- * Get a Berry Firmness by it's ID
2169
- * @param id The Berry ID
2170
- * @returns Berry Firmness
2171
- */
2172
- getBerryFirmnessById(id: number): Promise<BerryFirmness>;
2173
- /**
2174
- * Get a Berry Firmness by it's ID
2175
- * @param name The Berry name
2176
- * @returns Berry Firmness
2177
- */
2178
- getBerryFirmnessByName(name: string): Promise<BerryFirmness>;
2179
- /**
2180
- * Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their nature.
2181
- * Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail.
2182
- * @param id The Berry Flavor ID
2183
- * @returns Berry Flavor
2184
- */
2185
- getBerryFlavorById(id: number): Promise<BerryFlavor>;
2186
- /**
2187
- * Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their nature.
2188
- * Check out [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail.
2189
- * @param name The Berry Flavor name
2190
- * @returns Berry Flavor
2191
- */
2192
- getBerryFlavorByName(name: string): Promise<BerryFlavor>;
2193
- /**
2194
- * List Berries
2195
- * @param offset The first item that you will get
2196
- * @param limit How many berries per page
2197
- * @returns A list of berries
2198
- */
2199
- listBerries(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2200
- /**
2201
- * List Berries
2202
- * @param offset The first item that you will get
2203
- * @param limit How many berry firmnesses per page
2204
- * @returns A list of berry firmnesses
2205
- */
2206
- listBerryFirmnesses(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2207
- /**
2208
- * List Berry Flavors
2209
- * @param offset The first item that you will get
2210
- * @param limit How many Berry Flavors per page
2211
- * @returns A list of Berry Flavors
2212
- */
2213
- listBerryFlavors(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2214
- }
2215
- /**
2216
- * ### Contest Client
2217
- *
2218
- * Client used to access the Contest Endpoints:
2219
- * - [Contest Types](https://pokeapi.co/docs/v2#contest-types)
2220
- * - [Contest Effects](https://pokeapi.co/docs/v2#contest-effects)
2221
- * - [Super Contest Effects](https://pokeapi.co/docs/v2#super-contest-effects)
2222
- * ---
2223
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#contests-section)
2224
- */
2225
- export declare class ContestClient extends BaseClient {
2226
- /**
2227
- * @argument clientOptions Options for the client.
2228
- */
2229
- constructor(clientOptions?: ClientArgs);
2230
- /**
2231
- * Get a Contest Type by it's name
2232
- * @param name The contest type name
2233
- * @returns A Contest Type
2234
- */
2235
- getContestTypeByName(name: string): Promise<ContestType>;
2236
- /**
2237
- * Get a Contest Type by it's ID
2238
- * @param id The Contest Type ID
2239
- * @returns A Contest Type
2240
- */
2241
- getContestTypeById(id: number): Promise<ContestType>;
2242
- /**
2243
- * Get a Contest Effect by it's ID
2244
- * @param id The Contest Effect ID
2245
- * @returns Contest Effect
2246
- */
2247
- getContestEffectById(id: number): Promise<ContestEffect>;
2248
- /**
2249
- * Get a Super Contest Effect by it's ID
2250
- * @param id The Super Contest Effect ID
2251
- * @returns Super Contest Effect
2252
- */
2253
- getSuperContestEffectById(id: number): Promise<SuperContestEffect>;
2254
- /**
2255
- * List Contest Types
2256
- * @param offset The first item that you will get
2257
- * @param limit How many contest types per page
2258
- * @returns A list of contest types
2259
- */
2260
- listContestTypes(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2261
- /**
2262
- * List Contest Effects
2263
- * @param offset The first item that you will get
2264
- * @param limit How many contest effects per page
2265
- * @returns A list of contest effects
2266
- */
2267
- listContestEffects(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2268
- /**
2269
- * List Super Contest Effects
2270
- * @param offset The first item that you will get
2271
- * @param limit How many Super Contest Effect per page
2272
- * @returns A list of Super Contest Effect
2273
- */
2274
- listSuperContestEffects(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2275
- }
2276
- /**
2277
- * ### Encounter Client
2278
- *
2279
- * Client used to access the Encounter Endpoints:
2280
- * - [Encounter Methods](https://pokeapi.co/docs/v2#encounter-methods)
2281
- * - [Encounter Conditions](https://pokeapi.co/docs/v2#encounter-conditions)
2282
- * - [Encounter Condition Values](https://pokeapi.co/docs/v2#encounter-condition-values)
2283
- * ---
2284
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#encounters-section)
2285
- */
2286
- export declare class EncounterClient extends BaseClient {
2287
- /**
2288
- * @argument clientOptions Options for the client.
2289
- */
2290
- constructor(clientOptions?: ClientArgs);
2291
- /**
2292
- * Get an Encounter Method by it's name
2293
- * @param name The Encounter Method name
2294
- * @returns An Encounter Method
2295
- */
2296
- getEncounterMethodByName(name: string): Promise<EncounterMethod>;
2297
- /**
2298
- * Get an Encounter Method by it's ID
2299
- * @param id The Encounter Method ID
2300
- * @returns An Encounter Method
2301
- */
2302
- getEncounterMethodById(id: number): Promise<EncounterMethod>;
2303
- /**
2304
- * Get an Encounter Condition by it's ID
2305
- * @param id The Encounter Condition ID
2306
- * @returns An Encounter Condition
2307
- */
2308
- getEncounterConditionById(id: number): Promise<EncounterCondition>;
2309
- /**
2310
- * Get an Encounter Condition by it's name
2311
- * @param name The Encounter Condition name
2312
- * @returns An Encounter Condition
2313
- */
2314
- getEncounterConditionByName(name: string): Promise<EncounterCondition>;
2315
- /**
2316
- * Get an Encounter Condition Value by it's name
2317
- * @param name The Encounter Condition Value name
2318
- * @returns An Encounter Condition Value
2319
- */
2320
- getEncounterConditionValueByName(name: string): Promise<EncounterConditionValue>;
2321
- /**
2322
- * Get an Encounter Condition Value by it's ID
2323
- * @param id The Encounter Condition Value ID
2324
- * @returns An Encounter Condition Value
2325
- */
2326
- getEncounterConditionValueById(id: number): Promise<EncounterConditionValue>;
2327
- /**
2328
- * List Encounter Methods
2329
- * @param offset The first item that you will get
2330
- * @param limit How many Encounter Methods per page
2331
- * @returns A list of Encounter Methods
2332
- */
2333
- listEncounterMethods(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2334
- /**
2335
- * List Encounter Conditions
2336
- * @param offset The first item that you will get
2337
- * @param limit How many Encounter Conditions per page
2338
- * @returns A list of Encounter Methods
2339
- */
2340
- listEncounterConditions(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2341
- /**
2342
- * List Encounter Condition Values
2343
- * @param offset The first item that you will get
2344
- * @param limit How many Encounter Condition Values per page
2345
- * @returns A list of Encounter Condition Values
2346
- */
2347
- listEncounterConditionValues(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2348
- }
2349
- /**
2350
- * ### Evolution Client
2351
- *
2352
- * Client used to access the Berry Endpoints:
2353
- * - [Evolution Chains](https://pokeapi.co/docs/v2#evolution-chains)
2354
- * - [Evolution Triggers](https://pokeapi.co/docs/v2#evolution-triggers)
2355
- * ---
2356
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#evolution-section)
2357
- */
2358
- export declare class EvolutionClient extends BaseClient {
2359
- /**
2360
- * @argument clientOptions Options for the client.
2361
- */
2362
- constructor(clientOptions?: ClientArgs);
2363
- /**
2364
- * Get an Evolution Chain by it's ID
2365
- * @param id The Evolution Chain ID
2366
- * @returns An Evolution Chain
2367
- */
2368
- getEvolutionChainById(id: number): Promise<EvolutionChain>;
2369
- /**
2370
- * Get an Evolution Trigger by it's ID
2371
- * @param id The Evolution Trigger ID
2372
- * @returns An Evolution Trigger
2373
- */
2374
- getEvolutionTriggerById(id: number): Promise<EvolutionTrigger>;
2375
- /**
2376
- * Get an Evolution Trigger by it's name
2377
- * @param name The Evolution Trigger name
2378
- * @returns An Evolution Trigger
2379
- */
2380
- getEvolutionTriggerByName(name: string): Promise<EvolutionTrigger>;
2381
- /**
2382
- * List Evolution Chains
2383
- * @param offset The first item that you will get
2384
- * @param limit How many Evolution Chains per page
2385
- * @returns A list of Evolution Chains
2386
- */
2387
- listEvolutionChains(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2388
- /**
2389
- * List Evolution Triggers
2390
- * @param offset The first item that you will get
2391
- * @param limit How many Evolution Triggers per page
2392
- * @returns A list of Evolution Triggers
2393
- */
2394
- listEvolutionTriggers(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2395
- }
2396
- /**
2397
- * ### Game Client
2398
- *
2399
- * Client used to access the Game Endpoints:
2400
- * - [Generations](https://pokeapi.co/docs/v2#generations)
2401
- * - [Pokedexes](https://pokeapi.co/docs/v2#pokedexes)
2402
- * - [Versions](https://pokeapi.co/docs/v2#version)
2403
- * - [Version Groups](https://pokeapi.co/docs/v2#version-groups)
2404
- * ---
2405
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#games-section)
2406
- */
2407
- export declare class GameClient extends BaseClient {
2408
- /**
2409
- * @argument clientOptions Options for the client.
2410
- */
2411
- constructor(clientOptions?: ClientArgs);
2412
- /**
2413
- * Get a Generation by it's name
2414
- * @param name The generation name
2415
- * @returns A Generation
2416
- */
2417
- getGenerationByName(name: string): Promise<Generation>;
2418
- /**
2419
- * Get a Generation by it's ID
2420
- * @param id The generation ID
2421
- * @returns A Generation
2422
- */
2423
- getGenerationById(id: number): Promise<Generation>;
2424
- /**
2425
- * Get a Pokedex by it's name
2426
- * @param name The pokedex name
2427
- * @returns A Pokedex
2428
- */
2429
- getPokedexByName(name: string): Promise<Pokedex>;
2430
- /**
2431
- * Get a Pokedex by it's ID
2432
- * @param id The pokedex ID
2433
- * @returns A Pokedex
2434
- */
2435
- getPokedexById(id: number): Promise<Pokedex>;
2436
- /**
2437
- * Get a Version by it's name
2438
- * @param name The version name
2439
- * @returns A Version
2440
- */
2441
- getVersionByName(name: string): Promise<Version>;
2442
- /**
2443
- * Get a Version by it's ID
2444
- * @param id The version ID
2445
- * @returns A Version
2446
- */
2447
- getVersionById(id: number): Promise<Version>;
2448
- /**
2449
- * Get a Version Group by it's name
2450
- * @param name The version group name
2451
- * @returns A Version Group
2452
- */
2453
- getVersionGroupByName(name: string): Promise<VersionGroup>;
2454
- /**
2455
- * Get a Version Group by it's ID
2456
- * @param id The version group ID
2457
- * @returns A Version Group
2458
- */
2459
- getVersionGroupById(id: number): Promise<VersionGroup>;
2460
- /**
2461
- * List Generations
2462
- * @param offset The first item that you will get
2463
- * @param limit How many Generations per page
2464
- * @returns A list of Generations
2465
- */
2466
- listGenerations(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2467
- /**
2468
- * List Pokedexes
2469
- * @param offset The first item that you will get
2470
- * @param limit How many Pokedexes per page
2471
- * @returns A list of Pokedexes
2472
- */
2473
- listPokedexes(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2474
- /**
2475
- * List Versions
2476
- * @param offset The first item that you will get
2477
- * @param limit How many Versions per page
2478
- * @returns A list of Versions
2479
- */
2480
- listVersions(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2481
- /**
2482
- * List Version Groups
2483
- * @param offset The first item that you will get
2484
- * @param limit How many Version Groups per page
2485
- * @returns A list of Version Groups
2486
- */
2487
- listVersionGroups(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2488
- }
2489
- /**
2490
- * ### Item Client
2491
- *
2492
- * Client used to access the Item Endpoints:
2493
- * - [Item](https://pokeapi.co/docs/v2#item)
2494
- * - [Item Attributes](https://pokeapi.co/docs/v2#item-attributes)
2495
- * - [Item Categories](https://pokeapi.co/docs/v2#item-categories)
2496
- * - [Item Filing Effects](https://pokeapi.co/docs/v2#item-fling-effects)
2497
- * - [Item Pockets](https://pokeapi.co/docs/v2#item-pockets)
2498
- * ---
2499
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#items-section)
2500
- */
2501
- export declare class ItemClient extends BaseClient {
2502
- /**
2503
- * @argument clientOptions Options for the client.
2504
- */
2505
- constructor(clientOptions?: ClientArgs);
2506
- /**
2507
- * Get an Item by it's name
2508
- * @param name The item name
2509
- * @returns An Item
2510
- */
2511
- getItemByName(name: string): Promise<Item>;
2512
- /**
2513
- * Get an Item by it's ID
2514
- * @param id The item ID
2515
- * @returns An Item
2516
- */
2517
- getItemById(id: number): Promise<Item>;
2518
- /**
2519
- * Get an Item Attribute by it's name
2520
- * @param name The item attribute name
2521
- * @returns An Item Attribute
2522
- */
2523
- getItemAttributeByName(name: string): Promise<ItemAttribute>;
2524
- /**
2525
- * Get an Item Attribute by it's ID
2526
- * @param id The item attribute ID
2527
- * @returns An Item Attribute
2528
- */
2529
- getItemAttributeById(id: number): Promise<ItemAttribute>;
2530
- /**
2531
- * Get an Item Category by it's name
2532
- * @param name The item category name
2533
- * @returns An Item Category
2534
- */
2535
- getItemCategoryByName(name: string): Promise<ItemCategory>;
2536
- /**
2537
- * Get an Item Category by it's ID
2538
- * @param id The item category ID
2539
- * @returns An Item Category
2540
- */
2541
- getItemCategoryById(id: number): Promise<ItemCategory>;
2542
- /**
2543
- * Get an Item Filing Effect by it's name
2544
- * @param name The item filing effect name
2545
- * @returns An Item Filing Effect
2546
- */
2547
- getItemFlingEffectByName(name: string): Promise<ItemFlingEffect>;
2548
- /**
2549
- * Get an Item Filing Effect by it's ID
2550
- * @param id The item filing effect ID
2551
- * @returns An Item Filing Effect
2552
- */
2553
- getItemFlingEffectById(id: number): Promise<ItemFlingEffect>;
2554
- /**
2555
- * Get an Item Pocket by it's name
2556
- * @param name The item pocket name
2557
- * @returns An Item Pocket
2558
- */
2559
- getItemPocketByName(name: string): Promise<ItemPocket>;
2560
- /**
2561
- * Get an Item Pocket by it's ID
2562
- * @param id The item pocket ID
2563
- * @returns An Item Pocket
2564
- */
2565
- getItemPocketById(id: number): Promise<ItemPocket>;
2566
- /**
2567
- * List Items
2568
- * @param offset The first item that you will get
2569
- * @param limit How many Items per page
2570
- * @returns A list of Items
2571
- */
2572
- listItems(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2573
- /**
2574
- * List Item Attributes
2575
- * @param offset The first item that you will get
2576
- * @param limit How many Item Attributes per page
2577
- * @returns A list of Item Attributes
2578
- */
2579
- listItemAttributes(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2580
- /**
2581
- * List Item Categories
2582
- * @param offset The first item that you will get
2583
- * @param limit How many Item Categories per page
2584
- * @returns A list of Item Categories
2585
- */
2586
- listItemCategories(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2587
- /**
2588
- * List Item Filing Effects
2589
- * @param offset The first item that you will get
2590
- * @param limit How many Item Filing Effects per page
2591
- * @returns A list of Item Filing Effects
2592
- */
2593
- listItemFilingEffects(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2594
- /**
2595
- * List Item Pockets
2596
- * @param offset The first item that you will get
2597
- * @param limit How many Item Pockets per page
2598
- * @returns A list of Item Pockets
2599
- */
2600
- listItemPockets(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2601
- }
2602
- /**
2603
- * ### Location Client
2604
- *
2605
- * Client used to access the Location Endpoints:
2606
- * - [Locations](https://pokeapi.co/docs/v2#locations)
2607
- * - [Location Areas](https://pokeapi.co/docs/v2#location-areas)
2608
- * - [Pal Park Areas](https://pokeapi.co/docs/v2#pal-park-areas)
2609
- * - [Regions](https://pokeapi.co/docs/v2#regions)
2610
- * ---
2611
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#locations-section)
2612
- */
2613
- export declare class LocationClient extends BaseClient {
2614
- /**
2615
- * @argument clientOptions Options for the client.
2616
- */
2617
- constructor(clientOptions?: ClientArgs);
2618
- /**
2619
- * Get a Location by it's name
2620
- * @param name The Location name
2621
- * @returns A Location
2622
- */
2623
- getLocationByName(name: string): Promise<Location>;
2624
- /**
2625
- * Get a Location by it's ID
2626
- * @param id The Location ID
2627
- * @returns A location
2628
- */
2629
- getLocationById(id: number): Promise<Location>;
2630
- /**
2631
- * Get a Location Area by it's name
2632
- * @param name The Location Area name
2633
- * @returns A Location Area
2634
- */
2635
- getLocationAreaByName(name: string): Promise<LocationArea>;
2636
- /**
2637
- * Get a Location Area by it's ID
2638
- * @param id The Location Area ID
2639
- * @returns A Location Area
2640
- */
2641
- getLocationAreaById(id: number): Promise<LocationArea>;
2642
- /**
2643
- * Get a Pal Park Area by it's name
2644
- * @param name The Pal Park Area name
2645
- * @returns A Pal Park Area
2646
- */
2647
- getPalParkAreaByName(name: string): Promise<PalParkArea>;
2648
- /**
2649
- * Get a Pal Park Area by it's ID
2650
- * @param id The Pal Park Area ID
2651
- * @returns A Pal Park Area
2652
- */
2653
- getPalParkAreaById(id: number): Promise<PalParkArea>;
2654
- /**
2655
- * Get a Region by it's name
2656
- * @param name The Region name
2657
- * @returns A Region
2658
- */
2659
- getRegionByName(name: string): Promise<Region>;
2660
- /**
2661
- * Get a Region by it's ID
2662
- * @param id The Region ID
2663
- * @returns A Region
2664
- */
2665
- getRegionById(id: number): Promise<Region>;
2666
- /**
2667
- * List Locations
2668
- * @param offset The first item that you will get
2669
- * @param limit How many Locations per page
2670
- * @returns A list of Locations
2671
- */
2672
- listLocations(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2673
- /**
2674
- * List Location Areas
2675
- * @param offset The first item that you will get
2676
- * @param limit How many Locations per page
2677
- * @returns A list of Location Areas
2678
- */
2679
- listLocationAreas(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2680
- /**
2681
- * List Pal Park Areas
2682
- * @param offset The first item that you will get
2683
- * @param limit How many Pal Park Areas per page
2684
- * @returns A list of Pal Park Areas
2685
- */
2686
- listPalParkAreas(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2687
- /**
2688
- * List Regions
2689
- * @param offset The first item that you will get
2690
- * @param limit How many Regions per page
2691
- * @returns A list of Regions
2692
- */
2693
- listRegions(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2694
- }
2695
- /**
2696
- * ### Machine Client
2697
- *
2698
- * Client used to access the Machine Endpoints:
2699
- * - [Machines](https://pokeapi.co/docs/v2#machines)
2700
- *
2701
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#machines-section)
2702
- */
2703
- export declare class MachineClient extends BaseClient {
2704
- /**
2705
- * @argument clientOptions Options for the client.
2706
- */
2707
- constructor(clientOptions?: ClientArgs);
2708
- /**
2709
- * Get a Machine by it's ID
2710
- * @param id The Machine ID
2711
- * @returns A Machine
2712
- */
2713
- getMachineById(id: number): Promise<Machine>;
2714
- /**
2715
- * List Machines
2716
- * @param offset The first item that you will get
2717
- * @param limit How many Machines per page
2718
- * @returns A list of Machines
2719
- */
2720
- listMachines(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2721
- }
2722
- /**
2723
- * ### Move Client
2724
- *
2725
- * Client used to access the Move Endpoints:
2726
- * - [Moves](https://pokeapi.co/docs/v2#moves)
2727
- * - [Move Ailments](https://pokeapi.co/docs/v2#move-ailments)
2728
- * - [Move Battle Styles](https://pokeapi.co/docs/v2#move-battle-styles)
2729
- * - [Move Categories](https://pokeapi.co/docs/v2#move-categories)
2730
- * - [Move Damage Classes](https://pokeapi.co/docs/v2#move-damage-classes)
2731
- * - [Move Learn Methods](https://pokeapi.co/docs/v2#move-learn-methods)
2732
- * - [Move Move Targets](https://pokeapi.co/docs/v2#move-targets)
2733
- * ---
2734
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#moves-section)
2735
- */
2736
- export declare class MoveClient extends BaseClient {
2737
- /**
2738
- * @argument clientOptions Options for the client.
2739
- */
2740
- constructor(clientOptions?: ClientArgs);
2741
- /**
2742
- * Get a Move by it's name
2743
- * @param name The move name
2744
- * @returns A Move
2745
- */
2746
- getMoveByName(name: string): Promise<Move>;
2747
- /**
2748
- * Get a Move by it's ID
2749
- * @param id The Move ID
2750
- * @returns A Move
2751
- */
2752
- getMoveById(id: number): Promise<Move>;
2753
- /**
2754
- * Get a Move Ailment by it's name
2755
- * @param name The Move Ailment name
2756
- * @returns A Move Ailment
2757
- */
2758
- getMoveAilmentByName(name: string): Promise<MoveAilment>;
2759
- /**
2760
- * Get a Move Ailment by it's ID
2761
- * @param id The Move Ailment ID
2762
- * @returns A Move Ailment
2763
- */
2764
- getMoveAilmentById(id: number): Promise<MoveAilment>;
2765
- /**
2766
- * Get a Move Battle Style by it's name
2767
- * @param name The Move Battle Style name
2768
- * @returns A Move Battle Style
2769
- */
2770
- getMoveBattleStyleByName(name: string): Promise<MoveBattleStyle>;
2771
- /**
2772
- * Get a Move Battle Style by it's ID
2773
- * @param id The Move Battle Style ID
2774
- * @returns A Move Battle Style
2775
- */
2776
- getMoveBattleStyleById(id: number): Promise<MoveBattleStyle>;
2777
- /**
2778
- * Get a Move Battle Category by it's name
2779
- * @param name The Move Category name
2780
- * @returns A Move Category
2781
- */
2782
- getMoveCategoryByName(name: string): Promise<MoveCategory>;
2783
- /**
2784
- * Get a Move Battle Category by it's ID
2785
- * @param id The Move Category ID
2786
- * @returns A Move Category
2787
- */
2788
- getMoveCategoryById(id: number): Promise<MoveCategory>;
2789
- /**
2790
- * Get a Move Damage Class by it's name
2791
- * @param name The Move Damage Class name
2792
- * @returns A Move Damage Class
2793
- */
2794
- getMoveDamageClassByName(name: string): Promise<MoveDamageClass>;
2795
- /**
2796
- * Get a Move Damage Class by it's ID
2797
- * @param id The Move Damage Class ID
2798
- * @returns A Move Damage Class
2799
- */
2800
- getMoveDamageClassById(id: number): Promise<MoveDamageClass>;
2801
- /**
2802
- * Get a Move Learn Method by it's name
2803
- * @param name The Move Learn Method name
2804
- * @returns A Move Learn Method
2805
- */
2806
- getMoveLearnMethodByName(name: string): Promise<MoveLearnMethod>;
2807
- /**
2808
- * Get a Move Learn Method by it's ID
2809
- * @param id The Move Learn Method ID
2810
- * @returns A Move Learn Method
2811
- */
2812
- getMoveLearnMethodById(id: number): Promise<MoveLearnMethod>;
2813
- /**
2814
- * Get a Move Target by it's name
2815
- * @param name The Move Target name
2816
- * @returns A Move Target
2817
- */
2818
- getMoveTargetByName(name: string): Promise<MoveTarget>;
2819
- /**
2820
- * Get a Move Target by it's ID
2821
- * @param id The Move Target ID
2822
- * @returns A Move Target
2823
- */
2824
- getMoveTargetById(id: number): Promise<MoveTarget>;
2825
- /**
2826
- * List Moves
2827
- * @param offset The first item that you will get
2828
- * @param limit How many Moves per page
2829
- * @returns A list of Moves
2830
- */
2831
- listMoves(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2832
- /**
2833
- * List Move Ailments
2834
- * @param offset The first item that you will get
2835
- * @param limit How many Move Ailments per page
2836
- * @returns A list of Move Ailments
2837
- */
2838
- listMoveAilments(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2839
- /**
2840
- * List Move Battle Styles
2841
- * @param offset The first item that you will get
2842
- * @param limit How many Move Battle Styles per page
2843
- * @returns A list of Move Battle Styles
2844
- */
2845
- listMoveBattleStyles(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2846
- /**
2847
- * List Move Categories
2848
- * @param offset The first item that you will get
2849
- * @param limit How many Move Categories per page
2850
- * @returns A list of Move Categories
2851
- */
2852
- listMoveCategories(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2853
- /**
2854
- * List Move Damage Classes
2855
- * @param offset The first item that you will get
2856
- * @param limit How many Move Damage Classes per page
2857
- * @returns A list of Move Damage Classes
2858
- */
2859
- listMoveDamageClasses(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2860
- /**
2861
- * List Move Learn Methods
2862
- * @param offset The first item that you will get
2863
- * @param limit How many Move Learn Methods per page
2864
- * @returns A list of Move Learn Methods
2865
- */
2866
- listMoveLearnMethods(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2867
- /**
2868
- * List Move Targets
2869
- * @param offset The first item that you will get
2870
- * @param limit How many Move Targets per page
2871
- * @returns A list of Move Targets
2872
- */
2873
- listMoveTargets(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
2874
- }
2875
- /**
2876
- * ### Pokemon Client
2877
- *
2878
- * Client used to access the Pokemon Endpoints:
2879
- * - [Abilities](https://pokeapi.co/docs/v2#abilities)
2880
- * - [Characteristics](https://pokeapi.co/docs/v2#characteristics)
2881
- * - [Egg Groups](https://pokeapi.co/docs/v2#egg-groups)
2882
- * - [Genders](https://pokeapi.co/docs/v2#genders)
2883
- * - [Growth Rates](https://pokeapi.co/docs/v2#growth-rates)
2884
- * - [Natures](https://pokeapi.co/docs/v2#natures)
2885
- * - [Pokeathlon Stats](https://pokeapi.co/docs/v2#pokeathlon-stats)
2886
- * - [Pokemon](https://pokeapi.co/docs/v2#pokemon)
2887
- * - [Pokemon Location Areas](https://pokeapi.co/docs/v2#pokemon-location-areas)
2888
- * - [Pokemon Colors](https://pokeapi.co/docs/v2#pokemon-colors)
2889
- * - [Pokemon Forms](https://pokeapi.co/docs/v2#pokemon-forms)
2890
- * - [Pokemon Habitats](https://pokeapi.co/docs/v2#pokemon-habitats)
2891
- * - [Pokemon Shapes](https://pokeapi.co/docs/v2#pokemon-shapes)
2892
- * - [Pokemon Species](https://pokeapi.co/docs/v2#pokemon-species)
2893
- * - [Stats](https://pokeapi.co/docs/v2#stats)
2894
- * - [Types](https://pokeapi.co/docs/v2#types)
2895
- * ---
2896
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#pokemon-section)
2897
- */
2898
- export declare class PokemonClient extends BaseClient {
2899
- /**
2900
- * @argument clientOptions Options for the client.
2901
- */
2902
- constructor(clientOptions?: ClientArgs);
2903
- /**
2904
- * Get an Ability by it's name
2905
- * @param name The Ability name
2906
- * @returns An Ability
2907
- */
2908
- getAbilityByName(name: string): Promise<Ability>;
2909
- /**
2910
- * Get an Ability by it's ID
2911
- * @param id The Ability ID
2912
- * @returns An Ability
2913
- */
2914
- getAbilityById(id: number): Promise<Ability>;
2915
- /**
2916
- * Get a Characteristic by it's ID
2917
- * @param id The Characteristic ID
2918
- * @returns A Characteristic
2919
- */
2920
- getCharacteristicById(id: number): Promise<Characteristic>;
2921
- /**
2922
- * Get an Egg Group by it's name
2923
- * @param name The Egg Group name
2924
- * @returns An Egg Group
2925
- */
2926
- getEggGroupByName(name: string): Promise<EggGroup>;
2927
- /**
2928
- * Get an Egg Group by it's ID
2929
- * @param id The Egg Group ID
2930
- * @returns An Egg Group
2931
- */
2932
- getEggGroupById(id: number): Promise<EggGroup>;
2933
- /**
2934
- * Get a Gender by it's name
2935
- * @param name The gender name
2936
- * @returns An Egg Group
2937
- */
2938
- getGenderByName(name: string): Promise<Gender>;
2939
- /**
2940
- * Get a Gender by it's ID
2941
- * @param id The Gender ID
2942
- * @returns A Gender
2943
- */
2944
- getGenderById(id: number): Promise<Gender>;
2945
- /**
2946
- * Get a Growth Rate by it's name
2947
- * @param name The Growth Rate name
2948
- * @returns A Growth Rate
2949
- */
2950
- getGrowthRateByName(name: string): Promise<GrowthRate>;
2951
- /**
2952
- * Get a Growth Rate by it's ID
2953
- * @param id The Growth Rate ID
2954
- * @returns A Growth Rate
2955
- */
2956
- getGrowthRateById(id: number): Promise<GrowthRate>;
2957
- /**
2958
- * Get a Nature by it's name
2959
- * @param name The Nature name
2960
- * @returns A Nature
2961
- */
2962
- getNatureByName(name: string): Promise<Nature>;
2963
- /**
2964
- * Get a Nature by it's ID
2965
- * @param id The Nature ID
2966
- * @returns A Nature
2967
- */
2968
- getNatureById(id: number): Promise<Nature>;
2969
- /**
2970
- * Get a Pokeathlon Stat by it's name
2971
- * @param name The Pokeathlon Stat name
2972
- * @returns A Pokeathlon Stat
2973
- */
2974
- getPokeathlonStatByName(name: string): Promise<PokeathlonStat>;
2975
- /**
2976
- * Get a Pokeathlon Stat by it's ID
2977
- * @param id The Pokeathlon Stat ID
2978
- * @returns A Pokeathlon Stat
2979
- */
2980
- getPokeathlonStatById(id: number): Promise<PokeathlonStat>;
2981
- /**
2982
- * Get a Pokemon by it's name
2983
- * @param name The Pokemon name
2984
- * @returns A Pokemon Stat
2985
- */
2986
- getPokemonByName(name: string): Promise<Pokemon>;
2987
- /**
2988
- * Get a Pokemon by it's ID
2989
- * @param id The Pokemon ID
2990
- * @returns A Pokemon
2991
- */
2992
- getPokemonById(id: number): Promise<Pokemon>;
2993
- /**
2994
- * Get a Pokemon Location Area by it's ID
2995
- * @param id The Pokemon Location Area ID
2996
- * @returns A Pokemon Location Area
2997
- */
2998
- getPokemonLocationAreaById(id: number): Promise<LocationAreaEncounter[]>;
2999
- /**
3000
- * Get a Pokemon Color by it's name
3001
- * @param name The Pokemon Color name
3002
- * @returns A Pokemon Color
3003
- */
3004
- getPokemonColorByName(name: string): Promise<PokemonColor>;
3005
- /**
3006
- * Get a Pokemon Color by it's ID
3007
- * @param id The Pokemon Color ID
3008
- * @returns A Pokemon Color
3009
- */
3010
- getPokemonColorById(id: number): Promise<PokemonColor>;
3011
- /**
3012
- * Get a Pokemon Form by it's name
3013
- * @param name The Pokemon Form name
3014
- * @returns A Pokemon Form
3015
- */
3016
- getPokemonFormByName(name: string): Promise<PokemonForm>;
3017
- /**
3018
- * Get a Pokemon Form by it's ID
3019
- * @param id The Pokemon Form ID
3020
- * @returns A Pokemon Form
3021
- */
3022
- getPokemonFormById(id: number): Promise<PokemonForm>;
3023
- /**
3024
- * Get a Pokemon Habitat by it's name
3025
- * @param name The Pokemon Habitat name
3026
- * @returns A Pokemon Habitat
3027
- */
3028
- getPokemonHabitatByName(name: string): Promise<PokemonHabitat>;
3029
- /**
3030
- * Get a Pokemon Habitat by it's ID
3031
- * @param id The Pokemon Habitat Form ID
3032
- * @returns A Pokemon Habitat
3033
- */
3034
- getPokemonHabitatById(id: number): Promise<PokemonHabitat>;
3035
- /**
3036
- * Get a Pokemon Shape by it's name
3037
- * @param name The Pokemon Shape name
3038
- * @returns A Pokemon Shape
3039
- */
3040
- getPokemonShapeByName(name: string): Promise<PokemonShape>;
3041
- /**
3042
- * Get a Pokemon Shape by it's ID
3043
- * @param id The Pokemon Shape Form ID
3044
- * @returns A Pokemon Shape
3045
- */
3046
- getPokemonShapeById(id: number): Promise<PokemonShape>;
3047
- /**
3048
- * Get a Pokemon Species by it's name
3049
- * @param name The Pokemon Species name
3050
- * @returns A Pokemon Species
3051
- */
3052
- getPokemonSpeciesByName(name: string): Promise<PokemonSpecies>;
3053
- /**
3054
- * Get a Pokemon Species by it's ID
3055
- * @param id The Pokemon Species Form ID
3056
- * @returns A Pokemon Species
3057
- */
3058
- getPokemonSpeciesById(id: number): Promise<PokemonSpecies>;
3059
- /**
3060
- * Get a Stat by it's name
3061
- * @param name The Stat name
3062
- * @returns A Stat
3063
- */
3064
- getStatByName(name: string): Promise<Stat>;
3065
- /**
3066
- * Get a Stat by it's ID
3067
- * @param id The Stat ID
3068
- * @returns A Stat
3069
- */
3070
- getStatById(id: number): Promise<Stat>;
3071
- /**
3072
- * Get a Type by it's name
3073
- * @param name The Type name
3074
- * @returns A Type
3075
- */
3076
- getTypeByName(name: string): Promise<Type>;
3077
- /**
3078
- * Get a Type by it's ID
3079
- * @param id The Type ID
3080
- * @returns A Type
3081
- */
3082
- getTypeById(id: number): Promise<Type>;
3083
- /**
3084
- * List Abilities
3085
- * @param offset The first item that you will get
3086
- * @param limit How many Abilities per page
3087
- * @returns A list of Abilities
3088
- */
3089
- listAbilities(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3090
- /**
3091
- * List Characteristics
3092
- * @param offset The first item that you will get
3093
- * @param limit How many Characteristics per page
3094
- * @returns A list of Characteristics
3095
- */
3096
- listCharacteristics(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3097
- /**
3098
- * List Egg Groups
3099
- * @param offset The first item that you will get
3100
- * @param limit How many Egg Groups per page
3101
- * @returns A list of Egg Groups
3102
- */
3103
- listEggGroups(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3104
- /**
3105
- * List Genders
3106
- * @param offset The first item that you will get
3107
- * @param limit How many Genders per page
3108
- * @returns A list of Genders
3109
- */
3110
- listGenders(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3111
- /**
3112
- * List Growth Rates
3113
- * @param offset The first item that you will get
3114
- * @param limit How many Growth Rates per page
3115
- * @returns A list of Growth Rates
3116
- */
3117
- listGrowthRates(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3118
- /**
3119
- * List Natures
3120
- * @param offset The first item that you will get
3121
- * @param limit How many Growth Natures per page
3122
- * @returns A list of Natures
3123
- */
3124
- listNatures(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3125
- /**
3126
- * List Pokeathlon Stats
3127
- * @param offset The first item that you will get
3128
- * @param limit How many Pokeathlon Stats per page
3129
- * @returns A list of Pokeathlon Stats
3130
- */
3131
- listPokeathlonStats(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3132
- /**
3133
- * List Pokemons
3134
- * @param offset The first item that you will get
3135
- * @param limit How many Pokemons Stats per page
3136
- * @returns A list of Pokemons
3137
- */
3138
- listPokemons(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3139
- /**
3140
- * List Pokemon Colors
3141
- * @param offset The first item that you will get
3142
- * @param limit How many Pokemon Colors per page
3143
- * @returns A list of Pokemon Colors
3144
- */
3145
- listPokemonColors(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3146
- /**
3147
- * List Pokemon Forms
3148
- * @param offset The first item that you will get
3149
- * @param limit How many Pokemon Forms per page
3150
- * @returns A list of Pokemon Forms
3151
- */
3152
- listPokemonForms(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3153
- /**
3154
- * List Pokemon Habitats
3155
- * @param offset The first item that you will get
3156
- * @param limit How many Pokemon Habitats per page
3157
- * @returns A list of Pokemon Habitats
3158
- */
3159
- listPokemonHabitats(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3160
- /**
3161
- * List Pokemon Shapes
3162
- * @param offset The first item that you will get
3163
- * @param limit How many Pokemon Shapes per page
3164
- * @returns A list of Pokemon Shapes
3165
- */
3166
- listPokemonShapes(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3167
- /**
3168
- * List Pokemon Species
3169
- * @param offset The first item that you will get
3170
- * @param limit How many Pokemon Species per page
3171
- * @returns A list of Pokemon Species
3172
- */
3173
- listPokemonSpecies(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3174
- /**
3175
- * List Stats
3176
- * @param offset The first item that you will get
3177
- * @param limit How many Stats per page
3178
- * @returns A list of Stats
3179
- */
3180
- listStats(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3181
- /**
3182
- * List Types
3183
- * @param offset The first item that you will get
3184
- * @param limit How many Types per page
3185
- * @returns A list of Types
3186
- */
3187
- listTypes(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3188
- }
3189
- /**
3190
- * ### Utility Client
3191
- *
3192
- * Client used to access the Utility Endpoints:
3193
- * - [Languages](https://pokeapi.co/docs/v2#utility-section)
3194
- * - Resources
3195
- * ---
3196
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#utility-section)
3197
- */
3198
- export declare class UtilityClient extends BaseClient {
3199
- constructor(clientOptions?: ClientArgs);
3200
- /**
3201
- * Get a Language by it's ID
3202
- * @param id The Language ID
3203
- * @returns Language
3204
- */
3205
- getLanguageById(id: number): Promise<Language>;
3206
- /**
3207
- * Get a Language by it's name
3208
- * @param name The Language name
3209
- * @returns Language
3210
- */
3211
- getLanguageByName(name: string): Promise<Language>;
3212
- /**
3213
- * Get a Resource by it's url
3214
- * @param url The Resource url
3215
- * @returns Resource
3216
- */
3217
- getResourceByUrl(url: string): Promise<any>;
3218
- /**
3219
- * List Languages
3220
- * @param offset The first item that you will get
3221
- * @param limit How many Languages per page
3222
- * @returns A list of Languages
3223
- */
3224
- listLanguages(offset?: number, limit?: number): Promise<NamedAPIResourceList>;
3225
- }
3226
- /**
3227
- * ### Main Client
3228
- *
3229
- * The main client used to access all the PokéAPI Endpoints:
3230
- * - [Berries](https://pokeapi.co/docs/v2#berries-section)
3231
- * - [Contests](https://pokeapi.co/docs/v2#contests-section)
3232
- * - [Encounters](https://pokeapi.co/docs/v2#encounters-section)
3233
- * - [Evolution](https://pokeapi.co/docs/v2#evolution-section)
3234
- * - [Games](https://pokeapi.co/docs/v2#games-section)
3235
- * - [Items](https://pokeapi.co/docs/v2#items-section)
3236
- * - [Locations](https://pokeapi.co/docs/v2#locations-section)
3237
- * - [Machines](https://pokeapi.co/docs/v2#machines-section)
3238
- * - [Moves](https://pokeapi.co/docs/v2#moves-section)
3239
- * - [Pokémon](https://pokeapi.co/docs/v2#pokemon-section)
3240
- * - [Utility](https://pokeapi.co/docs/v2#utility-section)
3241
- * ---
3242
- * See [PokéAPI Documentation](https://pokeapi.co/docs/v2)
3243
- */
3244
- export declare class MainClient extends BaseClient {
3245
- berry: BerryClient;
3246
- contest: ContestClient;
3247
- encounter: EncounterClient;
3248
- evolution: EvolutionClient;
3249
- game: GameClient;
3250
- item: ItemClient;
3251
- location: LocationClient;
3252
- machine: MachineClient;
3253
- move: MoveClient;
3254
- pokemon: PokemonClient;
3255
- constructor(clientOptions?: ClientArgs);
3256
- }
3257
- export declare enum BaseURL {
3258
- REST = "https://pokeapi.co/api/v2"
3259
- }
3260
- /**
3261
- * Endpoints of the PokéAPI
3262
- */
3263
- export declare enum Endpoints {
3264
- Berry = "/berry",
3265
- BerryFirmness = "/berry-firmness",
3266
- BerryFlavor = "/berry-flavor",
3267
- ContestType = "/contest-type",
3268
- ContestEffect = "/contest-effect",
3269
- SuperContestEffect = "/super-contest-effect",
3270
- EncouterMethod = "/encounter-method",
3271
- EncounterCondition = "/encounter-condition",
3272
- EncouterConditionValue = "/encounter-condition-value",
3273
- EvolutionChain = "/evolution-chain",
3274
- EvolutionTrigger = "/evolution-trigger",
3275
- Generation = "/generation",
3276
- Pokedex = "/pokedex",
3277
- Version = "/version",
3278
- VersionGroup = "/version-group",
3279
- Item = "/item",
3280
- ItemAttribute = "/item-attribute",
3281
- ItemCategory = "/item-category",
3282
- ItemFlingEffect = "/item-fling-effect",
3283
- ItemPocket = "/item-pocket",
3284
- Location = "/location",
3285
- LocationArea = "/location-area",
3286
- PalParkArea = "/pal-park-area",
3287
- Region = "/region",
3288
- Machine = "/machine",
3289
- Move = "/move",
3290
- MoveAilment = "/move-ailment",
3291
- MoveBattleStyle = "/move-battle-style",
3292
- MoveCategory = "/move-category",
3293
- MoveDamageClass = "/move-damage-class",
3294
- MoveLearnMethod = "/move-learn-method",
3295
- MoveTarget = "/move-target",
3296
- Ability = "/ability",
3297
- Characteristic = "/characteristic",
3298
- EggGroup = "/egg-group",
3299
- Gender = "/gender",
3300
- GrowthRate = "/growth-rate",
3301
- Nature = "/nature",
3302
- PokeathlonStat = "/pokeathlon-stat",
3303
- Pokemon = "/pokemon",
3304
- PokemonLocationArea = "/pokemon/:id/encounters",
3305
- PokemonColor = "/pokemon-color",
3306
- PokemonForm = "/pokemon-form",
3307
- PokemonHabitat = "/pokemon-habitat",
3308
- PokemonShape = "/pokemon-shape",
3309
- PokemonSpecies = "/pokemon-species",
3310
- Stat = "/stat",
3311
- Type = "/type",
3312
- Language = "/language"
3313
- }
3314
- /** Enum of Berries (NAME - ID) */
3315
- export declare enum Berries {
3316
- CHERI = 1,
3317
- CHESTO = 2,
3318
- PECHA = 3,
3319
- RAWST = 4,
3320
- ASPEAR = 5,
3321
- LEPPA = 6,
3322
- ORAN = 7,
3323
- PERSIM = 8,
3324
- LUM = 9,
3325
- SITRUS = 10,
3326
- FIGY = 11,
3327
- WIKI = 12,
3328
- MAGO = 13,
3329
- AGUAV = 14,
3330
- IAPAPA = 15,
3331
- RAZZ = 16,
3332
- BLUK = 17,
3333
- NANAB = 18,
3334
- WEPEAR = 19,
3335
- PINAP = 20,
3336
- POMEG = 21,
3337
- KELPSY = 22,
3338
- QUALOT = 23,
3339
- HONDEW = 24,
3340
- GREPA = 25,
3341
- TAMATO = 26,
3342
- CORNN = 27,
3343
- MAGOST = 28,
3344
- RABUTA = 29,
3345
- NOMEL = 30,
3346
- SPELON = 31,
3347
- PAMTRE = 32,
3348
- WATMEL = 33,
3349
- DURIN = 34,
3350
- BELUE = 35,
3351
- OCCA = 36,
3352
- PASSHO = 37,
3353
- WACAN = 38,
3354
- RINDO = 39,
3355
- YACHE = 40,
3356
- CHOPLE = 41,
3357
- KEBIA = 42,
3358
- SHUCA = 43,
3359
- COBA = 44,
3360
- PAYAPA = 45,
3361
- TANGA = 46,
3362
- CHARTI = 47,
3363
- KASIB = 48,
3364
- HABAN = 49,
3365
- COLBUR = 50,
3366
- BABIRI = 51,
3367
- CHILAN = 52,
3368
- LIECHI = 53,
3369
- GANLON = 54,
3370
- SALAC = 55,
3371
- PETAYA = 56,
3372
- APICOT = 57,
3373
- LANSAT = 58,
3374
- STARF = 59,
3375
- ENIGMA = 60,
3376
- MICLE = 61,
3377
- CUSTAP = 62,
3378
- JABOCA = 63,
3379
- ROWAP = 64
3380
- }
3381
- /** Enum of Berry Firmnesses (NAME - ID) */
3382
- export declare enum BerryFirmnesses {
3383
- VERY_SOFT = 1,
3384
- SOFT = 2,
3385
- HARD = 3,
3386
- VERY_HARD = 4,
3387
- SUPER_HARD = 5
3388
- }
3389
- export declare enum BerryFlavors {
3390
- SPICY = 1,
3391
- DRY = 2,
3392
- SWEET = 3,
3393
- BITTER = 4,
3394
- SOUR = 5
3395
- }
3396
- export declare enum ContestTypes {
3397
- COOL = 1,
3398
- BEAUTY = 2,
3399
- CUTE = 3,
3400
- SMART = 4,
3401
- TOUGH = 5
3402
- }
3403
- export declare enum EncounterMethods {
3404
- WALK = 1,
3405
- OLD_ROD = 2,
3406
- GOOD_ROD = 3,
3407
- SUPER_ROD = 4,
3408
- SURF = 5,
3409
- ROCK_SMASH = 6,
3410
- HEADBUTT = 7,
3411
- DARK_GRASS = 8,
3412
- GRASS_SPOTS = 9,
3413
- CAVE_SPOTS = 10,
3414
- BRIDGE_SPOTS = 11,
3415
- SUPER_ROD_SPOTS = 12,
3416
- SURF_SPOTS = 13,
3417
- YELLOW_FLOWERS = 14,
3418
- PURPLE_FLOWERS = 15,
3419
- RED_FLOWERS = 16,
3420
- ROUGH_TERRAIN = 17,
3421
- GIFT = 18,
3422
- GIFT_EGG = 19,
3423
- ONLY_ONE = 20,
3424
- POKEFLUTE = 21,
3425
- HEADBUTT_LOW = 22,
3426
- HEADBUTT_NORMAL = 23,
3427
- HEADBUT_HIGH = 24,
3428
- SQUIRT_BOTTLE = 25,
3429
- WAILMER_PAIL = 26,
3430
- SEAWEED = 27
3431
- }
3432
- export declare enum EncounterConditions {
3433
- SWARM = 1,
3434
- TIME = 2,
3435
- RADAR = 3,
3436
- SLOT2 = 4,
3437
- RADIO = 5,
3438
- SEASON = 6,
3439
- STARTER = 7,
3440
- TV_OPTION = 8,
3441
- STORY_PROGRESS = 9,
3442
- OTHER = 10
3443
- }
3444
- export declare enum EncounterConditionValues {
3445
- SWARM_YES = 1,
3446
- SWARM_NO = 2,
3447
- TIME_MORNING = 3,
3448
- TIME_DAY = 4,
3449
- TIME_NIGHT = 5,
3450
- RADAR_ON = 6,
3451
- RADAR_OFF = 7,
3452
- SLOT2_NONE = 8,
3453
- SLOT2_RUBY = 9,
3454
- SLOT2_SAPHIRE = 10,
3455
- SLOT2_EMERALD = 11,
3456
- SLOT2_FIRERED = 12,
3457
- SLOT2_LEAFGREEN = 13,
3458
- RADIO_OFF = 14,
3459
- RADIO_HOEN = 15,
3460
- RADIO_SINNOH = 16,
3461
- SEASON_SPRING = 17,
3462
- SEASON_SUMMER = 18,
3463
- SWASON_AUTUMN = 19,
3464
- SEASON_WINTER = 20,
3465
- STARTER_BULBASAUR = 21,
3466
- STARTER_SQUIRTLE = 22,
3467
- STARTER_CHARMANDER = 23,
3468
- STARTER_CHESPIN = 24,
3469
- STARTER_FENNEKIN = 25,
3470
- STARTER_FROAKIE = 26,
3471
- TV_OPTION_BLUE = 27,
3472
- TV_OPTION_RED = 28,
3473
- STORY_PROGRESS_AWAKENED_BEASTS = 29,
3474
- STORY_PROGRESS_BEAT_GALACTIC_CORONET = 30,
3475
- STORY_PROGRESS_OAK_ETERNA_CITY = 31,
3476
- STORY_PROGRESS_OAK_VERMILION_COPYCAT = 32,
3477
- STORY_PROGRESS_MET_TORNADUS_THUNDURUS = 33,
3478
- STORY_PROGRESS_BEAT_ELITE_FOUR_ROUND_TWO = 34,
3479
- STORY_PROGRESS_HALL_OF_FAME = 35,
3480
- STORY_PROGRESS_NONE = 36,
3481
- STORY_PROGRESS_NATIONAL_DEX = 37,
3482
- OTHER_NONE = 38,
3483
- OTHER_SNORLAX_LL_BEAT_LEAGUE = 39
3484
- }
3485
- export declare enum EvolutionTriggers {
3486
- LEVEL_UP = 1,
3487
- TRADE = 2,
3488
- USE_ITEM = 3,
3489
- SHED = 4,
3490
- SPIN = 5,
3491
- TOWER_OF_DARKNESS = 6,
3492
- TOWER_OF_WATER = 7,
3493
- THREE_CRITICAL_HITS = 8,
3494
- TAKE_DAMAGE = 9,
3495
- OTHER = 10
3496
- }
3497
- export declare enum Generations {
3498
- GENERATION_I = 1,
3499
- GENERATION_II = 2,
3500
- GENERATION_III = 3,
3501
- GENERATION_IV = 4,
3502
- GENERATION_V = 5,
3503
- GENERATION_VI = 6,
3504
- GENERATION_VII = 7,
3505
- GENERATION_VIII = 8
3506
- }
3507
- export declare enum Pokedexes {
3508
- NATIONAL = 1,
3509
- KANTO = 2,
3510
- ORIGINAL_JOHTO = 3,
3511
- HOENN = 4,
3512
- ORIGINAL_SINNOH = 5,
3513
- EXTENDED_SINNOH = 6,
3514
- UPDATED_JOHTO = 7,
3515
- ORIGINAL_UNOVA = 8,
3516
- UPDATED_UNOVA = 9,
3517
- CONQUEST_GALLERY = 11,
3518
- KALOS_CENTRAL = 12,
3519
- KALOS_COASTAL = 13,
3520
- KALOS_MONTAIN = 14,
3521
- UPDATED_HOENN = 15,
3522
- ORIGINAL_ALOLA = 16,
3523
- ORIGINAL_MELEMELE = 17,
3524
- ORIGINAL_AKALA = 18,
3525
- ORIGINAL_ULAULA = 19,
3526
- ORIGINAL_PONI = 20,
3527
- UPDATED_ALOLA = 21,
3528
- UPDATED_MELEMELE = 22,
3529
- UPDATED_AKALA = 23,
3530
- UPDATED_ULAULA = 24,
3531
- UPDATED_PONI = 25,
3532
- UPDATED_KANTO = 26,
3533
- GALAR = 27,
3534
- ISLE_OF_ARMOR = 28,
3535
- CROWN_TUNDRA = 29
3536
- }
3537
- export declare enum Versions {
3538
- RED = 1,
3539
- BLUE = 2,
3540
- YELLOW = 3,
3541
- GOLD = 4,
3542
- SILVER = 5,
3543
- CRYSTAL = 6,
3544
- RUBY = 7,
3545
- SAPPHIRE = 8,
3546
- EMERALD = 9,
3547
- FIRERED = 10,
3548
- LEAFGREEN = 11,
3549
- DIAMOND = 12,
3550
- PEARL = 13,
3551
- PLATINUM = 14,
3552
- HEARTGOLD = 15,
3553
- SOULSILVER = 16,
3554
- BLACK = 17,
3555
- WHITE = 18,
3556
- COLOSSEUM = 19,
3557
- XD = 20,
3558
- BLACK_2 = 21,
3559
- WHITE_2 = 22,
3560
- X = 23,
3561
- Y = 24,
3562
- OMEGA_RUBY = 25,
3563
- ALPHA_SAPPHIRE = 26,
3564
- SUN = 27,
3565
- MOON = 28,
3566
- ULTRA_SUN = 29,
3567
- ULTRA_MOON = 30,
3568
- LETS_GO_PIKACHU = 31,
3569
- LETS_GO_EEVEE = 32,
3570
- SWORD = 33,
3571
- SHIELD = 34,
3572
- THE_ISLE_OF_ARMOR = 35,
3573
- THE_CROWN_TUNDRA = 36,
3574
- BRILLIANT_DIAMOND = 37,
3575
- SHINING_PEARL = 38,
3576
- LEGENDS_ARCEUS = 39
3577
- }
3578
- export declare enum VersionGroups {
3579
- RED_BLUE = 1,
3580
- YELLOW = 2,
3581
- GOLD_SILVER = 3,
3582
- CRYSTAL = 4,
3583
- RUBY_SAPPHIRE = 5,
3584
- EMERALD = 6,
3585
- FIRERED_LEAFGREEN = 7,
3586
- DIAMOND_PEARL = 8,
3587
- PLATINUM = 9,
3588
- HEARTGOLD_SOULSILVER = 10,
3589
- BLACK_WHITE = 11,
3590
- COLOSSEUM = 12,
3591
- XD = 13,
3592
- BLACK_2_WHITE_2 = 14,
3593
- X_Y = 15,
3594
- OMEGA_RUBY_ALPHA_SAPPHIRE = 16,
3595
- SUN_MOON = 17,
3596
- ULTRA_SUN_ULTRA_MOON = 18,
3597
- LETS_GO = 19,
3598
- SWORD_SHIELD = 20,
3599
- THE_ISLE_OF_ARMOR = 21,
3600
- THE_CROWN_TUNDRA = 22,
3601
- BRILLIANT_DIAMOND_AND_SHINING_PEARL = 23,
3602
- LEGENDS_ARCEUS = 24
3603
- }
3604
- export declare enum Regions {
3605
- KANTO = 1,
3606
- JOHTO = 2,
3607
- HOENN = 3,
3608
- SINNOH = 4,
3609
- UNOVA = 5,
3610
- KALOS = 6,
3611
- ALOLA = 7,
3612
- GALAR = 8,
3613
- HISUI = 9
3614
- }
3615
- export declare enum PalParkAreas {
3616
- FOREST = 1,
3617
- FIELD = 2,
3618
- MOUNTAIN = 3,
3619
- POND = 4,
3620
- SEA = 5
3621
- }
3622
- export declare enum MoveAilmtents {
3623
- UNKNOWN = -1,
3624
- NONE = 0,
3625
- PARALYSIS = 1,
3626
- SLEEP = 2,
3627
- FREEZE = 3,
3628
- BURN = 4,
3629
- POISON = 5,
3630
- CONFUSION = 6,
3631
- INFATUATION = 7,
3632
- TRAP = 8,
3633
- NIGHTMARE = 9,
3634
- TORMENT = 12,
3635
- DISABLE = 13,
3636
- YAWN = 14,
3637
- HEAL_BLOCK = 15,
3638
- NO_TYPE_IMMUNITY = 17,
3639
- LEECH_SEED = 18,
3640
- EMBARGO = 19,
3641
- PERISH_SONG = 20,
3642
- INGRAIN = 21,
3643
- SILENCE = 24,
3644
- TAR_SHOT = 42
3645
- }
3646
- export declare enum MoveBattleStyles {
3647
- ATTACK = 1,
3648
- DEFENSE = 2,
3649
- SUPPORT = 3
3650
- }
3651
- export declare enum MoveCategories {
3652
- DAMAGE = 0,
3653
- AILMENT = 1,
3654
- NET_GOOD_STATS = 2,
3655
- HEAL = 3,
3656
- DAMAGE_AILMENT = 4,
3657
- SWAGGER = 5,
3658
- DAMAGE_LOWER = 6,
3659
- DAMAGE_RAISE = 7,
3660
- DAMAGE_HEAL = 8,
3661
- OHKO = 9,
3662
- WHOLE_FIELD_EFFECT = 10,
3663
- FIELD_EFFECT = 11,
3664
- FORCE_SWITCH = 12,
3665
- UNIQUE = 13
3666
- }
3667
- export declare enum MoveDamageClasses {
3668
- STATUS = 1,
3669
- PHYSICAL = 2,
3670
- SPECIAL = 3
3671
- }
3672
- export declare enum MoveLearnMethods {
3673
- LEVEL_UP = 1,
3674
- EGG = 2,
3675
- TUTOR = 3,
3676
- MACHINE = 4,
3677
- STADIUM_SURFING_PIKACHU = 5,
3678
- LIGHT_BALL_EGG = 6,
3679
- COLOSSEUM_PURIFICATION = 7,
3680
- XD_SHADOW = 8,
3681
- XD_PURIFICATION = 9,
3682
- FORM_CHANGE = 10
3683
- }
3684
- export declare enum MoveTargets {
3685
- SPECIFIC_MOVE = 1,
3686
- SELECTED_POKEMON_ME_FIRST = 2,
3687
- ALLY = 3,
3688
- USERS_FIELD = 4,
3689
- USER_OR_ALLY = 5,
3690
- OPPONENTS_FIELD = 6,
3691
- USER = 7,
3692
- RANDOM_OPPONENT = 8,
3693
- ALL_OTHER_POKEMON = 9,
3694
- SELECTED_POKEMON = 10,
3695
- ALL_OPPONENTS = 11,
3696
- ENTIRE_FIELD = 12,
3697
- USER_AND_ALIES = 13,
3698
- ALL_POKEMON = 14,
3699
- ALL_ALLIES = 15
3700
- }
3701
- export declare enum EggGroups {
3702
- MONSTER = 1,
3703
- WATER1 = 2,
3704
- BUG = 3,
3705
- FLYING = 4,
3706
- GROUND = 5,
3707
- FAIRY = 6,
3708
- PLANT = 7,
3709
- HUMANSHAPE = 8,
3710
- WATER3 = 9,
3711
- MINERAL = 10,
3712
- INDETERMINATE = 11,
3713
- WATER2 = 12,
3714
- DITTO = 13,
3715
- DRAGON = 14,
3716
- NO_EGGS = 15
3717
- }
3718
- export declare enum Genders {
3719
- FEMALE = 1,
3720
- MALE = 2,
3721
- GENDERLESS = 3
3722
- }
3723
- export declare enum GrowthRates {
3724
- SLOW = 1,
3725
- MEDIUM = 2,
3726
- FAST = 3,
3727
- MEDIUM_SLOW = 4,
3728
- SLOW_THEN_VERY_FAST = 5,
3729
- FAST_THEN_VERY_SLOW = 6
3730
- }
3731
- export declare enum Natures {
3732
- HARDY = 1,
3733
- BOLD = 2,
3734
- MODEST = 3,
3735
- CALM = 4,
3736
- TIMID = 5,
3737
- LONELY = 6,
3738
- DOCILE = 7,
3739
- MILD = 8,
3740
- GENTLE = 9,
3741
- HASTY = 10,
3742
- ADAMANT = 11,
3743
- IMPISH = 12,
3744
- BASHFUL = 13,
3745
- CAREFUL = 14,
3746
- RASH = 15,
3747
- JOLLY = 16,
3748
- NAUGHTY = 17,
3749
- LAX = 18,
3750
- QUIRKY = 19,
3751
- NAIVE = 20,
3752
- BRAVE = 21,
3753
- RELAXED = 22,
3754
- QUIET = 23,
3755
- SASSY = 24,
3756
- SERIOUS = 25
3757
- }
3758
- export declare enum PokeathlonStats {
3759
- SPEED = 1,
3760
- POWER = 2,
3761
- SKILL = 3,
3762
- STAMINA = 4,
3763
- JUMP = 5
3764
- }
3765
- export declare enum PokemonColors {
3766
- BLACK = 1,
3767
- BLUE = 2,
3768
- BROWN = 3,
3769
- GRAY = 4,
3770
- GREEN = 5,
3771
- PINK = 6,
3772
- PURPLE = 7,
3773
- RED = 8,
3774
- WHITE = 9,
3775
- YELLOW = 10
3776
- }
3777
- export declare enum PokemonHabitats {
3778
- CAVE = 1,
3779
- FOREST = 2,
3780
- GRASSLAND = 3,
3781
- MONTAIN = 4,
3782
- RARE = 5,
3783
- ROUGH_TERRAIN = 6,
3784
- SEA = 7,
3785
- URBAN = 8,
3786
- WATERS_EDGE = 9
3787
- }
3788
- export declare enum PokemonShapes {
3789
- BALL = 1,
3790
- SQUIGGLE = 2,
3791
- FISH = 3,
3792
- ARMS = 4,
3793
- BLOB = 5,
3794
- UPRIGHT = 6,
3795
- LEGS = 7,
3796
- QUADRUPED = 8,
3797
- WINGS = 9,
3798
- TENTACLES = 10,
3799
- HEADS = 11,
3800
- HUMANOID = 12,
3801
- BUG_WINGS = 13,
3802
- ARMOR = 14
3803
- }
3804
- export declare enum Stats {
3805
- HP = 1,
3806
- ATTACK = 2,
3807
- DEFENSE = 3,
3808
- SPECIAL_ATTACK = 4,
3809
- SPECIAL_DEFENSE = 5,
3810
- SPEED = 6,
3811
- ACCURACY = 7,
3812
- EVASION = 8
3813
- }
3814
- export declare enum Types {
3815
- NORMAL = 1,
3816
- FIGHTING = 2,
3817
- FLYING = 3,
3818
- POISON = 4,
3819
- GROUND = 5,
3820
- ROCK = 6,
3821
- BUG = 7,
3822
- GHOST = 8,
3823
- STEEL = 9,
3824
- FIRE = 10,
3825
- WATER = 11,
3826
- GRASS = 12,
3827
- ELECTRIC = 13,
3828
- PSYCHIC = 14,
3829
- ICE = 15,
3830
- DRAGON = 16,
3831
- DARK = 17,
3832
- FAIRY = 18,
3833
- UNKNOWN = 10001,
3834
- SHADOW = 10002
3835
- }
3836
- export declare enum Languages {
3837
- JA_HRKT = 1,
3838
- ROOMAJI = 2,
3839
- KO = 3,
3840
- ZH_HANT = 4,
3841
- FR = 5,
3842
- DE = 6,
3843
- ES = 7,
3844
- IT = 8,
3845
- EN = 9,
3846
- CS = 10,
3847
- JA = 11,
3848
- ZH_HANS = 12,
3849
- PT_BR = 13
3850
- }
3851
- export declare enum ItemAttributes {
3852
- COUNTABLE = 1,
3853
- CONSUMABLE = 2,
3854
- USABLE_OVERWORLD = 3,
3855
- USABLE_IN_BATTLE = 4,
3856
- HOLDABLE = 5,
3857
- HOLDABLE_PASSIVE = 6,
3858
- HOLDABLE_ACTIVE = 7,
3859
- UNDERGROUND = 8
3860
- }
3861
- export declare enum ItemCategories {
3862
- STAT_BOOSTS = 1,
3863
- EFFORT_DROP = 2,
3864
- MEDICINE = 3,
3865
- OTHER = 4,
3866
- IN_A_PINCH = 5,
3867
- PICKY_HEALING = 6,
3868
- TYPE_PROTECTION = 7,
3869
- BAKING_ONLY = 8,
3870
- COLLECTIBLES = 9,
3871
- EVOLUTION = 10,
3872
- SPELUNKING = 11,
3873
- HELD_ITEMS = 12,
3874
- CHOICE = 13,
3875
- EFFORT_TRAINING = 14,
3876
- BAD_HELD_ITEMS = 15,
3877
- TRAINING = 16,
3878
- PLATES = 17,
3879
- SPECIES_SPECIFIC = 18,
3880
- TYPE_ENHANCEMENT = 19,
3881
- EVENT_ITEMS = 20,
3882
- GAMEPLAY = 21,
3883
- PLOT_ADVANCEMENT = 22,
3884
- UNUSED = 23,
3885
- LOOT = 24,
3886
- ALL_MAIL = 25,
3887
- VITAMINS = 26,
3888
- HEALING = 27,
3889
- PP_RECOVERY = 28,
3890
- REVIVAL = 29,
3891
- STATUS_CURES = 30,
3892
- MULCH = 32,
3893
- SPECIAL_BALLS = 33,
3894
- STANDARD_BALLS = 34,
3895
- DEX_COMPLETION = 35,
3896
- SCARVES = 36,
3897
- ALL_MACHINES = 37,
3898
- FLUTES = 38,
3899
- APRICORN_BALLS = 39,
3900
- APRICORN_BOX = 40,
3901
- DATA_CARDS = 41,
3902
- JEWELS = 42,
3903
- MIRACLE_SHOOTER = 43,
3904
- MEGA_STONES = 44,
3905
- MEMORIES = 45,
3906
- Z_CRYSTALS = 46,
3907
- SPECIES_CANDIES = 47,
3908
- CATCHING_BONUS = 48,
3909
- DYNAMAX_CRISTALS = 49,
3910
- NATURE_MINTS = 50,
3911
- CURRY_INGREDIENTS = 51
3912
- }
3913
- export declare enum ItemFlingEffects {
3914
- BADLY_POISON = 1,
3915
- BURN = 2,
3916
- BERRY_EFFECT = 3,
3917
- HERB_EFFECT = 4,
3918
- PARALYZE = 5,
3919
- POISON = 6,
3920
- FLINCH = 7
3921
- }
3922
- export declare enum ItemPockets {
3923
- MISC = 1,
3924
- MEDICINE = 2,
3925
- POKEBALLS = 3,
3926
- MACHINES = 4,
3927
- BERRIES = 5,
3928
- MAIL = 6,
3929
- BATTLE = 7,
3930
- KEY = 8
3931
- }
3932
-
3933
- export {};