@pushwoosh/rpc-v2-http-api-data 0.2.363 → 0.2.365

package/applications_controlgroup.d.ts

@@ -7,6 +7,7 @@ export type ApplicationsControlGroupService_UpdateControlGroupPercentage = RpcMe
 export type ApplicationsControlGroupService_UpdateControlGroupCountries = RpcMethod<UpdateControlGroupCountriesRequest, UpdateControlGroupCountriesResponse>;
 export type ApplicationsControlGroupService_UpdateControlGroupSettings = RpcMethod<UpdateControlGroupSettingsRequest, UpdateControlGroupSettingsResponse>;
 export type ApplicationsControlGroupService_ListControlGroupCycles = RpcMethod<ListControlGroupCyclesRequest, ListControlGroupCyclesResponse>;
+export type ApplicationsControlGroupService_RenameControlGroup = RpcMethod<RenameControlGroupRequest, RenameControlGroupResponse>;
 export type ApplicationsControlGroupService_DisableControlGroup = RpcMethod<DisableControlGroupRequest, DisableControlGroupResponse>;
 export type ApplicationsControlGroupService_ReshuffleControlGroup = RpcMethod<ReshuffleControlGroupRequest, ReshuffleControlGroupResponse>;
 export type ApplicationsControlGroupService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
