@pushwoosh/rpc-v2-http-api-data 0.2.373 → 0.2.375

package/data.js

@@ -14421,17 +14421,17 @@ export const data = {
                 "method": "post",
                 "path": "/api/events:getRevenueStatistics"
             },
-            "GetConversionSettings": {
-                "request": "pushwoosh.rpc_v2.events.GetConversionSettingsRequest",
-                "response": "pushwoosh.rpc_v2.events.ConversionSettings",
+            "GetConversionEvents": {
+                "request": "pushwoosh.rpc_v2.events.GetConversionEventsRequest",
+                "response": "pushwoosh.rpc_v2.events.ConversionEvents",
                 "method": "get",
-                "path": "/api/events:conversion-settings"
+                "path": "/api/events:conversion-events"
             },
-            "SaveConversionSettings": {
-                "request": "pushwoosh.rpc_v2.events.SaveConversionSettingsRequest",
-                "response": "pushwoosh.rpc_v2.events.ConversionSettings",
+            "SaveConversionEvents": {
+                "request": "pushwoosh.rpc_v2.events.SaveConversionEventsRequest",
+                "response": "pushwoosh.rpc_v2.events.ConversionEvents",
                 "method": "put",
-                "path": "/api/events:conversion-settings"
+                "path": "/api/events:conversion-events"
             }
         }
     },
@@ -14978,38 +14978,30 @@ export const data = {
             }
         }
     },
