@pushwoosh/rpc-v2-http-api-data 0.2.171 → 0.2.172

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.
@@ -6,6 +6,16 @@ export type ApplicationsControlGroupService_Reshuffle = RpcMethod<ReshuffleReque
6
6
  export type ApplicationsControlGroupService_ForceUpdateCalculation = RpcMethod<ForceUpdateCalculationRequest, ForceUpdateCalculationResponse>;
7
7
  export type ApplicationsControlGroupService_GetCalculationStatus = RpcMethod<GetCalculationStatusRequest, GetCalculationStatusResponse>;
8
8
  export type ApplicationsControlGroupService_GetAnalytics = RpcMethod<GetAnalyticsRequest, GetAnalyticsResponse>;
9
+ export type ApplicationsControlGroupService_ListControlGroups = RpcMethod<ListControlGroupsRequest, ListControlGroupsResponse>;
10
+ export type ApplicationsControlGroupService_CreateControlGroup = RpcMethod<CreateControlGroupRequest, CreateControlGroupResponse>;
11
+ export type ApplicationsControlGroupService_GetControlGroup = RpcMethod<GetControlGroupRequest, GetControlGroupResponse>;
12
+ export type ApplicationsControlGroupService_DeleteControlGroup = RpcMethod<DeleteControlGroupRequest, DeleteControlGroupResponse>;
13
+ export type ApplicationsControlGroupService_UpdateControlGroupPercentage = RpcMethod<UpdateControlGroupPercentageRequest, UpdateControlGroupPercentageResponse>;
14
+ export type ApplicationsControlGroupService_DisableControlGroup = RpcMethod<DisableControlGroupRequest, DisableControlGroupResponse>;
15
+ export type ApplicationsControlGroupService_ReshuffleControlGroup = RpcMethod<ReshuffleControlGroupRequest, ReshuffleControlGroupResponse>;
16
+ export type ApplicationsControlGroupService_ForceUpdateControlGroupCalculation = RpcMethod<ForceUpdateControlGroupCalculationRequest, ForceUpdateControlGroupCalculationResponse>;
17
+ export type ApplicationsControlGroupService_GetControlGroupCalculationStatus = RpcMethod<GetControlGroupCalculationStatusRequest, GetCalculationStatusResponse>;
18
+ export type ApplicationsControlGroupService_GetControlGroupAnalytics = RpcMethod<GetControlGroupAnalyticsRequest, GetAnalyticsResponse>;
9
19
  /**
10
20
  * Global Control Group: a hold-out of an application's users that receives no
11
21
  * marketing messages, so the effect of messaging can be measured against it.
@@ -37,6 +47,26 @@ export interface ApplicationsControlGroupService {
37
47
  GetCalculationStatus: ApplicationsControlGroupService_GetCalculationStatus;
38
48
  /** 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
49
  GetAnalytics: ApplicationsControlGroupService_GetAnalytics;
50
+ /** 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. */
51
+ ListControlGroups: ApplicationsControlGroupService_ListControlGroups;
52
+ /** 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. */
53
+ CreateControlGroup: ApplicationsControlGroupService_CreateControlGroup;
54
+ /** Returns one control group by its code, with its hold-out size, generation and the user counts behind it. */
55
+ GetControlGroup: ApplicationsControlGroupService_GetControlGroup;
56
+ /** Removes a control group entirely. Deleting the default one leaves the application without a fallback, so sends hold nobody out until a group is created again. To stop holding users out while keeping the group, disable it instead. */
57
+ DeleteControlGroup: ApplicationsControlGroupService_DeleteControlGroup;
58
+ /** Sets the hold-out percentage (1-20) of one control group. Resizing keeps every existing member: the hold-out grows or shrinks around them rather than being redrawn. */
59
+ UpdateControlGroupPercentage: ApplicationsControlGroupService_UpdateControlGroupPercentage;
60
+ /** Switches one control group off, keeping it and its generation so that switching it back on restores the same hold-out rather than drawing a new one. */
61
+ DisableControlGroup: ApplicationsControlGroupService_DisableControlGroup;
62
+ /** Redraws one control group's hold-out by incrementing its generation. This is the only way to get a different sample: membership is deterministic, so disabling and re-enabling reproduces exactly the same one. */
63
+ ReshuffleControlGroup: ApplicationsControlGroupService_ReshuffleControlGroup;
64
+ /** Starts a fresh count of one control group's size. The previously cached numbers keep being served until the new count finishes. */
65
+ ForceUpdateControlGroupCalculation: ApplicationsControlGroupService_ForceUpdateControlGroupCalculation;
66
+ /** Polls just the changing user counts of one control group while a size calculation runs. */
67
+ GetControlGroupCalculationStatus: ApplicationsControlGroupService_GetControlGroupCalculationStatus;
68
+ /** 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. */
69
+ GetControlGroupAnalytics: ApplicationsControlGroupService_GetControlGroupAnalytics;
40
70
  }