@@ -22,13 +23,13 @@ export type ApplicationsControlGroupService_CheckControlGroupMembership = RpcMet
  * keeps every existing member; only a reshuffle draws a new sample.
  */
 export interface ApplicationsControlGroupService {
-    /** Lists every control group configured for an application, including the unnamed one a send falls back to when it names no group. Use to show the groups of an application before picking one to inspect or change. */
+    /** Lists every control group configured for an application, the unnamed original one first. Use to show the groups of an application before picking one to inspect or change. */
     ListControlGroups: ApplicationsControlGroupService_ListControlGroups;
-    /** Creates a named control group for an application and returns it with its generated code. Only the group with an empty name is the fallback for a send that names no group; a named group holds users out only when the send selects it. */
+    /** Creates a named control group for an application and returns it with its generated code. Every enabled group holds users out of all marketing sends within its own countries and tag, independently of the other groups; groups may overlap. */
     CreateControlGroup: ApplicationsControlGroupService_CreateControlGroup;
     /** Returns one control group by its code, with its hold-out size, generation and the user counts behind it. */
     GetControlGroup: ApplicationsControlGroupService_GetControlGroup;
-    /** Removes a control group entirely. Deleting the unnamed one leaves the application without a fallback, so a send that names no group holds nobody out until an unnamed group is created again. To stop holding users out while keeping the group, disable it instead. */
+    /** Removes a control group entirely. Its statistics can no longer be opened. To stop holding users out while keeping the history, disable it instead. */
     DeleteControlGroup: ApplicationsControlGroupService_DeleteControlGroup;
     /** Deprecated: use UpdateControlGroupSettings, which applies size, scope and mode in one save. Sets the hold-out percentage (1-20) of one control group; resizing keeps every existing member and closes the running cycle. */
     UpdateControlGroupPercentage: ApplicationsControlGroupService_UpdateControlGroupPercentage;
@@ -38,6 +39,8 @@ export interface ApplicationsControlGroupService {
     UpdateControlGroupSettings: ApplicationsControlGroupService_UpdateControlGroupSettings;
     /** Lists the closed cycles of one control group, newest first: each is the membership the group ran with between two changes, with the settings it was drawn from. The running cycle is on the group itself. */
     ListControlGroupCycles: ApplicationsControlGroupService_ListControlGroupCycles;
+    /** Sets the name the panel shows for one control group; empty shows the technical name. The technical name is part of the membership hash and never changes, so renaming keeps the same hold-out and the running cycle. */
+    RenameControlGroup: ApplicationsControlGroupService_RenameControlGroup;
     /** Switches one control group off, closes the running cycle and resets its mode to permanent. The group and its generation are kept, so switching it back on restores the same hold-out rather than drawing a new one. */
     DisableControlGroup: ApplicationsControlGroupService_DisableControlGroup;
     /** Redraws one control group's hold-out by incrementing its generation and closes the running cycle. This is the only way to get a different sample: membership is deterministic, so disabling and re-enabling reproduces exactly the same one. */
@@ -158,6 +161,8 @@ export type ControlGroup = {
     scopeTag: string;
     /** Values of scope_tag that put a user in scope; a boolean tag uses "true" and "false". */
     scopeValues: string[];
+    /** Name the panel shows; empty shows name, and the unnamed group as Global. */
+    displayName: string;
 };
 export type ListControlGroupsRequest = {
     /** Application code (format XXXXX-XXXXX) whose control groups to list. */
@@ -187,6 +192,8 @@ export type CreateControlGroupRequest = {
     scopeTag?: string;
     /** Values of scope_tag that put a user in scope, required with scope_tag; a boolean tag takes "true" and "false". */
     scopeValues?: string[];
+    /** Name the panel shows, up to 64 characters; empty shows name. */
+    displayName?: string;
 };
 export type CreateControlGroupResponse = {
     group: ControlGroup;
@@ -269,6 +276,17 @@ export type ListControlGroupCyclesResponse = {
     /** Newest first. */
     cycles: ControlGroupCycle[];
 };
+export type RenameControlGroupRequest = {
+    /** Application code (format XXXXX-XXXXX) the group belongs to. */
+    code?: string;
+    /** Control group code (format XXXXX-XXXXX) to rename. */
+    controlGroupCode?: string;
+    /** New name the panel shows, up to 64 characters and unique within the application; empty shows the technical name. */
+    displayName?: string;
+};
+export type RenameControlGroupResponse = {
+    group: ControlGroup;
+};
 export type DisableControlGroupRequest = {
     /** Application code (format XXXXX-XXXXX) the group belongs to. */
     code?: string;

package/data.js

@@ -6957,6 +6957,12 @@ export const data = {
                 "method": "get",
                 "path": "/api/applications/{code}/control_groups/{control_group_code}/cycles"
             },
+            "RenameControlGroup": {
+                "request": "pushwoosh.rpc_v2.applications_controlgroup.RenameControlGroupRequest",
+                "response": "pushwoosh.rpc_v2.applications_controlgroup.RenameControlGroupResponse",
+                "method": "post",
+                "path": "/api/applications/{code}/control_groups/{control_group_code}/display_name"
+            },
             "DisableControlGroup": {
                 "request": "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupRequest",
                 "response": "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupResponse",
@@ -7145,6 +7151,9 @@ export const data = {
             "scopeValues": {
                 "type": "string",
                 "array": true
+            },
+            "displayName": {
+                "type": "string"
             }
         }
     },
@@ -7199,6 +7208,9 @@ export const data = {
             "scopeValues": {
                 "type": "string",
                 "array": true
+            },
+            "displayName": {
+                "type": "string"
             }
         }
     },
@@ -7355,6 +7367,28 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.applications_controlgroup.RenameControlGroupRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "controlGroupCode": {
+                "type": "string"
+            },
+            "displayName": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_controlgroup.RenameControlGroupResponse": {
+        "type": "I",
+        "fields": {
+            "group": {
+                "type": "pushwoosh.rpc_v2.applications_controlgroup.ControlGroup"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupRequest": {
         "type": "I",
         "fields": {
@@ -14668,6 +14702,13 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.events.Attribution": {
+        "type": "E",
+        "values": [
+            "ATTRIBUTION_SDK_HASH",
+            "ATTRIBUTION_LAST_CLICK"
+        ]
+    },
     "pushwoosh.rpc_v2.events.TimeInterval": {
         "type": "E",
         "values": [
@@ -14771,6 +14812,15 @@ export const data = {
             "attributeConditions": {
                 "type": "pushwoosh.rpc_v2.events.AttributeCondition",
                 "array": true
+            },
+            "messageCode": {
+                "type": "string"
+            },
+            "campaign": {
+                "type": "string"
+            },
+            "attribution": {
+                "type": "pushwoosh.rpc_v2.events.Attribution"
             }
         }
     },
@@ -14819,6 +14869,9 @@ export const data = {
             "platforms": {
                 "type": "number",
                 "array": true
+            },
+            "attribution": {
+                "type": "pushwoosh.rpc_v2.events.Attribution"
             }
         }
     },
@@ -16468,6 +16521,10 @@ export const data = {
             },
             "dateTo": {
                 "type": "Date"
+            },
+            "platforms": {
+                "type": "number",
+                "array": true
             }
         }
     },
@@ -17130,6 +17187,28 @@ export const data = {
             }
         }
     },
+    "pushwoosh.export_messages.v2.CountControlGroupRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "controlGroup": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.export_messages.v2.CountControlGroupResponse": {
+        "type": "I",
+        "fields": {
+            "totalUsers": {
+                "type": "number"
+            },
+            "controlGroupUsers": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Create_FieldViolations": {
         "type": "E",
         "values": [

package/events.d.ts

@@ -160,6 +160,11 @@ export type GetTriggeredCountResponse_Count = {
 export type GetTriggeredCountResponse = {
     count: Record<string, GetTriggeredCountResponse_Count>;
 };
+export type Attribution = 
+/** An event counts for the message whose hash the SDK stamped on it. */
+'ATTRIBUTION_SDK_HASH'
+/** An event counts for the message of the user's last click within the 72 hours before it. */
+ | 'ATTRIBUTION_LAST_CLICK';
 export type TimeInterval = 'TIME_INTERVAL_UNSPECIFIED' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH';
 export type ListOfValues = {
     values: string[];
@@ -209,6 +214,12 @@ export type GetDetailedStatisticsRequest = {
     interval?: TimeInterval;
     /** Filter triggers to those whose attributes match these conditions. */
     attributeConditions?: AttributeCondition[];
+    /** Message code to attribute event triggers to a single send; requires attribution ATTRIBUTION_LAST_CLICK. */
+    messageCode?: string;
+    /** Campaign code to attribute event triggers to a whole campaign; requires attribution ATTRIBUTION_LAST_CLICK. */
+    campaign?: string;
+    /** How triggers are tied to a message or campaign; the default counts every trigger of the event. */
+    attribution?: Attribution;
 };
 export type GetDetailedStatisticsResponse_TriggeredCount = {
     timestamp: Date;
@@ -230,6 +241,8 @@ export type GetTotalStatisticsRequest = {
     campaign?: string;
     /** Platform ids to count events on; empty counts every platform. */
     platforms?: number[];
+    /** How triggers are tied to message_code or campaign; the default trusts the hash the SDK stamped on the event. */
+    attribution?: Attribution;
 };
 export type GetTotalStatisticsResponse_EventTriggeredCount = {
     event: string;

package/package.json

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