@pushwoosh/rpc-v2-http-api-data 0.2.302 → 0.2.303

package/applications_controlgroup.d.ts

@@ -9,6 +9,7 @@ export type ApplicationsControlGroupService_ReshuffleControlGroup = RpcMethod<Re
 export type ApplicationsControlGroupService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
 export type ApplicationsControlGroupService_GetControlGroupCalculationStatus = RpcMethod<GetControlGroupCalculationStatusRequest, GetCalculationStatusResponse>;
 export type ApplicationsControlGroupService_GetControlGroupAnalytics = RpcMethod<GetControlGroupAnalyticsRequest, GetAnalyticsResponse>;
+export type ApplicationsControlGroupService_CheckControlGroupMembership = RpcMethod<CheckControlGroupMembershipRequest, CheckControlGroupMembershipResponse>;
 /**
  * Global Control Group: a hold-out of an application's users that receives no
  * marketing messages, so the effect of messaging can be measured against it.
@@ -38,6 +39,8 @@ export interface ApplicationsControlGroupService {
     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. */
     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 reading the base: use it to check the users of a send or an import instead of exporting the whole group. */
+    CheckControlGroupMembership: ApplicationsControlGroupService_CheckControlGroupMembership;
 }
 export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
 /**
@@ -78,6 +81,11 @@ export type ControlGroup = {
     lastModifiedAt: Date;
     /** Email of the user who last changed the group. */
     lastModifiedBy: string;
+    /**
+     * Numeric id of the application, the first part of the membership key
+     * <application_id>:<generation>:<name>:<user_id> the hash is taken over.
+     */
+    applicationId: number;
 };
 export type ListControlGroupsRequest = {
     /** Application code (format XXXXX-XXXXX) whose control groups to list. */
@@ -191,3 +199,26 @@ export type AnalyticsEvent = {
 export type GetAnalyticsResponse = {
     events: AnalyticsEvent[];
 };
+export type CheckControlGroupMembershipRequest = {
+    /** Application code (format XXXXX-XXXXX) the group belongs to. */
+    code?: string;
+    /** Control group code (format XXXXX-XXXXX) to check against. */
+    controlGroupCode?: string;
+    /**
+     * User ids to check, at most 1000 per call. An id the application has never
+     * seen is answered all the same: the verdict is a function of the id alone.
+     */
+    userIds?: string[];
+};
+/**
+ * UserMembership is one user's verdict. A group that is off holds nobody, so
+ * every id comes back false rather than as an error.
+ */
+export type UserMembership = {
+    userId: string;
+    inControlGroup: boolean;
+};
+export type CheckControlGroupMembershipResponse = {
+    /** One entry per requested id, in the order they were given. */
+    users: UserMembership[];
+};

package/data.js

@@ -6916,6 +6916,12 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse",
                 "method": "get",
                 "path": "/api/applications/{code}/control_groups/{control_group_code}/analytics"
+            },
+            "CheckControlGroupMembership": {
+                "request": "pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipRequest",
+                "response": "pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipResponse",
+                "method": "post",
+                "path": "/api/applications/{code}/control_groups/{control_group_code}/membership"
             }
         }
     },
@@ -6980,6 +6986,9 @@ export const data = {
             },
             "lastModifiedBy": {
                 "type": "string"
+            },
+            "applicationId": {
+                "type": "number"
             }
         }
     },
@@ -7233,6 +7242,41 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "controlGroupCode": {
+                "type": "string"
+            },
+            "userIds": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_controlgroup.UserMembership": {
+        "type": "I",
+        "fields": {
+            "userId": {
+                "type": "string"
+            },
+            "inControlGroup": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_controlgroup.CheckControlGroupMembershipResponse": {
+        "type": "I",
+        "fields": {
+            "users": {
+                "type": "pushwoosh.rpc_v2.applications_controlgroup.UserMembership",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications_groups.ApplicationsGroupsService": {
         "type": "S",
         "key": "applicationsGroups",

package/package.json

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