@pushwoosh/rpc-v2-http-api-data 0.2.412 → 0.2.414

package/catalog.d.ts

@@ -10,6 +10,8 @@ export type CatalogService_GetFeed = RpcMethod<GetFeedRequest, GetFeedResponse>;
 export type CatalogService_SetFeed = RpcMethod<SetFeedRequest, SetFeedResponse>;
 export type CatalogService_DeleteFeed = RpcMethod<DeleteFeedRequest, DeleteFeedResponse>;
 export type CatalogService_SyncFeed = RpcMethod<SyncFeedRequest, SyncFeedResponse>;
+export type CatalogService_GetOnsiteRecommendations = RpcMethod<GetOnsiteRecommendationsRequest, GetOnsiteRecommendationsResponse>;
+export type CatalogService_SetOnsiteRecommendations = RpcMethod<SetOnsiteRecommendationsRequest, SetOnsiteRecommendationsResponse>;
 /**
  * CatalogService manages the per-application product catalog used by email
  * product blocks. Proxies to the catalog backend (recommender-api).
@@ -37,6 +39,10 @@ export interface CatalogService {
     DeleteFeed: CatalogService_DeleteFeed;
     /** Starts a merchant-feed sync of an application (code XXXXX-XXXXX) catalog in the background. Returns started=false when a sync is already running. Poll get_catalog_feed for the outcome. */
     SyncFeed: CatalogService_SyncFeed;
+    /** Returns whether on-site recommendations are on for an application (code XXXXX-XXXXX): the public feed the Web SDK widget reads on the shop's own pages, and the shop origins allowed to show it. */
+    GetOnsiteRecommendations: CatalogService_GetOnsiteRecommendations;
+    /** Turns on-site recommendations on or off for an application (code XXXXX-XXXXX) and sets the shop origins (https://shop.example, up to 20) allowed to show them; an empty list allows any origin. Turning them off keeps the origins. */
+    SetOnsiteRecommendations: CatalogService_SetOnsiteRecommendations;
 }
 export type Product = {
     /** Unique product id within the application catalog (SKU or external id). */
@@ -174,6 +180,26 @@ export type SetFeedRequest = {
     url?: string;
 };
 export type SetFeedResponse = {};
+export type GetOnsiteRecommendationsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type GetOnsiteRecommendationsResponse = {
+    enabled: boolean;
+    /** Shop origins allowed to show the blocks, normalised to scheme://host[:port]; empty means any. */
+    origins: string[];
+};
+export type SetOnsiteRecommendationsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    enabled?: boolean;
+    /** Shop origins or bare domains (https://shop.example, shop.example); up to 20, empty means any. */
+    origins?: string[];
+};
+export type SetOnsiteRecommendationsResponse = {
+    /** The origins as stored: normalised, deduplicated, IDN hosts in punycode. */
+    origins: string[];
+};
 export type DeleteFeedRequest = {
     /** Pushwoosh application code (XXXXX-XXXXX). */
     applicationCode?: string;

package/data.js

@@ -9148,6 +9148,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.catalog.SyncFeedResponse",
                 "method": "post",
                 "path": "/api/catalog/feed:sync"
+            },
+            "GetOnsiteRecommendations": {
+                "request": "pushwoosh.rpc_v2.catalog.GetOnsiteRecommendationsRequest",
+                "response": "pushwoosh.rpc_v2.catalog.GetOnsiteRecommendationsResponse",
+                "method": "get",
+                "path": "/api/catalog/onsite"
+            },
+            "SetOnsiteRecommendations": {
+                "request": "pushwoosh.rpc_v2.catalog.SetOnsiteRecommendationsRequest",
+                "response": "pushwoosh.rpc_v2.catalog.SetOnsiteRecommendationsResponse",
+                "method": "post",
+                "path": "/api/catalog/onsite"
             }
         }
     },
@@ -9444,6 +9456,50 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.catalog.GetOnsiteRecommendationsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.GetOnsiteRecommendationsResponse": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "origins": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.SetOnsiteRecommendationsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "enabled": {
+                "type": "boolean"
+            },
+            "origins": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.SetOnsiteRecommendationsResponse": {
+        "type": "I",
+        "fields": {
+            "origins": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.catalog.DeleteFeedRequest": {
         "type": "I",
         "fields": {
@@ -24953,6 +25009,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"
             }
         }
     },
@@ -24992,9 +25078,6 @@ export const data = {
             },
             "syncIntervalMinutes": {
                 "type": "number"
-            },
-            "journeyUuid": {
-                "type": "string"
             }
         }
     },
@@ -25036,10 +25119,6 @@ export const data = {
             "syncIntervalMinutes": {
                 "type": "number",
                 "optional": true
-            },
-            "journeyUuid": {
-                "type": "string",
-                "optional": true
             }
         }
     },
@@ -25066,6 +25145,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/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.412",
+  "version": "0.2.414",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",