@pushwoosh/rpc-v2-http-api-data 0.2.179 → 0.2.181

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.
@@ -1,11 +1,4 @@
1
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
2
  export type ApplicationsControlGroupService_ListControlGroups = RpcMethod<ListControlGroupsRequest, ListControlGroupsResponse>;
10
3
  export type ApplicationsControlGroupService_CreateControlGroup = RpcMethod<CreateControlGroupRequest, CreateControlGroupResponse>;
11
4
  export type ApplicationsControlGroupService_GetControlGroup = RpcMethod<GetControlGroupRequest, GetControlGroupResponse>;
@@ -25,28 +18,6 @@ export type ApplicationsControlGroupService_GetControlGroupAnalytics = RpcMethod
25
18
  * keeps every existing member; only a reshuffle draws a new sample.
26
19
  */
27
20
  export interface ApplicationsControlGroupService {
28
- /** 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. */
29
- GetSettings: ApplicationsControlGroupService_GetSettings;
30
- /**
31
- * 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.
32
- *
33
- * Membership is computed, not stored, so enabling covers the whole user base immediately -- there is no backfill to wait for.
34
- */
35
- UpdatePercentage: ApplicationsControlGroupService_UpdatePercentage;
36
- /**
37
- * 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.
38
- *
39
- * Re-enabling afterwards produces the very same hold-out unless the group is reshuffled, because membership is a deterministic function of the user id.
40
- */
41
- Disable: ApplicationsControlGroupService_Disable;
42
- /** 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. */
43
- Reshuffle: ApplicationsControlGroupService_Reshuffle;
44
- /** 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. */
45
- ForceUpdateCalculation: ApplicationsControlGroupService_ForceUpdateCalculation;
46
- /** 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. */
47
- GetCalculationStatus: ApplicationsControlGroupService_GetCalculationStatus;
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. */
49
- GetAnalytics: ApplicationsControlGroupService_GetAnalytics;
50
21
  /** 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
22
  ListControlGroups: ApplicationsControlGroupService_ListControlGroups;
52
23
  /** 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 {
69
40
  GetControlGroupAnalytics: ApplicationsControlGroupService_GetControlGroupAnalytics;
70
41
  }
71
42
  export type TaskStatus = 'TASK_STATUS_UNSPECIFIED' | 'TASK_STATUS_NOT_STARTED' | 'TASK_STATUS_IN_PROGRESS' | 'TASK_STATUS_COMPLETED';
72
- export type GetSettingsRequest = {
73
- /** Application code (format XXXXX-XXXXX) whose control-group settings to fetch. */
74
- code?: string;
75
- };
76
- export type GetSettingsResponse = {
77
- percentage: number;
78
- enabled: boolean;
79
- /** All users in the application */
80
- totalUsers: number;
81
- /** Users held out, counted over the application */
82
- controlGroupUsers: number;
83
- calculationStatus: TaskStatus;
84
- /** Last time control group settings were modified */
85
- lastModifiedAt: Date;
86
- /** Email of user who last modified settings */
87
- lastModifiedBy: string;
88
- /** Whether cached size numbers are available (false => never calculated yet) */
89
- hasData: boolean;
90
- /** Incremented by every reshuffle; 0 means never reshuffled */
91
- generation: number;
92
- };
93
- export type UpdatePercentageRequest = {
94
- /** Application code (format XXXXX-XXXXX) to configure. */
95
- code?: string;
96
- /** Control-group hold-out size as a percentage, 1-20. */
97
- percentage?: number;
98
- };
99
- export type UpdatePercentageResponse = {};
100
- export type ReshuffleRequest = {
101
- /** Application code (format XXXXX-XXXXX) whose control group to redraw. */
102
- code?: string;
103
- };
104
- export type ReshuffleResponse = {
105
- /** Generation after the reshuffle. */
106
- generation: number;
107
- };
108
- export type DisableRequest = {
109
- /** Application code (format XXXXX-XXXXX) whose control group to disable. */
110
- code?: string;
111
- };
112
- export type DisableResponse = {};
113
- export type ForceUpdateCalculationRequest = {
114
- /** Application code (format XXXXX-XXXXX) to recalculate the user count for. */
115
- code?: string;
116
- };
117
- export type ForceUpdateCalculationResponse = {};
118
- export type GetCalculationStatusRequest = {
119
- /** Application code (format XXXXX-XXXXX) to poll calculation status for. */
120
- code?: string;
121
- };
122
43
  /**
123
44
  * GetCalculationStatusResponse is the lightweight subset of the settings
124
45
  * response that changes while a background size calculation runs. Clients poll
@@ -137,13 +58,12 @@ export type GetAnalyticsRequest_WindowDays = 'WINDOW_DAYS_UNSPECIFIED' | 'WINDOW
137
58
  /**
138
59
  * GetAnalyticsRequest asks for the precomputed Control-vs-Treatment analytics
139
60
  * for a window preset (3/7/30 days).
61
+ * GetAnalyticsRequest is no longer a request: the endpoint that took it is
62
+ * gone. It stays as the home of WindowDays, which
63
+ * GetControlGroupAnalyticsRequest still uses -- moving the enum would rename
64
+ * the generated type and every client importing it.
140
65
  */
