Skip to content

Commit 7f5cc5b

Browse files
authored
chore: update generated types (#1221)
- removes deprecated prospect sources
1 parent 047fba7 commit 7f5cc5b

File tree

1 file changed

+15
-24
lines changed

1 file changed

+15
-24
lines changed

src/api/generatedTypes.ts

+15-24
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export type Scalars = {
2020
Int: number;
2121
Float: number;
2222
_FieldSet: any;
23-
/** A date in the YYYY-MM-DD format. */
23+
/** A date string, such as 2007-12-03, compliant with the `full-date` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. */
2424
Date: any;
2525
/** A String representing a date in the format of `yyyy-MM-dd HH:mm:ss` */
2626
DateString: any;
@@ -37,7 +37,7 @@ export type Scalars = {
3737
* not treated differently from String in the API.
3838
*/
3939
Markdown: any;
40-
/** A positive integer number. */
40+
/** Integers that will have a value of 0 or more. */
4141
NonNegativeInt: any;
4242
Upload: any;
4343
/** A URL - usually, for an interesting story on the internet that's worth saving to Pocket. */
@@ -90,8 +90,8 @@ export type ApprovedCorpusItem = {
9090
/** Whether this item is a syndicated article. */
9191
isSyndicated: Scalars['Boolean'];
9292
/**
93-
* A flag to ML to not recommend this item long term after it is added to the corpus.
94-
* Example: a story covering an election, or "The best of 202x" collection.
93+
* Experimental data point that could imply either an expiry date or an urgency to be shown.
94+
* May be used for ML modeling.
9595
*/
9696
isTimeSensitive: Scalars['Boolean'];
9797
/** What language this story is in. This is a two-letter code, for example, 'EN' for English. */
@@ -117,7 +117,7 @@ export type ApprovedCorpusItem = {
117117
updatedAt: Scalars['Int'];
118118
/** A single sign-on user identifier of the user who last updated this entity. Null on creation. */
119119
updatedBy?: Maybe<Scalars['String']>;
120-
/** key field to identify the Approved Corpus Item entity in the Curated Corpus service */
120+
/** The URL of the story. */
121121
url: Scalars['Url'];
122122
};
123123

@@ -259,7 +259,7 @@ export type CachedImageInput = {
259259
fileType?: InputMaybe<ImageFileType>;
260260
/** Height of the image */
261261
height?: InputMaybe<Scalars['Int']>;
262-
/** Id of the image in the returned result set */
262+
/** ID that will be added to the generated response object so you can find it. NOTE: Can be any string that you like, it will be added to the response so you can use it when consuming it */
263263
id: Scalars['ID'];
264264
/** Quality of the image in whole percentage, 100 = full, quality 50 = half quality */
265265
qualityPercentage?: InputMaybe<Scalars['Int']>;
@@ -497,8 +497,8 @@ export enum CorpusLanguage {
497497
/** A node in a CorpusSearchConnection result */
498498
export type CorpusSearchNode = {
499499
__typename?: 'CorpusSearchNode';
500-
/** The preview of the search result */
501-
preview: PocketMetadata;
500+
/** Attaches the item so we can use the preview field */
501+
item?: Maybe<Item>;
502502
};
503503

504504
/** Input data for creating an Approved Item and optionally scheduling this item to appear on a Scheduled Surface. */
@@ -841,7 +841,10 @@ export type ImportApprovedCorpusItemPayload = {
841841
scheduledItem: ScheduledCorpusItem;
842842
};
843843

844-
/** Resolve by reference the Item entity to connect Prospect to Items. */
844+
/**
845+
* The heart of Pocket
846+
* A url and meta data related to it.
847+
*/
845848
export type Item = {
846849
__typename?: 'Item';
847850
/** If available, the url to an AMP version of this article */
@@ -1176,14 +1179,6 @@ export type Mutation = {
11761179
deleteCollectionStory: CollectionStory;
11771180
/** Deletes an item from a Scheduled Surface. */
11781181
deleteScheduledCorpusItem: ScheduledCorpusItem;
1179-
/**
1180-
* Marks a prospect as 'curated' in the database, preventing it from being displayed for prospecting.
1181-
* Returns the prospect if the operation succeeds, and null if not (almost surely due to an incorrect id).
1182-
*
1183-
* This is functionally a copy of updateProspectAsCurated for now, but will have differences in
1184-
* snowplow reporting down the line.
1185-
*/
1186-
dismissProspect?: Maybe<Prospect>;
11871182
/**
11881183
* Lets an automated process create an Approved Item and optionally schedule it to appear
11891184
* on a Scheduled Surface.
@@ -1253,6 +1248,8 @@ export type Mutation = {
12531248
/**
12541249
* Marks a prospect as 'curated' in the database, preventing it from being displayed for prospecting.
12551250
* Returns the prospect if the operation succeeds, and null if not (almost surely due to an incorrect id).
1251+
*
1252+
* Called when approving or rejecting a prospect into the corpus.
12561253
*/
12571254
updateProspectAsCurated?: Maybe<Prospect>;
12581255
/** Uploads an image to S3 for an Approved Item */
@@ -1315,10 +1312,6 @@ export type MutationDeleteScheduledCorpusItemArgs = {
13151312
data: DeleteScheduledCorpusItemInput;
13161313
};
13171314

1318-
export type MutationDismissProspectArgs = {
1319-
id: Scalars['ID'];
1320-
};
1321-
13221315
export type MutationImportApprovedCorpusItemArgs = {
13231316
data: ImportApprovedCorpusItemInput;
13241317
};
@@ -1559,7 +1552,6 @@ export type Prospect = {
15591552
*/
15601553
export enum ProspectType {
15611554
Counts = 'COUNTS',
1562-
CountsModeled = 'COUNTS_MODELED',
15631555
Dismissed = 'DISMISSED',
15641556
DomainAllowlist = 'DOMAIN_ALLOWLIST',
15651557
PublisherSubmitted = 'PUBLISHER_SUBMITTED',
@@ -1568,7 +1560,6 @@ export enum ProspectType {
15681560
RssLogisticRecent = 'RSS_LOGISTIC_RECENT',
15691561
SlateSchedulerV2 = 'SLATE_SCHEDULER_V2',
15701562
Timespent = 'TIMESPENT',
1571-
TimespentModeled = 'TIMESPENT_MODELED',
15721563
TitleUrlModeled = 'TITLE_URL_MODELED',
15731564
TopSaved = 'TOP_SAVED',
15741565
}
@@ -1795,7 +1786,7 @@ export type RejectedCorpusItem = {
17951786
* Temporarily a string value that will be provided by Prospect API, possibly an enum in the future.
17961787
*/
17971788
topic?: Maybe<Scalars['String']>;
1798-
/** key field to identify the Rejected Corpus Item entity in the Curated Corpus service */
1789+
/** The URL of the story. */
17991790
url: Scalars['Url'];
18001791
};
18011792

0 commit comments

Comments
 (0)