@pushwoosh/rpc-v2-http-api-data 0.2.16 → 0.2.17

package/applications.d.ts

@@ -15,6 +15,7 @@ export type ApplicationsService_GetControlGroupSettings = RpcMethod<GetControlGr
 export type ApplicationsService_UpdateControlGroupPercentage = RpcMethod<UpdateControlGroupPercentageRequest, UpdateControlGroupPercentageResponse>;
 export type ApplicationsService_DisableControlGroup = RpcMethod<DisableControlGroupRequest, DisableControlGroupResponse>;
 export type ApplicationsService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
+export type ApplicationsService_GetControlGroupCalculationStatus = RpcMethod<GetControlGroupCalculationStatusRequest, GetControlGroupCalculationStatusResponse>;
 export type ApplicationsService_GetDOIConfig = RpcMethod<GetDOIConfigRequest, GetDOIConfigResponse>;
 export type ApplicationsService_SetDOIConfig = RpcMethod<SetDOIConfigRequest, SetDOIConfigResponse>;
 export interface ApplicationsService {
@@ -33,6 +34,7 @@ export interface ApplicationsService {
     UpdateControlGroupPercentage: ApplicationsService_UpdateControlGroupPercentage;
     DisableControlGroup: ApplicationsService_DisableControlGroup;
     ForceUpdateControlGroupCalculation: ApplicationsService_ForceUpdateControlGroupCalculation;
+    GetControlGroupCalculationStatus: ApplicationsService_GetControlGroupCalculationStatus;
     GetDOIConfig: ApplicationsService_GetDOIConfig;
     SetDOIConfig: ApplicationsService_SetDOIConfig;
 }
@@ -191,6 +193,24 @@ export type ForceUpdateControlGroupCalculationRequest = {
     code?: string;
 };
 export type ForceUpdateControlGroupCalculationResponse = {};
+export type GetControlGroupCalculationStatusRequest = {
+    code?: string;
+};
+/**
+ * GetControlGroupCalculationStatusResponse is the lightweight subset of the
+ * settings response that changes while a background size calculation runs.
+ * Clients poll this on a timer to refresh numbers in place without re-fetching
+ * the whole settings page.
+ */
+export type GetControlGroupCalculationStatusResponse = {
+    /** All users in the application */
+    totalUsers: number;
+    /** Users with PW_ControlGroup = true */
+    controlGroupUsers: number;
+    calculationStatus: ControlGroupTaskStatus;
+    /** Whether cached size numbers are available */
+    hasData: boolean;
+};
 export type ShuffleControlGroupRequest = {
     code: string;
 };

package/data.js

@@ -2645,6 +2645,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/applications/{code}/control_group/recalculate"
             },
+            "GetControlGroupCalculationStatus": {
+                "request": "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusRequest",
+                "response": "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusResponse",
+                "method": "get",
+                "path": "/api/applications/{code}/control_group/calculation_status"
+            },
             "GetDOIConfig": {
                 "request": "pushwoosh.rpc_v2.applications.GetDOIConfigRequest",
                 "response": "pushwoosh.rpc_v2.applications.GetDOIConfigResponse",
@@ -3104,6 +3110,31 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusResponse": {
+        "type": "I",
+        "fields": {
+            "totalUsers": {
+                "type": "number"
+            },
+            "controlGroupUsers": {
+                "type": "number"
+            },
+            "calculationStatus": {
+                "type": "pushwoosh.rpc_v2.applications.ControlGroupTaskStatus"
+            },
+            "hasData": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications.ShuffleControlGroupRequest": {
         "type": "I",
         "fields": {

package/package.json

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