@pushwoosh/rpc-gateway-journey-data 0.27.225 → 0.27.227

package/data.js

@@ -419,6 +419,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/v2/journeygateway/test-webhook"
             },
+            "PreviewWebPlacement": {
+                "request": "pushwoosh.cj.journey.PreviewWebPlacementRequest",
+                "response": "pushwoosh.cj.journey.PreviewWebPlacementResponse",
+                "method": "post",
+                "path": "/api/v2/journeygateway/preview-web-placement"
+            },
             "GetApplicationsByAccountId": {
                 "request": "pushwoosh.cj.journey.GetApplicationsByAccountIdRequest",
                 "response": "pushwoosh.cj.journey.GetApplicationsByAccountIdResponse",
@@ -958,6 +964,9 @@ export const data = {
             },
             "sendLiveActivity": {
                 "type": "pushwoosh.cj.journey.PointStatSendLiveActivity"
+            },
+            "webPlacement": {
+                "type": "pushwoosh.cj.journey.PointStatWebPlacement"
             }
         },
         "oneofs": {
@@ -985,7 +994,8 @@ export const data = {
                     "sendInbox",
                     "sendFbMessenger",
                     "webhook",
-                    "sendLiveActivity"
+                    "sendLiveActivity",
+                    "webPlacement"
                 ]
             }
         }
@@ -1430,6 +1440,17 @@ export const data = {
             }
         }
     },
+    "pushwoosh.cj.journey.PointStatWebPlacement": {
+        "type": "I",
+        "fields": {
+            "shows": {
+                "type": "number"
+            },
+            "interactions": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.cj.journey.PointStatSendLiveActivity": {
         "type": "I",
         "fields": {
@@ -2766,7 +2787,8 @@ export const data = {
             "POINT_TYPE_SEND_FB_MESSENGER",
             "POINT_TYPE_HOLDOUT_SPLIT",
             "POINT_TYPE_SEND_LIVE_ACTIVITY",
-            "POINT_TYPE_LOOP"
+            "POINT_TYPE_LOOP",
+            "POINT_TYPE_WEB_PLACEMENT"
         ]
     },
     "pushwoosh.cj.journey.Point": {
@@ -2891,6 +2913,9 @@ export const data = {
             },
             "loop": {
                 "type": "pushwoosh.cj.journey.PointParamsLoop"
+            },
+            "webPlacement": {
+                "type": "pushwoosh.cj.journey.PointParamsWebPlacement"
             }
         },
         "oneofs": {
@@ -2925,7 +2950,8 @@ export const data = {
                     "sendFbMessenger",
                     "holdoutSplit",
                     "sendLiveActivity",
-                    "loop"
+                    "loop",
+                    "webPlacement"
                 ]
             }
         }
@@ -4643,6 +4669,69 @@ export const data = {
             }
         }
     },
+    "pushwoosh.cj.journey.WebPlacementKind": {
+        "type": "E",
+        "values": [
+            "WEB_PLACEMENT_KIND_POPUP",
+            "WEB_PLACEMENT_KIND_EMBEDDED"
+        ]
+    },
+    "pushwoosh.cj.journey.WebPlacementPriority": {
+        "type": "E",
+        "values": [
+            "WEB_PLACEMENT_PRIORITY_MEDIUM",
+            "WEB_PLACEMENT_PRIORITY_LOW",
+            "WEB_PLACEMENT_PRIORITY_HIGH"
+        ]
+    },
+    "pushwoosh.cj.journey.PointParamsWebPlacement": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "contentCode": {
+                "type": "string"
+            },
+            "kind": {
+                "type": "pushwoosh.cj.journey.WebPlacementKind"
+            },
+            "cssSelector": {
+                "type": "string"
+            },
+            "width": {
+                "type": "string"
+            },
+            "priority": {
+                "type": "pushwoosh.cj.journey.WebPlacementPriority"
+            },
+            "expireInMinutes": {
+                "type": "number"
+            },
+            "triggerEvent": {
+                "type": "pushwoosh.cj.journey.PointInappTriggerEvent",
+                "optional": true
+            },
+            "hideEvent": {
+                "type": "pushwoosh.cj.journey.PointInappTriggerEvent",
+                "optional": true
+            },
+            "dismissible": {
+                "type": "boolean"
+            },
+            "campaignCode": {
+                "type": "string",
+                "optional": true
+            },
+            "campaignUid": {
+                "type": "number",
+                "optional": true
+            },
+            "maxShowsPerDay": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.cj.journey.PointParamsSendInbox": {
         "type": "I",
         "fields": {
@@ -5917,6 +6006,9 @@ export const data = {
             },
             "allowJourneyLoopPoint": {
                 "type": "boolean"
+            },
+            "allowWebPlacement": {
+                "type": "boolean"
             }
         }
     },
