@pushwoosh/rpc-v2-http-api-data 0.2.348 → 0.2.350

package/applications_controlgroup.d.ts

@@ -48,7 +48,7 @@ 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 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 holds a user out only if one of their devices is in those countries. */
+    /** 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;
 }
 export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
@@ -148,6 +148,10 @@ export type ControlGroup = {
     /** The running cycle. A disabled group has no running cycle: its number is the next one to start. */
     cycleNumber: number;
     cycleStartedAt: Date;
+    /** Tag the hold-out is scoped to, AND-ed with countries; empty is no tag scope. */
+    scopeTag: string;
+    /** Values of scope_tag that put a user in scope; a boolean tag uses "true" and "false". */
+    scopeValues: string[];
 };
 export type ListControlGroupsRequest = {
     /** Application code (format XXXXX-XXXXX) whose control groups to list. */
@@ -173,6 +177,10 @@ export type CreateControlGroupRequest = {
     refreshPeriodDays?: number;
     /** End of the experiment, experiment only: at least 30 days ahead. */
     endsAt?: Date;
+    /** String or boolean tag to scope the hold-out to, AND-ed with countries; empty means no tag scope. */
+    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[];
 };
 export type CreateControlGroupResponse = {
     group: ControlGroup;
@@ -237,6 +245,10 @@ export type UpdateControlGroupSettingsRequest = {
     refreshPeriodDays?: number;
     /** End of the experiment, experiment only: at least 30 days ahead. */
     endsAt?: Date;
+    /** String or boolean tag to scope the hold-out to, AND-ed with countries; empty removes the tag scope. */
+    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[];
 };
 export type UpdateControlGroupSettingsResponse = {
     group: ControlGroup;
@@ -340,8 +352,8 @@ export type CheckControlGroupMembershipRequest = {
     controlGroupCode?: string;
     /**
      * User ids to check, at most 1000 per call. An id the application has never
-     * seen is answered from the id alone, unless the group is scoped to countries:
-     * such an id has no device in them and comes back false.
+     * seen is answered from the id alone, unless the group is scoped to countries or
+     * a tag: such an id has no device in the scope and comes back false.
      */
     userIds?: string[];
 };

package/data.js

@@ -7176,6 +7176,13 @@ export const data = {
             },
             "cycleStartedAt": {
                 "type": "Date"
+            },
+            "scopeTag": {
+                "type": "string"
+            },
+            "scopeValues": {
+                "type": "string",
+                "array": true
             }
         }
     },
@@ -7223,6 +7230,13 @@ export const data = {
             },
             "endsAt": {
                 "type": "Date"
+            },
+            "scopeTag": {
+                "type": "string"
+            },
+            "scopeValues": {
+                "type": "string",
+                "array": true
             }
         }
     },
@@ -7341,6 +7355,13 @@ export const data = {
             },
             "endsAt": {
                 "type": "Date"
+            },
+            "scopeTag": {
+                "type": "string"
+            },
+            "scopeValues": {
+                "type": "string",
+                "array": true
             }
         }
     },

package/package.json

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