@pushwoosh/rpc-v2-http-api-data 0.2.336 → 0.2.337

package/applications_controlgroup.d.ts

@@ -42,7 +42,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 reading the base: use it to check the users of a send or an import instead of exporting the whole group. */
+    /** 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. */
     CheckControlGroupMembership: ApplicationsControlGroupService_CheckControlGroupMembership;
 }
 export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
@@ -222,7 +222,8 @@ export type CheckControlGroupMembershipRequest = {
     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.
+     * 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.
      */
     userIds?: string[];
 };

package/data.js

@@ -15485,7 +15485,8 @@ export const data = {
             "EXPORT_MESSAGE_PROPERTY_TOTAL_CLICKS",
             "EXPORT_MESSAGE_PROPERTY_CLICKS",
             "EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED",
-            "EXPORT_MESSAGE_PROPERTY_MESSAGE_CODE"
+            "EXPORT_MESSAGE_PROPERTY_MESSAGE_CODE",
+            "EXPORT_MESSAGE_PROPERTY_CAMPAIGN_NAME"
         ]
     },
     "pushwoosh.export_messages.v2.Source": {
@@ -15531,6 +15532,18 @@ export const data = {
             "TRANSACTIONAL"
         ]
     },
+    "pushwoosh.export_messages.v2.MessageHistoryChannel": {
+        "type": "E",
+        "values": [
+            "MESSAGE_HISTORY_CHANNEL_UNSPECIFIED",
+            "MESSAGE_HISTORY_CHANNEL_PUSH",
+            "MESSAGE_HISTORY_CHANNEL_INBOX",
+            "MESSAGE_HISTORY_CHANNEL_EMAIL",
+            "MESSAGE_HISTORY_CHANNEL_SMS",
+            "MESSAGE_HISTORY_CHANNEL_WHATSAPP",
+            "MESSAGE_HISTORY_CHANNEL_FB_MESSENGER"
+        ]
+    },
     "pushwoosh.export_messages.v2.ApplySegmentExportType": {
         "type": "E",
         "values": [
@@ -15585,6 +15598,9 @@ export const data = {
             },
             "messageCode": {
                 "type": "string"
+            },
+            "channel": {
+                "type": "pushwoosh.export_messages.v2.MessageHistoryChannel"
             }
         }
     },