@@ -7622,6 +7714,28 @@ export const data = {
             }
         }
     },
+    "pushwoosh.cj.journey.PreviewWebPlacementRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "hwid": {
+                "type": "string"
+            },
+            "params": {
+                "type": "pushwoosh.cj.journey.PointParamsWebPlacement"
+            }
+        }
+    },
+    "pushwoosh.cj.journey.PreviewWebPlacementResponse": {
+        "type": "I",
+        "fields": {
+            "userId": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.cj.journey.GetEventsByApplicationCodeRequest": {
         "type": "I",
         "fields": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-gateway-journey-data",
-  "version": "0.27.225",
+  "version": "0.27.227",
   "description": "CJ api gateway HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",

package/pushwoosh_cj_journey.d.ts

@@ -69,6 +69,7 @@ export type Journey_GetEventAttributeValues = RpcMethod<GetEventAttributeValuesR
 export type Journey_GetRichMediaByApplicationCode = RpcMethod<GetRichMediaByApplicationCodeRequest, GetRichMediaByApplicationCodeResponse>;
 export type Journey_GetRichMediaByCode = RpcMethod<GetRichMediaByCodeRequest, GetRichMediaByCodeResponse>;
 export type Journey_TestWebhook = RpcMethod<TestWebhookRequest, TestWebhookResponse>;
+export type Journey_PreviewWebPlacement = RpcMethod<PreviewWebPlacementRequest, PreviewWebPlacementResponse>;
 export type Journey_GetApplicationsByAccountId = RpcMethod<GetApplicationsByAccountIdRequest, GetApplicationsByAccountIdResponse>;
 export type Journey_GetFiltersByAccountId = RpcMethod<GetFiltersByAccountIdRequest, GetFiltersByAccountIdResponse>;
 export type Journey_GetEventsByApplicationCodes = RpcMethod<GetEventsByApplicationCodesRequest, GetEventsByApplicationCodesResponse>;
@@ -258,6 +259,8 @@ export interface Journey {
     GetRichMediaByCode: Journey_GetRichMediaByCode;
     /** Fires a test HTTP request to a customer-supplied webhook URL and returns the live response status and body. Reaches an external endpoint; use to verify a journey webhook point before saving. */
     TestWebhook: Journey_TestWebhook;
+    /** Shows a web placement, as configured in the point form, on one test device of the application: it appears on the device's next page view for an hour, outside any journey and its statistics. */
+    PreviewWebPlacement: Journey_PreviewWebPlacement;
     /** Returns the applications available to the current account for journey building. Read-only lookup used to populate app pickers. */
     GetApplicationsByAccountId: Journey_GetApplicationsByAccountId;
     /** Returns the filters/segments available to the current account for use in journey audience and split points. Read-only lookup. */
@@ -639,7 +642,11 @@ export type PointStat_pointStat_sendLiveActivity = {
     type: 'sendLiveActivity';
     data: PointStatSendLiveActivity;
 };
-export type PointStat_pointStat = PointStat_pointStat_sendPush | PointStat_pointStat_inApp | PointStat_pointStat_sendSms | PointStat_pointStat_sendWhatsapp | PointStat_pointStat_sendData | PointStat_pointStat_sendEmail | PointStat_pointStat_messageBus | PointStat_pointStat_goalEvent | PointStat_pointStat_terminator | PointStat_pointStat_delay | PointStat_pointStat_booleanSplitter | PointStat_pointStat_waitEvent | PointStat_pointStat_sendLine | PointStat_pointStat_sendKakao | PointStat_pointStat_sendTelegram | PointStat_pointStat_audienceSync | PointStat_pointStat_sendViber | PointStat_pointStat_smartContent | PointStat_pointStat_issueWalletPass | PointStat_pointStat_sendInbox | PointStat_pointStat_sendFbMessenger | PointStat_pointStat_webhook | PointStat_pointStat_sendLiveActivity;
+export type PointStat_pointStat_webPlacement = {
+    type: 'webPlacement';
+    data: PointStatWebPlacement;
+};
+export type PointStat_pointStat = PointStat_pointStat_sendPush | PointStat_pointStat_inApp | PointStat_pointStat_sendSms | PointStat_pointStat_sendWhatsapp | PointStat_pointStat_sendData | PointStat_pointStat_sendEmail | PointStat_pointStat_messageBus | PointStat_pointStat_goalEvent | PointStat_pointStat_terminator | PointStat_pointStat_delay | PointStat_pointStat_booleanSplitter | PointStat_pointStat_waitEvent | PointStat_pointStat_sendLine | PointStat_pointStat_sendKakao | PointStat_pointStat_sendTelegram | PointStat_pointStat_audienceSync | PointStat_pointStat_sendViber | PointStat_pointStat_smartContent | PointStat_pointStat_issueWalletPass | PointStat_pointStat_sendInbox | PointStat_pointStat_sendFbMessenger | PointStat_pointStat_webhook | PointStat_pointStat_sendLiveActivity | PointStat_pointStat_webPlacement;
 /** PointStat contains statistics specific to the point type */
 export type PointStat = {
     pointStat: PointStat_pointStat;
@@ -939,6 +946,13 @@ export type PointStatIssueWalletPass = {
     /** Number of travelers skipped: anonymous or the issuing call failed */
     skipped: number;
 };
+/** PointStatWebPlacement contains statistics for web placement points */
+export type PointStatWebPlacement = {
+    /** Number of times the placement was shown */
+    shows: number;
+    /** Number of clicks inside the placement */
+    interactions: number;
+};
 /** PointStatSendLiveActivity contains statistics for Live Activity points */
 export type PointStatSendLiveActivity = {
     /** Number of travelers the card action was pushed for */
@@ -1858,7 +1872,9 @@ export type PointType =
 /** Holdout split point (holds a share of travelers out of the journey) */
  | 'POINT_TYPE_HOLDOUT_SPLIT'
 /** Live Activity card point */
- | 'POINT_TYPE_SEND_LIVE_ACTIVITY' | 'POINT_TYPE_LOOP';
+ | 'POINT_TYPE_SEND_LIVE_ACTIVITY' | 'POINT_TYPE_LOOP'
+/** Web popup or inline block shown on the customer's website */
+ | 'POINT_TYPE_WEB_PLACEMENT';
 /** Point represents a single node in the journey */
 export type Point = {
     /** Unique identifier (UUID) of the point */
@@ -1998,7 +2014,11 @@ export type PointDataWrapper_data_loop = {
     type: 'loop';
     data: PointParamsLoop;
 };
-export type PointDataWrapper_data = PointDataWrapper_data_messageBus | PointDataWrapper_data_delay | PointDataWrapper_data_terminator | PointDataWrapper_data_sendPush | PointDataWrapper_data_goalEvent | PointDataWrapper_data_sendEmail | PointDataWrapper_data_booleanSplitter | PointDataWrapper_data_waitEvent | PointDataWrapper_data_inapp | PointDataWrapper_data_startBySegment | PointDataWrapper_data_abSplitter | PointDataWrapper_data_setTags | PointDataWrapper_data_webHook | PointDataWrapper_data_filter | PointDataWrapper_data_sendSms | PointDataWrapper_data_startByApi | PointDataWrapper_data_sendWhatsapp | PointDataWrapper_data_sendData | PointDataWrapper_data_sendLine | PointDataWrapper_data_sendKakao | PointDataWrapper_data_sendTelegram | PointDataWrapper_data_audienceSync | PointDataWrapper_data_sendViber | PointDataWrapper_data_smartContent | PointDataWrapper_data_issueWalletPass | PointDataWrapper_data_sendInbox | PointDataWrapper_data_sendFbMessenger | PointDataWrapper_data_holdoutSplit | PointDataWrapper_data_sendLiveActivity | PointDataWrapper_data_loop;
+export type PointDataWrapper_data_webPlacement = {
+    type: 'webPlacement';
+    data: PointParamsWebPlacement;
+};
+export type PointDataWrapper_data = PointDataWrapper_data_messageBus | PointDataWrapper_data_delay | PointDataWrapper_data_terminator | PointDataWrapper_data_sendPush | PointDataWrapper_data_goalEvent | PointDataWrapper_data_sendEmail | PointDataWrapper_data_booleanSplitter | PointDataWrapper_data_waitEvent | PointDataWrapper_data_inapp | PointDataWrapper_data_startBySegment | PointDataWrapper_data_abSplitter | PointDataWrapper_data_setTags | PointDataWrapper_data_webHook | PointDataWrapper_data_filter | PointDataWrapper_data_sendSms | PointDataWrapper_data_startByApi | PointDataWrapper_data_sendWhatsapp | PointDataWrapper_data_sendData | PointDataWrapper_data_sendLine | PointDataWrapper_data_sendKakao | PointDataWrapper_data_sendTelegram | PointDataWrapper_data_audienceSync | PointDataWrapper_data_sendViber | PointDataWrapper_data_smartContent | PointDataWrapper_data_issueWalletPass | PointDataWrapper_data_sendInbox | PointDataWrapper_data_sendFbMessenger | PointDataWrapper_data_holdoutSplit | PointDataWrapper_data_sendLiveActivity | PointDataWrapper_data_loop | PointDataWrapper_data_webPlacement;
 /** PointDataWrapper contains point-specific configuration based on type */
 export type PointDataWrapper = {
     data: PointDataWrapper_data;
@@ -3160,6 +3180,43 @@ export type PointInappTriggerEvent = {
     /** Conditions to match event attributes, all must hold */
     eventConditions: PointEventCondition[];
 };
+/** WebPlacementKind is how the placement is shown on the website */
+export type WebPlacementKind = 
+/** Modal popup over the page */
+'WEB_PLACEMENT_KIND_POPUP'
+/** Inline block inserted into a page element */
+ | 'WEB_PLACEMENT_KIND_EMBEDDED';
+/** WebPlacementPriority picks one placement when several target the same element */
+export type WebPlacementPriority = 'WEB_PLACEMENT_PRIORITY_MEDIUM' | 'WEB_PLACEMENT_PRIORITY_LOW' | 'WEB_PLACEMENT_PRIORITY_HIGH';
+/** PointParamsWebPlacement shows a web popup content on the user's next page view or on an event */
+export type PointParamsWebPlacement = {
+    /** Application code (must have a web platform) */
+    applicationCode: string;
+    /** Web popup content code (kind CONTENT, without form fields) */
+    contentCode: string;
+    /** Popup or inline block */
+    kind: WebPlacementKind;
+    /** CSS selector of the page element an inline block goes into; required for EMBEDDED, empty for POPUP */
+    cssSelector: string;
+    /** CSS width of the block; empty keeps the element's own width */
+    width: string;
+    /** Priority among placements targeting the same element */
+    priority: WebPlacementPriority;
+    /** How long the placement waits and stays on the site, 1..10080 minutes */
+    expireInMinutes: number;
+    /** Event that shows the placement; unset shows it on the next page view */
+    triggerEvent?: PointInappTriggerEvent;
+    /** Event that removes the placement */
+    hideEvent?: PointInappTriggerEvent;
+    /** Whether the visitor can close the placement */
+    dismissible: boolean;
+    /** Campaign code, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
+    campaignCode?: string;
+    /** Campaign UID, assigned when the journey starts. Leave empty in Create and in new points, except for the system campaign created for this point; in existing points, leave empty or as read. Otherwise the request is rejected. */
+    campaignUid?: number;
+    /** Popups only: shows per visitor per day, 0..100; 0 is no cap. Inline blocks keep 0 */
+    maxShowsPerDay: number;
+};
 /** PointParamsSendInbox contains App Inbox message point configuration */
 export type PointParamsSendInbox = {
     /** App Inbox preset code (message content) */
@@ -4044,6 +4101,8 @@ export type AccountRestrictionValues = {
     allowJourneyPointTemplates: boolean;
     /** Whether the Loop point can be placed on the canvas */
     allowJourneyLoopPoint: boolean;
+    /** Whether the Web placement point can be placed on the canvas */
+    allowWebPlacement: boolean;
 };
 /**
  * SavePointTemplateRequest carries one manifest version. A published (slug, version) is immutable:
@@ -5043,6 +5102,20 @@ export type TestWebhookResponse = {
     statusCode: number;
     body: string;
 };
+/** PreviewWebPlacementRequest shows the placement of an unsaved or saved point to a test device */
+export type PreviewWebPlacementRequest = {
+    /** Application code; params.application_code must match it */
+    applicationCode?: string;
+    /** HWID of a test device registered in the application */
+    hwid?: string;
+    /** The placement as configured in the point form */
+    params?: PointParamsWebPlacement;
+};
+/** PreviewWebPlacementResponse names who the placement was queued for */
+export type PreviewWebPlacementResponse = {
+    /** User ID the placement waits under: the device's user, or its HWID when it has none */
+    userId: string;
+};
 /** GetEventsByApplicationCodeRequest requests events for an application */
 export type GetEventsByApplicationCodeRequest = {
     /** Application code */