tmdb-rs 1.0.4

Async, fully-typed TMDB (API v3 + v4) client with compile-time append_to_response
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
use serde::Deserialize;
use time::Date;

use crate::common::{
    AccountStates, AlternativeTitles, Changes, ExternalIds, Images, Rated, StatusResponse,
    Translations, Videos, WatchProviders,
};
use crate::endpoints::credit::Credits;
use crate::endpoints::genre::Genre;
use crate::endpoints::keyword::{Keyword, TvKeywords};
use crate::endpoints::list::ListShort;
use crate::endpoints::review::Review;
use crate::{
    Backdrop, CountryCode, GuestSessionId, Language, Logo, Page, Poster, Profile, SessionId, Still,
};

#[derive(Debug, Clone, Deserialize)]
pub struct ContentRating {
    #[serde(rename = "iso_3166_1")]
    pub country: CountryCode,
    pub rating: String,
}

#[derive(Debug, Clone, Deserialize)]
pub struct ContentRatings {
    pub results: Vec<ContentRating>,
}

/// one season inside a series' details
#[derive(Debug, Clone, Deserialize)]
pub struct SeasonShort {
    pub season_number: u32,
    pub name: String,
    pub episode_count: u32,
    pub overview: Option<String>,
    #[serde(rename = "poster_path")]
    pub poster: Option<Poster>,
    #[serde(default, deserialize_with = "crate::common::opt_date")]
    pub air_date: Option<Date>,
}

use crate::append::appendable;

/// one series in a list or search response
#[derive(Debug, Clone, Deserialize)]
pub struct TvShort {
    pub id: u64,
    pub name: String,
    pub original_name: String,
    pub overview: String,
    #[serde(
        rename = "first_air_date",
        default,
        deserialize_with = "crate::common::opt_date"
    )]
    pub release_date: Option<Date>,
    #[serde(rename = "poster_path")]
    pub poster: Option<Poster>,
    #[serde(rename = "backdrop_path")]
    pub backdrop: Option<Backdrop>,
    pub vote_average: f64,
    pub vote_count: u32,
    pub popularity: f64,
    #[serde(default)]
    pub genre_ids: Vec<u64>,
    #[serde(default, deserialize_with = "crate::common::opt_language")]
    pub original_language: Option<Language>,
    #[serde(default)]
    pub origin_country: Vec<String>,
    pub adult: bool,
}

/// a series' next aired episode
#[derive(Debug, Clone, Deserialize)]
pub struct NextEpisode {
    pub id: u64,
    pub name: String,
    pub episode_number: u32,
    pub season_number: u32,
    #[serde(default, deserialize_with = "crate::common::opt_date")]
    pub air_date: Option<Date>,
}

/// one episode inside a season
#[derive(Debug, Clone, Deserialize)]
pub struct Episode {
    pub id: u64,
    pub name: String,
    pub overview: String,
    pub episode_number: u32,
    pub season_number: u32,
    pub runtime: Option<u32>,
    #[serde(rename = "still_path")]
    pub still: Option<Still>,
    #[serde(default, deserialize_with = "crate::common::opt_date")]
    pub air_date: Option<Date>,
    pub vote_average: f64,
    pub vote_count: u32,
}

/// one role in an aggregate credits entry
#[derive(Debug, Clone, Deserialize)]
pub struct Role {
    pub credit_id: String,
    pub character: String,
    pub episode_count: u32,
}

#[derive(Debug, Clone, Deserialize)]
pub struct AggregateCastMember {
    pub id: u64,
    pub name: String,
    #[serde(rename = "profile_path")]
    pub profile: Option<Profile>,
    pub roles: Vec<Role>,
    pub total_episode_count: u32,
    pub order: Option<u32>,
}

/// one job in an aggregate credits entry
#[derive(Debug, Clone, Deserialize)]
pub struct Job {
    pub credit_id: String,
    pub job: String,
    pub episode_count: u32,
}

#[derive(Debug, Clone, Deserialize)]
pub struct AggregateCrewMember {
    pub id: u64,
    pub name: String,
    #[serde(rename = "profile_path")]
    pub profile: Option<Profile>,
    pub jobs: Vec<Job>,
    pub total_episode_count: u32,
    pub department: String,
}

/// credits rolled up across all episodes of a series
#[derive(Debug, Clone, Deserialize)]
pub struct AggregateCredits {
    pub cast: Vec<AggregateCastMember>,
    pub crew: Vec<AggregateCrewMember>,
}