41
71
  export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
42
72
  export type GetSettingsRequest = {
@@ -114,6 +144,115 @@ export type GetAnalyticsRequest = {
114
144
  /** Analytics lookback window preset (3, 7 or 30 days). */
115
145
  windowDays?: GetAnalyticsRequest_WindowDays;
116
146
  };
147
+ /** ControlGroup is one configured control group of an application. */
148
+ export type ControlGroup = {
149
+ /** Control group code (format XXXXX-XXXXX), stable for the life of the group. */
150
+ code: string;
151
+ /** Group name; empty is the application's original, unnamed group. */
152
+ name: string;
153
+ /** Seglang expression the group is measured over; empty is the whole base. */
154
+ segment: string;
155
+ /** Hold-out size as a percentage, 1-20. Zero means the group is off. */
156
+ percentage: number;
157
+ enabled: boolean;
158
+ /** Whether a send that does not name a group falls back to this one. */
159
+ isDefault: boolean;
160
+ /** Incremented by every reshuffle; 0 means never reshuffled. */
161
+ generation: number;
162
+ lastModifiedAt: Date;
163
+ /** Email of the user who last changed the group. */
164
+ lastModifiedBy: string;
165
+ };
166
+ export type ListControlGroupsRequest = {
167
+ /** Application code (format XXXXX-XXXXX) whose control groups to list. */
168
+ code?: string;
169
+ };
170
+ export type ListControlGroupsResponse = {
171
+ controlGroups: ControlGroup[];
172
+ };
173
+ export type CreateControlGroupRequest = {
174
+ /** Application code (format XXXXX-XXXXX) to create the group for. */
175
+ code?: string;
176
+ /** Group name, up to 64 characters and without a colon. Must be unique within the application. */
177
+ name?: string;
178
+ /** Hold-out size as a percentage, 1-20. */
179
+ percentage?: number;
180
+ /** Seglang expression to measure the group over; empty means the whole base. */
181
+ segment?: string;
182
+ };
183
+ export type CreateControlGroupResponse = {
184
+ group: ControlGroup;
185
+ };
186
+ export type GetControlGroupRequest = {
187
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
188
+ code?: string;
189
+ /** Control group code (format XXXXX-XXXXX) to fetch. */
190
+ controlGroupCode?: string;
191
+ };
192
+ export type GetControlGroupResponse = {
193
+ group: ControlGroup;
194
+ /** All users in the application */
195
+ totalUsers: number;
196
+ /** Users held out */
197
+ controlGroupUsers: number;
198
+ calculationStatus: TaskStatus;
199
+ /** Whether cached size numbers are available */
200
+ hasData: boolean;
201
+ };
202
+ export type DeleteControlGroupRequest = {
203
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
204
+ code?: string;
205
+ /** Control group code (format XXXXX-XXXXX) to delete. */
206
+ controlGroupCode?: string;
207
+ };
208
+ export type DeleteControlGroupResponse = {};
209
+ export type UpdateControlGroupPercentageRequest = {
210
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
211
+ code?: string;
212
+ /** Control group code (format XXXXX-XXXXX) to resize. */
213
+ controlGroupCode?: string;
214
+ /** Hold-out size as a percentage, 1-20. */
215
+ percentage?: number;
216
+ };
217
+ export type UpdateControlGroupPercentageResponse = {};
218
+ export type DisableControlGroupRequest = {
219
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
220
+ code?: string;
221
+ /** Control group code (format XXXXX-XXXXX) to switch off. */
222
+ controlGroupCode?: string;
223
+ };
224
+ export type DisableControlGroupResponse = {};
225
+ export type ReshuffleControlGroupRequest = {
226
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
227
+ code?: string;
228
+ /** Control group code (format XXXXX-XXXXX) to redraw. */
229
+ controlGroupCode?: string;
230
+ };
231
+ export type ReshuffleControlGroupResponse = {
232
+ /** Generation after the reshuffle. */
233
+ generation: number;
234
+ };
235
+ export type ForceUpdateControlGroupCalculationRequest = {
236
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
237
+ code?: string;
238
+ /** Control group code (format XXXXX-XXXXX) to recount. */
239
+ controlGroupCode?: string;
240
+ };
241
+ export type ForceUpdateControlGroupCalculationResponse = {};
242
+ export type GetControlGroupCalculationStatusRequest = {
243
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
244
+ code?: string;
245
+ /** Control group code (format XXXXX-XXXXX) to poll. */
246
+ controlGroupCode?: string;
247
+ };
248
+ export type GetControlGroupAnalyticsRequest = {
249
+ /** Application code (format XXXXX-XXXXX) the group belongs to. */
250
+ code?: string;
251
+ /** Control group code (format XXXXX-XXXXX) to report on. */
252
+ controlGroupCode?: string;
253
+ /** Analytics lookback window preset (3, 7 or 30 days). */
254
+ windowDays?: GetAnalyticsRequest_WindowDays;
255
+ };
117
256
  export type AnalyticsGroup = {
118
257
  users: number;
119
258
  conversions: number;
package/data.js CHANGED
@@ -6340,6 +6340,66 @@ export const data = {
6340
6340
  "response": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse",
6341
6341
  "method": "get",
6342
6342
  "path": "/api/applications/{code}/control_group/analytics"
6343
+ },
6344
+ "ListControlGroups": {
6345
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsRequest",
6346
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsResponse",
6347
+ "method": "get",
6348
+ "path": "/api/applications/{code}/control_groups"
6349
+ },
6350
+ "CreateControlGroup": {
6351
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.CreateControlGroupRequest",
6352
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.CreateControlGroupResponse",
6353
+ "method": "post",
6354
+ "path": "/api/applications/{code}/control_groups"
6355
+ },
6356
+ "GetControlGroup": {
6357
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupRequest",
6358
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupResponse",
6359
+ "method": "get",
6360
+ "path": "/api/applications/{code}/control_groups/{control_group_code}"
6361
+ },
6362
+ "DeleteControlGroup": {
6363
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.DeleteControlGroupRequest",
6364
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.DeleteControlGroupResponse",
6365
+ "method": "delete",
6366
+ "path": "/api/applications/{code}/control_groups/{control_group_code}"
6367
+ },
6368
+ "UpdateControlGroupPercentage": {
6369
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupPercentageRequest",
6370
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupPercentageResponse",
6371
+ "method": "post",
6372
+ "path": "/api/applications/{code}/control_groups/{control_group_code}"
6373
+ },
6374
+ "DisableControlGroup": {
6375
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupRequest",
6376
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupResponse",
6377
+ "method": "post",
6378
+ "path": "/api/applications/{code}/control_groups/{control_group_code}/disable"
6379
+ },
6380
+ "ReshuffleControlGroup": {
6381
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleControlGroupRequest",
6382
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleControlGroupResponse",
6383
+ "method": "post",
6384
+ "path": "/api/applications/{code}/control_groups/{control_group_code}/reshuffle"
6385
+ },
6386
+ "ForceUpdateControlGroupCalculation": {
6387
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateControlGroupCalculationRequest",
6388
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateControlGroupCalculationResponse",
6389
+ "method": "post",
6390
+ "path": "/api/applications/{code}/control_groups/{control_group_code}/recalculate"
6391
+ },
6392
+ "GetControlGroupCalculationStatus": {
6393
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupCalculationStatusRequest",
6394
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusResponse",
6395
+ "method": "get",
6396
+ "path": "/api/applications/{code}/control_groups/{control_group_code}/calculation_status"
6397
+ },
6398
+ "GetControlGroupAnalytics": {
6399
+ "request": "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupAnalyticsRequest",
6400
+ "response": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse",
6401
+ "method": "get",
6402
+ "path": "/api/applications/{code}/control_groups/{control_group_code}/analytics"
6343
6403
  }
6344
6404
  }
6345
6405
  },
