@pushwoosh/rpc-v2-http-api-data 0.2.180 → 0.2.182

package/applications_controlgroup.d.ts

@@ -1,11 +1,4 @@
 import { RpcMethod } from './commonTypes';
-export type ApplicationsControlGroupService_GetSettings = RpcMethod<GetSettingsRequest, GetSettingsResponse>;
-export type ApplicationsControlGroupService_UpdatePercentage = RpcMethod<UpdatePercentageRequest, UpdatePercentageResponse>;
-export type ApplicationsControlGroupService_Disable = RpcMethod<DisableRequest, DisableResponse>;
-export type ApplicationsControlGroupService_Reshuffle = RpcMethod<ReshuffleRequest, ReshuffleResponse>;
-export type ApplicationsControlGroupService_ForceUpdateCalculation = RpcMethod<ForceUpdateCalculationRequest, ForceUpdateCalculationResponse>;
-export type ApplicationsControlGroupService_GetCalculationStatus = RpcMethod<GetCalculationStatusRequest, GetCalculationStatusResponse>;
-export type ApplicationsControlGroupService_GetAnalytics = RpcMethod<GetAnalyticsRequest, GetAnalyticsResponse>;
 export type ApplicationsControlGroupService_ListControlGroups = RpcMethod<ListControlGroupsRequest, ListControlGroupsResponse>;
 export type ApplicationsControlGroupService_CreateControlGroup = RpcMethod<CreateControlGroupRequest, CreateControlGroupResponse>;
 export type ApplicationsControlGroupService_GetControlGroup = RpcMethod<GetControlGroupRequest, GetControlGroupResponse>;
