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

package/catalog.d.ts

@@ -0,0 +1,98 @@
+import { RpcMethod } from './commonTypes';
+export type CatalogService_ListProducts = RpcMethod<ListProductsRequest, ListProductsResponse>;
+export type CatalogService_GetProducts = RpcMethod<GetProductsRequest, GetProductsResponse>;
+export type CatalogService_UpsertProducts = RpcMethod<UpsertProductsRequest, UpsertProductsResponse>;
+export type CatalogService_DeleteProducts = RpcMethod<DeleteProductsRequest, DeleteProductsResponse>;
+export type CatalogService_DeleteAllProducts = RpcMethod<DeleteAllProductsRequest, DeleteAllProductsResponse>;
+export type CatalogService_ListCategories = RpcMethod<ListCategoriesRequest, ListCategoriesResponse>;
+/**
+ * CatalogService manages the per-application product catalog used by email
+ * product blocks. Proxies to the catalog backend (recommender-api).
+ */
+export interface CatalogService {
+    /** Lists products of an application (code XXXXX-XXXXX) catalog with a title search, category filter, sorting and pagination. Returns one page and the total match count. Use to browse or search the product catalog. */
+    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;
+    /** 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. */
+    DeleteProducts: CatalogService_DeleteProducts;
+    /** Deletes ALL products of an application (code XXXXX-XXXXX) catalog. Irreversible; use only when the user explicitly asks to clear the whole catalog. */
+    DeleteAllProducts: CatalogService_DeleteAllProducts;
+    /** Returns the distinct product categories of an application (code XXXXX-XXXXX) catalog. Use to build category filters. */
+    ListCategories: CatalogService_ListCategories;
+}
+export type Product = {
+    /** Unique product id within the application catalog (SKU or external id). */
+    id: string;
+    title: string;
+    description: string;
+    imageUrl: string;
+    /** Product page URL. */
+    url: string;
+    price: number;
+    category: string;
+    sku: string;
+    currentStock: number;
+    /** ISO 4217 code, e.g. "USD". */
+    currency: string;
+    /** Discounted price; 0 means no sale. */
+    salePrice: number;
+};
+export type ListProductsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Case-insensitive substring match on title. */
+    search?: string;
+    category?: string;
+    /** One of: title, price, category, sku, stock; default title. */
+    sortBy?: string;
+    sortDesc?: boolean;
+    /** 0-based page number. */
+    page?: number;
+    /** Defaults to 50, capped at 500. */
+    pageSize?: number;
+};
+export type ListProductsResponse = {
+    products: Product[];
+    /** Total matching products regardless of pagination. */
+    total: number;
+};
+export type GetProductsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    productIds?: string[];
+};
+export type GetProductsResponse = {
+    products: Product[];
+};
+export type UpsertProductsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    products?: Product[];
+};
+export type UpsertProductsResponse = {
+    inserted: number;
+    updated: number;
+};
+export type DeleteProductsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    productIds?: string[];
+};
+export type DeleteProductsResponse = {
+    deleted: number;
+};
+export type DeleteAllProductsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type DeleteAllProductsResponse = {};
+export type ListCategoriesRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type ListCategoriesResponse = {
+    categories: string[];
+};

package/catalog.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/data.js

