@pushwoosh/rpc-v2-http-api-data 0.1.887 → 0.1.889

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/data.js CHANGED
@@ -9393,6 +9393,9 @@ export const data = {
9393
9393
  "pushwoosh.rpc_v2.filters.CreateFilterRequest": {
9394
9394
  "type": "I",
9395
9395
  "fields": {
9396
+ "application": {
9397
+ "type": "string"
9398
+ },
9396
9399
  "name": {
9397
9400
  "type": "string"
9398
9401
  },
@@ -9421,6 +9424,9 @@ export const data = {
9421
9424
  "pushwoosh.rpc_v2.filters.CloneFilterRequest": {
9422
9425
  "type": "I",
9423
9426
  "fields": {
9427
+ "application": {
9428
+ "type": "string"
9429
+ },
9424
9430
  "newName": {
9425
9431
  "type": "string"
9426
9432
  },
@@ -9440,6 +9446,9 @@ export const data = {
9440
9446
  "pushwoosh.rpc_v2.filters.UpdateFilterRequest": {
9441
9447
  "type": "I",
9442
9448
  "fields": {
9449
+ "application": {
9450
+ "type": "string"
9451
+ },
9443
9452
  "filter": {
9444
9453
  "type": "string"
9445
9454
  },
@@ -9461,6 +9470,9 @@ export const data = {
9461
9470
  "pushwoosh.rpc_v2.filters.DeleteFilterRequest": {
9462
9471
  "type": "I",
9463
9472
  "fields": {
9473
+ "application": {
9474
+ "type": "string"
9475
+ },
9464
9476
  "filter": {
9465
9477
  "type": "string"
9466
9478
  }
@@ -9473,6 +9485,9 @@ export const data = {
9473
9485
  "pushwoosh.rpc_v2.filters.GetCountryCitiesRequest": {
9474
9486
  "type": "I",
9475
9487
  "fields": {
9488
+ "application": {
9489
+ "type": "string"
9490
+ },
9476
9491
  "searchByName": {
9477
9492
  "type": "string"
9478
9493
  }
@@ -9510,6 +9525,9 @@ export const data = {
9510
9525
  "pushwoosh.rpc_v2.filters.GetCitiesByHashesRequest": {
9511
9526
  "type": "I",
9512
9527
  "fields": {
9528
+ "application": {
9529
+ "type": "string"
9530
+ },
9513
9531
  "hashes": {
9514
9532
  "type": "string",
9515
9533
  "array": true
@@ -9546,6 +9564,9 @@ export const data = {
9546
9564
  "pushwoosh.rpc_v2.filters.GetSeglangRequest": {
9547
9565
  "type": "I",
9548
9566
  "fields": {
9567
+ "application": {
9568
+ "type": "string"
9569
+ },
9549
9570
  "filterExpression": {
9550
9571
  "type": "pushwoosh.objects.filters.v1.FilterExpression"
9551
9572
  }
@@ -9562,6 +9583,9 @@ export const data = {
9562
9583
  "pushwoosh.rpc_v2.filters.SeglangToFilterExpressionRequest": {
9563
9584
  "type": "I",
9564
9585
  "fields": {
9586
+ "application": {
9587
+ "type": "string"
9588
+ },
9565
9589
  "seglang": {
9566
9590
  "type": "string"
9567
9591
  }
@@ -9619,6 +9643,9 @@ export const data = {
9619
9643
  "pushwoosh.rpc_v2.filters.GetFilterUsageRequest": {
9620
9644
  "type": "I",
9621
9645
  "fields": {
9646
+ "application": {
9647
+ "type": "string"
9648
+ },
9622
9649
  "filter": {
9623
9650
  "type": "string"
9624
9651
  },
@@ -20204,55 +20231,95 @@ export const data = {
20204
20231
  }
20205
20232
  }
20206
20233
  },
20207
- "pushwoosh.rpc_v2.popup_forms.PopupFormsService": {
20234
+ "pushwoosh.rpc.popup_forms.v3.PopupFormsServiceErrors": {
20235
+ "type": "E",
20236
+ "values": [
20237
+ "POPUP_FORMS_SERVICE_ERRORS_UNSPECIFIED",
20238
+ "NAME_EMPTY",
20239
+ "NAME_TOO_LONG",
20240
+ "NAME_ALREADY_EXISTS",
20241
+ "POPUP_FORM_CONTENT_CODE_EMPTY",
20242
+ "POPUP_FORM_CONTENT_CODE_INVALID",
20243
+ "DEVICE_TYPE_EMPTY",
20244
+ "DEVICE_TYPE_INVALID",
20245
+ "VISITORS_TYPE_EMPTY",
20246
+ "VISITORS_TYPE_INVALID",
20247
+ "FREQUENCY_EMPTY",
20248
+ "FREQUENCY_INVALID",
20249
+ "DELAY_NEGATIVE",
20250
+ "MATCHING_PAGE_INVALID",
20251
+ "STATUS_EMPTY",
20252
+ "STATUS_INVALID",
20253
+ "PER_PAGE_TOO_LARGE",
20254
+ "POPUP_FORM_NOT_FOUND",
20255
+ "POPUP_FORM_ALREADY_DRAFT",
20256
+ "POPUP_FORM_ALREADY_ACTIVE",
20257
+ "POPUP_FORM_ALREADY_PAUSED"
20258
+ ],
20259
+ "valuesArgs": {
20260
+ "NAME_TOO_LONG": [
20261
+ "max_length"
20262
+ ],
20263
+ "NAME_ALREADY_EXISTS": [
20264
+ "name"
20265
+ ],
20266
+ "MATCHING_PAGE_INVALID": [
20267
+ "page"
20268
+ ],
20269
+ "PER_PAGE_TOO_LARGE": [
20270
+ "max_per_page"
20271
+ ]
20272
+ }
20273
+ },
20274
+ "pushwoosh.rpc.popup_forms.v3.PopupFormsService": {
20208
20275
  "type": "S",
20209
20276
  "key": "popupForms",
20210
20277
  "methods": {
20211
20278
  "List": {
20212
- "request": "pushwoosh.rpc_v2.popup_forms.ListPopupFormsRequest",
20213
- "response": "pushwoosh.rpc_v2.popup_forms.ListPopupFormsResponse",
20279
+ "request": "pushwoosh.rpc.popup_forms.v3.ListRequest",
20280
+ "response": "pushwoosh.rpc.popup_forms.v3.ListResponse",
20214
20281
  "method": "get",
20215
- "path": "/api/popup_forms"
20282
+ "path": "/api/v3/popup_forms"
20216
20283
  },
20217
20284
  "Get": {
20218
- "request": "pushwoosh.rpc_v2.popup_forms.GetPopupFormRequest",
20219
- "response": "pushwoosh.rpc_v2.popup_forms.GetPopupFormResponse",
20285
+ "request": "pushwoosh.rpc.popup_forms.v3.GetRequest",
20286
+ "response": "pushwoosh.rpc.popup_forms.v3.GetResponse",
20220
20287
  "method": "get",
20221
- "path": "/api/popup_forms/{code}"
20222
- },
20223
- "Delete": {
20224
- "request": "pushwoosh.rpc_v2.popup_forms.DeletePopupFormRequest",
20225
- "response": "pushwoosh.rpc_v2.popup_forms.DeletePopupFormResponse",
20226
- "method": "delete",
20227
- "path": "/api/popup_forms/{code}"
20288
+ "path": "/api/v3/popup_forms/{code}"
20228
20289
  },
20229
20290
  "Create": {
20230
- "request": "pushwoosh.rpc_v2.popup_forms.CreatePopupFormRequest",
20231
- "response": "pushwoosh.rpc_v2.popup_forms.CreatePopupFormResponse",
20291
+ "request": "pushwoosh.rpc.popup_forms.v3.CreateRequest",
20292
+ "response": "pushwoosh.rpc.popup_forms.v3.CreateResponse",
20232
20293
  "method": "post",
20233
- "path": "/api/popup_forms:create"
20294
+ "path": "/api/v3/popup_forms:create"
20234
20295
  },
20235
20296
  "Update": {
20236
- "request": "pushwoosh.rpc_v2.popup_forms.UpdatePopupFormRequest",
20237
- "response": "pushwoosh.rpc_v2.popup_forms.UpdatePopupFormResponse",
20297
+ "request": "pushwoosh.rpc.popup_forms.v3.UpdateRequest",
20298
+ "response": "pushwoosh.rpc.popup_forms.v3.UpdateResponse",
20238
20299
  "method": "put",
20239
- "path": "/api/popup_forms/{code}"
20300
+ "path": "/api/v3/popup_forms/{code}"
20301
+ },
20302
+ "Delete": {
20303
+ "request": "pushwoosh.rpc.popup_forms.v3.DeleteRequest",
20304
+ "response": "pushwoosh.rpc.popup_forms.v3.DeleteResponse",
20305
+ "method": "delete",
20306
+ "path": "/api/v3/popup_forms/{code}"
20240
20307
  },
20241
20308
  "Deactivate": {
20242
- "request": "pushwoosh.rpc_v2.popup_forms.DeactivatePopupFormRequest",
20243
- "response": "pushwoosh.rpc_v2.popup_forms.DeactivatePopupFormResponse",
20309
+ "request": "pushwoosh.rpc.popup_forms.v3.DeactivateRequest",
20310
+ "response": "pushwoosh.rpc.popup_forms.v3.DeactivateResponse",
20244
20311
  "method": "post",
20245
- "path": "/api/popup_forms/{code}:deactivate"
20312
+ "path": "/api/v3/popup_forms/{code}:deactivate"
20246
20313
  },
20247
20314
  "Activate": {
20248
- "request": "pushwoosh.rpc_v2.popup_forms.ActivatePopupFormRequest",
20249
- "response": "pushwoosh.rpc_v2.popup_forms.ActivatePopupFormResponse",
20315
+ "request": "pushwoosh.rpc.popup_forms.v3.ActivateRequest",
20316
+ "response": "pushwoosh.rpc.popup_forms.v3.ActivateResponse",
20250
20317
  "method": "post",
20251
- "path": "/api/popup_forms/{code}:activate"
20318
+ "path": "/api/v3/popup_forms/{code}:activate"
20252
20319
  }
20253
20320
  }
20254
20321
  },
20255
- "pushwoosh.rpc_v2.popup_forms.PopupForm": {
20322
+ "pushwoosh.rpc.popup_forms.v3.PopupForm": {
20256
20323
  "type": "I",
20257
20324
  "fields": {
20258
20325
  "code": {
@@ -20262,7 +20329,8 @@ export const data = {
20262
20329
  "type": "string"
20263
20330
  },
20264
20331
  "description": {
20265
- "type": "string"
20332
+ "type": "string",
20333
+ "optional": true
20266
20334
  },
20267
20335
  "status": {
20268
20336
  "type": "string"
@@ -20300,21 +20368,21 @@ export const data = {
20300
20368
  }
20301
20369
  }
20302
20370
  },
20303
- "pushwoosh.rpc_v2.popup_forms.ListPopupFormsRequest.OrderBy": {
20371
+ "pushwoosh.rpc.popup_forms.v3.ListRequest.OrderBy": {
20304
20372
  "type": "E",
20305
20373
  "values": [
20306
20374
  "PUBLISHED",
20307
20375
  "NAME"
20308
20376
  ]
20309
20377
  },
20310
- "pushwoosh.rpc_v2.popup_forms.ListPopupFormsRequest.OrderDirection": {
20378
+ "pushwoosh.rpc.popup_forms.v3.ListRequest.OrderDirection": {
20311
20379
  "type": "E",
20312
20380
  "values": [
20313
20381
  "DESC",
20314
20382
  "ASC"
20315
20383
  ]
20316
20384
  },
20317
- "pushwoosh.rpc_v2.popup_forms.ListPopupFormsRequest": {
20385
+ "pushwoosh.rpc.popup_forms.v3.ListRequest": {
20318
20386
  "type": "I",
20319
20387
  "fields": {
20320
20388
  "application": {
@@ -20328,10 +20396,10 @@ export const data = {
20328
20396
  "optional": true
20329
20397
  },
20330
20398
  "orderBy": {
20331
- "type": "pushwoosh.rpc_v2.popup_forms.ListPopupFormsRequest.OrderBy"
20399
+ "type": "pushwoosh.rpc.popup_forms.v3.ListRequest.OrderBy"
20332
20400
  },
20333
20401
  "orderDirection": {
20334
- "type": "pushwoosh.rpc_v2.popup_forms.ListPopupFormsRequest.OrderDirection"
20402
+ "type": "pushwoosh.rpc.popup_forms.v3.ListRequest.OrderDirection"
20335
20403
  },
20336
20404
  "page": {
20337
20405
  "type": "number"
@@ -20341,7 +20409,7 @@ export const data = {
20341
20409
  }
20342
20410
  }
20343
20411
  },
20344
- "pushwoosh.rpc_v2.popup_forms.PopupFormListItem": {
20412
+ "pushwoosh.rpc.popup_forms.v3.ListResponse.ListItem": {
20345
20413
  "type": "I",
20346
20414
  "fields": {
20347
20415
  "code": {
@@ -20351,7 +20419,8 @@ export const data = {
20351
20419
  "type": "string"
20352
20420
  },
20353
20421
  "description": {
20354
- "type": "string"
20422
+ "type": "string",
20423
+ "optional": true
20355
20424
  },
20356
20425
  "status": {
20357
20426
  "type": "string"
@@ -20367,11 +20436,11 @@ export const data = {
20367
20436
  }
20368
20437
  }
20369
20438
  },
20370
- "pushwoosh.rpc_v2.popup_forms.ListPopupFormsResponse": {
20439
+ "pushwoosh.rpc.popup_forms.v3.ListResponse": {
20371
20440
  "type": "I",
20372
20441
  "fields": {
20373
- "popupForms": {
20374
- "type": "pushwoosh.rpc_v2.popup_forms.PopupFormListItem",
20442
+ "items": {
20443
+ "type": "pushwoosh.rpc.popup_forms.v3.ListResponse.ListItem",
20375
20444
  "array": true
20376
20445
  },
20377
20446
  "page": {
@@ -20388,7 +20457,7 @@ export const data = {
20388
20457
  }
20389
20458
  }
20390
20459
  },
20391
- "pushwoosh.rpc_v2.popup_forms.GetPopupFormRequest": {
20460
+ "pushwoosh.rpc.popup_forms.v3.GetRequest": {
20392
20461
  "type": "I",
20393
20462
  "fields": {
20394
20463
  "code": {
@@ -20396,15 +20465,15 @@ export const data = {
20396
20465
  }
20397
20466
  }
20398
20467
  },
20399
- "pushwoosh.rpc_v2.popup_forms.GetPopupFormResponse": {
20468
+ "pushwoosh.rpc.popup_forms.v3.GetResponse": {
20400
20469
  "type": "I",
20401
20470
  "fields": {
20402
- "popupForm": {
20403
- "type": "pushwoosh.rpc_v2.popup_forms.PopupForm"
20471
+ "item": {
20472
+ "type": "pushwoosh.rpc.popup_forms.v3.PopupForm"
20404
20473
  }
20405
20474
  }
20406
20475
  },
20407
- "pushwoosh.rpc_v2.popup_forms.CreatePopupFormRequest": {
20476
+ "pushwoosh.rpc.popup_forms.v3.CreateRequest": {
20408
20477
  "type": "I",
20409
20478
  "fields": {
20410
20479
  "application": {
@@ -20441,7 +20510,7 @@ export const data = {
20441
20510
  }
20442
20511
  }
20443
20512
  },
20444
- "pushwoosh.rpc_v2.popup_forms.CreatePopupFormResponse": {
20513
+ "pushwoosh.rpc.popup_forms.v3.CreateResponse": {
20445
20514
  "type": "I",
20446
20515
  "fields": {
20447
20516
  "code": {
@@ -20449,48 +20518,58 @@ export const data = {
20449
20518
  }
20450
20519
  }
20451
20520
  },
20452
- "pushwoosh.rpc_v2.popup_forms.UpdatePopupFormRequest": {
20521
+ "pushwoosh.rpc.popup_forms.v3.UpdateRequest": {
20453
20522
  "type": "I",
20454
20523
  "fields": {
20455
20524
  "code": {
20456
20525
  "type": "string"
20457
20526
  },
20458
20527
  "name": {
20459
- "type": "string"
20528
+ "type": "string",
20529
+ "optional": true
20460
20530
  },
20461
20531
  "description": {
20462
20532
  "type": "string",
20463
20533
  "optional": true
20464
20534
  },
20465
20535
  "popupFormContentCode": {
20466
- "type": "string"
20536
+ "type": "string",
20537
+ "optional": true
20467
20538
  },
20468
20539
  "deviceType": {
20469
- "type": "string"
20540
+ "type": "string",
20541
+ "optional": true
20470
20542
  },
20471
20543
  "visitorsType": {
20472
- "type": "string"
20544
+ "type": "string",
20545
+ "optional": true
20546
+ },
20547
+ "updateMatchingPages": {
20548
+ "type": "boolean"
20473
20549
  },
20474
20550
  "matchingPages": {
20475
20551
  "type": "string",
20476
20552
  "array": true
20477
20553
  },
20478
20554
  "delay": {
20479
- "type": "number"
20555
+ "type": "number",
20556
+ "optional": true
20480
20557
  },
20481
20558
  "frequency": {
20482
- "type": "string"
20559
+ "type": "string",
20560
+ "optional": true
20483
20561
  },
20484
20562
  "status": {
20485
- "type": "string"
20563
+ "type": "string",
20564
+ "optional": true
20486
20565
  }
20487
20566
  }
20488
20567
  },
20489
- "pushwoosh.rpc_v2.popup_forms.UpdatePopupFormResponse": {
20568
+ "pushwoosh.rpc.popup_forms.v3.UpdateResponse": {
20490
20569
  "type": "I",
20491
20570
  "fields": {}
20492
20571
  },
20493
- "pushwoosh.rpc_v2.popup_forms.DeletePopupFormRequest": {
20572
+ "pushwoosh.rpc.popup_forms.v3.DeleteRequest": {
20494
20573
  "type": "I",
20495
20574
  "fields": {
20496
20575
  "code": {
@@ -20498,11 +20577,11 @@ export const data = {
20498
20577
  }
20499
20578
  }
20500
20579
  },
20501
- "pushwoosh.rpc_v2.popup_forms.DeletePopupFormResponse": {
20580
+ "pushwoosh.rpc.popup_forms.v3.DeleteResponse": {
20502
20581
  "type": "I",
20503
20582
  "fields": {}
20504
20583
  },
20505
- "pushwoosh.rpc_v2.popup_forms.DeactivatePopupFormRequest": {
20584
+ "pushwoosh.rpc.popup_forms.v3.DeactivateRequest": {
20506
20585
  "type": "I",
20507
20586
  "fields": {
20508
20587
  "code": {
@@ -20510,11 +20589,11 @@ export const data = {
20510
20589
  }
20511
20590
  }
20512
20591
  },
20513
- "pushwoosh.rpc_v2.popup_forms.DeactivatePopupFormResponse": {
20592
+ "pushwoosh.rpc.popup_forms.v3.DeactivateResponse": {
20514
20593
  "type": "I",
20515
20594
  "fields": {}
20516
20595
  },
20517
- "pushwoosh.rpc_v2.popup_forms.ActivatePopupFormRequest": {
20596
+ "pushwoosh.rpc.popup_forms.v3.ActivateRequest": {
20518
20597
  "type": "I",
20519
20598
  "fields": {
20520
20599
  "code": {
@@ -20522,7 +20601,7 @@ export const data = {
20522
20601
  }
20523
20602
  }
20524
20603
  },
20525
- "pushwoosh.rpc_v2.popup_forms.ActivatePopupFormResponse": {
20604
+ "pushwoosh.rpc.popup_forms.v3.ActivateResponse": {
20526
20605
  "type": "I",
20527
20606
  "fields": {}
20528
20607
  },
package/filters.d.ts CHANGED
@@ -108,6 +108,8 @@ export type GetFilterRequest = {
108
108
  filter?: string;
109
109
  };
110
110
  export type CreateFilterRequest = {
111
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
112
+ application?: string;
111
113
  name?: string;
112
114
  filterExpression?: pushwoosh_objects_filters_v1_FilterExpression;
113
115
  /** application for high speed filter */
@@ -128,6 +130,8 @@ export type CreateFilterResponse = {
128
130
  filter: string;
129
131
  };
130
132
  export type CloneFilterRequest = {
133
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
134
+ application?: string;
131
135
  newName?: string;
132
136
  filter?: string;
133
137
  };
@@ -135,6 +139,8 @@ export type CloneFilterResponse = {
135
139
  filter: string;
136
140
  };
137
141
  export type UpdateFilterRequest = {
142
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
143
+ application?: string;
138
144
  filter?: string;
139
145
  name?: string;
140
146
  filterExpression?: pushwoosh_objects_filters_v1_FilterExpression;
@@ -142,11 +148,15 @@ export type UpdateFilterRequest = {
142
148
  };
143
149
  export type UpdateFilterResponse = {};
144
150
  export type DeleteFilterRequest = {
151
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
152
+ application?: string;
145
153
  filter?: string;
146
154
  };
147
155
  export type DeleteFilterResponse = {};
148
156
  /** returns cities and their coordinates for the given country based on existing tag (City) values */
149
157
  export type GetCountryCitiesRequest = {
158
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
159
+ application?: string;
150
160
  /** like %search_by_name% */
151
161
  searchByName?: string;
152
162
  };
@@ -163,6 +173,8 @@ export type GetCountryCitiesResponse = {
163
173
  };
164
174
  /** returns cities coordinates by cities hashes (country code, city name) */
165
175
  export type GetCitiesByHashesRequest = {
176
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
177
+ application?: string;
166
178
  hashes?: string[];
167
179
  };
168
180
  export type GetCitiesByHashesResponse = {
@@ -175,12 +187,16 @@ export type CompileFilterRequest = {
175
187
  };
176
188
  export type CompileFilterResponse = {};
177
189
  export type GetSeglangRequest = {
190
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
191
+ application?: string;
178
192
  filterExpression?: pushwoosh_objects_filters_v1_FilterExpression;
179
193
  };
180
194
  export type GetSeglangResponse = {
181
195
  seglang: string;
182
196
  };
183
197
  export type SeglangToFilterExpressionRequest = {
198
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
199
+ application?: string;
184
200
  seglang?: string;
185
201
  };
186
202
  export type SeglangToFilterExpressionResponse = {
@@ -202,6 +218,8 @@ export type GetMatchedSegmentsResponse = {
202
218
  totalFilters: number;
203
219
  };
204
220
  export type GetFilterUsageRequest = {
221
+ /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
222
+ application?: string;
205
223
  filter?: string;
206
224
  onlyActiveCampaigns?: boolean;
207
225
  };
package/index.d.ts CHANGED
@@ -40,7 +40,7 @@ import { MediaFilesService as pushwoosh_rpc_v2_media_files_MediaFilesService } f
40
40
  import { MessagesService as pushwoosh_rpc_v2_messages_MessagesService } from './messages';
41
41
  import { FiltersCrudService as pushwoosh_objects_filters_v1_FiltersCrudService } from './pushwoosh_objects_filters_v1';
42
42
  import { RestrictionValuesCrudService as pushwoosh_objects_restrictionValues_v1_RestrictionValuesCrudService } from './pushwoosh_objects_restrictionValues_v1';
43
- import { PopupFormsService as pushwoosh_rpc_v2_popup_forms_PopupFormsService } from './popup_forms';
43
+ import { PopupFormsService as pushwoosh_rpc_popup_forms_v3_PopupFormsService } from './pushwoosh_rpc_popup_forms_v3';
44
44
  import { PopupFormsContentsService as pushwoosh_rpc_popup_forms_contents_v3_PopupFormsContentsService } from './pushwoosh_rpc_popup_forms_contents_v3';
45
45
  import { presetsService as pushwoosh_rpc_v2_presets_presetsService } from './presets';
46
46
  import { ReferralPartnerService as pushwoosh_rpc_v2_referral_partners_ReferralPartnerService } from './referral_partners';
@@ -102,7 +102,7 @@ export type API = {
102
102
  messages: pushwoosh_rpc_v2_messages_MessagesService;
103
103
  filtersCrud: pushwoosh_objects_filters_v1_FiltersCrudService;
104
104
  restrictionValuesCrud: pushwoosh_objects_restrictionValues_v1_RestrictionValuesCrudService;
105
- popupForms: pushwoosh_rpc_v2_popup_forms_PopupFormsService;
105
+ popupForms: pushwoosh_rpc_popup_forms_v3_PopupFormsService;
106
106
  popupFormsContents: pushwoosh_rpc_popup_forms_contents_v3_PopupFormsContentsService;
107
107
  presets: pushwoosh_rpc_v2_presets_presetsService;
108
108
  referralPartner: pushwoosh_rpc_v2_referral_partners_ReferralPartnerService;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.1.887",
3
+ "version": "0.1.889",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -0,0 +1,238 @@
1
+ import { RpcMethod } from './commonTypes';
2
+ /**
3
+ * PopupFormsServiceErrors enumerates every machine-readable error reason
4
+ * (field violations and failed preconditions) returned by PopupFormsService endpoints.
5
+ */
6
+ export type PopupFormsServiceErrors =
7
+ /** Unspecified error. */
8
+ 'POPUP_FORMS_SERVICE_ERRORS_UNSPECIFIED'
9
+ /** Popup Form name cannot be empty. */
10
+ | 'NAME_EMPTY'
11
+ /**
12
+ * Popup Form name cannot be longer than 255 characters.
13
+ * args: max_length - the maximum allowed length of name.
14
+ */
15
+ | 'NAME_TOO_LONG'
16
+ /**
17
+ * Popup Form with the same name already exists.
18
+ * args: name - the name of the existing popup form.
19
+ */
20
+ | 'NAME_ALREADY_EXISTS'
21
+ /** Popup Form Content code is required. */
22
+ | 'POPUP_FORM_CONTENT_CODE_EMPTY'
23
+ /** Popup Form Content code is invalid. */
24
+ | 'POPUP_FORM_CONTENT_CODE_INVALID'
25
+ /** Device type is required. */
26
+ | 'DEVICE_TYPE_EMPTY'
27
+ /** Device type is invalid. */
28
+ | 'DEVICE_TYPE_INVALID'
29
+ /** Visitors type is required. */
30
+ | 'VISITORS_TYPE_EMPTY'
31
+ /** Visitors type is invalid. */
32
+ | 'VISITORS_TYPE_INVALID'
33
+ /** Frequency is required. */
34
+ | 'FREQUENCY_EMPTY'
35
+ /** Frequency is invalid. */
36
+ | 'FREQUENCY_INVALID'
37
+ /** Delay must be a positive number. */
38
+ | 'DELAY_NEGATIVE'
39
+ /**
40
+ * Matching page has invalid format.
41
+ * args: page - the invalid matching page value.
42
+ */
43
+ | 'MATCHING_PAGE_INVALID'
44
+ /** Status is required. */
45
+ | 'STATUS_EMPTY'
46
+ /** Status is invalid. */
47
+ | 'STATUS_INVALID'
48
+ /**
49
+ * Per page cannot be greater than 100.
50
+ * args: max_per_page - the maximum allowed value of per_page.
51
+ */
52
+ | 'PER_PAGE_TOO_LARGE'
53
+ /** Popup Form not found. */
54
+ | 'POPUP_FORM_NOT_FOUND'
55
+ /** Popup Form is already draft. */
56
+ | 'POPUP_FORM_ALREADY_DRAFT'
57
+ /** Popup Form is already active. */
58
+ | 'POPUP_FORM_ALREADY_ACTIVE'
59
+ /** Popup Form is already paused. */
60
+ | 'POPUP_FORM_ALREADY_PAUSED';
61
+ export type PopupFormsService_List = RpcMethod<ListRequest, ListResponse>;
62
+ export type PopupFormsService_Get = RpcMethod<GetRequest, GetResponse>;
63
+ export type PopupFormsService_Create = RpcMethod<CreateRequest, CreateResponse>;
64
+ export type PopupFormsService_Update = RpcMethod<UpdateRequest, UpdateResponse>;
65
+ export type PopupFormsService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
66
+ export type PopupFormsService_Deactivate = RpcMethod<DeactivateRequest, DeactivateResponse>;
67
+ export type PopupFormsService_Activate = RpcMethod<ActivateRequest, ActivateResponse>;
68
+ export interface PopupFormsService {
69
+ /** List Popup Forms for given application and filters. */
70
+ List: PopupFormsService_List;
71
+ /** Get Popup Form by code. */
72
+ Get: PopupFormsService_Get;
73
+ /** Create new Popup Form. Popup Form code will be generated by server and returned in response. */
74
+ Create: PopupFormsService_Create;
75
+ /** Update Popup Form. */
76
+ Update: PopupFormsService_Update;
77
+ /** Delete Popup Form. */
78
+ Delete: PopupFormsService_Delete;
79
+ /** Deactivate Popup Form (set status to paused). */
80
+ Deactivate: PopupFormsService_Deactivate;
81
+ /** Activate Popup Form (set status to active). */
82
+ Activate: PopupFormsService_Activate;
83
+ }
84
+ export type PopupForm = {
85
+ /** Popup Form code. */
86
+ code: string;
87
+ /** Name of Popup Form. */
88
+ name: string;
89
+ /** Description of Popup Form. */
90
+ description?: string;
91
+ /** Status of Popup Form (active, paused, draft). */
92
+ status: string;
93
+ /** Code of associated Popup Form Content. */
94
+ popupFormContentCode: string;
95
+ /** Name of associated Popup Form Content. */
96
+ popupFormContentName: string;
97
+ /** Device type (all, mobile, desktop). */
98
+ deviceType: string;
99
+ /** Visitors type (all, new, returning). */
100
+ visitorsType: string;
101
+ /** Matching pages for display rules. Empty list means no page restrictions. */
102
+ matchingPages: string[];
103
+ /** Delay in seconds before showing the Popup Form. */
104
+ delay: number;
105
+ /** Frequency of showing (once, every_visit, once_per_session). */
106
+ frequency: string;
107
+ /** Timestamp when Popup Form was published (activated). */
108
+ published: Date;
109
+ /** Popup Form created timestamp. */
110
+ created: Date;
111
+ /** Popup Form updated timestamp. */
112
+ updated: Date;
113
+ };
114
+ export type ListRequest_OrderBy = 'PUBLISHED' | 'NAME';
115
+ export type ListRequest_OrderDirection = 'DESC' | 'ASC';
116
+ export type ListRequest = {
117
+ /** Application code to filter by. */
118
+ application?: string;
119
+ /** Search query to filter by name or code. */
120
+ search?: string;
121
+ /** Optional status filter. */
122
+ status?: string;
123
+ /** Field to order results by. */
124
+ orderBy?: ListRequest_OrderBy;
125
+ /** Order direction. */
126
+ orderDirection?: ListRequest_OrderDirection;
127
+ /** Page number. Pagination starts from 0. */
128
+ page?: number;
129
+ /** Number of items per page. */
130
+ perPage?: number;
131
+ };
132
+ export type ListResponse_ListItem = {
133
+ /** Similar to the PopupForm. */
134
+ code: string;
135
+ /** Similar to the PopupForm. */
136
+ name: string;
137
+ /** Similar to the PopupForm. */
138
+ description?: string;
139
+ /** Similar to the PopupForm. */
140
+ status: string;
141
+ /** Number of visitors. */
142
+ visitors: number;
143
+ /** Number of impressions. */
144
+ impressions: number;
145
+ /** Similar to the PopupForm. */
146
+ updated: Date;
147
+ };
148
+ export type ListResponse = {
149
+ /** List of Popup Forms for the current page. */
150
+ items: ListResponse_ListItem[];
151
+ /** Current page number. Pagination starts from 0. */
152
+ page: number;
153
+ /** Number of items per page. */
154
+ perPage: number;
155
+ /** Total number of pages. */
156
+ totalPages: number;
157
+ /** Total number of items across all pages. */
158
+ total: number;
159
+ };
160
+ export type GetRequest = {
161
+ /** Similar to the PopupForm. */
162
+ code?: string;
163
+ };
164
+ export type GetResponse = {
165
+ /** Popup Form. */
166
+ item: PopupForm;
167
+ };
168
+ export type CreateRequest = {
169
+ /** Application code to which Popup Form belongs. */
170
+ application?: string;
171
+ /** Similar to the PopupForm. */
172
+ name?: string;
173
+ /** Similar to the PopupForm. */
174
+ description?: string;
175
+ /** Similar to the PopupForm. */
176
+ popupFormContentCode?: string;
177
+ /** Similar to the PopupForm. */
178
+ deviceType?: string;
179
+ /** Similar to the PopupForm. */
180
+ visitorsType?: string;
181
+ /** Similar to the PopupForm. */
182
+ matchingPages?: string[];
183
+ /** Similar to the PopupForm. */
184
+ delay?: number;
185
+ /** Similar to the PopupForm. */
186
+ frequency?: string;
187
+ /** Similar to the PopupForm. */
188
+ status?: string;
189
+ };
190
+ export type CreateResponse = {
191
+ /** Similar to the PopupForm. */
192
+ code: string;
193
+ };
194
+ export type UpdateRequest = {
195
+ /** Similar to the PopupForm. */
196
+ code?: string;
197
+ /** Similar to the PopupForm. */
198
+ name?: string;
199
+ /** Similar to the PopupForm. */
200
+ description?: string;
201
+ /** Similar to the PopupForm. */
202
+ popupFormContentCode?: string;
203
+ /** Similar to the PopupForm. */
204
+ deviceType?: string;
205
+ /** Similar to the PopupForm. */
206
+ visitorsType?: string;
207
+ /**
208
+ * Controls how matching_pages is applied (PATCH semantics):
209
+ * - true → replace matching_pages with the provided list.
210
+ * - false → do not touch matching_pages.
211
+ * Required because proto3 cannot distinguish an unset repeated field from one explicitly set to an empty list.
212
+ */
213
+ updateMatchingPages?: boolean;
214
+ /** Similar to the PopupForm. Only applied when update_matching_pages is true. */
215
+ matchingPages?: string[];
216
+ /** Similar to the PopupForm. */
217
+ delay?: number;
218
+ /** Similar to the PopupForm. */
219
+ frequency?: string;
220
+ /** Similar to the PopupForm. */
221
+ status?: string;
222
+ };
223
+ export type UpdateResponse = {};
224
+ export type DeleteRequest = {
225
+ /** Similar to the PopupForm. */
226
+ code?: string;
227
+ };
228
+ export type DeleteResponse = {};
229
+ export type DeactivateRequest = {
230
+ /** Similar to the PopupForm. */
231
+ code?: string;
232
+ };
233
+ export type DeactivateResponse = {};
234
+ export type ActivateRequest = {
235
+ /** Similar to the PopupForm. */
236
+ code?: string;
237
+ };
238
+ export type ActivateResponse = {};
package/popup_forms.d.ts DELETED
@@ -1,106 +0,0 @@
1
- import { RpcMethod } from './commonTypes';
2
- export type PopupFormsService_List = RpcMethod<ListPopupFormsRequest, ListPopupFormsResponse>;
3
- export type PopupFormsService_Get = RpcMethod<GetPopupFormRequest, GetPopupFormResponse>;
4
- export type PopupFormsService_Delete = RpcMethod<DeletePopupFormRequest, DeletePopupFormResponse>;
5
- export type PopupFormsService_Create = RpcMethod<CreatePopupFormRequest, CreatePopupFormResponse>;
6
- export type PopupFormsService_Update = RpcMethod<UpdatePopupFormRequest, UpdatePopupFormResponse>;
7
- export type PopupFormsService_Deactivate = RpcMethod<DeactivatePopupFormRequest, DeactivatePopupFormResponse>;
8
- export type PopupFormsService_Activate = RpcMethod<ActivatePopupFormRequest, ActivatePopupFormResponse>;
9
- export interface PopupFormsService {
10
- List: PopupFormsService_List;
11
- Get: PopupFormsService_Get;
12
- Delete: PopupFormsService_Delete;
13
- Create: PopupFormsService_Create;
14
- Update: PopupFormsService_Update;
15
- Deactivate: PopupFormsService_Deactivate;
16
- Activate: PopupFormsService_Activate;
17
- }
18
- export type PopupForm = {
19
- code: string;
20
- name: string;
21
- description: string;
22
- status: string;
23
- popupFormContentCode: string;
24
- popupFormContentName: string;
25
- deviceType: string;
26
- visitorsType: string;
27
- matchingPages: string[];
28
- delay: number;
29
- frequency: string;
30
- published: Date;
31
- created: Date;
32
- updated: Date;
33
- };
34
- export type ListPopupFormsRequest_OrderBy = 'PUBLISHED' | 'NAME';
35
- export type ListPopupFormsRequest_OrderDirection = 'DESC' | 'ASC';
36
- export type ListPopupFormsRequest = {
37
- application?: string;
38
- search?: string;
39
- status?: string;
40
- orderBy?: ListPopupFormsRequest_OrderBy;
41
- orderDirection?: ListPopupFormsRequest_OrderDirection;
42
- page?: number;
43
- perPage?: number;
44
- };
45
- export type PopupFormListItem = {
46
- code: string;
47
- name: string;
48
- description: string;
49
- status: string;
50
- visitors: number;
51
- impressions: number;
52
- updated: Date;
53
- };
54
- export type ListPopupFormsResponse = {
55
- popupForms: PopupFormListItem[];
56
- page: number;
57
- perPage: number;
58
- totalPages: number;
59
- total: number;
60
- };
61
- export type GetPopupFormRequest = {
62
- code?: string;
63
- };
64
- export type GetPopupFormResponse = {
65
- popupForm: PopupForm;
66
- };
67
- export type CreatePopupFormRequest = {
68
- application?: string;
69
- name?: string;
70
- description?: string;
71
- popupFormContentCode?: string;
72
- deviceType?: string;
73
- visitorsType?: string;
74
- matchingPages?: string[];
75
- delay?: number;
76
- frequency?: string;
77
- status?: string;
78
- };
79
- export type CreatePopupFormResponse = {
80
- code: string;
81
- };
82
- export type UpdatePopupFormRequest = {
83
- code?: string;
84
- name?: string;
85
- description?: string;
86
- popupFormContentCode?: string;
87
- deviceType?: string;
88
- visitorsType?: string;
89
- matchingPages?: string[];
90
- delay?: number;
91
- frequency?: string;
92
- status?: string;
93
- };
94
- export type UpdatePopupFormResponse = {};
95
- export type DeletePopupFormRequest = {
96
- code?: string;
97
- };
98
- export type DeletePopupFormResponse = {};
99
- export type DeactivatePopupFormRequest = {
100
- code?: string;
101
- };
102
- export type DeactivatePopupFormResponse = {};
103
- export type ActivatePopupFormRequest = {
104
- code?: string;
105
- };
106
- export type ActivatePopupFormResponse = {};