@@ -25,28 +18,6 @@ export type ApplicationsControlGroupService_GetControlGroupAnalytics = RpcMethod
  * keeps every existing member; only a reshuffle draws a new sample.
  */
 export interface ApplicationsControlGroupService {
-    /** Returns the control-group settings for an application: hold-out percentage, enabled flag, generation, total vs hold-out user counts and calculation status. Use to display control-group config; get_control_group_calculation_status polls just the changing counts. */
-    GetSettings: ApplicationsControlGroupService_GetSettings;
-    /**
-     * Sets the control-group hold-out percentage (1-20) for an application and records who changed it. Resizing keeps every existing member: the hold-out grows or shrinks around them rather than being redrawn. Use to enable or resize the control group.
-     *
-     * Membership is computed, not stored, so enabling covers the whole user base immediately -- there is no backfill to wait for.
-     */
-    UpdatePercentage: ApplicationsControlGroupService_UpdatePercentage;
-    /**
-     * Disables the control group for an application, removing its percentage setting and queuing a background job that clears leftover PW_ControlGroup tag values from before membership became a computation. Use to turn the hold-out group off.
-     *
-     * Re-enabling afterwards produces the very same hold-out unless the group is reshuffled, because membership is a deterministic function of the user id.
-     */
-    Disable: ApplicationsControlGroupService_Disable;
-    /** Redraws the control group of an application: every user is assigned again, so the hold-out is a fresh sample of the same size. Use when the same users have been excluded from messaging for too long, and note that it restarts the measurement period. */
-    Reshuffle: ApplicationsControlGroupService_Reshuffle;
-    /** Kicks off a fresh count of the application's users and of how many of them are held out, leaving the previously cached numbers in place until it finishes. Use to refresh stale sizes on demand. */
-    ForceUpdateCalculation: ApplicationsControlGroupService_ForceUpdateCalculation;
-    /** Returns just the counts and calculation status that change while a background size calc runs. Poll this on a timer instead of re-fetching get_control_group_settings. */
-    GetCalculationStatus: ApplicationsControlGroupService_GetCalculationStatus;
-    /** Returns precomputed control-vs-treatment analytics (conversions, uplift, statistical significance) per event for an application over a 3/7/30-day window. Use to measure the incremental impact of messaging. */
-    GetAnalytics: ApplicationsControlGroupService_GetAnalytics;
     /** 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. */
     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. */
@@ -69,56 +40,6 @@ export interface ApplicationsControlGroupService {
     GetControlGroupAnalytics: ApplicationsControlGroupService_GetControlGroupAnalytics;
 }
 export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
-export type GetSettingsRequest = {
-    /** Application code (format XXXXX-XXXXX) whose control-group settings to fetch. */
-    code?: string;
-};
-export type GetSettingsResponse = {
-    percentage: number;
-    enabled: boolean;
-    /** All users in the application */
-    totalUsers: number;
-    /** Users held out, counted over the application */
-    controlGroupUsers: number;
-    calculationStatus: TaskStatus;
-    /** Last time control group settings were modified */
-    lastModifiedAt: Date;
-    /** Email of user who last modified settings */
-    lastModifiedBy: string;
-    /** Whether cached size numbers are available (false => never calculated yet) */
-    hasData: boolean;
-    /** Incremented by every reshuffle; 0 means never reshuffled */
-    generation: number;
-};
-export type UpdatePercentageRequest = {
-    /** Application code (format XXXXX-XXXXX) to configure. */
-    code?: string;
-    /** Control-group hold-out size as a percentage, 1-20. */
-    percentage?: number;
-};
-export type UpdatePercentageResponse = {};
-export type ReshuffleRequest = {
-    /** Application code (format XXXXX-XXXXX) whose control group to redraw. */
-    code?: string;
-};
-export type ReshuffleResponse = {
-    /** Generation after the reshuffle. */
-    generation: number;
-};
-export type DisableRequest = {
-    /** Application code (format XXXXX-XXXXX) whose control group to disable. */
-    code?: string;
-};
-export type DisableResponse = {};
-export type ForceUpdateCalculationRequest = {
-    /** Application code (format XXXXX-XXXXX) to recalculate the user count for. */
-    code?: string;
-};
-export type ForceUpdateCalculationResponse = {};
-export type GetCalculationStatusRequest = {
-    /** Application code (format XXXXX-XXXXX) to poll calculation status for. */
-    code?: string;
-};
 /**
  * GetCalculationStatusResponse is the lightweight subset of the settings
  * response that changes while a background size calculation runs. Clients poll
@@ -137,13 +58,12 @@ export type GetAnalyticsRequest_WindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW
 /**
  * GetAnalyticsRequest asks for the precomputed Control-vs-Treatment analytics
  * for a window preset (3/7/30 days).
+ * GetAnalyticsRequest is no longer a request: the endpoint that took it is
+ * gone. It stays as the home of WindowDays, which
+ * GetControlGroupAnalyticsRequest still uses -- moving the enum would rename
+ * the generated type and every client importing it.
  */
-export type GetAnalyticsRequest = {
-    /** Application code (format XXXXX-XXXXX) to report on. */
-    code?: string;
-    /** Analytics lookback window preset (3, 7 or 30 days). */
-    windowDays?: GetAnalyticsRequest_WindowDays;
-};
+export type GetAnalyticsRequest = {};
 /** ControlGroup is one configured control group of an application. */
 export type ControlGroup = {
     /** Control group code (format XXXXX-XXXXX), stable for the life of the group. */

package/data.js

@@ -6346,48 +6346,6 @@ export const data = {
         "type": "S",
         "key": "applicationsControlGroup",
         "methods": {
-            "GetSettings": {
-                "request": "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsRequest",
-                "response": "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsResponse",
-                "method": "get",
-                "path": "/api/applications/{code}/control_group"
-            },
-            "UpdatePercentage": {
-                "request": "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageRequest",
-                "response": "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageResponse",
-                "method": "post",
-                "path": "/api/applications/{code}/control_group"
-            },
-            "Disable": {
-                "request": "pushwoosh.rpc_v2.applications_controlgroup.DisableRequest",
-                "response": "pushwoosh.rpc_v2.applications_controlgroup.DisableResponse",
-                "method": "delete",
-                "path": "/api/applications/{code}/control_group"
-            },
-            "Reshuffle": {
-                "request": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleRequest",
-                "response": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleResponse",
-                "method": "post",
-                "path": "/api/applications/{code}/control_group/reshuffle"
-            },
-            "ForceUpdateCalculation": {
-                "request": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationRequest",
-                "response": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationResponse",
-                "method": "post",
-                "path": "/api/applications/{code}/control_group/recalculate"
-            },
-            "GetCalculationStatus": {
-                "request": "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusRequest",
-                "response": "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusResponse",
-                "method": "get",
-                "path": "/api/applications/{code}/control_group/calculation_status"
-            },
-            "GetAnalytics": {
-                "request": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest",
-                "response": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse",
-                "method": "get",
-                "path": "/api/applications/{code}/control_group/analytics"
-            },
             "ListControlGroups": {
                 "request": "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsRequest",
                 "response": "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsResponse",
@@ -6459,109 +6417,6 @@ export const data = {
             "TASK_STATUS_COMPLETED"
         ]
     },
-    "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsRequest": {
-        "type": "I",
-        "fields": {
-            "code": {
-                "type": "string"
-            }
-        }
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsResponse": {
-        "type": "I",
-        "fields": {
-            "percentage": {
-                "type": "number"
-            },
-            "enabled": {
-                "type": "boolean"
-            },
-            "totalUsers": {
-                "type": "number"
-            },
-            "controlGroupUsers": {
-                "type": "number"
-            },
-            "calculationStatus": {
-                "type": "pushwoosh.rpc_v2.applications_controlgroup.TaskStatus"
-            },
-            "lastModifiedAt": {
-                "type": "Date"
-            },
-            "lastModifiedBy": {
-                "type": "string"
-            },
-            "hasData": {
-                "type": "boolean"
-            },
-            "generation": {
-                "type": "number"
-            }
-        }
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageRequest": {
-        "type": "I",
-        "fields": {
-            "code": {
-                "type": "string"
-            },
-            "percentage": {
-                "type": "number"
-            }
-        }
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageResponse": {
-        "type": "I",
-        "fields": {}
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleRequest": {
-        "type": "I",
-        "fields": {
-            "code": {
-                "type": "string"
-            }
-        }
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleResponse": {
-        "type": "I",
-        "fields": {
-            "generation": {
-                "type": "number"
-            }
-        }
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.DisableRequest": {
-        "type": "I",
-        "fields": {
-            "code": {
-                "type": "string"
-            }
-        }
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.DisableResponse": {
-        "type": "I",
-        "fields": {}
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationRequest": {
-        "type": "I",
-        "fields": {
-            "code": {
-                "type": "string"
-            }
-        }
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationResponse": {
-        "type": "I",
-        "fields": {}
-    },
-    "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusRequest": {
-        "type": "I",
-        "fields": {
-            "code": {
-                "type": "string"
-            }
-        }
-    },
     "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusResponse": {
         "type": "I",
         "fields": {
@@ -6590,14 +6445,7 @@ export const data = {
     },
     "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest": {
         "type": "I",
-        "fields": {
-            "code": {
-                "type": "string"
-            },
-            "windowDays": {
-                "type": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest.WindowDays"
-            }
-        }
+        "fields": {}
     },
     "pushwoosh.rpc_v2.applications_controlgroup.ControlGroup": {
         "type": "I",
@@ -12498,7 +12346,8 @@ export const data = {
             "EXPORT_MESSAGE_PROPERTY_TOTAL_OPENED",
             "EXPORT_MESSAGE_PROPERTY_TOTAL_CLICKS",
             "EXPORT_MESSAGE_PROPERTY_CLICKS",
-            "EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED"
+            "EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED",
+            "EXPORT_MESSAGE_PROPERTY_MESSAGE_CODE"
         ]
     },
     "pushwoosh.export_messages.v2.Source": {
@@ -12534,6 +12383,14 @@ export const data = {
             "MESSAGE_STATUS_WAITING"
         ]
     },
+    "pushwoosh.export_messages.v2.MessageType": {
+        "type": "E",
+        "values": [
+            "MESSAGE_TYPE_UNSPECIFIED",
+            "MARKETING",
+            "TRANSACTIONAL"
+        ]
+    },
     "pushwoosh.export_messages.v2.ApplySegmentExportType": {
         "type": "E",
         "values": [
@@ -12609,6 +12466,9 @@ export const data = {
             "properties": {
                 "type": "pushwoosh.export_messages.v2.ExportMessageProperty",
                 "array": true
+            },
+            "messageType": {
+                "type": "pushwoosh.export_messages.v2.MessageType"
             }
         }
     },
@@ -12617,6 +12477,9 @@ export const data = {
         "fields": {
             "file": {
                 "type": "string"
+            },
+            "truncated": {
+                "type": "boolean"
             }
         }
     },
@@ -13366,6 +13229,9 @@ export const data = {
         "fields": {
             "applicationCode": {
                 "type": "string"
+            },
+            "controlGroupCode": {
+                "type": "string"
             }
         }
     },
@@ -26796,7 +26662,8 @@ export const data = {
     "pushwoosh.rpc_v2.rich_medias.ListRequest.OrderBy": {
         "type": "E",
         "values": [
-            "CREATED_DATE"
+            "CREATED_DATE",
+            "UPDATED_DATE"
         ]
     },
     "pushwoosh.rpc_v2.rich_medias.ListRequest.OrderType": {

package/package.json

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

package/pushwoosh_export_messages_v2.d.ts

@@ -429,13 +429,14 @@ export type TrackingLogCSVArgs = {
 export type TrackingLogCSVResult = {
     file: 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 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 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'
 /** deprecated */
  | 'TWITTER';
 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';
 export type ApplySegmentExportType = 'APPLY_SEGMENT_EXPORT_TYPE_UNSPECIFIED' | 'ALL' | 'OPEN' | 'NOT_OPEN';
 export type DateRange = {
     /** date format yyyy-mm-dd */
@@ -460,9 +461,12 @@ export type ExportMessagesV2Args = {
     appGroupCode: string;
     filters: GetMessageHistoryFilters;
     properties: ExportMessageProperty[];
+    messageType: MessageType;
 };
 export type ExportMessagesV2Result = {
     file: string;
+    /** set when the export hit the row limit and the file holds only its first rows */
+    truncated: boolean;
 };
 export type ExportUnregisteredDevicesArgs = {
     applicationCode: string;
@@ -709,6 +713,11 @@ export type ExportJourneyGoalUsersResult = {
 };
 export type ExportControlGroupArgs = {
     applicationCode: string;
+    /**
+     * Control group to export, by code. Empty exports the application's global
+     * group, which is what every task created before groups had codes meant.
+     */
+    controlGroupCode: string;
 };
 export type ExportControlGroupResult = {
     file: string;

package/rich_medias.d.ts

@@ -98,7 +98,7 @@ export type GetResponse = {
     richMedia: RichMedia;
 };
 export type ListRequest_ListView = 'LIST' | 'TILES';
-export type ListRequest_OrderBy = 'CREATED_DATE';
+export type ListRequest_OrderBy = 'CREATED_DATE' | 'UPDATED_DATE';
 export type ListRequest_OrderType = 'ASC' | 'DESC';
 export type ListRequest = {
     /** Free-text search over rich media name and code. */