141
- export type GetAnalyticsRequest = {
142
- /** Application code (format XXXXX-XXXXX) to report on. */
143
- code?: string;
144
- /** Analytics lookback window preset (3, 7 or 30 days). */
145
- windowDays?: GetAnalyticsRequest_WindowDays;
146
- };
66
+ export type GetAnalyticsRequest = {};
147
67
  /** ControlGroup is one configured control group of an application. */
148
68
  export type ControlGroup = {
149
69
  /** Control group code (format XXXXX-XXXXX), stable for the life of the group. */
package/data.js CHANGED
@@ -6346,48 +6346,6 @@ export const data = {
6346
6346
  "type": "S",
6347
6347
  "key": "applicationsControlGroup",
6348
6348
  "methods": {
6349
- "GetSettings": {
6350
- "request": "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsRequest",
6351
- "response": "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsResponse",
6352
- "method": "get",
6353
- "path": "/api/applications/{code}/control_group"
6354
- },
6355
- "UpdatePercentage": {
6356
- "request": "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageRequest",
6357
- "response": "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageResponse",
6358
- "method": "post",
6359
- "path": "/api/applications/{code}/control_group"
6360
- },
6361
- "Disable": {
6362
- "request": "pushwoosh.rpc_v2.applications_controlgroup.DisableRequest",
6363
- "response": "pushwoosh.rpc_v2.applications_controlgroup.DisableResponse",
6364
- "method": "delete",
6365
- "path": "/api/applications/{code}/control_group"
6366
- },
6367
- "Reshuffle": {
6368
- "request": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleRequest",
6369
- "response": "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleResponse",
6370
- "method": "post",
6371
- "path": "/api/applications/{code}/control_group/reshuffle"
6372
- },
6373
- "ForceUpdateCalculation": {
6374
- "request": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationRequest",
6375
- "response": "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationResponse",
6376
- "method": "post",
6377
- "path": "/api/applications/{code}/control_group/recalculate"
6378
- },
6379
- "GetCalculationStatus": {
6380
- "request": "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusRequest",
6381
- "response": "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusResponse",
6382
- "method": "get",
6383
- "path": "/api/applications/{code}/control_group/calculation_status"
6384
- },
6385
- "GetAnalytics": {
6386
- "request": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest",
6387
- "response": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsResponse",
6388
- "method": "get",
6389
- "path": "/api/applications/{code}/control_group/analytics"
6390
- },
6391
6349
  "ListControlGroups": {
6392
6350
  "request": "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsRequest",
6393
6351
  "response": "pushwoosh.rpc_v2.applications_controlgroup.ListControlGroupsResponse",
@@ -6459,109 +6417,6 @@ export const data = {
6459
6417
  "TASK_STATUS_COMPLETED"
6460
6418
  ]
6461
6419
  },
6462
- "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsRequest": {
6463
- "type": "I",
6464
- "fields": {
6465
- "code": {
6466
- "type": "string"
6467
- }
6468
- }
6469
- },
6470
- "pushwoosh.rpc_v2.applications_controlgroup.GetSettingsResponse": {
6471
- "type": "I",
6472
- "fields": {
6473
- "percentage": {
6474
- "type": "number"
6475
- },
6476
- "enabled": {
6477
- "type": "boolean"
6478
- },
6479
- "totalUsers": {
6480
- "type": "number"
6481
- },
6482
- "controlGroupUsers": {
6483
- "type": "number"
6484
- },
6485
- "calculationStatus": {
6486
- "type": "pushwoosh.rpc_v2.applications_controlgroup.TaskStatus"
6487
- },
6488
- "lastModifiedAt": {
6489
- "type": "Date"
6490
- },
6491
- "lastModifiedBy": {
6492
- "type": "string"
6493
- },
6494
- "hasData": {
6495
- "type": "boolean"
6496
- },
6497
- "generation": {
6498
- "type": "number"
6499
- }
6500
- }
6501
- },
6502
- "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageRequest": {
6503
- "type": "I",
6504
- "fields": {
6505
- "code": {
6506
- "type": "string"
6507
- },
6508
- "percentage": {
6509
- "type": "number"
6510
- }
6511
- }
6512
- },
6513
- "pushwoosh.rpc_v2.applications_controlgroup.UpdatePercentageResponse": {
6514
- "type": "I",
6515
- "fields": {}
6516
- },
6517
- "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleRequest": {
6518
- "type": "I",
6519
- "fields": {
6520
- "code": {
6521
- "type": "string"
6522
- }
6523
- }
6524
- },
6525
- "pushwoosh.rpc_v2.applications_controlgroup.ReshuffleResponse": {
6526
- "type": "I",
6527
- "fields": {
6528
- "generation": {
6529
- "type": "number"
6530
- }
6531
- }
6532
- },
6533
- "pushwoosh.rpc_v2.applications_controlgroup.DisableRequest": {
6534
- "type": "I",
6535
- "fields": {
6536
- "code": {
6537
- "type": "string"
6538
- }
6539
- }
6540
- },
6541
- "pushwoosh.rpc_v2.applications_controlgroup.DisableResponse": {
6542
- "type": "I",
6543
- "fields": {}
6544
- },
6545
- "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationRequest": {
6546
- "type": "I",
6547
- "fields": {
6548
- "code": {
6549
- "type": "string"
6550
- }
6551
- }
6552
- },
6553
- "pushwoosh.rpc_v2.applications_controlgroup.ForceUpdateCalculationResponse": {
6554
- "type": "I",
6555
- "fields": {}
6556
- },
6557
- "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusRequest": {
6558
- "type": "I",
6559
- "fields": {
6560
- "code": {
6561
- "type": "string"
6562
- }
6563
- }
6564
- },
6565
6420
  "pushwoosh.rpc_v2.applications_controlgroup.GetCalculationStatusResponse": {
6566
6421
  "type": "I",
6567
6422
  "fields": {
@@ -6590,14 +6445,7 @@ export const data = {
6590
6445
  },
6591
6446
  "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest": {
6592
6447
  "type": "I",
6593
- "fields": {
6594
- "code": {
6595
- "type": "string"
6596
- },
6597
- "windowDays": {
6598
- "type": "pushwoosh.rpc_v2.applications_controlgroup.GetAnalyticsRequest.WindowDays"
6599
- }
6600
- }
6448
+ "fields": {}
6601
6449
  },
6602
6450
  "pushwoosh.rpc_v2.applications_controlgroup.ControlGroup": {
6603
6451
  "type": "I",
@@ -12498,7 +12346,8 @@ export const data = {
12498
12346
  "EXPORT_MESSAGE_PROPERTY_TOTAL_OPENED",
12499
12347
  "EXPORT_MESSAGE_PROPERTY_TOTAL_CLICKS",
12500
12348
  "EXPORT_MESSAGE_PROPERTY_CLICKS",
12501
- "EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED"
12349
+ "EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED",
12350
+ "EXPORT_MESSAGE_PROPERTY_MESSAGE_CODE"
12502
12351
  ]
12503
12352
  },
12504
12353
  "pushwoosh.export_messages.v2.Source": {
@@ -12534,6 +12383,14 @@ export const data = {
12534
12383
  "MESSAGE_STATUS_WAITING"
12535
12384
  ]
12536
12385
  },
12386
+ "pushwoosh.export_messages.v2.MessageType": {
12387
+ "type": "E",
12388
+ "values": [
12389
+ "MESSAGE_TYPE_UNSPECIFIED",
12390
+ "MARKETING",
12391
+ "TRANSACTIONAL"
12392
+ ]
12393
+ },
12537
12394
  "pushwoosh.export_messages.v2.ApplySegmentExportType": {
12538
12395
  "type": "E",
12539
12396
  "values": [
@@ -12609,6 +12466,9 @@ export const data = {
12609
12466
  "properties": {
12610
12467
  "type": "pushwoosh.export_messages.v2.ExportMessageProperty",
12611
12468
  "array": true
12469
+ },
12470
+ "messageType": {
12471
+ "type": "pushwoosh.export_messages.v2.MessageType"
12612
12472
  }
12613
12473
  }
12614
12474
  },
@@ -12617,6 +12477,9 @@ export const data = {
12617
12477
  "fields": {
12618
12478
  "file": {
12619
12479
  "type": "string"
12480
+ },
12481
+ "truncated": {
12482
+ "type": "boolean"
12620
12483
  }
12621
12484
  }
12622
12485
  },
@@ -13366,6 +13229,9 @@ export const data = {
13366
13229
  "fields": {
13367
13230
  "applicationCode": {
13368
13231
  "type": "string"
13232
+ },
13233
+ "controlGroupCode": {
13234
+ "type": "string"
13369
13235
  }
13370
13236
  }
13371
13237
  },
@@ -30182,6 +30048,18 @@ export const data = {
30182
30048
  "response": "pushwoosh.rpc_v2.whatsapp.FetchCatalogResponse",
30183
30049
  "method": "get",
30184
30050
  "path": "/api/whatsapp/catalog"
30051
+ },
30052
+ "GetWelcomeMessage": {
30053
+ "request": "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageRequest",
30054
+ "response": "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageResponse",
30055
+ "method": "get",
30056
+ "path": "/api/whatsapp/welcome"
30057
+ },
30058
+ "UpdateWelcomeMessage": {
30059
+ "request": "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageRequest",
30060
+ "response": "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageResponse",
30061
+ "method": "put",
30062
+ "path": "/api/whatsapp/welcome"
30185
30063
  }
30186
30064
  }
30187
30065
  },
@@ -30299,6 +30177,71 @@ export const data = {
30299
30177
  }
30300
30178
  }
30301
30179
  },
30180
+ "pushwoosh.rpc_v2.whatsapp.WelcomeMessage": {
30181
+ "type": "I",
30182
+ "fields": {
30183
+ "enabled": {
30184
+ "type": "boolean"
30185
+ },
30186
+ "localizedContent": {
30187
+ "type": "string",
30188
+ "mapKeyType": "string"
30189
+ },
30190
+ "localizedAttachment": {
30191
+ "type": "string",
30192
+ "mapKeyType": "string"
30193
+ },
30194
+ "updated": {
30195
+ "type": "Date"
30196
+ },
30197
+ "campaignCode": {
30198
+ "type": "string"
30199
+ }
30200
+ }
30201
+ },
30202
+ "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageRequest": {
30203
+ "type": "I",
30204
+ "fields": {
30205
+ "application": {
30206
+ "type": "string"
30207
+ }
30208
+ }
30209
+ },
30210
+ "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageResponse": {
30211
+ "type": "I",
30212
+ "fields": {
30213
+ "welcomeMessage": {
30214
+ "type": "pushwoosh.rpc_v2.whatsapp.WelcomeMessage"
30215
+ }
30216
+ }
30217
+ },
30218
+ "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageRequest": {
30219
+ "type": "I",
30220
+ "fields": {
30221
+ "application": {
30222
+ "type": "string"
30223
+ },
30224
+ "enabled": {
30225
+ "type": "boolean"
30226
+ },
30227
+ "localizedContent": {
30228
+ "type": "string",
30229
+ "mapKeyType": "string"
30230
+ },
30231
+ "localizedAttachment": {
30232
+ "type": "string",
30233
+ "mapKeyType": "string"
30234
+ }
30235
+ }
30236
+ },
30237
+ "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageResponse": {
30238
+ "type": "I",
30239
+ "fields": {
30240
+ "welcomeMessage": {
30241
+ "type": "pushwoosh.rpc_v2.whatsapp.WelcomeMessage"
30242
+ }
30243
+ }
30244
+ },
30302
30245
  "pushwoosh.rpc_v2.whatsapp_presets.WhatsAppPresetsService": {
30303
30246
  "type": "S",
30304
30247
  "key": "whatsAppPresets",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.179",
3
+ "version": "0.2.181",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -429,13 +429,14 @@ export type TrackingLogCSVArgs = {
429
429
  export type TrackingLogCSVResult = {
430
430
  file: string;
431
431
  };
432
- 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';
432
+ 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';
433
433
  export type Source = 'SOURCE_UNSPECIFIED'
434
434
  /** deprecated */
435
435
  | 'AB_EXPERIMENT' | 'AB_TEST' | 'API' | 'AUTO_PUSH' | 'CP' | 'CSV' | 'CUSTOMER_JOURNEY' | 'EMAIL_API' | 'EMAIL_CP' | 'GEO_ZONE' | 'PUSH_ON_EVENT' | 'RSS' | 'SYSTEM'
436
436
  /** deprecated */
437
437
  | 'TWITTER';
438
438
  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';
439
+ export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'MARKETING' | 'TRANSACTIONAL';
439
440
  export type ApplySegmentExportType = 'APPLY_SEGMENT_EXPORT_TYPE_UNSPECIFIED' | 'ALL' | 'OPEN' | 'NOT_OPEN';
440
441
  export type DateRange = {
441
442
  /** date format yyyy-mm-dd */
@@ -460,9 +461,12 @@ export type ExportMessagesV2Args = {
460
461
  appGroupCode: string;
461
462
  filters: GetMessageHistoryFilters;
462
463
  properties: ExportMessageProperty[];
464
+ messageType: MessageType;
463
465
  };
464
466
  export type ExportMessagesV2Result = {
465
467
  file: string;
468
+ /** set when the export hit the row limit and the file holds only its first rows */
469
+ truncated: boolean;
466
470
  };
467
471
  export type ExportUnregisteredDevicesArgs = {
468
472
  applicationCode: string;
@@ -709,6 +713,11 @@ export type ExportJourneyGoalUsersResult = {
709
713
  };
710
714
  export type ExportControlGroupArgs = {
711
715
  applicationCode: string;
716
+ /**
717
+ * Control group to export, by code. Empty exports the application's global
718
+ * group, which is what every task created before groups had codes meant.
719
+ */
720
+ controlGroupCode: string;
712
721
  };
713
722
  export type ExportControlGroupResult = {
714
723
  file: string;
package/whatsapp.d.ts CHANGED
@@ -3,6 +3,8 @@ export type WhatsAppService_RegisterWABA = RpcMethod<RegisterWABARequest, Regist
3
3
  export type WhatsAppService_RegisterWABATwilio = RpcMethod<RegisterWABATwilioRequest, RegisterWABATwilioResponse>;
4
4
  export type WhatsAppService_AuthResponseCode = RpcMethod<AuthResponseCodeRequest, AuthResponseCodeResponse>;
5
5
  export type WhatsAppService_FetchCatalog = RpcMethod<FetchCatalogRequest, FetchCatalogResponse>;
6
+ export type WhatsAppService_GetWelcomeMessage = RpcMethod<GetWelcomeMessageRequest, GetWelcomeMessageResponse>;
7
+ export type WhatsAppService_UpdateWelcomeMessage = RpcMethod<UpdateWelcomeMessageRequest, UpdateWelcomeMessageResponse>;
6
8
  export interface WhatsAppService {
7
9
  /** Connects a WhatsApp Business Account to an application code via Meta Cloud API, storing the WABA and phone-number IDs, subscribing the number to Pushwoosh webhooks and registering it with Meta. Use for direct Meta onboarding; use connect_whatsapp_account_twilio for Twilio-routed senders. */
8
10
  RegisterWABA: WhatsAppService_RegisterWABA;
@@ -12,6 +14,10 @@ export interface WhatsAppService {
12
14
  AuthResponseCode: WhatsAppService_AuthResponseCode;
13
15
  /** Returns the WhatsApp Business catalog and its products for an application code by querying Meta. Use to list products available for WhatsApp product messages; a WABA has at most one catalog. */
14
16
  FetchCatalog: WhatsAppService_FetchCatalog;
17
+ /** Returns the WhatsApp welcome message of an application: the text sent in reply to the first message of a new conversation, its localizations, attachment links and whether it is switched on. */
18
+ GetWelcomeMessage: WhatsAppService_GetWelcomeMessage;
19
+ /** Creates or updates the WhatsApp welcome message of an application. Sending it enables reporting: every greeting is reported under a service campaign created on the first save. */
20
+ UpdateWelcomeMessage: WhatsAppService_UpdateWelcomeMessage;
15
21
  }
16
22
  export type RegisterWABARequest = {
17
23
  /** application code */
@@ -62,3 +68,31 @@ export type Product = {
62
68
  price: string;
63
69
  brand: string;
64
70
  };
71
+ export type WelcomeMessage = {
72
+ enabled: boolean;
73
+ /** text map {"default": "Hi!", "de": "Hallo!"}; the locale a device gets is picked by its Language tag */
74
+ localizedContent: Record<string, string>;
75
+ /** attachment link map {"default": "https://...jpg"}; the text of the same locale is sent as the media caption */
76
+ localizedAttachment: Record<string, string>;
77
+ updated: Date;
78
+ /** Campaign every greeting is reported under; the Message statistics screen takes it to show them together. */
79
+ campaignCode: string;
80
+ };
81
+ export type GetWelcomeMessageRequest = {
82
+ /** application code */
83
+ application?: string;
84
+ };
85
+ export type GetWelcomeMessageResponse = {
86
+ /** absent when the application has no welcome message yet */
87
+ welcomeMessage: WelcomeMessage;
88
+ };
89
+ export type UpdateWelcomeMessageRequest = {
90
+ /** application code */
91
+ application?: string;
92
+ enabled?: boolean;
93
+ localizedContent?: Record<string, string>;
94
+ localizedAttachment?: Record<string, string>;
95
+ };
96
+ export type UpdateWelcomeMessageResponse = {
97
+ welcomeMessage: WelcomeMessage;
98
+ };