Merge pull request #348 from prezly/feature/dev-18879-update-coverage-api

[DEV-18879][DEV-18781] Document new coverage<>story matching properties

Author: e1himself

src/types/CoverageEntry.ts

@@ -21,7 +21,18 @@ export interface CoverageEntry {
     is_deleted: boolean;
     headline: string;
     user: UserRef;
+
     story: Story | null;
+    /**
+     * Tells whether the story reference has been manually set, or automatically matched.
+     * `none` means no information (which is only used for null references).
+     */
+    story_reference_origin: 'manual' | 'auto' | 'none';
+    /**
+     * Number of displayed story suggestions (if the automatic matching was not sure enough about it).
+     */
+    suggested_stories_count: number;
+
     newsroom: NewsroomRef | null;
     author_contact: Contact | null;
     organisation_contact: Contact | null;

src/types/Story.ts

@@ -92,6 +92,7 @@ export interface Story {
     oembed: OEmbedInfo;
 
     coverage_number: number;
+    auto_matched_coverage_number: number;
     language: string;
     last_coverage_at: string | null;