aletheia 1.0.0

A client library for the Guardian's content API
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
639
640
641
642
643
//! Structs for deserializing the Guardian's content API responses.
//!
//! Many of these structs were autogenerated
//! by Thrift with manual tweaks using existing
//! Thrift definitions.

use chrono::Utc;
use serde::Deserialize;
use std::collections::BTreeMap;

#[derive(Clone, Debug, Deserialize)]
pub struct Response {
    pub message: Option<String>,
    pub response: Option<SearchResponse>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SearchResponse {
    pub status: Option<String>,
    pub user_tier: Option<String>,
    pub total: Option<u32>,
    pub start_index: Option<u32>,
    pub page_size: Option<u32>,
    pub current_page: Option<u32>,
    pub pages: Option<isize>,
    pub order_by: Option<String>,
    pub results: Option<Vec<SearchResult>>,
    pub message: Option<String>,
    pub content: Option<Content>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Fields {
    pub byline: Option<String>,
    pub short_url: Option<String>,
    pub trail_text: Option<String>,
    pub headline: Option<String>,
    pub body: Option<String>,
    pub body_text: Option<String>,
    pub last_modified: Option<chrono::DateTime<Utc>>,
    pub has_story_package: Option<String>,
    pub score: Option<String>,
    pub standfirst: Option<String>,
    pub show_in_related_content: Option<String>,
    pub thumbnail: Option<String>,
    pub wordcount: Option<String>,
    pub commentable: Option<String>,
    pub is_premoderated: Option<String>,
    pub allow_ugc: Option<String>,
    pub publication: Option<String>,
    pub internal_page_code: Option<String>,
    pub production_office: Option<String>,
    pub should_hide_adverts: Option<String>,
    pub live_blogging_now: Option<String>,
    pub comment_close_date: Option<chrono::DateTime<Utc>>,
    pub star_rating: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Tag {
    pub id: String,
    pub r#type: String,
    pub web_title: String,
    pub web_url: String,
    pub api_url: String,
    pub references: Vec<Reference>,
    pub bio: Option<String>,
    pub byline_image_url: Option<String>,
    pub byline_large_image_url: Option<String>,
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub email_address: Option<String>,
    pub twitter_handle: Option<String>,
    pub section_id: Option<String>,
    pub section_name: Option<String>,
    pub description: Option<String>,
    pub paid_content_type: Option<String>,
    pub paid_content_type_campaign_colour: Option<String>,
    pub rcs_id: Option<String>,
    pub r2_contributor_id: Option<String>,
    pub tag_categories: Option<Vec<String>>,
    pub entity_ids: Option<Vec<String>>,
    pub campaign_information_type: Option<String>,
    pub internal_name: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SearchResult {
    pub id: String,
    pub r#type: Option<String>,
    pub section_id: Option<String>,
    pub section_name: Option<String>,
    pub web_publication_date: Option<chrono::DateTime<Utc>>,
    pub web_title: String,
    pub web_url: String,
    pub api_url: String,
    pub is_hosted: Option<bool>,
    pub pillar_id: Option<String>,
    pub pillar_name: Option<String>,
    pub fields: Option<Fields>,
    pub tags: Option<Vec<Tag>>,
    pub section: Option<Section>,
    pub blocks: Option<Blocks>,
    pub editions: Option<Vec<Edition>>,
}

#[derive(Clone, Debug, Deserialize)]
pub struct Reference {
    pub id: String,
    pub r#type: String,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Section {
    pub id: String,
    pub web_title: String,
    pub web_url: String,
    pub api_url: String,
    pub editions: Vec<Edition>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Edition {
    pub id: String,
    pub web_title: String,
    pub web_url: String,
    pub api_url: String,
    pub code: String,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Blocks {
    pub main: Option<Block>,
    pub body: Option<Vec<Block>>,
    pub total_body_blocks: Option<i32>,
    pub requested_body_blocks: Option<BTreeMap<String, Vec<Block>>>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Block {
    pub id: String,
    pub body_html: String,
    pub body_text_summary: String,
    pub title: Option<String>,
    pub attributes: BlockAttributes,
    pub published: bool,
    pub created_date: Option<serde_json::Value>,
    pub first_published_date: Option<serde_json::Value>,
    pub published_date: Option<serde_json::Value>,
    pub last_modified_date: Option<serde_json::Value>,
    pub contributors: Vec<String>,
    pub elements: Vec<BlockElement>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BlockElement {
    pub r#type: String,
    pub assets: Vec<Asset>,
    pub text_type_data: Option<TextElementFields>,
    pub video_type_data: Option<VideoElementFields>,
    pub tweet_type_data: Option<TweetElementFields>,
    pub image_type_data: Option<ImageElementFields>,
    pub audio_type_data: Option<AudioElementFields>,
    pub pullquote_type_data: Option<PullquoteElementFields>,
    pub interactive_type_data: Option<InteractiveElementFields>,
    pub map_type_data: Option<StandardElementFields>,
    pub document_type_data: Option<StandardElementFields>,
    pub table_type_data: Option<StandardElementFields>,
    pub witness_type_data: Option<WitnessElementFields>,
    pub rich_link_type_data: Option<RichLinkElementFields>,
    pub membership_type_data: Option<MembershipElementFields>,
    pub embed_type_data: Option<EmbedElementFields>,
    pub instagram_type_data: Option<InstagramElementFields>,
    pub comment_type_data: Option<CommentElementFields>,
    pub vine_type_data: Option<VineElementFields>,
    pub content_atom_type_data: Option<ContentAtomElementFields>,
    pub tracking: Option<Box<EmbedTracking>>,
    pub code_type_data: Option<CodeElementFields>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TextElementFields {
    pub html: Option<String>,
    pub role: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VideoElementFields {
    pub url: Option<String>,
    pub description: Option<String>,
    pub title: Option<String>,
    pub html: Option<String>,
    pub source: Option<String>,
    pub credit: Option<String>,
    pub caption: Option<String>,
    pub height: Option<i32>,
    pub width: Option<i32>,
    pub duration: Option<i32>,
    pub content_auth_system: Option<String>,
    pub embeddable: Option<String>,
    pub is_inappropriate_for_adverts: Option<bool>,
    pub media_id: Option<String>,
    pub still_image_url: Option<String>,
    pub thumbnail_url: Option<String>,
    pub short_url: Option<String>,
    pub role: Option<String>,
    pub original_url: Option<String>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TweetElementFields {
    pub source: Option<String>,
    pub url: Option<String>,
    pub id: Option<String>,
    pub html: Option<String>,
    pub original_url: Option<String>,
    pub role: Option<String>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ImageElementFields {
    pub caption: Option<String>,
    pub copyright: Option<String>,
    pub display_credit: Option<bool>,
    pub credit: Option<String>,
    pub source: Option<String>,
    pub photographer: Option<String>,
    pub alt: Option<String>,
    pub media_id: Option<String>,
    pub media_api_uri: Option<String>,
    pub picdar_urn: Option<String>,
    pub suppliers_reference: Option<String>,
    pub image_type: Option<String>,
    pub comment: Option<String>,
    pub role: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AudioElementFields {
    pub html: Option<String>,
    pub source: Option<String>,
    pub description: Option<String>,
    pub title: Option<String>,
    pub credit: Option<String>,
    pub caption: Option<String>,
    pub duration_minutes: Option<i32>,
    pub duration_seconds: Option<i32>,
    pub clean: Option<bool>,
    pub explicit: Option<bool>,
    pub role: Option<String>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PullquoteElementFields {
    pub html: Option<String>,
    pub attribution: Option<String>,
    pub role: Option<String>,
    pub source: Option<String>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct InteractiveElementFields {
    pub url: Option<String>,
    pub original_url: Option<String>,
    pub source: Option<String>,
    pub caption: Option<String>,
    pub alt: Option<String>,
    pub script_url: Option<String>,
    pub html: Option<String>,
    pub script_name: Option<String>,
    pub iframe_url: Option<String>,
    pub role: Option<String>,
    pub is_mandatory: Option<bool>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct StandardElementFields {
    pub url: Option<String>,
    pub original_url: Option<String>,
    pub source: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub credit: Option<String>,
    pub caption: Option<String>,
    pub width: Option<i32>,
    pub height: Option<i32>,
    pub html: Option<String>,
    pub role: Option<String>,
    pub is_mandatory: Option<bool>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WitnessElementFields {
    pub url: Option<String>,
    pub original_url: Option<String>,
    pub witness_embed_type: Option<String>,
    pub media_id: Option<String>,
    pub source: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub author_name: Option<String>,
    pub author_username: Option<String>,
    pub author_witness_profile_url: Option<String>,
    pub author_guardian_profile_url: Option<String>,
    pub caption: Option<String>,
    pub alt: Option<String>,
    pub width: Option<i32>,
    pub height: Option<i32>,
    pub html: Option<String>,
    pub api_url: Option<String>,
    pub photographer: Option<String>,
    pub date_created: Option<chrono::DateTime<Utc>>,
    pub youtube_url: Option<String>,
    pub youtube_source: Option<String>,
    pub youtube_title: Option<String>,
    pub youtube_description: Option<String>,
    pub youtube_author_name: Option<String>,
    pub youtube_html: Option<String>,
    pub role: Option<String>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RichLinkElementFields {
    pub url: Option<String>,
    pub original_url: Option<String>,
    pub link_text: Option<String>,
    pub link_prefix: Option<String>,
    pub role: Option<String>,
    pub sponsorship: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct MembershipElementFields {
    pub original_url: Option<String>,
    pub link_text: Option<String>,
    pub link_prefix: Option<String>,
    pub title: Option<String>,
    pub venue: Option<String>,
    pub location: Option<String>,
    pub identifier: Option<String>,
    pub image: Option<String>,
    pub price: Option<String>,
    pub start: Option<chrono::DateTime<Utc>>,
    pub end: Option<chrono::DateTime<Utc>>,
    pub role: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EmbedElementFields {
    pub html: Option<String>,
    pub safe_embed_code: Option<bool>,
    pub alt: Option<String>,
    pub is_mandatory: Option<bool>,
    pub role: Option<String>,
    pub source: Option<String>,
    pub source_domain: Option<String>,
    pub caption: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct InstagramElementFields {
    pub original_url: String,
    pub title: String,
    pub source: String,
    pub author_url: String,
    pub author_username: String,
    pub html: Option<String>,
    pub width: Option<i32>,
    pub alt: Option<String>,
    pub caption: Option<String>,
    pub role: Option<String>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CommentElementFields {
    pub source: Option<String>,
    pub discussion_key: Option<String>,
    pub comment_url: Option<String>,
    pub original_url: Option<String>,
    pub source_url: Option<String>,
    pub discussion_url: Option<String>,
    pub author_url: Option<String>,
    pub html: Option<String>,
    pub author_name: Option<String>,
    pub comment_id: Option<i32>,
    pub role: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VineElementFields {
    pub original_url: String,
    pub title: String,
    pub source: String,
    pub author_url: String,
    pub author_username: String,
    pub html: Option<String>,
    pub width: Option<i32>,
    pub height: Option<i32>,
    pub alt: Option<String>,
    pub caption: Option<String>,
    pub role: Option<String>,
    pub source_domain: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ContentAtomElementFields {
    pub atom_id: String,
    pub atom_type: String,
    pub role: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EmbedTracking {
    pub tracks: String,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CodeElementFields {
    pub html: String,
    pub language: String,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Asset {
    pub r#type: String,
    pub mime_type: Option<String>,
    pub file: Option<String>,
    pub type_data: Option<AssetFields>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AssetFields {
    pub aspect_ratio: Option<String>,
    pub alt_text: Option<String>,
    pub is_inappropriate_for_adverts: Option<bool>,
    pub caption: Option<String>,
    pub credit: Option<String>,
    pub embeddable: Option<bool>,
    pub photographer: Option<String>,
    pub source: Option<String>,
    pub still_image_url: Option<String>,
    pub width: Option<i32>,
    pub height: Option<i32>,
    pub name: Option<String>,
    pub secure_file: Option<String>,
    pub is_master: Option<bool>,
    pub size_in_bytes: Option<i64>,
    pub duration_minutes: Option<i32>,
    pub duration_seconds: Option<i32>,
    pub display_credit: Option<bool>,
    pub thumbnail_url: Option<String>,
    pub role: Option<String>,
    pub media_id: Option<String>,
    pub iframe_url: Option<String>,
    pub script_name: Option<String>,
    pub script_url: Option<String>,
    pub block_ads: Option<bool>,
    pub html: Option<String>,
    pub embed_type: Option<String>,
    pub explicit: Option<bool>,
    pub clean: Option<bool>,
    pub thumbnail_image_url: Option<String>,
    pub link_text: Option<String>,
    pub link_prefix: Option<String>,
    pub short_url: Option<String>,
    pub image_type: Option<String>,
    pub suppliers_reference: Option<String>,
    pub media_api_uri: Option<String>,
    pub copyright: Option<String>,
    pub mime_type: Option<String>,
    pub url: Option<String>,
    pub original_url: Option<String>,
    pub id: Option<String>,
    pub attribution: Option<String>,
    pub description: Option<String>,
    pub title: Option<String>,
    pub content_auth_system: Option<String>,
    pub alt: Option<String>,
    pub picdar_urn: Option<String>,
    pub comment: Option<String>,
    pub witness_embed_type: Option<String>,
    pub author_name: Option<String>,
    pub author_username: Option<String>,
    pub author_witness_profile_url: Option<String>,
    pub author_guardian_profile_url: Option<String>,
    pub api_url: Option<String>,
    pub date_created: Option<serde_json::Value>,
    pub youtube_url: Option<String>,
    pub youtube_source: Option<String>,
    pub youtube_title: Option<String>,
    pub youtube_description: Option<String>,
    pub youtube_author_name: Option<String>,
    pub youtube_html: Option<String>,
    pub venue: Option<String>,
    pub location: Option<String>,
    pub identifier: Option<String>,
    pub price: Option<String>,
    pub start: Option<chrono::DateTime<Utc>>,
    pub end: Option<chrono::DateTime<Utc>>,
    pub safe_embed_code: Option<bool>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CapiDateTime {
    pub date_time: i64,
    pub iso8601: String,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
#[allow(dead_code)]
pub struct BlockAttributes {
    key_event: Option<bool>,
    summary: Option<bool>,
    title: Option<String>,
    pinned: Option<bool>,
    membership_placeholder: Option<MembershipPlaceholder>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct MembershipPlaceholder {
    pub campaign_code: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
#[allow(dead_code)]
pub struct User {
    email: Option<String>,
    first_name: Option<String>,
    last_name: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Content {
    pub id: String,
    pub r#type: String,
    pub section_id: Option<String>,
    pub section_name: Option<String>,
    pub web_publication_date: Option<chrono::DateTime<Utc>>,
    pub web_title: String,
    pub web_url: String,
    pub api_url: String,
    pub fields: Option<ContentFields>,
    pub tags: Vec<Tag>,
    // pub elements: Option<Vec<Element>>,
    pub references: Option<Vec<Reference>>,
    pub is_expired: Option<bool>,
    pub blocks: Option<Blocks>,
    // pub rights: Option<Rights>,
    pub section: Option<Section>,
    pub is_gone: Option<bool>,
    pub is_hosted: bool,
    pub pillar_id: Option<String>,
    pub pillar_name: Option<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ContentFields {
    pub headline: Option<String>,
    pub standfirst: Option<String>,
    pub trail_text: Option<String>,
    pub byline: Option<String>,
    pub main: Option<String>,
    pub body: Option<String>,
    pub newspaper_page_number: Option<i32>,
    pub star_rating: Option<i32>,
    pub contributor_bio: Option<String>,
    pub membership_access: Option<String>,
    pub wordcount: Option<i32>,
    pub comment_close_date: Option<CapiDateTime>,
    pub commentable: Option<bool>,
    pub display_hint: Option<String>,
    pub first_publication_date: Option<CapiDateTime>,
    pub has_story_package: Option<bool>,
    pub is_inappropriate_for_sponsorship: Option<bool>,
    pub is_premoderated: Option<bool>,
    pub last_modified: Option<CapiDateTime>,
    pub live_blogging_now: Option<bool>,
    pub newspaper_edition_date: Option<CapiDateTime>,
    pub production_office: Option<String>,
    pub publication: Option<String>,
    pub scheduled_publication_date: Option<CapiDateTime>,
    pub short_url: Option<String>,
    pub should_hide_adverts: Option<bool>,
    pub show_in_related_content: Option<bool>,
    pub thumbnail: Option<String>,
    pub legally_sensitive: Option<bool>,
    pub allow_ugc: Option<bool>,
    pub sensitive: Option<bool>,
    pub lang: Option<String>,
    pub is_live: Option<bool>,
    pub internal_short_id: Option<String>,
    pub short_social_share_text: Option<String>,
    pub social_share_text: Option<String>,
    pub body_text: Option<String>,
    pub char_count: Option<i32>,
    pub internal_video_code: Option<String>,
    pub should_hide_reader_revenue: Option<bool>,
    pub show_affiliate_links: Option<bool>,
    pub byline_html: Option<String>,
}