@pushwoosh/rpc-v2-http-api-data 0.2.151 → 0.2.152

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/applications.d.ts CHANGED
@@ -11,12 +11,6 @@ export type ApplicationsService_UpdateURLParams = RpcMethod<UpdateURLParamsReque
11
11
  export type ApplicationsService_SendEmailVerification = RpcMethod<SendEmailVerificationRequest, SendEmailVerificationResponse>;
12
12
  export type ApplicationsService_GetAccountGroupPermissions = RpcMethod<GetAccountGroupPermissionsRequest, GetAccountGroupPermissionsResponse>;
13
13
  export type ApplicationsService_SaveAccountGroupPermissions = RpcMethod<SaveAccountGroupPermissionsRequest, SaveAccountGroupPermissionsResponse>;
14
- export type ApplicationsService_GetControlGroupSettings = RpcMethod<GetControlGroupSettingsRequest, GetControlGroupSettingsResponse>;
15
- export type ApplicationsService_UpdateControlGroupPercentage = RpcMethod<UpdateControlGroupPercentageRequest, UpdateControlGroupPercentageResponse>;
16
- export type ApplicationsService_DisableControlGroup = RpcMethod<DisableControlGroupRequest, DisableControlGroupResponse>;
17
- export type ApplicationsService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
18
- export type ApplicationsService_GetControlGroupCalculationStatus = RpcMethod<GetControlGroupCalculationStatusRequest, GetControlGroupCalculationStatusResponse>;
19
- export type ApplicationsService_GetControlGroupAnalytics = RpcMethod<GetControlGroupAnalyticsRequest, GetControlGroupAnalyticsResponse>;
20
14
  export type ApplicationsService_GetDOIConfig = RpcMethod<GetDOIConfigRequest, GetDOIConfigResponse>;
21
15
  export type ApplicationsService_SetDOIConfig = RpcMethod<SetDOIConfigRequest, SetDOIConfigResponse>;