@@ -4860,6 +4860,217 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.catalog.CatalogService": {
+        "type": "S",
+        "key": "catalog",
+        "methods": {
+            "ListProducts": {
+                "request": "pushwoosh.rpc_v2.catalog.ListProductsRequest",
+                "response": "pushwoosh.rpc_v2.catalog.ListProductsResponse",
+                "method": "get",
+                "path": "/api/catalog/products"
+            },
+            "GetProducts": {
+                "request": "pushwoosh.rpc_v2.catalog.GetProductsRequest",
+                "response": "pushwoosh.rpc_v2.catalog.GetProductsResponse",
+                "method": "post",
+                "path": "/api/catalog/products:get"
+            },
+            "UpsertProducts": {
+                "request": "pushwoosh.rpc_v2.catalog.UpsertProductsRequest",
+                "response": "pushwoosh.rpc_v2.catalog.UpsertProductsResponse",
+                "method": "post",
+                "path": "/api/catalog/products"
+            },
+            "DeleteProducts": {
+                "request": "pushwoosh.rpc_v2.catalog.DeleteProductsRequest",
+                "response": "pushwoosh.rpc_v2.catalog.DeleteProductsResponse",
+                "method": "post",
+                "path": "/api/catalog/products:delete"
+            },
+            "DeleteAllProducts": {
+                "request": "pushwoosh.rpc_v2.catalog.DeleteAllProductsRequest",
+                "response": "pushwoosh.rpc_v2.catalog.DeleteAllProductsResponse",
+                "method": "post",
+                "path": "/api/catalog/products:delete-all"
+            },
+            "ListCategories": {
+                "request": "pushwoosh.rpc_v2.catalog.ListCategoriesRequest",
+                "response": "pushwoosh.rpc_v2.catalog.ListCategoriesResponse",
+                "method": "get",
+                "path": "/api/catalog/categories"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.Product": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            },
+            "imageUrl": {
+                "type": "string"
+            },
+            "url": {
+                "type": "string"
+            },
+            "price": {
+                "type": "number"
+            },
+            "category": {
+                "type": "string"
+            },
+            "sku": {
+                "type": "string"
+            },
+            "currentStock": {
+                "type": "number"
+            },
+            "currency": {
+                "type": "string"
+            },
+            "salePrice": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.ListProductsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "search": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            },
+            "sortBy": {
+                "type": "string"
+            },
+            "sortDesc": {
+                "type": "boolean"
+            },
+            "page": {
+                "type": "number"
+            },
+            "pageSize": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.ListProductsResponse": {
+        "type": "I",
+        "fields": {
+            "products": {
+                "type": "pushwoosh.rpc_v2.catalog.Product",
+                "array": true
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.GetProductsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "productIds": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.GetProductsResponse": {
+        "type": "I",
+        "fields": {
+            "products": {
+                "type": "pushwoosh.rpc_v2.catalog.Product",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.UpsertProductsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "products": {
+                "type": "pushwoosh.rpc_v2.catalog.Product",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.UpsertProductsResponse": {
+        "type": "I",
+        "fields": {
+            "inserted": {
+                "type": "number"
+            },
+            "updated": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.DeleteProductsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "productIds": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.DeleteProductsResponse": {
+        "type": "I",
+        "fields": {
+            "deleted": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.DeleteAllProductsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.DeleteAllProductsResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.catalog.ListCategoriesRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.catalog.ListCategoriesResponse": {
+        "type": "I",
+        "fields": {
+            "categories": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.categories.CategoriesService": {
         "type": "S",
         "key": "categories",

package/index.d.ts

@@ -15,6 +15,7 @@ import { ApplicationsGroupsService as pushwoosh_rpc_v2_applications_groups_Appli
 import { ApplicationsInfoService as pushwoosh_rpc_v2_applications_info_ApplicationsInfoService } from './applications_info';
 import { ApplicationsStatisticsService as pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService } from './applications_statistics';
 import { CampaignsService as pushwoosh_rpc_v2_campaigns_CampaignsService } from './campaigns';
+import { CatalogService as pushwoosh_rpc_v2_catalog_CatalogService } from './catalog';
 import { CategoriesService as pushwoosh_rpc_v2_categories_CategoriesService } from './categories';
 import { MessagingService as pushwoosh_channels_messagingApi_v2_MessagingService } from './pushwoosh_channels_messagingApi_v2';
 import { CloudPagesService as pushwoosh_rpc_v2_cloud_pages_CloudPagesService } from './cloud_pages';
@@ -81,6 +82,7 @@ export type API = {
     applicationsInfo: pushwoosh_rpc_v2_applications_info_ApplicationsInfoService;
     applicationsStatistics: pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService;
     campaigns: pushwoosh_rpc_v2_campaigns_CampaignsService;
+    catalog: pushwoosh_rpc_v2_catalog_CatalogService;
     categories: pushwoosh_rpc_v2_categories_CategoriesService;
     messaging: pushwoosh_channels_messagingApi_v2_MessagingService;
     cloudPages: pushwoosh_rpc_v2_cloud_pages_CloudPagesService;

package/package.json

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