@pushwoosh/rpc-v2-http-api-data 0.2.137 → 0.2.139

package/catalog.d.ts

@@ -1,6 +1,7 @@
 import { RpcMethod } from './commonTypes';
 export type CatalogService_ListProducts = RpcMethod<ListProductsRequest, ListProductsResponse>;
 export type CatalogService_GetProducts = RpcMethod<GetProductsRequest, GetProductsResponse>;
+export type CatalogService_PreviewFeed = RpcMethod<PreviewFeedRequest, PreviewFeedResponse>;
 export type CatalogService_UpsertProducts = RpcMethod<UpsertProductsRequest, UpsertProductsResponse>;
 export type CatalogService_DeleteProducts = RpcMethod<DeleteProductsRequest, DeleteProductsResponse>;
 export type CatalogService_DeleteAllProducts = RpcMethod<DeleteAllProductsRequest, DeleteAllProductsResponse>;
@@ -18,6 +19,8 @@ export interface CatalogService {
     ListProducts: CatalogService_ListProducts;
     /** Returns catalog products of an application (code XXXXX-XXXXX) by product IDs. Use to re-read specific products, e.g. to refresh product blocks in an email template. */
     GetProducts: CatalogService_GetProducts;
+    /** Returns the product rows a catalog rule would put into a message, ranked the way the send-time products feed ranks them. Use to preview a recommendation rule before saving a preset: the plain catalog list is ordered by the catalog, not by the strategy. Per-recipient strategies (also_bought, recently_viewed) are not previewable and answer FAILED_PRECONDITION. */
+    PreviewFeed: CatalogService_PreviewFeed;
     /** Inserts or updates products of an application (code XXXXX-XXXXX) catalog, matched by product id; at most 1000 per request. Returns inserted and updated counts. Use to add products manually or import them from a CSV file. */
     UpsertProducts: CatalogService_UpsertProducts;
     /** Deletes products from an application (code XXXXX-XXXXX) catalog by product IDs. Returns the number of deleted products. */
@@ -71,6 +74,38 @@ export type ListProductsResponse = {
     /** Total matching products regardless of pagination. */
     total: number;
 };
+export type PreviewFeedRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    category?: string;
+    /** One of: newest, price_asc, price_desc, title; default newest. */
+    sort?: string;
+    /** Rows to return, 1..50; defaults to 10. */
+    limit?: number;
+    /**
+     * One of: newest, bestsellers_7d, bestsellers_30d, back_in_stock, price_drop, or empty for
+     * the plain rule; per-recipient ones (also_bought, recently_viewed) are rejected for now.
+     */
+    strategy?: string;
+};
+export type PreviewFeedItem = {
+    id: string;
+    title: string;
+    description: string;
+    imageUrl: string;
+    /** Product page URL, without the click-attribution parameters the send adds. */
+    url: string;
+    /** Display string, formatted the way the feed formats it, e.g. "$12.99". */
+    priceFormatted: string;
+    /** Empty unless the product is on sale. */
+    oldPriceFormatted: string;
+    category: string;
+};
+export type PreviewFeedResponse = {
+    items: PreviewFeedItem[];
+    /** The strategy yielded nothing and the plain catalog rule answered instead. */
+    fellBack: boolean;
+};
 export type GetProductsRequest = {
     /** Pushwoosh application code (XXXXX-XXXXX). */
     applicationCode?: string;

package/data.js

@@ -6703,6 +6703,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/catalog/products:get"
             },
+            "PreviewFeed": {
+                "request": "pushwoosh.rpc_v2.catalog.PreviewFeedRequest",
+                "response": "pushwoosh.rpc_v2.catalog.PreviewFeedResponse",
+                "method": "post",
+                "path": "/api/catalog/products:preview"
+            },
             "UpsertProducts": {
                 "request": "pushwoosh.rpc_v2.catalog.UpsertProductsRequest",
                 "response": "pushwoosh.rpc_v2.catalog.UpsertProductsResponse",
@@ -6829,6 +6835,67 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.catalog.PreviewFeedRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            },
+            "sort": {
+                "type": "string"
+            },
+            "limit": {
+                "type": "number"
+            },
+            "strategy": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.PreviewFeedItem": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            },
+            "imageUrl": {
+                "type": "string"
+            },
+            "url": {
+                "type": "string"
+            },
+            "priceFormatted": {
+                "type": "string"
+            },
+            "oldPriceFormatted": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.PreviewFeedResponse": {
+        "type": "I",
+        "fields": {
+            "items": {
+                "type": "pushwoosh.rpc_v2.catalog.PreviewFeedItem",
+                "array": true
+            },
+            "fellBack": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.catalog.GetProductsRequest": {
         "type": "I",
         "fields": {

package/package.json

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