-    "pushwoosh.rpc_v2.events.ContactType": {
-        "type": "E",
-        "values": [
-            "CONTACT_TYPE_UNSPECIFIED",
-            "CONTACT_TYPE_CLICK",
-            "CONTACT_TYPE_SENT"
-        ]
-    },
     "pushwoosh.rpc_v2.events.ConversionEvent": {
         "type": "I",
         "fields": {
             "name": {
                 "type": "string"
             },
-            "attributionWindowSeconds": {
-                "type": "number"
+            "revenueMapping": {
+                "type": "pushwoosh.rpc_v2.events.RevenueMapping"
+            },
+            "isDefault": {
+                "type": "boolean"
             }
         }
     },
-    "pushwoosh.rpc_v2.events.ConversionSettings": {
+    "pushwoosh.rpc_v2.events.ConversionEvents": {
         "type": "I",
         "fields": {
             "events": {
                 "type": "pushwoosh.rpc_v2.events.ConversionEvent",
                 "array": true
-            },
-            "contactType": {
-                "type": "pushwoosh.rpc_v2.events.ContactType"
             }
         }
     },
-    "pushwoosh.rpc_v2.events.GetConversionSettingsRequest": {
+    "pushwoosh.rpc_v2.events.GetConversionEventsRequest": {
         "type": "I",
         "fields": {
             "application": {
@@ -15017,14 +15009,15 @@ export const data = {
             }
         }
     },
-    "pushwoosh.rpc_v2.events.SaveConversionSettingsRequest": {
+    "pushwoosh.rpc_v2.events.SaveConversionEventsRequest": {
         "type": "I",
         "fields": {
             "application": {
                 "type": "string"
             },
-            "settings": {
-                "type": "pushwoosh.rpc_v2.events.ConversionSettings"
+            "events": {
+                "type": "pushwoosh.rpc_v2.events.ConversionEvent",
+                "array": true
             }
         }
     },
@@ -24079,6 +24072,12 @@ export const data = {
             },
             "lastSyncedArticles": {
                 "type": "number"
+            },
+            "syncIntervalMinutes": {
+                "type": "number"
+            },
+            "journeyUuid": {
+                "type": "string"
             }
         }
     },
@@ -24116,6 +24115,14 @@ export const data = {
             },
             "enabled": {
                 "type": "boolean"
+            },
+            "syncIntervalMinutes": {
+                "type": "number",
+                "optional": true
+            },
+            "journeyUuid": {
+                "type": "string",
+                "optional": true
             }
         }
     },

package/events.d.ts

@@ -9,8 +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_GetConversionSettings = RpcMethod<GetConversionSettingsRequest, ConversionSettings>;
-export type EventsService_SaveConversionSettings = RpcMethod<SaveConversionSettingsRequest, ConversionSettings>;
+export type EventsService_GetConversionEvents = RpcMethod<GetConversionEventsRequest, ConversionEvents>;
+export type EventsService_SaveConversionEvents = RpcMethod<SaveConversionEventsRequest, ConversionEvents>;
 export interface EventsService {
     /** Returns one custom event by name for an application, including its attributes, store-days and revenue mapping. Use after list_events to inspect a single event's definition. */
     Get: EventsService_Get;
@@ -32,10 +32,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 which custom events of an application count as conversions for campaign attribution, each with its attribution window, plus the contact type (click or send) conversions are counted from. Empty events means attribution is not configured yet. */
-    GetConversionSettings: EventsService_GetConversionSettings;
-    /** Replaces the conversion settings of an application: up to 3 events with an attribution window each (24h, 72h, 7d or 30d) and one contact type for all of them. Events left out of the request stop counting as conversions. */
-    SaveConversionSettings: EventsService_SaveConversionSettings;
+    /** 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. */
+    SaveConversionEvents: EventsService_SaveConversionEvents;
 }
 export type GetEventRequest = {
     /** Application code (format XXXXX-XXXXX) the event belongs to. */
@@ -276,27 +276,25 @@ export type GetRevenueStatisticsResponse_EventRevenue = {
 export type GetRevenueStatisticsResponse = {
     metrics: GetRevenueStatisticsResponse_EventRevenue[];
 };
-/** ContactType is the touch a conversion is counted from: the click on the message (default) or the send itself. */
-export type ContactType = 'CONTACT_TYPE_UNSPECIFIED' | 'CONTACT_TYPE_CLICK' | 'CONTACT_TYPE_SENT';
 export type ConversionEvent = {
-    /** Name of the application's custom event that counts as a conversion. */
+    /** Name of the application's event that counts as a conversion. */
     name: string;
-    /** Attribution window in seconds: 86400, 259200, 604800 or 2592000. Zero means the default 259200 (72h). */
-    attributionWindowSeconds: number;
+    /** Where the event keeps its amount and currency; unset for an event counted without revenue. */
+    revenueMapping: RevenueMapping;
+    /** PW_Conversion: always listed, always tracks revenue, cannot be removed. */
+    isDefault: boolean;
 };
-export type ConversionSettings = {
-    /** Up to 3 events counted as conversions, each with its own window. */
+export type ConversionEvents = {
+    /** Events counted as conversions, PW_Conversion first. */
     events: ConversionEvent[];
-    /** Contact type shared by all events of the application; UNSPECIFIED reads as CLICK. */
-    contactType: ContactType;
 };
-export type GetConversionSettingsRequest = {
+export type GetConversionEventsRequest = {
     /** Application code (format XXXXX-XXXXX). */
     application?: string;
 };
-export type SaveConversionSettingsRequest = {
+export type SaveConversionEventsRequest = {
     /** Application code (format XXXXX-XXXXX). */
     application?: string;
-    /** Full replacement of the application's conversion settings; events left out stop counting. */
-    settings?: ConversionSettings;
+    /** Full replacement of the application's conversion events; events left out stop counting. */
+    events?: ConversionEvent[];
 };

package/news.d.ts

@@ -4,14 +4,14 @@ export type NewsService_SetNewsFeed = RpcMethod<SetNewsFeedRequest, SetNewsFeedR
 export type NewsService_DeleteNewsFeed = RpcMethod<DeleteNewsFeedRequest, DeleteNewsFeedResponse>;
 /**
  * NewsService manages the registry of news feeds an application's email news
- * blocks read from. Feeds are imported hourly by the recommender.
+ * blocks read from. Feeds are imported on their own interval by uds/rss-feeds.
  */
 export interface NewsService {
-    /** Lists the news feeds registered for an application (code XXXXX-XXXXX), each with the outcome of its last hourly import. Use to fill the feed selector of an email news block and to show why a feed went quiet. */
+    /** 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. */
     ListNewsFeeds: NewsService_ListNewsFeeds;
-    /** Registers an RSS/Atom news feed for an application (code XXXXX-XXXXX), or updates one when code is given. Articles are imported hourly; an application may have several feeds. */
+    /** 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. */
     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 hourly import run. */
+    /** 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;
 }
 export type NewsFeed = {
@@ -25,7 +25,7 @@ export type NewsFeed = {
     enabled: boolean;
     created: Date;
     updated: Date;
-    /** Outcome of the last hourly import: "ok" | "error", empty before the first run. */
+    /** Outcome of the last import: "ok" | "error", empty before the first run. */
     lastStatus: string;
     /** Why that import failed; empty when it succeeded. */
     lastError: string;
@@ -33,6 +33,10 @@ export type NewsFeed = {
     lastSyncedAt?: Date;
     /** Articles the last successful import stored. */
     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). */
@@ -50,6 +54,13 @@ export type SetNewsFeedRequest = {
     /** http(s) URL of an RSS or Atom feed. */
     url?: string;
     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;

package/package.json

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