@pushwoosh/rpc-v2-http-api-data 0.2.79 → 0.2.81

package/catalog.d.ts

@@ -5,6 +5,10 @@ export type CatalogService_UpsertProducts = RpcMethod<UpsertProductsRequest, Ups
 export type CatalogService_DeleteProducts = RpcMethod<DeleteProductsRequest, DeleteProductsResponse>;
 export type CatalogService_DeleteAllProducts = RpcMethod<DeleteAllProductsRequest, DeleteAllProductsResponse>;
 export type CatalogService_ListCategories = RpcMethod<ListCategoriesRequest, ListCategoriesResponse>;
+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>;
 /**
  * CatalogService manages the per-application product catalog used by email
  * product blocks. Proxies to the catalog backend (recommender-api).
@@ -22,6 +26,14 @@ export interface CatalogService {
     DeleteAllProducts: CatalogService_DeleteAllProducts;
     /** Returns the distinct product categories of an application (code XXXXX-XXXXX) catalog. Use to build category filters. */
     ListCategories: CatalogService_ListCategories;
+    /** Returns the merchant-feed URL of an application (code XXXXX-XXXXX) catalog and the last sync state. Empty url means no feed is connected. */
+    GetFeed: CatalogService_GetFeed;
+    /** Connects a merchant feed (JSON or Google Merchant XML, http(s) URL) to an application (code XXXXX-XXXXX) catalog; one feed per application. The feed is imported hourly; use sync_catalog_feed to import right away. */
+    SetFeed: CatalogService_SetFeed;
+    /** Disconnects the merchant feed from an application (code XXXXX-XXXXX) catalog. Already-imported products stay in the catalog. */
+    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;
 }
 export type Product = {
     /** Unique product id within the application catalog (SKU or external id). */
@@ -96,3 +108,47 @@ export type ListCategoriesRequest = {
 export type ListCategoriesResponse = {
     categories: string[];
 };
+/** Last merchant-feed sync outcome; empty status means the feed never synced. */
+export type FeedState = {
+    /** One of: syncing, ok, error. */
+    status: string;
+    startedAt: Date;
+    finishedAt: Date;
+    itemsUpserted: number;
+    /** Products that disappeared from the feed and were removed. */
+    itemsDeleted: number;
+    /** Feed entries without the required id+title. */
+    itemsSkipped: number;
+    /** The feed answered 304 Not Modified — catalog left as is. */
+    notModified: boolean;
+    error: string;
+};
+export type GetFeedRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type GetFeedResponse = {
+    /** Empty when no feed is connected. */
+    url: string;
+    state: FeedState;
+};
+export type SetFeedRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** http(s) URL of a JSON or Google Merchant XML feed. */
+    url?: string;
+};
+export type SetFeedResponse = {};
+export type DeleteFeedRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type DeleteFeedResponse = {};
+export type SyncFeedRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type SyncFeedResponse = {
+    /** False when a sync was already running (the running one continues). */
+    started: boolean;
+};

package/data.js

@@ -4899,6 +4899,30 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.catalog.ListCategoriesResponse",
                 "method": "get",
                 "path": "/api/catalog/categories"
+            },
+            "GetFeed": {
+                "request": "pushwoosh.rpc_v2.catalog.GetFeedRequest",
+                "response": "pushwoosh.rpc_v2.catalog.GetFeedResponse",
+                "method": "get",
+                "path": "/api/catalog/feed"
+            },
+            "SetFeed": {
+                "request": "pushwoosh.rpc_v2.catalog.SetFeedRequest",
+                "response": "pushwoosh.rpc_v2.catalog.SetFeedResponse",
+                "method": "post",
+                "path": "/api/catalog/feed"
+            },
+            "DeleteFeed": {
+                "request": "pushwoosh.rpc_v2.catalog.DeleteFeedRequest",
+                "response": "pushwoosh.rpc_v2.catalog.DeleteFeedResponse",
+                "method": "post",
+                "path": "/api/catalog/feed:delete"
+            },
+            "SyncFeed": {
+                "request": "pushwoosh.rpc_v2.catalog.SyncFeedRequest",
+                "response": "pushwoosh.rpc_v2.catalog.SyncFeedResponse",
+                "method": "post",
+                "path": "/api/catalog/feed:sync"
             }
         }
     },
@@ -5071,6 +5095,97 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.catalog.FeedState": {
+        "type": "I",
+        "fields": {
+            "status": {
+                "type": "string"
+            },
+            "startedAt": {
+                "type": "Date"
+            },
+            "finishedAt": {
+                "type": "Date"
+            },
+            "itemsUpserted": {
+                "type": "number"
+            },
+            "itemsDeleted": {
+                "type": "number"
+            },
+            "itemsSkipped": {
+                "type": "number"
+            },
+            "notModified": {
+                "type": "boolean"
+            },
+            "error": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.GetFeedRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.GetFeedResponse": {
+        "type": "I",
+        "fields": {
+            "url": {
+                "type": "string"
+            },
+            "state": {
+                "type": "pushwoosh.rpc_v2.catalog.FeedState"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.SetFeedRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "url": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.SetFeedResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.catalog.DeleteFeedRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.DeleteFeedResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.catalog.SyncFeedRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.SyncFeedResponse": {
+        "type": "I",
+        "fields": {
+            "started": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.categories.CategoriesService": {
         "type": "S",
         "key": "categories",

package/package.json

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