@pushwoosh/rpc-v2-http-api-data 0.2.413 → 0.2.415

package/data.js

@@ -14810,6 +14810,18 @@ export const data = {
                 "method": "post",
                 "path": "/api/events:getRevenueStatistics"
             },
+            "GetRevenueSuggestions": {
+                "request": "pushwoosh.rpc_v2.events.GetRevenueSuggestionsRequest",
+                "response": "pushwoosh.rpc_v2.events.RevenueSuggestions",
+                "method": "get",
+                "path": "/api/events:revenue-suggestions"
+            },
+            "DismissRevenueSuggestions": {
+                "request": "pushwoosh.rpc_v2.events.DismissRevenueSuggestionsRequest",
+                "response": "pushwoosh.rpc_v2.events.DismissRevenueSuggestionsResponse",
+                "method": "post",
+                "path": "/api/events:dismiss-revenue-suggestions"
+            },
             "GetConversionEvents": {
                 "request": "pushwoosh.rpc_v2.events.GetConversionEventsRequest",
                 "response": "pushwoosh.rpc_v2.events.ConversionEvents",
@@ -15390,6 +15402,52 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.events.RevenueSuggestion": {
+        "type": "I",
+        "fields": {
+            "event": {
+                "type": "string"
+            },
+            "valueAttr": {
+                "type": "string"
+            },
+            "currencyAttr": {
+                "type": "string"
+            },
+            "triggeredCount": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.RevenueSuggestions": {
+        "type": "I",
+        "fields": {
+            "suggestions": {
+                "type": "pushwoosh.rpc_v2.events.RevenueSuggestion",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.GetRevenueSuggestionsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.DismissRevenueSuggestionsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.DismissRevenueSuggestionsResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.rpc_v2.events.GetConversionEventsRequest": {
         "type": "I",
         "fields": {
@@ -25009,6 +25067,36 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.news.DeleteNewsFeedResponse",
                 "method": "post",
                 "path": "/api/news/feeds:delete"
+            },
+            "ListNewsFeedCampaigns": {
+                "request": "pushwoosh.rpc_v2.news.ListNewsFeedCampaignsRequest",
+                "response": "pushwoosh.rpc_v2.news.ListNewsFeedCampaignsResponse",
+                "method": "get",
+                "path": "/api/news/campaigns"
+            },
+            "GetNewsFeedCampaign": {
+                "request": "pushwoosh.rpc_v2.news.GetNewsFeedCampaignRequest",
+                "response": "pushwoosh.rpc_v2.news.GetNewsFeedCampaignResponse",
+                "method": "get",
+                "path": "/api/news/campaigns/{code}"
+            },
+            "SetNewsFeedCampaign": {
+                "request": "pushwoosh.rpc_v2.news.SetNewsFeedCampaignRequest",
+                "response": "pushwoosh.rpc_v2.news.SetNewsFeedCampaignResponse",
+                "method": "post",
+                "path": "/api/news/campaigns"
+            },
+            "SetNewsFeedCampaignStatus": {
+                "request": "pushwoosh.rpc_v2.news.SetNewsFeedCampaignStatusRequest",
+                "response": "pushwoosh.rpc_v2.news.SetNewsFeedCampaignStatusResponse",
+                "method": "post",
+                "path": "/api/news/campaigns/{code}:status"
+            },
+            "DeleteNewsFeedCampaign": {
+                "request": "pushwoosh.rpc_v2.news.DeleteNewsFeedCampaignRequest",
+                "response": "pushwoosh.rpc_v2.news.DeleteNewsFeedCampaignResponse",
+                "method": "post",
+                "path": "/api/news/campaigns:delete"
             }
         }
     },
@@ -25048,9 +25136,6 @@ export const data = {
             },
             "syncIntervalMinutes": {
                 "type": "number"
-            },
-            "journeyUuid": {
-                "type": "string"
             }
         }
     },
@@ -25092,10 +25177,6 @@ export const data = {
             "syncIntervalMinutes": {
                 "type": "number",
                 "optional": true
-            },
-            "journeyUuid": {
-                "type": "string",
-                "optional": true
             }
         }
     },
