This repository has been archived by the owner on Aug 17, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
endpoints.ts
501 lines (405 loc) · 8.5 KB
/
endpoints.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
/**
* Represents the types of endpoints that is available through Nookipedia's API.
*/
type Endpoints = Villager | Fossil | Critter;
/**
* Represents the names of endpoints available through Nookiepdia's API.
*/
type Names = 'villager' | 'fossil' | 'critter';
/**
* Represents what the API will respond for a request about the events for a date.
*/
type Today = {
/**
* A brief message stating the current date and indicating whether there are any events for the day.
*/
message: string;
/**
* An array of event messages, which includes a combination of holidays and birthdays.
*/
events: string[];
/**
* An array of URLs for the images for villagers that have birthdays today.
*/
villager_images: string[];
};
/**
* Represents what the API will respond for a request about a critter.
*/
type Critter = {
/**
* Here's some information about this critter.
*/
message: string;
/**
* The critter's name.
*/
name: string;
/**
* A link to an image of this critter.
*/
image: string;
/**
* The critter's scientific name.
*/
'scientific-name': string;
/**
* What family this critter is a part of.
*/
family: string;
/**
* Represents what months this critter is available.
*/
'time-year': string;
/**
* Represents the hours that this critter is available.
*/
'time-day': string;
/**
* Represents where this critter can be found.
*/
location: string;
/**
* Represents this critter's size.
*/
size: string;
/**
* Represents this critter's rarity.
*/
rarity: string;
/**
* Represents how much this critter can sell for.
*/
price: string;
/**
* Represents what the PC says when catching this critter.
*/
caught: string;
/**
* A link to the entry for this critter on https://nookipedia.com.
*/
link: string;
/**
* Represents the date that information for this critter was last updated.
*/
updated: string;
/**
* Represents when this critter was last cached in the format "DD/MM/YYY".
*/
cached: string;
/**
* Represents when this critter's cached data will expire.
*/
'api-cache-expire': string;
};
/**
* Represents what the API will respond for a request about a fossil.
*/
type Fossil = {
/**
* Here's some information about this fossil.
*/
message: string;
/**
* The fossil's name.
*/
name: string;
/**
* A link to an image of this villager.
*/
image: string;
/**
* The fossil's scientific name.
*/
'scientific-name': string;
/**
* Represents the sections that this fossil is a part of.
*/
sections: string;
/**
* Represents the period of when this fossil existed.
*/
period: string;
/**
* The length of this fossil.
*/
length: string;
/**
* How much this fossil will sell for.
*/
price: string;
/**
* A link to the entry for this fossil on Nookipedia.
*/
link: string;
/**
* Represents the date that information for this fossil was last updated.
*/
updated: string;
/**
* Represents when this fossil was last cached in the format "DD/MM/YYY".
*/
cached: string;
/**
* Represents when this fossil's cached data will expire.
*/
'api-cache-expire': string;
};
/**
* Represents what the API will respond for a request about a villager.
*/
type Villager = {
/**
* Here's some information of this villager.
*/
message: string;
/**
* The name of the villager.
*/
name: string;
/**
* A link to an image of this villager.
*/
image: string;
/**
* The villager's phrase.
*/
quote: string;
/**
* The villager's gender.
*/
gender: string;
/**
* The villager's personality.
*/
personality: string;
/**
* The villager's species.
*/
species: string;
/**
* The villager's birthday.
*/
birthday: string;
/**
* The villager's zodiac sign.
*/
sign: string;
/**
* The villager's initial phrase.
*/
phrase: string;
/**
* The villager's initial clothes.
*/
clothes: string;
/**
* The villager's favorite fruit (for Animal Crossing on Gamecube).
*/
'islander-favorite': string;
/**
* What the villager is allergic to.
*/
'islander-allergic': string;
/**
* A link to an image of the villager's picture frame.
*/
picture: string;
/**
* Represents how many siblings this villager has.
*/
siblings: string;
/**
* Represents the villager's skill.
*/
skill: string;
/**
* Represents the villager's goal.
*/
goal: string;
/**
* Represents the villager's fear.
*/
fear: string;
/**
* Represents the villager's favorite clothing.
*/
favclothing: string;
/**
* Represents the villager's least favorite clothing.
*/
leastfavclothing: string;
/**
* Represents the villager's favorite color.
*/
favcolor: string;
/**
* Represents the villager's favorite coffee type.
*/
'coffee-type': string;
/**
* Represents how the villager likes their milk.
*/
'coffee-milk': string;
/**
* Represents how the villager likes their sugar.
*/
'coffee-sugar': string;
/**
* The villager's name in Japanese.
*/
'name-jp': string;
/**
* The romanization for the villager's Japanese name.
*/
'name-jp-r': string;
/**
* The meaning for the villager's Japanese name.
*/
'name-jp-m': string;
/**
* The villager's name in Korean.
*/
'name-ko': string;
/**
* The romanization for the villager's Korean name.
*/
'name-ko-r': string;
/**
* The meaning for the villager's Korean name.
*/
'name-ko-m': string;
/**
* The villager's name in Chinese (simplified).
*/
'name-zh': string;
/**
* The romanization for the villager's Chinese (simplified) name.
*/
'name-zh-r': string;
/**
* The meaning for the villager's Chinese (simplified) name.
*/
'name-zh-m': string;
/**
* The villager's Chinese (traditional) name.
*/
'name-zht': string;
/**
* The villager's name in Chinese (iQue player).
*/
'name-zhq': string;
/**
* The romanization for the villager's Chinese (iQue player) name.
*/
'name-zhq-r': string;
/**
* The meaning for the villager's Chinese (iQue player) name.
*/
'name-zhq-m': string;
/**
* The villager's name in Arabic.
*/
'name-ar': string;
/**
* The romanization for the villager's Arabic name.
*/
'name-ar-r': string;
/**
* The meaning for the villager's Arabic name.
*/
'name-ar-m': string;
/**
* The villager's name in Russian.
*/
'name-ru': string;
/**
* The romanization for the villager's Russian name.
*/
'name-ru-r': string;
/**
* The meaning for the villager's Russian name.
*/
'name-ru-m': string;
/**
* The villager's name in Dutch.
*/
'name-nl': string;
/**
* The meaning for the villager's Dutch name.
*/
'name-nl-m': string;
/**
* The villager's name in German.
*/
'name-de': string;
/**
* The meaning for the villager's German name.
*/
'name-de-m': string;
/**
* The villager's name in Spanish (European).
*/
'name-es': string;
/**
* The meaning for the villager's Spanish (European) name.
*/
'name-es-m': string;
/**
* The villager's name in Spanish (Latin American).
*/
'name-esl': string;
/**
* The meaning for the villager's Spanish (Latin American) name.
*/
'name-esl-m': string;
/**
* The villager's name in French (European).
*/
'name-fr': string;
/**
* The meaning for the villager's French (European) name.
*/
'name-fr-m': string;
/**
* The villager's name in French (Quebec).
*/
'name-frq': string;
/**
* The meaning for the villager's French (Quebec) name.
*/
'name-frq-m': string;
/**
* The villager's name in Italian.
*/
'name-it': string;
/**
* The meaning for the villager's Italian name.
*/
'name-it-m': string;
/**
* The villager's name in Portuguese.
*/
'name-pt': string;
/**
* The meaning for the villager's Portuguese name.
*/
'name-pt-m': string;
/**
* A link to the entry for this villager on https://nookipedia.com.
*/
link: string;
/**
* Represents the date that this villager was last updated.
*/
updated: string;
/**
* Represents the date that information for this villager was last updated.
*/
cached: string;
/**
* Represents when this villager's cached data will expire.
*/
'api-cache-expire': string;
};
export { Endpoints, Names, Today, Villager, Critter, Fossil };