@pushwoosh/rpc-v2-http-api-data 0.2.212 → 0.2.213

package/app_inbox_presets.d.ts

@@ -5,48 +5,72 @@ export type appInboxPresetsService_Create = RpcMethod<CreateAppInboxPresetReques
 export type appInboxPresetsService_Update = RpcMethod<UpdateAppInboxPresetRequest, UpdateAppInboxPresetResponse>;
 export type appInboxPresetsService_Delete = RpcMethod<DeleteAppInboxPresetRequest, DeleteAppInboxPresetResponse>;
 export interface appInboxPresetsService {
+    /** Lists one application's App Inbox presets (inbox message templates) with paging, search over name and code, category filter and ordering. Use to browse presets or to find a preset code. */
     List: appInboxPresetsService_List;
+    /** Returns a single App Inbox preset by its preset code: name, categories and the per-locale content. Use after list_app_inbox_presets to inspect one preset. */
     Get: appInboxPresetsService_Get;
+    /** Creates an App Inbox preset under an application from per-locale content; each call yields a fresh preset code. Category names the application does not have yet are created with it. */
     Create: appInboxPresetsService_Create;
+    /** Updates an App Inbox preset by preset code: name, categories and localized content are replaced when given, omitted fields keep their current value. */
     Update: appInboxPresetsService_Update;
+    /** Permanently deletes an App Inbox preset by preset code. Refused while a running or paused journey still sends the preset; irreversible once it goes through. */
     Delete: appInboxPresetsService_Delete;
 }
 export type ListAppInboxPresetsRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListAppInboxPresetsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListAppInboxPresetsRequest = {
+    /** Application code (format XXXXX-XXXXX) whose presets to list; required. */
     application?: string;
     orderBy?: ListAppInboxPresetsRequest_OrderBy;
     orderDirection?: ListAppInboxPresetsRequest_OrderDirection;
     page?: number;
+    /** Presets per page; 100 when omitted. */
     perPage?: number;
+    /** Free-text search over preset name and preset code. */
     searchByName?: string;
+    /** Restrict the list to presets carrying these category names. */
     searchByCategory?: string[];
 };
 export type AppInboxPresetOpenAction = {
+    /** What opens when the message is tapped: "url", "deep_link" or "rich_media". Empty means no action; only the field belonging to the chosen type is read. */
     type: string;
+    /** Target URL for type "url". */
     url: string;
+    /** Deeplink code for type "deep_link". */
     deepLinkCode: string;
+    /** Deeplink parameters for type "deep_link". */
     deepLinkParams: Record<string, string>;
+    /** Rich Media code for type "rich_media". */
     richMediaCode: string;
 };
 export type AppInboxPresetCarouselSlide = {
+    /** Absolute https URL of the slide image; required. */
     imageUrl: string;
     caption: string;
 };
 export type AppInboxPresetLocale = {
+    /** Message title; required for every layout except "banner". */
     title: string;
+    /** Message body; required for every layout except "banner". */
     body: string;
+    /** Absolute https icon URL; required for the "classic" layout. */
     iconUrl: string;
+    /** Absolute https image URL; required for the "captioned" and "banner" layouts. */
     bannerUrl: string;
     openAction: AppInboxPresetOpenAction;
+    /** Arbitrary key-value payload delivered to the app along with the message. */
     customData: object;
+    /** Layout of the inbox message: "classic" (the default when empty), "captioned", "banner" or "carousel". Each layout makes different fields of this message required. */
     layoutType: string;
+    /** Slides of the "carousel" layout: 1 to 10 of them, required for it, ignored otherwise. */
     carousel: AppInboxPresetCarouselSlide[];
 };
 export type AppInboxPreset = {
     name: string;
+    /** Preset code, the identifier the other App Inbox tools take. */
     code: string;
     categories: string[];
+    /** Content per language code, e.g. "en". */
     localizedContent: Record<string, AppInboxPresetLocale>;
     created: Date;
     updated: Date;
@@ -58,30 +82,39 @@ export type ListAppInboxPresetsResponse = {
     total: number;
 };
 export type GetAppInboxPresetRequest = {
+    /** Preset code of the preset to fetch. */
     code?: string;
 };
 export type GetAppInboxPresetResponse = {
     preset: AppInboxPreset;
 };
 export type CreateAppInboxPresetRequest = {
+    /** Application code (format XXXXX-XXXXX) to create the preset under; required. */
     application?: string;
     name?: string;
+    /** Category names to tag the preset with; unknown ones are created on the application. */
     categories?: string[];
+    /** Content per language code, e.g. "en". */
     localizedContent?: Record<string, AppInboxPresetLocale>;
 };
 export type CreateAppInboxPresetResponse = {
     preset: AppInboxPreset;
 };
 export type UpdateAppInboxPresetRequest = {
+    /** Preset code of the preset to update. */
     code?: string;
+    /** New preset name; omit to leave unchanged. */
     name?: string;
+    /** Replacement category list; omit to leave unchanged. */
     categories?: string[];
+    /** Replacement content per language code; omit to leave unchanged. */
     localizedContent?: Record<string, AppInboxPresetLocale>;
 };
 export type UpdateAppInboxPresetResponse = {
     preset: AppInboxPreset;
 };
 export type DeleteAppInboxPresetRequest = {
+    /** Preset code of the preset to delete. */
     code?: string;
 };
 export type DeleteAppInboxPresetResponse = {};

package/package.json

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