@@ -16069,7 +16085,8 @@ export const data = {
         "values": [
             "sends",
             "deliveries",
-            "opens"
+            "opens",
+            "holdout"
         ]
     },
     "pushwoosh.export_messages.v2.ExportMessageRecipientsArgs": {

package/package.json

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

package/pushwoosh_export_messages_v2.d.ts

@@ -580,7 +580,7 @@ export type TrackingLogCSVResult = {
     /** Ready-to-use download URL for `file`; empty when the service has no base URL configured. */
     fileUrl: string;
 };
-export type ExportMessageProperty = 'EXPORT_MESSAGE_PROPERTY_UNSPECIFIED' | 'EXPORT_MESSAGE_PROPERTY_ID' | 'EXPORT_MESSAGE_PROPERTY_TIMESTAMP' | 'EXPORT_MESSAGE_PROPERTY_CONTENT' | 'EXPORT_MESSAGE_PROPERTY_TITLE' | 'EXPORT_MESSAGE_PROPERTY_APPLICATIONS' | 'EXPORT_MESSAGE_PROPERTY_STATUS' | 'EXPORT_MESSAGE_PROPERTY_PLATFORMS' | 'EXPORT_MESSAGE_PROPERTY_SOURCE' | 'EXPORT_MESSAGE_PROPERTY_FILTER' | 'EXPORT_MESSAGE_PROPERTY_SUBSCRIPTION_SEGMENTS' | 'EXPORT_MESSAGE_PROPERTY_SENT' | 'EXPORT_MESSAGE_PROPERTY_OPENED' | 'EXPORT_MESSAGE_PROPERTY_ERRORS' | 'EXPORT_MESSAGE_PROPERTY_RECIPIENTS' | 'EXPORT_MESSAGE_PROPERTY_DELIVERED' | 'EXPORT_MESSAGE_PROPERTY_TOTAL_DELIVERED' | 'EXPORT_MESSAGE_PROPERTY_TOTAL_OPENED' | 'EXPORT_MESSAGE_PROPERTY_TOTAL_CLICKS' | 'EXPORT_MESSAGE_PROPERTY_CLICKS' | 'EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED' | 'EXPORT_MESSAGE_PROPERTY_MESSAGE_CODE';
+export type ExportMessageProperty = 'EXPORT_MESSAGE_PROPERTY_UNSPECIFIED' | 'EXPORT_MESSAGE_PROPERTY_ID' | 'EXPORT_MESSAGE_PROPERTY_TIMESTAMP' | 'EXPORT_MESSAGE_PROPERTY_CONTENT' | 'EXPORT_MESSAGE_PROPERTY_TITLE' | 'EXPORT_MESSAGE_PROPERTY_APPLICATIONS' | 'EXPORT_MESSAGE_PROPERTY_STATUS' | 'EXPORT_MESSAGE_PROPERTY_PLATFORMS' | 'EXPORT_MESSAGE_PROPERTY_SOURCE' | 'EXPORT_MESSAGE_PROPERTY_FILTER' | 'EXPORT_MESSAGE_PROPERTY_SUBSCRIPTION_SEGMENTS' | 'EXPORT_MESSAGE_PROPERTY_SENT' | 'EXPORT_MESSAGE_PROPERTY_OPENED' | 'EXPORT_MESSAGE_PROPERTY_ERRORS' | 'EXPORT_MESSAGE_PROPERTY_RECIPIENTS' | 'EXPORT_MESSAGE_PROPERTY_DELIVERED' | 'EXPORT_MESSAGE_PROPERTY_TOTAL_DELIVERED' | 'EXPORT_MESSAGE_PROPERTY_TOTAL_OPENED' | 'EXPORT_MESSAGE_PROPERTY_TOTAL_CLICKS' | 'EXPORT_MESSAGE_PROPERTY_CLICKS' | 'EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED' | 'EXPORT_MESSAGE_PROPERTY_MESSAGE_CODE' | 'EXPORT_MESSAGE_PROPERTY_CAMPAIGN_NAME';
 export type Source = 'SOURCE_UNSPECIFIED'
 /** deprecated */
  | 'AB_EXPERIMENT' | 'AB_TEST' | 'API' | 'AUTO_PUSH' | 'CP' | 'CSV' | 'CUSTOMER_JOURNEY' | 'EMAIL_API' | 'EMAIL_CP' | 'GEO_ZONE' | 'PUSH_ON_EVENT' | 'RSS' | 'SYSTEM'
@@ -590,6 +590,8 @@ export type Source = 'SOURCE_UNSPECIFIED'
  | 'WHATSAPP_API' | 'SMS_API';
 export type MessageStatus = 'MESSAGE_STATUS_UNSPECIFIED' | 'MESSAGE_STATUS_CANCELED' | 'MESSAGE_STATUS_CREATING' | 'MESSAGE_STATUS_DONE' | 'MESSAGE_STATUS_FAIL' | 'MESSAGE_STATUS_PENDING' | 'MESSAGE_STATUS_PROCESSING' | 'MESSAGE_STATUS_WAITING';
 export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'MARKETING' | 'TRANSACTIONAL';
+/** Channel of the messages listing; values mirror statistics-api's MessageHistoryChannel. */
+export type MessageHistoryChannel = 'MESSAGE_HISTORY_CHANNEL_UNSPECIFIED' | 'MESSAGE_HISTORY_CHANNEL_PUSH' | 'MESSAGE_HISTORY_CHANNEL_INBOX' | 'MESSAGE_HISTORY_CHANNEL_EMAIL' | 'MESSAGE_HISTORY_CHANNEL_SMS' | 'MESSAGE_HISTORY_CHANNEL_WHATSAPP' | 'MESSAGE_HISTORY_CHANNEL_FB_MESSENGER';
 export type ApplySegmentExportType = 'APPLY_SEGMENT_EXPORT_TYPE_UNSPECIFIED' | 'ALL' | 'OPEN' | 'NOT_OPEN';
 export type DateRange = {
     /** date format yyyy-mm-dd */
@@ -607,6 +609,7 @@ export type GetMessageHistoryFilters = {
     campaigns: string[];
     messageId: number;
     messageCode: string;
+    channel: MessageHistoryChannel;
 };
 export type ExportMessagesV2Args = {
     search: string;
@@ -778,7 +781,9 @@ export type ExportJourneyPointUsersResult = {
     /** Ready-to-use download URL for `file`; empty when the service has no base URL configured. */
     fileUrl: string;
 };
-export type ExportMessageRecipientsArgs_Type = 'sends' | 'deliveries' | 'opens';
+export type ExportMessageRecipientsArgs_Type = 'sends' | 'deliveries' | 'opens'
+/** Users a control group held out of the message: the 1028 cut, nothing was sent to them. */
+ | 'holdout';
 export type ExportMessageRecipientsArgs = {
     messageId: number;
     campaign: string;