@@ -25122,6 +25203,185 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.news.NewsFeedCampaign": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "feedCode": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "status": {
+                "type": "string"
+            },
+            "push": {
+                "type": "boolean"
+            },
+            "inbox": {
+                "type": "boolean"
+            },
+            "filterCode": {
+                "type": "string"
+            },
+            "inboxExpiresInDays": {
+                "type": "number",
+                "optional": true
+            },
+            "maxArticles": {
+                "type": "number"
+            },
+            "ttlSeconds": {
+                "type": "number",
+                "optional": true
+            },
+            "sendRate": {
+                "type": "number",
+                "optional": true
+            },
+            "campaignCode": {
+                "type": "string"
+            },
+            "lastSentAt": {
+                "type": "Date",
+                "optional": true
+            },
+            "lastSentTitle": {
+                "type": "string"
+            },
+            "created": {
+                "type": "Date"
+            },
+            "updated": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.ListNewsFeedCampaignsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.ListNewsFeedCampaignsResponse": {
+        "type": "I",
+        "fields": {
+            "campaigns": {
+                "type": "pushwoosh.rpc_v2.news.NewsFeedCampaign",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.GetNewsFeedCampaignRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.GetNewsFeedCampaignResponse": {
+        "type": "I",
+        "fields": {
+            "campaign": {
+                "type": "pushwoosh.rpc_v2.news.NewsFeedCampaign"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.SetNewsFeedCampaignRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            },
+            "feedCode": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "push": {
+                "type": "boolean"
+            },
+            "inbox": {
+                "type": "boolean"
+            },
+            "filterCode": {
+                "type": "string"
+            },
+            "inboxExpiresInDays": {
+                "type": "number",
+                "optional": true
+            },
+            "maxArticles": {
+                "type": "number"
+            },
+            "ttlSeconds": {
+                "type": "number",
+                "optional": true
+            },
+            "sendRate": {
+                "type": "number",
+                "optional": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.SetNewsFeedCampaignResponse": {
+        "type": "I",
+        "fields": {
+            "campaign": {
+                "type": "pushwoosh.rpc_v2.news.NewsFeedCampaign"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.SetNewsFeedCampaignStatusRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            },
+            "status": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.SetNewsFeedCampaignStatusResponse": {
+        "type": "I",
+        "fields": {
+            "campaign": {
+                "type": "pushwoosh.rpc_v2.news.NewsFeedCampaign"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.DeleteNewsFeedCampaignRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.news.DeleteNewsFeedCampaignResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.objects.filters.v1.LogicExpression.Binary.Operator": {
         "type": "E",
         "values": [

package/events.d.ts

@@ -9,6 +9,8 @@ export type EventsService_GetTriggeredCount = RpcMethod<GetTriggeredCountRequest
 export type EventsService_GetDetailedStatistics = RpcMethod<GetDetailedStatisticsRequest, GetDetailedStatisticsResponse>;
 export type EventsService_GetTotalStatistics = RpcMethod<GetTotalStatisticsRequest, GetTotalStatisticsResponse>;
 export type EventsService_GetRevenueStatistics = RpcMethod<GetRevenueStatisticsRequest, GetRevenueStatisticsResponse>;
+export type EventsService_GetRevenueSuggestions = RpcMethod<GetRevenueSuggestionsRequest, RevenueSuggestions>;
+export type EventsService_DismissRevenueSuggestions = RpcMethod<DismissRevenueSuggestionsRequest, DismissRevenueSuggestionsResponse>;
 export type EventsService_GetConversionEvents = RpcMethod<GetConversionEventsRequest, ConversionEvents>;
 export type EventsService_SaveConversionEvents = RpcMethod<SaveConversionEventsRequest, ConversionEvents>;
 export interface EventsService {
@@ -32,6 +34,10 @@ export interface EventsService {
     GetTotalStatistics: EventsService_GetTotalStatistics;
     /** Returns per-currency revenue totals and triggered counts for the revenue-mapped events of an application over a date range. Use to show how much revenue an event brought, kept in the original currencies. */
     GetRevenueStatistics: EventsService_GetRevenueStatistics;
+    /** Returns the revenue mappings the daily cron suggests for an application: custom events that already carry a purchase amount and an ISO currency code and are not conversion events yet, best first, each with the two attribute names. An empty list means nothing suitable was found or the client dismissed the hint. */
+    GetRevenueSuggestions: EventsService_GetRevenueSuggestions;
+    /** Hides the suggested revenue mapping hint for an application for good; the suggestions are kept but no longer returned. */
+    DismissRevenueSuggestions: EventsService_DismissRevenueSuggestions;
     /** Returns the events counted as conversions on the Conversions board, PW_Conversion first, each with its revenue attributes when it tracks revenue. */
     GetConversionEvents: EventsService_GetConversionEvents;
     /** Replaces the list of events counted as conversions on the Conversions board. Events left out of the request stop counting; PW_Conversion is always kept. Revenue attributes of an event are set through Update (revenue_mapping). A newly listed event is scheduled for a history recalculation. */
@@ -288,6 +294,33 @@ export type ConversionEvents = {
     /** Events counted as conversions, PW_Conversion first. */
     events: ConversionEvent[];
 };
+/**
+ * RevenueSuggestion is a revenue mapping found by the cron but not enabled yet: the event
+ * and the attributes that would feed PW_Conversion value and currency.
+ */
+export type RevenueSuggestion = {
+    /** Name of the suggested custom event. */
+    event: string;
+    /** Event attribute holding the purchase amount. */
+    valueAttr: string;
+    /** Event attribute holding the ISO currency code. */
+    currencyAttr: string;
+    /** How many times the event fired over the last 30 days when the suggestion was made. */
+    triggeredCount: number;
+};
+export type RevenueSuggestions = {
+    /** Candidate events best first: purchase-like names, then the most frequent. Empty when there is nothing to show. */
+    suggestions: RevenueSuggestion[];
+};
+export type GetRevenueSuggestionsRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+};
+export type DismissRevenueSuggestionsRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+};
+export type DismissRevenueSuggestionsResponse = {};
 export type GetConversionEventsRequest = {
     /** Application code (format XXXXX-XXXXX). */
     application?: string;

package/news.d.ts

@@ -2,6 +2,11 @@ import { RpcMethod } from './commonTypes';
 export type NewsService_ListNewsFeeds = RpcMethod<ListNewsFeedsRequest, ListNewsFeedsResponse>;
 export type NewsService_SetNewsFeed = RpcMethod<SetNewsFeedRequest, SetNewsFeedResponse>;
 export type NewsService_DeleteNewsFeed = RpcMethod<DeleteNewsFeedRequest, DeleteNewsFeedResponse>;
+export type NewsService_ListNewsFeedCampaigns = RpcMethod<ListNewsFeedCampaignsRequest, ListNewsFeedCampaignsResponse>;
+export type NewsService_GetNewsFeedCampaign = RpcMethod<GetNewsFeedCampaignRequest, GetNewsFeedCampaignResponse>;
+export type NewsService_SetNewsFeedCampaign = RpcMethod<SetNewsFeedCampaignRequest, SetNewsFeedCampaignResponse>;
+export type NewsService_SetNewsFeedCampaignStatus = RpcMethod<SetNewsFeedCampaignStatusRequest, SetNewsFeedCampaignStatusResponse>;
+export type NewsService_DeleteNewsFeedCampaign = RpcMethod<DeleteNewsFeedCampaignRequest, DeleteNewsFeedCampaignResponse>;
 /**
  * NewsService manages the registry of news feeds an application's email news
  * blocks read from. Feeds are imported on their own interval by uds/rss-feeds.
@@ -13,6 +18,16 @@ export interface NewsService {
     SetNewsFeed: NewsService_SetNewsFeed;
     /** Removes a news feed of an application (code XXXXX-XXXXX) from the registry. Its already imported articles are deleted by the next import run. */
     DeleteNewsFeed: NewsService_DeleteNewsFeed;
+    /** Lists the feed campaigns of an application (code XXXXX-XXXXX): each sends every new article of one of its news feeds as a push and/or an App Inbox message. Use to show the campaigns listing with the last article sent. */
+    ListNewsFeedCampaigns: NewsService_ListNewsFeedCampaigns;
+    /** Returns one feed campaign of an application (code XXXXX-XXXXX) by its code, for the edit form. */
+    GetNewsFeedCampaign: NewsService_GetNewsFeedCampaign;
+    /** Creates a feed campaign for an application (code XXXXX-XXXXX), or replaces the definition of one when code is given. A new campaign is active at once: the next check of its feed sends the articles that arrive from now on. The whole definition is sent every time. */
+    SetNewsFeedCampaign: NewsService_SetNewsFeedCampaign;
+    /** Pauses or resumes a feed campaign of an application (code XXXXX-XXXXX). An inactive campaign skips the articles that arrive meanwhile; they are not sent on resume. */
+    SetNewsFeedCampaignStatus: NewsService_SetNewsFeedCampaignStatus;
+    /** Deletes a feed campaign of an application (code XXXXX-XXXXX) together with its statistics campaign. Messages already sent stay in the history. */
+    DeleteNewsFeedCampaign: NewsService_DeleteNewsFeedCampaign;
 }
 export type NewsFeed = {
     /** Stable feed id; an email block references the feed by this code. */
@@ -35,8 +50,6 @@ export type NewsFeed = {
     lastSyncedArticles: number;
     /** Minutes between imports of this feed. */
     syncIntervalMinutes: number;
-    /** Journey started for every new article through its API-based entry point; empty when none. */
-    journeyUuid: string;
 };
 export type ListNewsFeedsRequest = {
     /** Pushwoosh application code (XXXXX-XXXXX). */
@@ -56,11 +69,6 @@ export type SetNewsFeedRequest = {
     enabled?: boolean;
     /** Minutes between imports, 1..60. Absent keeps the stored value (60 for a new feed). */
     syncIntervalMinutes?: number;
-    /**
-     * Journey to start for every new article: the application's own, with an API-based entry point.
-     * Absent keeps the stored link, empty removes it.
-     */
-    journeyUuid?: string;
 };
 export type SetNewsFeedResponse = {
     feed: NewsFeed;
@@ -71,3 +79,97 @@ export type DeleteNewsFeedRequest = {
     code?: string;
 };
 export type DeleteNewsFeedResponse = {};
+/**
+ * NewsFeedCampaign sends every new article of a news feed to an audience as a push
+ * and/or an App Inbox message; the article is the content, the campaign is the delivery rules.
+ */
+export type NewsFeedCampaign = {
+    /** Stable campaign id. */
+    code: string;
+    /** Feed whose new articles the campaign sends. */
+    feedCode: string;
+    name: string;
+    /**
+     * "active" | "inactive". A failing feed import pauses sending by itself without changing this;
+     * see the feed's last_status.
+     */
+    status: string;
+    /** Send a push notification per article. */
+    push: boolean;
+    /** Leave an App Inbox entry per article: attached to the push, or standalone when push is off. */
+    inbox: boolean;
+    /** Audience segment; empty sends to all subscribers of the application. */
+    filterCode: string;
+    /** Days an inbox entry stays after the send; absent leaves the platform default. */
+    inboxExpiresInDays?: number;
+    /** How many new articles one feed check may send, newest first, a minute apart. */
+    maxArticles: number;
+    /** Push time to live in seconds; absent leaves the platform default. */
+    ttlSeconds?: number;
+    /** Messages per second; absent uses the account send rate. */
+    sendRate?: number;
+    /** Statistics campaign the messages are counted under. */
+    campaignCode: string;
+    /** When the last article went out and what it was. Absent before the first send. */
+    lastSentAt?: Date;
+    lastSentTitle: string;
+    created: Date;
+    updated: Date;
+};
+export type ListNewsFeedCampaignsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type ListNewsFeedCampaignsResponse = {
+    campaigns: NewsFeedCampaign[];
+};
+export type GetNewsFeedCampaignRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    code?: string;
+};
+export type GetNewsFeedCampaignResponse = {
+    campaign: NewsFeedCampaign;
+};
+export type SetNewsFeedCampaignRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Empty creates a campaign; a code replaces that campaign's definition. */
+    code?: string;
+    /** One of the application's news feeds. */
+    feedCode?: string;
+    name?: string;
+    /** At least one of push and inbox. */
+    push?: boolean;
+    /** Needs App Inbox integrated in the application. */
+    inbox?: boolean;
+    /** Segment of the application or of the account; empty means all subscribers. */
+    filterCode?: string;
+    /** 1..365, only with inbox. Absent leaves the platform default. */
+    inboxExpiresInDays?: number;
+    /** 1..10; 0 means 1. */
+    maxArticles?: number;
+    /** 1..2419200 (28 days), only with push. Absent leaves the platform default. */
+    ttlSeconds?: number;
+    /** 1..10000 messages per second. Absent uses the account send rate. */
+    sendRate?: number;
+};
+export type SetNewsFeedCampaignResponse = {
+    campaign: NewsFeedCampaign;
+};
+export type SetNewsFeedCampaignStatusRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    code?: string;
+    /** "active" | "inactive". */
+    status?: string;
+};
+export type SetNewsFeedCampaignStatusResponse = {
+    campaign: NewsFeedCampaign;
+};
+export type DeleteNewsFeedCampaignRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    code?: string;
+};
+export type DeleteNewsFeedCampaignResponse = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.413",
+  "version": "0.2.415",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",