@@ -6492,6 +6552,218 @@ export const data = {
6492
6552
  }
6493
6553
  }
6494
6554
  },
6555
+ "pushwoosh.rpc_v2.applications_controlgroup.ControlGroup": {
6556
+ "type": "I",
6557
+ "fields": {
6558
+ "code": {
6559
+ "type": "string"
6560
+ },
6561
+ "name": {
6562
+ "type": "string"
6563
+ },
6564
+ "segment": {
6565
+ "type": "string"
6566
+ },
6567
+ "percentage": {
6568
+ "type": "number"
6569
+ },
6570
+ "enabled": {
6571
+ "type": "boolean"
6572
+ },
6573
+ "isDefault": {
6574
+ "type": "boolean"
6575
+ },
6576
+ "generation": {
6577
+ "type": "number"
6578
+ },
6579
+ "lastModifiedAt": {
6580
+ "type": "Date"
6581
+ },
6582
+ "lastModifiedBy": {
6583
+ "type": "string"
6584
+ }
6585
+ }
6586
+ },
6587
+ "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsRequest": {
6588
+ "type": "I",
6589
+ "fields": {
6590
+ "code": {
6591
+ "type": "string"
6592
+ }
6593
+ }
6594
+ },
6595
+ "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsResponse": {
6596
+ "type": "I",
6597
+ "fields": {
6598
+ "controlGroups": {
6599
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.ControlGroup",
6600
+ "array": true
6601
+ }
6602
+ }
6603
+ },
6604
+ "pushwoosh.rpc_v2.applications_controlgroup.CreateControlGroupRequest": {
6605
+ "type": "I",
6606
+ "fields": {
6607
+ "code": {
6608
+ "type": "string"
6609
+ },
6610
+ "name": {
6611
+ "type": "string"
6612
+ },
6613
+ "percentage": {
6614
+ "type": "number"
6615
+ },
6616
+ "segment": {
6617
+ "type": "string"
6618
+ }
6619
+ }
6620
+ },
6621
+ "pushwoosh.rpc_v2.applications_controlgroup.CreateControlGroupResponse": {
6622
+ "type": "I",
6623
+ "fields": {
6624
+ "group": {
6625
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.ControlGroup"
6626
+ }
6627
+ }
6628
+ },
6629
+ "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupRequest": {
6630
+ "type": "I",
6631
+ "fields": {
6632
+ "code": {
6633
+ "type": "string"
6634
+ },
6635
+ "controlGroupCode": {
6636
+ "type": "string"
6637
+ }
6638
+ }
6639
+ },
6640
+ "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupResponse": {
6641
+ "type": "I",
6642
+ "fields": {
6643
+ "group": {
6644
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.ControlGroup"
6645
+ },
6646
+ "totalUsers": {
6647
+ "type": "number"
6648
+ },
6649
+ "controlGroupUsers": {
6650
+ "type": "number"
6651
+ },
6652
+ "calculationStatus": {
6653
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.TaskStatus"
6654
+ },
6655
+ "hasData": {
6656
+ "type": "boolean"
6657
+ }
6658
+ }
6659
+ },
6660
+ "pushwoosh.rpc_v2.applications_controlgroup.DeleteControlGroupRequest": {
6661
+ "type": "I",
6662
+ "fields": {
6663
+ "code": {
6664
+ "type": "string"
6665
+ },
6666
+ "controlGroupCode": {
6667
+ "type": "string"
6668
+ }
6669
+ }
6670
+ },
6671
+ "pushwoosh.rpc_v2.applications_controlgroup.DeleteControlGroupResponse": {
6672
+ "type": "I",
6673
+ "fields": {}
6674
+ },
6675
+ "pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupPercentageRequest": {
6676
+ "type": "I",
6677
+ "fields": {
6678
+ "code": {
6679
+ "type": "string"
6680
+ },
6681
+ "controlGroupCode": {
6682
+ "type": "string"
6683
+ },
6684
+ "percentage": {
6685
+ "type": "number"
6686
+ }
6687
+ }
6688
+ },
6689
+ "pushwoosh.rpc_v2.applications_controlgroup.UpdateControlGroupPercentageResponse": {
6690
+ "type": "I",
6691
+ "fields": {}
6692
+ },
6693
+ "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupRequest": {
6694
+ "type": "I",
6695
+ "fields": {
6696
+ "code": {
6697
+ "type": "string"
6698
+ },
6699
+ "controlGroupCode": {
6700
+ "type": "string"
6701
+ }
6702
+ }
6703
+ },
6704
+ "pushwoosh.rpc_v2.applications_controlgroup.DisableControlGroupResponse": {
6705
+ "type": "I",
6706
+ "fields": {}
6707
+ },
6708
+ "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleControlGroupRequest": {
6709
+ "type": "I",
6710
+ "fields": {
6711
+ "code": {
6712
+ "type": "string"
6713
+ },
6714
+ "controlGroupCode": {
6715
+ "type": "string"
6716
+ }
6717
+ }
6718
+ },
6719
+ "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleControlGroupResponse": {
6720
+ "type": "I",
6721
+ "fields": {
6722
+ "generation": {
6723
+ "type": "number"
6724
+ }
6725
+ }
6726
+ },
6727
+ "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateControlGroupCalculationRequest": {
6728
+ "type": "I",
6729
+ "fields": {
6730
+ "code": {
6731
+ "type": "string"
6732
+ },
6733
+ "controlGroupCode": {
6734
+ "type": "string"
6735
+ }
6736
+ }
6737
+ },
6738
+ "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateControlGroupCalculationResponse": {
6739
+ "type": "I",
6740
+ "fields": {}
6741
+ },
6742
+ "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupCalculationStatusRequest": {
6743
+ "type": "I",
6744
+ "fields": {
6745
+ "code": {
6746
+ "type": "string"
6747
+ },
6748
+ "controlGroupCode": {
6749
+ "type": "string"
6750
+ }
6751
+ }
6752
+ },
6753
+ "pushwoosh.rpc_v2.applications_controlgroup.GetControlGroupAnalyticsRequest": {
6754
+ "type": "I",
6755
+ "fields": {
6756
+ "code": {
6757
+ "type": "string"
6758
+ },
6759
+ "controlGroupCode": {
6760
+ "type": "string"
6761
+ },
6762
+ "windowDays": {
6763
+ "type": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest.WindowDays"
6764
+ }
6765
+ }
6766
+ },
6495
6767
  "pushwoosh.rpc_v2.applications_controlgroup.AnalyticsGroup": {
6496
6768
  "type": "I",
6497
6769
  "fields": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.171",
3
+ "version": "0.2.172",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",