22
16
  export interface ApplicationsService {
@@ -42,24 +36,11 @@ export interface ApplicationsService {
42
36
  GetAccountGroupPermissions: ApplicationsService_GetAccountGroupPermissions;
43
37
  /** Overwrites the See/Modify/Send rights that account groups have on an application, rebuilding each group's ACE rights. Use to grant or revoke group access to an app; returns the resulting permissions. */
44
38
  SaveAccountGroupPermissions: ApplicationsService_SaveAccountGroupPermissions;
45
- /** Returns the global control-group settings for an application: hold-out percentage, enabled flag, total vs control user counts and calculation status. Use to display control-group config; get_control_group_calculation_status polls just the changing counts. */
46
- GetControlGroupSettings: ApplicationsService_GetControlGroupSettings;
47
- /** Sets the global control-group hold-out percentage (1-99) for an application and records who changed it, creating the PW_ControlGroup tag if missing. Use to enable or resize the control group. */
48
- UpdateControlGroupPercentage: ApplicationsService_UpdateControlGroupPercentage;
49
- /** Disables the global control group for an application, removing its percentage setting and queuing a background job to strip the PW_ControlGroup tag from all devices. Use to turn the hold-out group off. */
50
- DisableControlGroup: ApplicationsService_DisableControlGroup;
51
- /** Kicks off a fresh recalculation of control-group and total user counts for an application, leaving the previously cached numbers in place until it finishes. Use to refresh stale size numbers on demand. */
52
- ForceUpdateControlGroupCalculation: ApplicationsService_ForceUpdateControlGroupCalculation;
53
- /** Returns just the control-group counts and calculation status that change while a background size calc runs, for an application. Poll this on a timer instead of re-fetching get_control_group_settings. */
54
- GetControlGroupCalculationStatus: ApplicationsService_GetControlGroupCalculationStatus;
55
- /** 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. */
56
- GetControlGroupAnalytics: ApplicationsService_GetControlGroupAnalytics;
57
39
  /** Returns the double opt-in (DOI) configuration for an application: whether DOI is enabled and the confirmation email preset code. Use to check DOI status before toggling with set_doi_config. */
58
40
  GetDOIConfig: ApplicationsService_GetDOIConfig;
59
41
  /** Enables or disables double opt-in (DOI) for an application; enabling for the first time clones the confirmation email preset into the account. Use to require email confirmation before subscribing. */
60
42
  SetDOIConfig: ApplicationsService_SetDOIConfig;
61
43
  }
62
- export type ControlGroupTaskStatus = 'CONTROL_GROUP_TASK_STATUS_UNSPECIFIED' | 'CONTROL_GROUP_TASK_STATUS_NOT_STARTED' | 'CONTROL_GROUP_TASK_STATUS_IN_PROGRESS' | 'CONTROL_GROUP_TASK_STATUS_COMPLETED';
63
44
  export type ApplicationPlatformSubscribersCount = {
64
45
  pushEnabled: number;
65
46
  pushDisabled: number;
@@ -206,98 +187,6 @@ export type SaveAccountGroupPermissionsRequest = {
206
187
  export type SaveAccountGroupPermissionsResponse = {
207
188
  permissions: AccountGroupPermissions[];
208
189
  };
209
- export type GetControlGroupSettingsRequest = {
210
- /** Application code (format XXXXX-XXXXX) whose control-group settings to fetch. */
211
- code?: string;
212
- };
213
- export type GetControlGroupSettingsResponse = {
214
- percentage: number;
215
- enabled: boolean;
216
- /** All users in the application */
217
- totalUsers: number;
218
- /** Users with PW_ControlGroup = true */
219
- controlGroupUsers: number;
220
- calculationStatus: ControlGroupTaskStatus;
221
- /** Last time control group settings were modified */
222
- lastModifiedAt: Date;
223
- /** Email of user who last modified settings */
224
- lastModifiedBy: string;
225
- /** Whether cached size numbers are available (false => never calculated yet) */
226
- hasData: boolean;
227
- };
228
- export type UpdateControlGroupPercentageRequest = {
229
- /** Application code (format XXXXX-XXXXX) to configure. */
230
- code?: string;
231
- /** Control-group hold-out size as a percentage, 1-99. */
232
- percentage?: number;
233
- };
234
- export type UpdateControlGroupPercentageResponse = {};
235
- export type DisableControlGroupRequest = {
236
- /** Application code (format XXXXX-XXXXX) whose control group to disable. */
237
- code?: string;
238
- };
239
- export type DisableControlGroupResponse = {};
240
- export type ForceUpdateControlGroupCalculationRequest = {
241
- /** Application code (format XXXXX-XXXXX) to recalculate control-group size for. */
242
- code?: string;
243
- };
244
- export type ForceUpdateControlGroupCalculationResponse = {};
245
- export type GetControlGroupCalculationStatusRequest = {
246
- /** Application code (format XXXXX-XXXXX) to poll calculation status for. */
247
- code?: string;
248
- };
249
- /**
250
- * GetControlGroupCalculationStatusResponse is the lightweight subset of the
251
- * settings response that changes while a background size calculation runs.
252
- * Clients poll this on a timer to refresh numbers in place without re-fetching
253
- * the whole settings page.
254
- */
255
- export type GetControlGroupCalculationStatusResponse = {
256
- /** All users in the application */
257
- totalUsers: number;
258
- /** Users with PW_ControlGroup = true */
259
- controlGroupUsers: number;
260
- calculationStatus: ControlGroupTaskStatus;
261
- /** Whether cached size numbers are available */
262
- hasData: boolean;
263
- };
264
- export type ShuffleControlGroupRequest = {
265
- code: string;
266
- };
267
- export type ShuffleControlGroupResponse = {};
268
- export type GetControlGroupAnalyticsRequest_WindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW_DAYS_3' | 'WINDOW_DAYS_7' | 'WINDOW_DAYS_30';
269
- /**
270
- * GetControlGroupAnalyticsRequest asks for the precomputed Control-vs-Treatment
271
- * analytics for a window preset (3/7/30 days).
272
- */
273
- export type GetControlGroupAnalyticsRequest = {
274
- /** Application code (format XXXXX-XXXXX) to report on. */
275
- code?: string;
276
- /** Analytics lookback window preset (3, 7 or 30 days). */
277
- windowDays?: GetControlGroupAnalyticsRequest_WindowDays;
278
- };
279
- export type ControlGroupAnalyticsGroup = {
280
- users: number;
281
- conversions: number;
282
- conversionRate: number;
283
- eventsPerUser: number;
284
- };
285
- export type ControlGroupAnalyticsEvent_Significance = 'SIGNIFICANCE_UNSPECIFIED' | 'SIGNIFICANCE_NOT_ENOUGH_DATA' | 'SIGNIFICANCE_NOT_SIGNIFICANT' | 'SIGNIFICANCE_SIGNIFICANT';
286
- export type ControlGroupAnalyticsEvent = {
287
- event: string;
288
- treatment: ControlGroupAnalyticsGroup;
289
- control: ControlGroupAnalyticsGroup;
290
- upliftPct: number;
291
- incrementalEvents: number;
292
- percentOfTreatment: number;
293
- zScore: number;
294
- pValue: number;
295
- confidencePct: number;
296
- significance: ControlGroupAnalyticsEvent_Significance;
297
- };
298
- export type GetControlGroupAnalyticsResponse = {
299
- events: ControlGroupAnalyticsEvent[];
300
- };
301
190
  export type DoubleOptInConfig = {
302
191
  enabled: boolean;
303
192
  emailPreset: string;
@@ -0,0 +1,138 @@
1
+ import { RpcMethod } from './commonTypes';
2
+ export type ApplicationsControlGroupService_GetSettings = RpcMethod<GetSettingsRequest, GetSettingsResponse>;
3
+ export type ApplicationsControlGroupService_UpdatePercentage = RpcMethod<UpdatePercentageRequest, UpdatePercentageResponse>;
4
+ export type ApplicationsControlGroupService_Disable = RpcMethod<DisableRequest, DisableResponse>;
5
+ export type ApplicationsControlGroupService_Reshuffle = RpcMethod<ReshuffleRequest, ReshuffleResponse>;
6
+ export type ApplicationsControlGroupService_ForceUpdateCalculation = RpcMethod<ForceUpdateCalculationRequest, ForceUpdateCalculationResponse>;
7
+ export type ApplicationsControlGroupService_GetCalculationStatus = RpcMethod<GetCalculationStatusRequest, GetCalculationStatusResponse>;
8
+ export type ApplicationsControlGroupService_GetAnalytics = RpcMethod<GetAnalyticsRequest, GetAnalyticsResponse>;
9
+ /**
10
+ * Global Control Group: a hold-out of an application's users that receives no
11
+ * marketing messages, so the effect of messaging can be measured against it.
12
+ *
13
+ * Membership is a deterministic function of the user id, the application, the
14
+ * group generation and the hold-out size -- nothing is stored per user. Resizing
15
+ * keeps every existing member; only a reshuffle draws a new sample.
16
+ */
17
+ export interface ApplicationsControlGroupService {
18
+ /** 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. */
19
+ GetSettings: ApplicationsControlGroupService_GetSettings;
20
+ /**
21
+ * 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.
22
+ *
23
+ * Membership is computed, not stored, so enabling covers the whole user base immediately -- there is no backfill to wait for.
24
+ */
25
+ UpdatePercentage: ApplicationsControlGroupService_UpdatePercentage;
26
+ /**
27
+ * 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.
28
+ *
29
+ * Re-enabling afterwards produces the very same hold-out unless the group is reshuffled, because membership is a deterministic function of the user id.
30
+ */
31
+ Disable: ApplicationsControlGroupService_Disable;
32
+ /** 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. */
33
+ Reshuffle: ApplicationsControlGroupService_Reshuffle;
34
+ /** Kicks off a fresh recalculation of the application's user count, leaving the previously cached number in place until it finishes. Use to refresh a stale size on demand. */
35
+ ForceUpdateCalculation: ApplicationsControlGroupService_ForceUpdateCalculation;
36
+ /** 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. */
37
+ GetCalculationStatus: ApplicationsControlGroupService_GetCalculationStatus;
38
+ /** 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. */
39
+ GetAnalytics: ApplicationsControlGroupService_GetAnalytics;
40
+ }
41
+ export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
42
+ export type GetSettingsRequest = {
43
+ /** Application code (format XXXXX-XXXXX) whose control-group settings to fetch. */
44
+ code?: string;
45
+ };
46
+ export type GetSettingsResponse = {
47
+ percentage: number;
48
+ enabled: boolean;
49
+ /** All users in the application */
50
+ totalUsers: number;
51
+ /** Users held out, derived from percentage and total_users */
52
+ controlGroupUsers: number;
53
+ calculationStatus: TaskStatus;
54
+ /** Last time control group settings were modified */
55
+ lastModifiedAt: Date;
56
+ /** Email of user who last modified settings */
57
+ lastModifiedBy: string;
58
+ /** Whether cached size numbers are available (false => never calculated yet) */
59
+ hasData: boolean;
60
+ /** Incremented by every reshuffle; 0 means never reshuffled */
61
+ generation: number;
62
+ };
63
+ export type UpdatePercentageRequest = {
64
+ /** Application code (format XXXXX-XXXXX) to configure. */
65
+ code?: string;
66
+ /** Control-group hold-out size as a percentage, 1-20. */
67
+ percentage?: number;
68
+ };
69
+ export type UpdatePercentageResponse = {};
70
+ export type ReshuffleRequest = {
71
+ /** Application code (format XXXXX-XXXXX) whose control group to redraw. */
72
+ code?: string;
73
+ };
74
+ export type ReshuffleResponse = {
75
+ /** Generation after the reshuffle. */
76
+ generation: number;
77
+ };
78
+ export type DisableRequest = {
79
+ /** Application code (format XXXXX-XXXXX) whose control group to disable. */
80
+ code?: string;
81
+ };
82
+ export type DisableResponse = {};
83
+ export type ForceUpdateCalculationRequest = {
84
+ /** Application code (format XXXXX-XXXXX) to recalculate the user count for. */
85
+ code?: string;
86
+ };
87
+ export type ForceUpdateCalculationResponse = {};
88
+ export type GetCalculationStatusRequest = {
89
+ /** Application code (format XXXXX-XXXXX) to poll calculation status for. */
90
+ code?: string;
91
+ };
92
+ /**
93
+ * GetCalculationStatusResponse is the lightweight subset of the settings
94
+ * response that changes while a background size calculation runs. Clients poll
95
+ * this on a timer to refresh numbers in place without re-fetching the whole page.
96
+ */
97
+ export type GetCalculationStatusResponse = {
98
+ /** All users in the application */
99
+ totalUsers: number;
100
+ /** Users held out, derived from percentage and total_users */
101
+ controlGroupUsers: number;
102
+ calculationStatus: TaskStatus;
103
+ /** Whether cached size numbers are available */
104
+ hasData: boolean;
105
+ };
106
+ export type GetAnalyticsRequest_WindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW_DAYS_3' | 'WINDOW_DAYS_7' | 'WINDOW_DAYS_30';
107
+ /**
108
+ * GetAnalyticsRequest asks for the precomputed Control-vs-Treatment analytics
109
+ * for a window preset (3/7/30 days).
110
+ */
111
+ export type GetAnalyticsRequest = {
112
+ /** Application code (format XXXXX-XXXXX) to report on. */
113
+ code?: string;
114
+ /** Analytics lookback window preset (3, 7 or 30 days). */
115
+ windowDays?: GetAnalyticsRequest_WindowDays;
116
+ };
117
+ export type AnalyticsGroup = {
118
+ users: number;
119
+ conversions: number;
120
+ conversionRate: number;
121
+ eventsPerUser: number;
122
+ };
123
+ export type AnalyticsEvent_Significance = 'SIGNIFICANCE_UNSPECIFIED' | 'SIGNIFICANCE_NOT_ENOUGH_DATA' | 'SIGNIFICANCE_NOT_SIGNIFICANT' | 'SIGNIFICANCE_SIGNIFICANT';
124
+ export type AnalyticsEvent = {
125
+ event: string;
126
+ treatment: AnalyticsGroup;
127
+ control: AnalyticsGroup;
128
+ upliftPct: number;
129
+ incrementalEvents: number;
130
+ percentOfTreatment: number;
131
+ zScore: number;
132
+ pValue: number;
133
+ confidencePct: number;
134
+ significance: AnalyticsEvent_Significance;
135
+ };
136
+ export type GetAnalyticsResponse = {
137
+ events: AnalyticsEvent[];
138
+ };
@@ -0,0 +1,3 @@
1
+ /* eslint-disable */
2
+ /* Autogenerated code */
3
+ export {};
package/data.js CHANGED
@@ -4875,42 +4875,6 @@ export const data = {
4875
4875
  "method": "put",
4876
4876
  "path": "/api/applications/{code}/account_group_permissions"
4877
4877
  },
4878
- "GetControlGroupSettings": {
4879
- "request": "pushwoosh.rpc_v2.applications.GetControlGroupSettingsRequest",
4880
- "response": "pushwoosh.rpc_v2.applications.GetControlGroupSettingsResponse",
4881
- "method": "get",
4882
- "path": "/api/applications/{code}/control_group"
4883
- },
4884
- "UpdateControlGroupPercentage": {
4885
- "request": "pushwoosh.rpc_v2.applications.UpdateControlGroupPercentageRequest",
4886
- "response": "pushwoosh.rpc_v2.applications.UpdateControlGroupPercentageResponse",
4887
- "method": "post",
4888
- "path": "/api/applications/{code}/control_group"
4889
- },
4890
- "DisableControlGroup": {
4891
- "request": "pushwoosh.rpc_v2.applications.DisableControlGroupRequest",
4892
- "response": "pushwoosh.rpc_v2.applications.DisableControlGroupResponse",
4893
- "method": "delete",
4894
- "path": "/api/applications/{code}/control_group"
4895
- },
4896
- "ForceUpdateControlGroupCalculation": {
4897
- "request": "pushwoosh.rpc_v2.applications.ForceUpdateControlGroupCalculationRequest",
4898
- "response": "pushwoosh.rpc_v2.applications.ForceUpdateControlGroupCalculationResponse",
4899
- "method": "post",
4900
- "path": "/api/applications/{code}/control_group/recalculate"
4901
- },
4902
- "GetControlGroupCalculationStatus": {
4903
- "request": "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusRequest",
4904
- "response": "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusResponse",
4905
- "method": "get",
4906
- "path": "/api/applications/{code}/control_group/calculation_status"
4907
- },
4908
- "GetControlGroupAnalytics": {
4909
- "request": "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest",
4910
- "response": "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsResponse",
4911
- "method": "get",
4912
- "path": "/api/applications/{code}/control_group/analytics"
4913
- },
4914
4878
  "GetDOIConfig": {
4915
4879
  "request": "pushwoosh.rpc_v2.applications.GetDOIConfigRequest",
4916
4880
  "response": "pushwoosh.rpc_v2.applications.GetDOIConfigResponse",
@@ -4925,15 +4889,6 @@ export const data = {
4925
4889
  }
4926
4890
  }
4927
4891
  },
4928
- "pushwoosh.rpc_v2.applications.ControlGroupTaskStatus": {
4929
- "type": "E",
4930
- "values": [
4931
- "CONTROL_GROUP_TASK_STATUS_UNSPECIFIED",
4932
- "CONTROL_GROUP_TASK_STATUS_NOT_STARTED",
4933
- "CONTROL_GROUP_TASK_STATUS_IN_PROGRESS",
4934
- "CONTROL_GROUP_TASK_STATUS_COMPLETED"
4935
- ]
4936
- },
4937
4892
  "pushwoosh.rpc_v2.applications.ApplicationPlatformSubscribersCount": {
4938
4893
  "type": "I",
4939
4894
  "fields": {
@@ -5294,209 +5249,6 @@ export const data = {
5294
5249
  }
5295
5250
  }
5296
5251
  },
5297
- "pushwoosh.rpc_v2.applications.GetControlGroupSettingsRequest": {
5298
- "type": "I",
5299
- "fields": {
5300
- "code": {
5301
- "type": "string"
5302
- }
5303
- }
5304
- },
5305
- "pushwoosh.rpc_v2.applications.GetControlGroupSettingsResponse": {
5306
- "type": "I",
5307
- "fields": {
5308
- "percentage": {
5309
- "type": "number"
5310
- },
5311
- "enabled": {
5312
- "type": "boolean"
5313
- },
5314
- "totalUsers": {
5315
- "type": "number"
5316
- },
5317
- "controlGroupUsers": {
5318
- "type": "number"
5319
- },
5320
- "calculationStatus": {
5321
- "type": "pushwoosh.rpc_v2.applications.ControlGroupTaskStatus"
5322
- },
5323
- "lastModifiedAt": {
5324
- "type": "Date"
5325
- },
5326
- "lastModifiedBy": {
5327
- "type": "string"
5328
- },
5329
- "hasData": {
5330
- "type": "boolean"
5331
- }
5332
- }
5333
- },
5334
- "pushwoosh.rpc_v2.applications.UpdateControlGroupPercentageRequest": {
5335
- "type": "I",
5336
- "fields": {
5337
- "code": {
5338
- "type": "string"
5339
- },
5340
- "percentage": {
5341
- "type": "number"
5342
- }
5343
- }
5344
- },
5345
- "pushwoosh.rpc_v2.applications.UpdateControlGroupPercentageResponse": {
5346
- "type": "I",
5347
- "fields": {}
5348
- },
5349
- "pushwoosh.rpc_v2.applications.DisableControlGroupRequest": {
5350
- "type": "I",
5351
- "fields": {
5352
- "code": {
5353
- "type": "string"
5354
- }
5355
- }
5356
- },
5357
- "pushwoosh.rpc_v2.applications.DisableControlGroupResponse": {
5358
- "type": "I",
5359
- "fields": {}
5360
- },
5361
- "pushwoosh.rpc_v2.applications.ForceUpdateControlGroupCalculationRequest": {
5362
- "type": "I",
5363
- "fields": {
5364
- "code": {
5365
- "type": "string"
5366
- }
5367
- }
5368
- },
5369
- "pushwoosh.rpc_v2.applications.ForceUpdateControlGroupCalculationResponse": {
5370
- "type": "I",
5371
- "fields": {}
5372
- },
5373
- "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusRequest": {
5374
- "type": "I",
5375
- "fields": {
5376
- "code": {
5377
- "type": "string"
5378
- }
5379
- }
5380
- },
5381
- "pushwoosh.rpc_v2.applications.GetControlGroupCalculationStatusResponse": {
5382
- "type": "I",
5383
- "fields": {
5384
- "totalUsers": {
5385
- "type": "number"
5386
- },
5387
- "controlGroupUsers": {
5388
- "type": "number"
5389
- },
5390
- "calculationStatus": {
5391
- "type": "pushwoosh.rpc_v2.applications.ControlGroupTaskStatus"
5392
- },
5393
- "hasData": {
5394
- "type": "boolean"
5395
- }
5396
- }
5397
- },
5398
- "pushwoosh.rpc_v2.applications.ShuffleControlGroupRequest": {
5399
- "type": "I",
5400
- "fields": {
5401
- "code": {
5402
- "type": "string"
5403
- }
5404
- }
5405
- },
5406
- "pushwoosh.rpc_v2.applications.ShuffleControlGroupResponse": {
5407
- "type": "I",
5408
- "fields": {}
5409
- },
5410
- "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest.WindowDays": {
5411
- "type": "E",
5412
- "values": [
5413
- "WINDOW_DAYS_UNSPECIFIED",
5414
- "WINDOW_DAYS_3",
5415
- "WINDOW_DAYS_7",
5416
- "WINDOW_DAYS_30"
5417
- ]
5418
- },
5419
- "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest": {
5420
- "type": "I",
5421
- "fields": {
5422
- "code": {
5423
- "type": "string"
5424
- },
5425
- "windowDays": {
5426
- "type": "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsRequest.WindowDays"
5427
- }
5428
- }
5429
- },
5430
- "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsGroup": {
5431
- "type": "I",
5432
- "fields": {
5433
- "users": {
5434
- "type": "number"
5435
- },
5436
- "conversions": {
5437
- "type": "number"
5438
- },
5439
- "conversionRate": {
5440
- "type": "number"
5441
- },
5442
- "eventsPerUser": {
5443
- "type": "number"
5444
- }
5445
- }
5446
- },
5447
- "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent.Significance": {
5448
- "type": "E",
5449
- "values": [
5450
- "SIGNIFICANCE_UNSPECIFIED",
5451
- "SIGNIFICANCE_NOT_ENOUGH_DATA",
5452
- "SIGNIFICANCE_NOT_SIGNIFICANT",
5453
- "SIGNIFICANCE_SIGNIFICANT"
5454
- ]
5455
- },
5456
- "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent": {
5457
- "type": "I",
5458
- "fields": {
5459
- "event": {
5460
- "type": "string"
5461
- },
5462
- "treatment": {
5463
- "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsGroup"
5464
- },
5465
- "control": {
5466
- "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsGroup"
5467
- },
5468
- "upliftPct": {
5469
- "type": "number"
5470
- },
5471
- "incrementalEvents": {
5472
- "type": "number"
5473
- },
5474
- "percentOfTreatment": {
5475
- "type": "number"
5476
- },
5477
- "zScore": {
5478
- "type": "number"
5479
- },
5480
- "pValue": {
5481
- "type": "number"
5482
- },
5483
- "confidencePct": {
5484
- "type": "number"
5485
- },
5486
- "significance": {
5487
- "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent.Significance"
5488
- }
5489
- }
5490
- },
5491
- "pushwoosh.rpc_v2.applications.GetControlGroupAnalyticsResponse": {
5492
- "type": "I",
5493
- "fields": {
5494
- "events": {
5495
- "type": "pushwoosh.rpc_v2.applications.ControlGroupAnalyticsEvent",
5496
- "array": true
5497
- }
5498
- }
5499
- },
5500
5252
  "pushwoosh.rpc_v2.applications.DoubleOptInConfig": {
5501
5253
  "type": "I",
5502
5254
  "fields": {
@@ -6507,6 +6259,273 @@ export const data = {
6507
6259
  "type": "I",
6508
6260
  "fields": {}
6509
6261
  },
6262
+ "pushwoosh.rpc_v2.applications_controlgroup.ApplicationsControlGroupService": {
6263
+ "type": "S",
6264
+ "key": "applicationsControlGroup",
6265
+ "methods": {
6266
+ "GetSettings": {
6267
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsRequest",
6268
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsResponse",
6269
+ "method": "get",
6270
+ "path": "/api/applications/{code}/control_group"
6271
+ },
6272
+ "UpdatePercentage": {
6273
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageRequest",
6274
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageResponse",
6275
+ "method": "post",
6276
+ "path": "/api/applications/{code}/control_group"
6277
+ },
6278
+ "Disable": {
6279
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.DisableRequest",
6280
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.DisableResponse",
6281
+ "method": "delete",
6282
+ "path": "/api/applications/{code}/control_group"
6283
+ },
6284
+ "Reshuffle": {
6285
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleRequest",
6286
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleResponse",
6287
+ "method": "post",
6288
+ "path": "/api/applications/{code}/control_group/reshuffle"
6289
+ },
6290
+ "ForceUpdateCalculation": {
6291
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationRequest",
6292
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationResponse",
6293
+ "method": "post",
6294
+ "path": "/api/applications/{code}/control_group/recalculate"
6295
+ },
6296
+ "GetCalculationStatus": {
6297
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusRequest",
6298
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusResponse",
6299
+ "method": "get",
6300
+ "path": "/api/applications/{code}/control_group/calculation_status"
6301
+ },
6302
+ "GetAnalytics": {
6303
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest",
6304
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse",
6305
+ "method": "get",
6306
+ "path": "/api/applications/{code}/control_group/analytics"
6307
+ }
6308
+ }
6309
+ },
6310
+ "pushwoosh.rpc_v2.applications_controlgroup.TaskStatus": {
6311
+ "type": "E",
6312
+ "values": [
6313
+ "TASK_STATUS_UNSPECIFIED",
6314
+ "TASK_STATUS_NOT_STARTED",
6315
+ "TASK_STATUS_IN_PROGRESS",
6316
+ "TASK_STATUS_COMPLETED"
6317
+ ]
6318
+ },
6319
+ "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsRequest": {
6320
+ "type": "I",
6321
+ "fields": {
6322
+ "code": {
6323
+ "type": "string"
6324
+ }
6325
+ }
6326
+ },
6327
+ "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsResponse": {
6328
+ "type": "I",
6329
+ "fields": {
6330
+ "percentage": {
6331
+ "type": "number"
6332
+ },
6333
+ "enabled": {
6334
+ "type": "boolean"
6335
+ },
6336
+ "totalUsers": {
6337
+ "type": "number"
6338
+ },
6339
+ "controlGroupUsers": {
6340
+ "type": "number"
6341
+ },
6342
+ "calculationStatus": {
6343
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.TaskStatus"
6344
+ },
6345
+ "lastModifiedAt": {
6346
+ "type": "Date"
6347
+ },
6348
+ "lastModifiedBy": {
6349
+ "type": "string"
6350
+ },
6351
+ "hasData": {
6352
+ "type": "boolean"
6353
+ },
6354
+ "generation": {
6355
+ "type": "number"
6356
+ }
6357
+ }
6358
+ },
6359
+ "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageRequest": {
6360
+ "type": "I",
6361
+ "fields": {
6362
+ "code": {
6363
+ "type": "string"
6364
+ },
6365
+ "percentage": {
6366
+ "type": "number"
6367
+ }
6368
+ }
6369
+ },
6370
+ "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageResponse": {
6371
+ "type": "I",
6372
+ "fields": {}
6373
+ },
6374
+ "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleRequest": {
6375
+ "type": "I",
6376
+ "fields": {
6377
+ "code": {
6378
+ "type": "string"
6379
+ }
6380
+ }
6381
+ },
6382
+ "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleResponse": {
6383
+ "type": "I",
6384
+ "fields": {
6385
+ "generation": {
6386
+ "type": "number"
6387
+ }
6388
+ }
6389
+ },
6390
+ "pushwoosh.rpc_v2.applications_controlgroup.DisableRequest": {
6391
+ "type": "I",
6392
+ "fields": {
6393
+ "code": {
6394
+ "type": "string"
6395
+ }
6396
+ }
6397
+ },
6398
+ "pushwoosh.rpc_v2.applications_controlgroup.DisableResponse": {
6399
+ "type": "I",
6400
+ "fields": {}
6401
+ },
6402
+ "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationRequest": {
6403
+ "type": "I",
6404
+ "fields": {
6405
+ "code": {
6406
+ "type": "string"
6407
+ }
6408
+ }
6409
+ },
6410
+ "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationResponse": {
6411
+ "type": "I",
6412
+ "fields": {}
6413
+ },
6414
+ "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusRequest": {
6415
+ "type": "I",
6416
+ "fields": {
6417
+ "code": {
6418
+ "type": "string"
6419
+ }
6420
+ }
6421
+ },
6422
+ "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusResponse": {
6423
+ "type": "I",
6424
+ "fields": {
6425
+ "totalUsers": {
6426
+ "type": "number"
6427
+ },
6428
+ "controlGroupUsers": {
6429
+ "type": "number"
6430
+ },
6431
+ "calculationStatus": {
6432
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.TaskStatus"
6433
+ },
6434
+ "hasData": {
6435
+ "type": "boolean"
6436
+ }
6437
+ }
6438
+ },
6439
+ "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest.WindowDays": {
6440
+ "type": "E",
6441
+ "values": [
6442
+ "WINDOW_DAYS_UNSPECIFIED",
6443
+ "WINDOW_DAYS_3",
6444
+ "WINDOW_DAYS_7",
6445
+ "WINDOW_DAYS_30"
6446
+ ]
6447
+ },
6448
+ "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest": {
6449
+ "type": "I",
6450
+ "fields": {
6451
+ "code": {
6452
+ "type": "string"
6453
+ },
6454
+ "windowDays": {
6455
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest.WindowDays"
6456
+ }
6457
+ }
6458
+ },
6459
+ "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsGroup": {
6460
+ "type": "I",
6461
+ "fields": {
6462
+ "users": {
6463
+ "type": "number"
6464
+ },
6465
+ "conversions": {
6466
+ "type": "number"
6467
+ },
6468
+ "conversionRate": {
6469
+ "type": "number"
6470
+ },
6471
+ "eventsPerUser": {
6472
+ "type": "number"
6473
+ }
6474
+ }
6475
+ },
6476
+ "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsEvent.Significance": {
6477
+ "type": "E",
6478
+ "values": [
6479
+ "SIGNIFICANCE_UNSPECIFIED",
6480
+ "SIGNIFICANCE_NOT_ENOUGH_DATA",
6481
+ "SIGNIFICANCE_NOT_SIGNIFICANT",
6482
+ "SIGNIFICANCE_SIGNIFICANT"
6483
+ ]
6484
+ },
6485
+ "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsEvent": {
6486
+ "type": "I",
6487
+ "fields": {
6488
+ "event": {
6489
+ "type": "string"
6490
+ },
6491
+ "treatment": {
6492
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsGroup"
6493
+ },
6494
+ "control": {
6495
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsGroup"
6496
+ },
6497
+ "upliftPct": {
6498
+ "type": "number"
6499
+ },
6500
+ "incrementalEvents": {
6501
+ "type": "number"
6502
+ },
6503
+ "percentOfTreatment": {
6504
+ "type": "number"
6505
+ },
6506
+ "zScore": {
6507
+ "type": "number"
6508
+ },
6509
+ "pValue": {
6510
+ "type": "number"
6511
+ },
6512
+ "confidencePct": {
6513
+ "type": "number"
6514
+ },
6515
+ "significance": {
6516
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsEvent.Significance"
6517
+ }
6518
+ }
6519
+ },
6520
+ "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse": {
6521
+ "type": "I",
6522
+ "fields": {
6523
+ "events": {
6524
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsEvent",
6525
+ "array": true
6526
+ }
6527
+ }
6528
+ },
6510
6529
  "pushwoosh.rpc_v2.applications_groups.ApplicationsGroupsService": {
6511
6530
  "type": "S",
6512
6531
  "key": "applicationsGroups",
package/index.d.ts CHANGED
@@ -11,6 +11,7 @@ import { ApplicationEmailFromsService as pushwoosh_rpc_v2_applications_email_fro
11
11
  import { ApplicationSoundsService as pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService } from './applications_sounds';
12
12
  import { ApplicationsAlertsService as pushwoosh_rpc_v2_applications_alerts_ApplicationsAlertsService } from './applications_alerts';
13
13
  import { ApplicationsConfigurationsService as pushwoosh_rpc_v2_applications_configurations_ApplicationsConfigurationsService } from './applications_configurations';
14
+ import { ApplicationsControlGroupService as pushwoosh_rpc_v2_applications_controlgroup_ApplicationsControlGroupService } from './applications_controlgroup';
14
15
  import { ApplicationsGroupsService as pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService } from './applications_groups';
15
16
  import { ApplicationsInfoService as pushwoosh_rpc_v2_applications_info_ApplicationsInfoService } from './applications_info';
16
17
  import { ApplicationsStatisticsService as pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService } from './applications_statistics';
@@ -79,6 +80,7 @@ export type API = {
79
80
  applicationSounds: pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService;
80
81
  applicationsAlerts: pushwoosh_rpc_v2_applications_alerts_ApplicationsAlertsService;
81
82
  applicationsConfigurations: pushwoosh_rpc_v2_applications_configurations_ApplicationsConfigurationsService;
83
+ applicationsControlGroup: pushwoosh_rpc_v2_applications_controlgroup_ApplicationsControlGroupService;
82
84
  applicationsGroups: pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService;
83
85
  applicationsInfo: pushwoosh_rpc_v2_applications_info_ApplicationsInfoService;
84
86
  applicationsStatistics: pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.151",
3
+ "version": "0.2.152",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",