/// one network on an episode group
#[derive(Debug, Clone, Deserialize)]
pub struct NetworkShort {
    pub id: u64,
    pub name: String,
    #[serde(rename = "logo_path")]
    pub logo: Option<Logo>,
    pub origin_country: Option<String>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct EpisodeGroupShort {
    pub id: String,
    pub name: String,
    pub description: String,
    pub episode_count: u32,
    pub group_count: u32,
    #[serde(rename = "type")]
    pub kind: u32,
    pub network: Option<NetworkShort>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct EpisodeGroups {
    pub results: Vec<EpisodeGroupShort>,
}

/// one group inside an episode group
#[derive(Debug, Clone, Deserialize)]
pub struct EpisodeGroupEntry {
    pub id: String,
    pub name: String,
    pub order: u32,
    #[serde(default)]
    pub episodes: Vec<Episode>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct EpisodeGroup {
    pub id: String,
    pub name: String,
    pub description: String,
    pub episode_count: u32,
    pub group_count: u32,
    #[serde(rename = "type")]
    pub kind: u32,
    pub network: Option<NetworkShort>,
    pub groups: Vec<EpisodeGroupEntry>,
}

/// one episode screened in theatres
#[derive(Debug, Clone, Deserialize)]
pub struct ScreenedEntry {
    pub id: u64,
    pub episode_number: u32,
    pub season_number: u32,
}

#[derive(Debug, Clone, Deserialize)]
pub struct ScreenedTheatrically {
    pub results: Vec<ScreenedEntry>,
}

appendable! {
    AggregateCredits,
    ContentRatings,
    EpisodeGroups,
    ScreenedTheatrically,
}

endpoint! {
    /// the primary details of a series
    tv(id: u64): GET "/tv/{id}" => TvDetails {
        params { language: Language }
        base {
            pub id: u64,
            pub name: String,
            pub original_name: String,
            pub overview: String,
            pub tagline: String,
            #[serde(
                rename = "first_air_date",
                default,
                deserialize_with = "crate::common::opt_date"
            )]
            pub release_date: Option<Date>,
            #[serde(default, deserialize_with = "crate::common::opt_date")]
            pub last_air_date: Option<Date>,
            pub vote_average: f64,
            pub vote_count: u32,
            pub popularity: f64,
            pub number_of_seasons: u32,
            pub number_of_episodes: u32,
            pub episode_run_time: Vec<u32>,
            #[serde(default, deserialize_with = "crate::common::opt_language")]
            pub original_language: Option<Language>,
            #[serde(rename = "poster_path")]
            pub poster: Option<Poster>,
            #[serde(rename = "backdrop_path")]
            pub backdrop: Option<Backdrop>,
            pub genres: Vec<Genre>,
            #[serde(rename = "homepage")]
            pub website: String,
            pub status: String,
            pub in_production: bool,
            #[serde(default, deserialize_with = "crate::common::language_list")]
            pub languages: Vec<Language>,
            #[serde(default)]
            pub origin_country: Vec<String>,
            #[serde(default)]
            pub seasons: Vec<SeasonShort>,
            pub next_episode_to_air: Option<NextEpisode>,
            pub adult: bool,
        }
        appends {
            account_states: AccountStates,
            aggregate_credits: AggregateCredits,
            alternative_titles: AlternativeTitles,
            changes: Changes,
            content_ratings: ContentRatings,
            credits: Credits,
            episode_groups: EpisodeGroups,
            external_ids: ExternalIds,
            images: Images,
            keywords: TvKeywords,
            lists: Page<ListShort>,
            recommendations: Page<TvShort>,
            reviews: Page<Review>,
            similar: Page<TvShort>,
            translations: Translations,
            videos: Videos,
            watch_providers: WatchProviders as "watch/providers",
        }
    }
}

endpoint! {
    /// one season of a series, episodes included
    tv_season(id: u64, season: u32): GET "/tv/{id}/season/{season}" => SeasonDetails {
        params { language: Language }
        base {
            pub id: u64,
            pub season_number: u32,
            pub name: String,
            pub overview: String,
            #[serde(default, deserialize_with = "crate::common::opt_date")]
            pub air_date: Option<Date>,
            #[serde(rename = "poster_path")]
    pub poster: Option<Poster>,
            #[serde(default)]
            pub episodes: Vec<Episode>,
        }
        appends {
            account_states: AccountStates,
            aggregate_credits: AggregateCredits,
            changes: Changes,
            credits: Credits,
            external_ids: ExternalIds,
            images: Images,
            translations: Translations,
            videos: Videos,
            watch_providers: WatchProviders as "watch/providers",
        }
    }
}

endpoint! {
    /// one episode of a series
    tv_episode(id: u64, season: u32, episode: u32): GET "/tv/{id}/season/{season}/episode/{episode}" => EpisodeDetails {
        params { language: Language }
        base {
            pub id: u64,
            pub name: String,
            pub overview: String,
            pub episode_number: u32,
            pub season_number: u32,
            pub runtime: Option<u32>,
            #[serde(rename = "still_path")]
    pub still: Option<Still>,
            #[serde(default, deserialize_with = "crate::common::opt_date")]
            pub air_date: Option<Date>,
            pub vote_average: f64,
            pub vote_count: u32,
        }
        appends {
            account_states: AccountStates,
            changes: Changes,
            credits: Credits,
            external_ids: ExternalIds,
            images: Images,
            translations: Translations,
            videos: Videos,
        }
    }
}

endpoint! {
    /// the newest series
    tv_latest(): GET "/tv/latest" => TvDetails {
        params { language: Language }
    }
}

endpoint! {
    /// series ordered by popularity
    tv_popular(): GET "/tv/popular" => Page<TvShort> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// series ordered by rating
    tv_top_rated(): GET "/tv/top_rated" => Page<TvShort> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// series with an episode airing in the next week
    tv_on_the_air(): GET "/tv/on_the_air" => Page<TvShort> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// series with an episode airing today
    tv_airing_today(): GET "/tv/airing_today" => Page<TvShort> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// a series' keywords, without the details round-trip
    tv_keywords(id: u64): GET "/tv/{id}/keywords" => Vec<Keyword> [results]
}

endpoint! {
    /// a series' ids on other databases
    tv_external_ids(id: u64): GET "/tv/{id}/external_ids" => ExternalIds
}

endpoint! {
    /// a series' account states (favorite, rated, watchlist)
    tv_account_states(id: u64): GET "/tv/{id}/account_states" => AccountStates {
        params { session_id: SessionId, guest_session_id: GuestSessionId }
    }
}

endpoint! {
    /// a series' aggregate credits
    tv_aggregate_credits(id: u64): GET "/tv/{id}/aggregate_credits" => AggregateCredits {
        params { language: Language }
    }
}

endpoint! {
    /// a series' alternative titles
    tv_alternative_titles(id: u64): GET "/tv/{id}/alternative_titles" => AlternativeTitles
}

endpoint! {
    /// a series' recent changes
    tv_changes_by_id(id: u64): GET "/tv/{id}/changes" => Changes {
        params { start_date: Date, end_date: Date, page: u32 }
    }
}

endpoint! {
    /// a series' content ratings by country
    tv_content_ratings(id: u64): GET "/tv/{id}/content_ratings" => ContentRatings
}

endpoint! {
    /// a series' credits
    tv_credits(id: u64): GET "/tv/{id}/credits" => Credits {
        params { language: Language }
    }
}

endpoint! {
    /// a series' episode groups
    tv_episode_groups(id: u64): GET "/tv/{id}/episode_groups" => EpisodeGroups
}

endpoint! {
    /// a series' images
    tv_images(id: u64): GET "/tv/{id}/images" => Images {
        params { language: Language, include_image_language: Vec<Language> }
    }
}

endpoint! {
    /// the lists a series appears in
    tv_lists(id: u64): GET "/tv/{id}/lists" => Page<ListShort> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// series similar to a series
    tv_similar(id: u64): GET "/tv/{id}/similar" => Page<TvShort> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// a series' recommendations
    tv_recommendations(id: u64): GET "/tv/{id}/recommendations" => Page<TvShort> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// a series' reviews
    tv_reviews(id: u64): GET "/tv/{id}/reviews" => Page<Review> {
        params { language: Language, page: u32 }
    }
}

endpoint! {
    /// the episodes of a series that were screened in theatres
    tv_screened_theatrically(id: u64): GET "/tv/{id}/screened_theatrically" => ScreenedTheatrically
}

endpoint! {
    /// a series' translations
    tv_translations(id: u64): GET "/tv/{id}/translations" => Translations
}

endpoint! {
    /// a series' videos (trailers, teasers, ...)
    tv_videos(id: u64): GET "/tv/{id}/videos" => Videos {
        params { language: Language, include_image_language: Vec<Language> }
    }
}

endpoint! {
    /// where a series can be streamed, rented or bought, by country
    tv_watch_providers(id: u64): GET "/tv/{id}/watch/providers" => WatchProviders
}

endpoint! {
    /// rate a series; pass a session or guest session
    rate_tv(id: u64): POST "/tv/{id}/rating" => StatusResponse {
        params { session_id: SessionId, guest_session_id: GuestSessionId }
        body { value: f64 }
    }
}

endpoint! {
    /// delete a series rating
    unrate_tv(id: u64): DELETE "/tv/{id}/rating" => StatusResponse {
        params { session_id: SessionId, guest_session_id: GuestSessionId }
    }
}

endpoint! {
    /// a season's account states (per-episode ratings)
    tv_season_account_states(id: u64, season: u32): GET "/tv/{id}/season/{season}/account_states" => Vec<EpisodeAccountState> [results] {
        params { session_id: SessionId, guest_session_id: GuestSessionId }
    }
}

#[derive(Debug, Clone, Deserialize)]
pub struct EpisodeAccountState {
    pub id: u64,
    pub episode_number: u32,
    pub rated: Rated,
}

endpoint! {
    /// a season's aggregate credits
    tv_season_aggregate_credits(id: u64, season: u32): GET "/tv/{id}/season/{season}/aggregate_credits" => AggregateCredits {
        params { language: Language }
    }
}

endpoint! {
    /// a season's changes
    tv_season_changes(id: u64): GET "/tv/season/{id}/changes" => Changes {
        params { start_date: Date, end_date: Date, page: u32 }
    }
}

endpoint! {
    /// a season's credits
    tv_season_credits(id: u64, season: u32): GET "/tv/{id}/season/{season}/credits" => Credits {
        params { language: Language }
    }
}

endpoint! {
    /// a season's ids on other databases
    tv_season_external_ids(id: u64, season: u32): GET "/tv/{id}/season/{season}/external_ids" => ExternalIds
}

endpoint! {
    /// a season's images
    tv_season_images(id: u64, season: u32): GET "/tv/{id}/season/{season}/images" => Images {
        params { language: Language, include_image_language: Vec<Language> }
    }
}

endpoint! {
    /// a season's translations
    tv_season_translations(id: u64, season: u32): GET "/tv/{id}/season/{season}/translations" => Translations
}

endpoint! {
    /// a season's videos
    tv_season_videos(id: u64, season: u32): GET "/tv/{id}/season/{season}/videos" => Videos {
        params { language: Language, include_image_language: Vec<Language> }
    }
}

endpoint! {
    /// where a season can be watched, by country
    tv_season_watch_providers(id: u64, season: u32): GET "/tv/{id}/season/{season}/watch/providers" => WatchProviders
}

endpoint! {
    /// an episode's account states
    tv_episode_account_states(id: u64, season: u32, episode: u32): GET "/tv/{id}/season/{season}/episode/{episode}/account_states" => EpisodeAccountStates {
        params { session_id: SessionId, guest_session_id: GuestSessionId }
    }
}

/// an episode's own account state
#[derive(Debug, Clone, Deserialize)]
pub struct EpisodeAccountStates {
    pub id: u64,
    pub rated: Rated,
}

endpoint! {
    /// an episode's changes
    tv_episode_changes(id: u64): GET "/tv/episode/{id}/changes" => Changes {
        params { start_date: Date, end_date: Date, page: u32 }
    }
}

endpoint! {
    /// an episode's credits
    tv_episode_credits(id: u64, season: u32, episode: u32): GET "/tv/{id}/season/{season}/episode/{episode}/credits" => Credits {
        params { language: Language }
    }
}

endpoint! {
    /// an episode's ids on other databases
    tv_episode_external_ids(id: u64, season: u32, episode: u32): GET "/tv/{id}/season/{season}/episode/{episode}/external_ids" => ExternalIds
}

endpoint! {
    /// an episode's images
    tv_episode_images(id: u64, season: u32, episode: u32): GET "/tv/{id}/season/{season}/episode/{episode}/images" => Images {
        params { language: Language, include_image_language: Vec<Language> }
    }
}

endpoint! {
    /// an episode's translations
    tv_episode_translations(id: u64, season: u32, episode: u32): GET "/tv/{id}/season/{season}/episode/{episode}/translations" => Translations
}

endpoint! {
    /// an episode's videos
    tv_episode_videos(id: u64, season: u32, episode: u32): GET "/tv/{id}/season/{season}/episode/{episode}/videos" => Videos {
        params { language: Language, include_image_language: Vec<Language> }
    }
}

endpoint! {
    /// rate an episode; pass a session or guest session
    rate_tv_episode(id: u64, season: u32, episode: u32): POST "/tv/{id}/season/{season}/episode/{episode}/rating" => StatusResponse {
        params { session_id: SessionId, guest_session_id: GuestSessionId }
        body { value: f64 }
    }
}

endpoint! {
    /// delete an episode rating
    unrate_tv_episode(id: u64, season: u32, episode: u32): DELETE "/tv/{id}/season/{season}/episode/{episode}/rating" => StatusResponse {
        params { session_id: SessionId, guest_session_id: GuestSessionId }
    }
}

endpoint! {
    /// an episode group
    tv_episode_group(id: &str): GET "/tv/episode_group/{id}" => EpisodeGroup {
        params { language: Language }
    }
}