@pushwoosh/rpc-v2-http-api-data 0.2.353 → 0.2.355

package/applications_controlgroup.d.ts

@@ -22,13 +22,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 which one is the default a send falls back to. Use to show the groups of an application before picking one to inspect or change. */
+    /** 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. */
     ListControlGroups: ApplicationsControlGroupService_ListControlGroups;
-    /** Creates a named control group for an application and returns it with its generated code. The first group an application gets becomes the default one; later groups have to be selected explicitly by whoever sends. */
+    /** 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. */
     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 default one leaves the application without a fallback, so sends hold nobody out until a group is created again. To stop holding users out while keeping the group, disable it instead. */
+    /** 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. */
     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;
@@ -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.
@@ -302,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": {
@@ -7471,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.353",
+  "version": "0.2.355",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",