@pushwoosh/rpc-v2-http-api-data 0.2.374 → 0.2.375
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data.js +14 -0
- package/news.d.ts +16 -5
- package/package.json +1 -1
package/data.js
CHANGED
|
@@ -24072,6 +24072,12 @@ export const data = {
|
|
|
24072
24072
|
},
|
|
24073
24073
|
"lastSyncedArticles": {
|
|
24074
24074
|
"type": "number"
|
|
24075
|
+
},
|
|
24076
|
+
"syncIntervalMinutes": {
|
|
24077
|
+
"type": "number"
|
|
24078
|
+
},
|
|
24079
|
+
"journeyUuid": {
|
|
24080
|
+
"type": "string"
|
|
24075
24081
|
}
|
|
24076
24082
|
}
|
|
24077
24083
|
},
|
|
@@ -24109,6 +24115,14 @@ export const data = {
|
|
|
24109
24115
|
},
|
|
24110
24116
|
"enabled": {
|
|
24111
24117
|
"type": "boolean"
|
|
24118
|
+
},
|
|
24119
|
+
"syncIntervalMinutes": {
|
|
24120
|
+
"type": "number",
|
|
24121
|
+
"optional": true
|
|
24122
|
+
},
|
|
24123
|
+
"journeyUuid": {
|
|
24124
|
+
"type": "string",
|
|
24125
|
+
"optional": true
|
|
24112
24126
|
}
|
|
24113
24127
|
}
|
|
24114
24128
|
},
|
package/news.d.ts
CHANGED
|
@@ -4,14 +4,14 @@ export type NewsService_SetNewsFeed = RpcMethod<SetNewsFeedRequest, SetNewsFeedR
|
|
|
4
4
|
export type NewsService_DeleteNewsFeed = RpcMethod<DeleteNewsFeedRequest, DeleteNewsFeedResponse>;
|
|
5
5
|
/**
|
|
6
6
|
* NewsService manages the registry of news feeds an application's email news
|
|
7
|
-
* blocks read from. Feeds are imported
|
|
7
|
+
* blocks read from. Feeds are imported on their own interval by uds/rss-feeds.
|
|
8
8
|
*/
|
|
9
9
|
export interface NewsService {
|
|
10
|
-
/** Lists the news feeds registered for an application (code XXXXX-XXXXX), each with the outcome of its last
|
|
10
|
+
/** Lists the news feeds registered for an application (code XXXXX-XXXXX), each with the outcome of its last import. Use to fill the feed selector of an email news block and to show why a feed went quiet. */
|
|
11
11
|
ListNewsFeeds: NewsService_ListNewsFeeds;
|
|
12
|
-
/** Registers an RSS/Atom news feed for an application (code XXXXX-XXXXX), or updates one when code is given. Articles are imported
|
|
12
|
+
/** Registers an RSS/Atom news feed for an application (code XXXXX-XXXXX), or updates one when code is given. Articles are imported on the feed's interval; an application may have several feeds. */
|
|
13
13
|
SetNewsFeed: NewsService_SetNewsFeed;
|
|
14
|
-
/** Removes a news feed of an application (code XXXXX-XXXXX) from the registry. Its already imported articles are deleted by the next
|
|
14
|
+
/** Removes a news feed of an application (code XXXXX-XXXXX) from the registry. Its already imported articles are deleted by the next import run. */
|
|
15
15
|
DeleteNewsFeed: NewsService_DeleteNewsFeed;
|
|
16
16
|
}
|
|
17
17
|
export type NewsFeed = {
|
|
@@ -25,7 +25,7 @@ export type NewsFeed = {
|
|
|
25
25
|
enabled: boolean;
|
|
26
26
|
created: Date;
|
|
27
27
|
updated: Date;
|
|
28
|
-
/** Outcome of the last
|
|
28
|
+
/** Outcome of the last import: "ok" | "error", empty before the first run. */
|
|
29
29
|
lastStatus: string;
|
|
30
30
|
/** Why that import failed; empty when it succeeded. */
|
|
31
31
|
lastError: string;
|
|
@@ -33,6 +33,10 @@ export type NewsFeed = {
|
|
|
33
33
|
lastSyncedAt?: Date;
|
|
34
34
|
/** Articles the last successful import stored. */
|
|
35
35
|
lastSyncedArticles: number;
|
|
36
|
+
/** Minutes between imports of this feed. */
|
|
37
|
+
syncIntervalMinutes: number;
|
|
38
|
+
/** Journey started for every new article through its API-based entry point; empty when none. */
|
|
39
|
+
journeyUuid: string;
|
|
36
40
|
};
|
|
37
41
|
export type ListNewsFeedsRequest = {
|
|
38
42
|
/** Pushwoosh application code (XXXXX-XXXXX). */
|
|
@@ -50,6 +54,13 @@ export type SetNewsFeedRequest = {
|
|
|
50
54
|
/** http(s) URL of an RSS or Atom feed. */
|
|
51
55
|
url?: string;
|
|
52
56
|
enabled?: boolean;
|
|
57
|
+
/** Minutes between imports, 1..60. Absent keeps the stored value (60 for a new feed). */
|
|
58
|
+
syncIntervalMinutes?: number;
|
|
59
|
+
/**
|
|
60
|
+
* Journey to start for every new article: the application's own, with an API-based entry point.
|
|
61
|
+
* Absent keeps the stored link, empty removes it.
|
|
62
|
+
*/
|
|
63
|
+
journeyUuid?: string;
|
|
53
64
|
};
|
|
54
65
|
export type SetNewsFeedResponse = {
|
|
55
66
|
feed: NewsFeed;
|