@pushwoosh/rpc-v2-http-api-data 0.2.265 → 0.2.266

package/data.js

@@ -12595,6 +12595,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.events.GetTotalStatisticsResponse",
                 "method": "post",
                 "path": "/api/events:getTotalStatistics"
+            },
+            "GetConversionSettings": {
+                "request": "pushwoosh.rpc_v2.events.GetConversionSettingsRequest",
+                "response": "pushwoosh.rpc_v2.events.ConversionSettings",
+                "method": "get",
+                "path": "/api/events:conversion-settings"
+            },
+            "SaveConversionSettings": {
+                "request": "pushwoosh.rpc_v2.events.SaveConversionSettingsRequest",
+                "response": "pushwoosh.rpc_v2.events.ConversionSettings",
+                "method": "put",
+                "path": "/api/events:conversion-settings"
             }
         }
     },
@@ -13049,6 +13061,56 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.events.ContactType": {
+        "type": "E",
+        "values": [
+            "CONTACT_TYPE_UNSPECIFIED",
+            "CONTACT_TYPE_CLICK",
+            "CONTACT_TYPE_SENT"
+        ]
+    },
+    "pushwoosh.rpc_v2.events.ConversionEvent": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "attributionWindowSeconds": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.ConversionSettings": {
+        "type": "I",
+        "fields": {
+            "events": {
+                "type": "pushwoosh.rpc_v2.events.ConversionEvent",
+                "array": true
+            },
+            "contactType": {
+                "type": "pushwoosh.rpc_v2.events.ContactType"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.GetConversionSettingsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.SaveConversionSettingsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "settings": {
+                "type": "pushwoosh.rpc_v2.events.ConversionSettings"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.export_messages.ExportStatisticsService": {
         "type": "S",
         "key": "exportStatistics",

package/events.d.ts

@@ -8,6 +8,8 @@ export type EventsService_GetAttributeValues = RpcMethod<GetAttributeValuesReque
 export type EventsService_GetTriggeredCount = RpcMethod<GetTriggeredCountRequest, GetTriggeredCountResponse>;
 export type EventsService_GetDetailedStatistics = RpcMethod<GetDetailedStatisticsRequest, GetDetailedStatisticsResponse>;
 export type EventsService_GetTotalStatistics = RpcMethod<GetTotalStatisticsRequest, GetTotalStatisticsResponse>;
+export type EventsService_GetConversionSettings = RpcMethod<GetConversionSettingsRequest, ConversionSettings>;
+export type EventsService_SaveConversionSettings = RpcMethod<SaveConversionSettingsRequest, ConversionSettings>;
 export interface EventsService {
     /** Returns one custom event by name for an application, including its attributes, store-days and revenue mapping. Use after list_events to inspect a single event's definition. */
     Get: EventsService_Get;
@@ -27,6 +29,10 @@ export interface EventsService {
     GetDetailedStatistics: EventsService_GetDetailedStatistics;
     /** Returns total and unique triggered counts for custom events over a date range, optionally scoped to a message code or campaign. Use to attribute event volume to a specific send or campaign. */
     GetTotalStatistics: EventsService_GetTotalStatistics;
+    /** Returns which custom events of an application count as conversions for campaign attribution, each with its attribution window, plus the contact type (click or send) conversions are counted from. Empty events means attribution is not configured yet. */
+    GetConversionSettings: EventsService_GetConversionSettings;
+    /** Replaces the conversion settings of an application: up to 3 events with an attribution window each (24h, 72h, 7d or 30d) and one contact type for all of them. Events left out of the request stop counting as conversions. */
+    SaveConversionSettings: EventsService_SaveConversionSettings;
 }
 export type GetEventRequest = {
     /** Application code (format XXXXX-XXXXX) the event belongs to. */
@@ -223,3 +229,27 @@ export type GetTotalStatisticsResponse = {
     /** Distinct users across all events at once; metrics are per event, so summing their uniq counts double-counts. */
     totalUniqTriggeredCount: number;
 };
+/** ContactType is the touch a conversion is counted from: the click on the message (default) or the send itself. */
+export type ContactType = 'CONTACT_TYPE_UNSPECIFIED' | 'CONTACT_TYPE_CLICK' | 'CONTACT_TYPE_SENT';
+export type ConversionEvent = {
+    /** Name of the application's custom event that counts as a conversion. */
+    name: string;
+    /** Attribution window in seconds: 86400, 259200, 604800 or 2592000. Zero means the default 259200 (72h). */
+    attributionWindowSeconds: number;
+};
+export type ConversionSettings = {
+    /** Up to 3 events counted as conversions, each with its own window. */
+    events: ConversionEvent[];
+    /** Contact type shared by all events of the application; UNSPECIFIED reads as CLICK. */
+    contactType: ContactType;
+};
+export type GetConversionSettingsRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+};
+export type SaveConversionSettingsRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+    /** Full replacement of the application's conversion settings; events left out stop counting. */
+    settings?: ConversionSettings;
+};

package/package.json

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