@pushwoosh/rpc-v2-http-api-data 0.2.352 → 0.2.354

package/applications_controlgroup.d.ts

@@ -46,7 +46,7 @@ export interface ApplicationsControlGroupService {
     ForceUpdateControlGroupCalculation: ApplicationsControlGroupService_ForceUpdateControlGroupCalculation;
     /** Polls just the changing user counts of one control group while a size calculation runs. */
     GetControlGroupCalculationStatus: ApplicationsControlGroupService_GetControlGroupCalculationStatus;
-    /** Returns the precomputed Control-vs-Treatment analytics for one control group. Only the default group has analytics: the nightly job still measures one hold-out per application, so any other group comes back empty until it learns about groups. */
+    /** Returns the precomputed Control-vs-Treatment analytics for one control group cycle: the running cycle over a 3, 7 or 30 day window, or a closed cycle over its full period. A cycle the job has not measured yet comes back empty. */
     GetControlGroupAnalytics: ApplicationsControlGroupService_GetControlGroupAnalytics;
     /** Reports for each user id whether it is held out by one control group right now. Membership is computed from the id, so this answers without exporting the base: use it to check the users of a send or an import instead of exporting the whole group. A group scoped to countries or a tag holds a user out only if one of their devices is in that scope. */
     CheckControlGroupMembership: ApplicationsControlGroupService_CheckControlGroupMembership;
@@ -73,7 +73,9 @@ export type GetCalculationStatusResponse = {
  * grpc-gateway puts on the wire in JSON, and renaming them would break every
  * client mid-rollout.
  */
-export type AnalyticsWindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW_DAYS_3' | 'WINDOW_DAYS_7' | 'WINDOW_DAYS_30';
+export type AnalyticsWindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW_DAYS_3' | 'WINDOW_DAYS_7' | 'WINDOW_DAYS_30'
+/** The whole cycle; only a closed cycle is measured this way, so it needs a cycle_number. */
+ | 'WINDOW_DAYS_FULL_PERIOD';
 /**
  * ControlGroupMode is how long a drawn membership lives. Unspecified reads as
  * permanent, which is what every group was before modes existed.
@@ -116,6 +118,10 @@ export type ControlGroupCycle = {
     startedAt: Date;
     endedAt: Date;
     closeReason: ControlGroupCycleCloseReason;
+    /** Tag the cycle's hold-out was scoped to, AND-ed with countries; empty for no tag scope and for cycles closed before it existed. */
+    scopeTag: string;
+    /** Values of scope_tag that put a user in scope during this cycle. */
+    scopeValues: string[];
 };
 /** ControlGroup is one configured control group of an application. */
 export type ControlGroup = {
@@ -298,8 +304,13 @@ export type GetControlGroupAnalyticsRequest = {
     code?: string;
     /** Control group code (format XXXXX-XXXXX) to report on. */
     controlGroupCode?: string;
-    /** Analytics lookback window preset (3, 7 or 30 days). */
+    /** Analytics lookback window preset (3, 7 or 30 days, or the full period of a closed cycle). */
     windowDays?: AnalyticsWindowDays;
+    /**
+     * Cycle to report on: the group's cycle_number for the running one, a listed number for a closed one.
+     * 0 is the latest rows whatever their cycle; required with WINDOW_DAYS_FULL_PERIOD.
+     */
+    cycleNumber?: number;
 };
 export type AnalyticsGroup = {
     users: number;

package/data.js

@@ -7073,7 +7073,8 @@ export const data = {
             "WINDOW_DAYS_UNSPECIFIED",
             "WINDOW_DAYS_3",
             "WINDOW_DAYS_7",
-            "WINDOW_DAYS_30"
+            "WINDOW_DAYS_30",
+            "WINDOW_DAYS_FULL_PERIOD"
         ]
     },
     "pushwoosh.rpc_v2.applications_controlgroup.ControlGroupMode": {
@@ -7125,6 +7126,13 @@ export const data = {
             },
             "closeReason": {
                 "type": "pushwoosh.rpc_v2.applications_controlgroup.ControlGroupCycleCloseReason"
+            },
+            "scopeTag": {
+                "type": "string"
+            },
+            "scopeValues": {
+                "type": "string",
+                "array": true
             }
         }
     },
@@ -7464,6 +7472,9 @@ export const data = {
             },
             "windowDays": {
                 "type": "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsWindowDays"
+            },
+            "cycleNumber": {
+                "type": "number"
             }
         }
     },

package/package.json

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