@pushwoosh/rpc-v2-http-api-data 0.1.888 → 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 +110 -58
- package/index.d.ts +2 -2
- package/package.json +1 -1
- package/pushwoosh_rpc_popup_forms_v3.d.ts +238 -0
- package/popup_forms.d.ts +0 -106
- /package/{popup_forms.js → pushwoosh_rpc_popup_forms_v3.js} +0 -0
package/data.js
CHANGED
|
@@ -20231,55 +20231,95 @@ export const data = {
|
|
|
20231
20231
|
}
|
|
20232
20232
|
}
|
|
20233
20233
|
},
|
|
20234
|
-
"pushwoosh.
|
|
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": {
|
|
20235
20275
|
"type": "S",
|
|
20236
20276
|
"key": "popupForms",
|
|
20237
20277
|
"methods": {
|
|
20238
20278
|
"List": {
|
|
20239
|
-
"request": "pushwoosh.
|
|
20240
|
-
"response": "pushwoosh.
|
|
20279
|
+
"request": "pushwoosh.rpc.popup_forms.v3.ListRequest",
|
|
20280
|
+
"response": "pushwoosh.rpc.popup_forms.v3.ListResponse",
|
|
20241
20281
|
"method": "get",
|
|
20242
|
-
"path": "/api/popup_forms"
|
|
20282
|
+
"path": "/api/v3/popup_forms"
|
|
20243
20283
|
},
|
|
20244
20284
|
"Get": {
|
|
20245
|
-
"request": "pushwoosh.
|
|
20246
|
-
"response": "pushwoosh.
|
|
20285
|
+
"request": "pushwoosh.rpc.popup_forms.v3.GetRequest",
|
|
20286
|
+
"response": "pushwoosh.rpc.popup_forms.v3.GetResponse",
|
|
20247
20287
|
"method": "get",
|
|
20248
|
-
"path": "/api/popup_forms/{code}"
|
|
20249
|
-
},
|
|
20250
|
-
"Delete": {
|
|
20251
|
-
"request": "pushwoosh.rpc_v2.popup_forms.DeletePopupFormRequest",
|
|
20252
|
-
"response": "pushwoosh.rpc_v2.popup_forms.DeletePopupFormResponse",
|
|
20253
|
-
"method": "delete",
|
|
20254
|
-
"path": "/api/popup_forms/{code}"
|
|
20288
|
+
"path": "/api/v3/popup_forms/{code}"
|
|
20255
20289
|
},
|
|
20256
20290
|
"Create": {
|
|
20257
|
-
"request": "pushwoosh.
|
|
20258
|
-
"response": "pushwoosh.
|
|
20291
|
+
"request": "pushwoosh.rpc.popup_forms.v3.CreateRequest",
|
|
20292
|
+
"response": "pushwoosh.rpc.popup_forms.v3.CreateResponse",
|
|
20259
20293
|
"method": "post",
|
|
20260
|
-
"path": "/api/popup_forms:create"
|
|
20294
|
+
"path": "/api/v3/popup_forms:create"
|
|
20261
20295
|
},
|
|
20262
20296
|
"Update": {
|
|
20263
|
-
"request": "pushwoosh.
|
|
20264
|
-
"response": "pushwoosh.
|
|
20297
|
+
"request": "pushwoosh.rpc.popup_forms.v3.UpdateRequest",
|
|
20298
|
+
"response": "pushwoosh.rpc.popup_forms.v3.UpdateResponse",
|
|
20265
20299
|
"method": "put",
|
|
20266
|
-
"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}"
|
|
20267
20307
|
},
|
|
20268
20308
|
"Deactivate": {
|
|
20269
|
-
"request": "pushwoosh.
|
|
20270
|
-
"response": "pushwoosh.
|
|
20309
|
+
"request": "pushwoosh.rpc.popup_forms.v3.DeactivateRequest",
|
|
20310
|
+
"response": "pushwoosh.rpc.popup_forms.v3.DeactivateResponse",
|
|
20271
20311
|
"method": "post",
|
|
20272
|
-
"path": "/api/popup_forms/{code}:deactivate"
|
|
20312
|
+
"path": "/api/v3/popup_forms/{code}:deactivate"
|
|
20273
20313
|
},
|
|
20274
20314
|
"Activate": {
|
|
20275
|
-
"request": "pushwoosh.
|
|
20276
|
-
"response": "pushwoosh.
|
|
20315
|
+
"request": "pushwoosh.rpc.popup_forms.v3.ActivateRequest",
|
|
20316
|
+
"response": "pushwoosh.rpc.popup_forms.v3.ActivateResponse",
|
|
20277
20317
|
"method": "post",
|
|
20278
|
-
"path": "/api/popup_forms/{code}:activate"
|
|
20318
|
+
"path": "/api/v3/popup_forms/{code}:activate"
|
|
20279
20319
|
}
|
|
20280
20320
|
}
|
|
20281
20321
|
},
|
|
20282
|
-
"pushwoosh.
|
|
20322
|
+
"pushwoosh.rpc.popup_forms.v3.PopupForm": {
|
|
20283
20323
|
"type": "I",
|
|
20284
20324
|
"fields": {
|
|
20285
20325
|
"code": {
|
|
@@ -20289,7 +20329,8 @@ export const data = {
|
|
|
20289
20329
|
"type": "string"
|
|
20290
20330
|
},
|
|
20291
20331
|
"description": {
|
|
20292
|
-
"type": "string"
|
|
20332
|
+
"type": "string",
|
|
20333
|
+
"optional": true
|
|
20293
20334
|
},
|
|
20294
20335
|
"status": {
|
|
20295
20336
|
"type": "string"
|
|
@@ -20327,21 +20368,21 @@ export const data = {
|
|
|
20327
20368
|
}
|
|
20328
20369
|
}
|
|
20329
20370
|
},
|
|
20330
|
-
"pushwoosh.
|
|
20371
|
+
"pushwoosh.rpc.popup_forms.v3.ListRequest.OrderBy": {
|
|
20331
20372
|
"type": "E",
|
|
20332
20373
|
"values": [
|
|
20333
20374
|
"PUBLISHED",
|
|
20334
20375
|
"NAME"
|
|
20335
20376
|
]
|
|
20336
20377
|
},
|
|
20337
|
-
"pushwoosh.
|
|
20378
|
+
"pushwoosh.rpc.popup_forms.v3.ListRequest.OrderDirection": {
|
|
20338
20379
|
"type": "E",
|
|
20339
20380
|
"values": [
|
|
20340
20381
|
"DESC",
|
|
20341
20382
|
"ASC"
|
|
20342
20383
|
]
|
|
20343
20384
|
},
|
|
20344
|
-
"pushwoosh.
|
|
20385
|
+
"pushwoosh.rpc.popup_forms.v3.ListRequest": {
|
|
20345
20386
|
"type": "I",
|
|
20346
20387
|
"fields": {
|
|
20347
20388
|
"application": {
|
|
@@ -20355,10 +20396,10 @@ export const data = {
|
|
|
20355
20396
|
"optional": true
|
|
20356
20397
|
},
|
|
20357
20398
|
"orderBy": {
|
|
20358
|
-
"type": "pushwoosh.
|
|
20399
|
+
"type": "pushwoosh.rpc.popup_forms.v3.ListRequest.OrderBy"
|
|
20359
20400
|
},
|
|
20360
20401
|
"orderDirection": {
|
|
20361
|
-
"type": "pushwoosh.
|
|
20402
|
+
"type": "pushwoosh.rpc.popup_forms.v3.ListRequest.OrderDirection"
|
|
20362
20403
|
},
|
|
20363
20404
|
"page": {
|
|
20364
20405
|
"type": "number"
|
|
@@ -20368,7 +20409,7 @@ export const data = {
|
|
|
20368
20409
|
}
|
|
20369
20410
|
}
|
|
20370
20411
|
},
|
|
20371
|
-
"pushwoosh.
|
|
20412
|
+
"pushwoosh.rpc.popup_forms.v3.ListResponse.ListItem": {
|
|
20372
20413
|
"type": "I",
|
|
20373
20414
|
"fields": {
|
|
20374
20415
|
"code": {
|
|
@@ -20378,7 +20419,8 @@ export const data = {
|
|
|
20378
20419
|
"type": "string"
|
|
20379
20420
|
},
|
|
20380
20421
|
"description": {
|
|
20381
|
-
"type": "string"
|
|
20422
|
+
"type": "string",
|
|
20423
|
+
"optional": true
|
|
20382
20424
|
},
|
|
20383
20425
|
"status": {
|
|
20384
20426
|
"type": "string"
|
|
@@ -20394,11 +20436,11 @@ export const data = {
|
|
|
20394
20436
|
}
|
|
20395
20437
|
}
|
|
20396
20438
|
},
|
|
20397
|
-
"pushwoosh.
|
|
20439
|
+
"pushwoosh.rpc.popup_forms.v3.ListResponse": {
|
|
20398
20440
|
"type": "I",
|
|
20399
20441
|
"fields": {
|
|
20400
|
-
"
|
|
20401
|
-
"type": "pushwoosh.
|
|
20442
|
+
"items": {
|
|
20443
|
+
"type": "pushwoosh.rpc.popup_forms.v3.ListResponse.ListItem",
|
|
20402
20444
|
"array": true
|
|
20403
20445
|
},
|
|
20404
20446
|
"page": {
|
|
@@ -20415,7 +20457,7 @@ export const data = {
|
|
|
20415
20457
|
}
|
|
20416
20458
|
}
|
|
20417
20459
|
},
|
|
20418
|
-
"pushwoosh.
|
|
20460
|
+
"pushwoosh.rpc.popup_forms.v3.GetRequest": {
|
|
20419
20461
|
"type": "I",
|
|
20420
20462
|
"fields": {
|
|
20421
20463
|
"code": {
|
|
@@ -20423,15 +20465,15 @@ export const data = {
|
|
|
20423
20465
|
}
|
|
20424
20466
|
}
|
|
20425
20467
|
},
|
|
20426
|
-
"pushwoosh.
|
|
20468
|
+
"pushwoosh.rpc.popup_forms.v3.GetResponse": {
|
|
20427
20469
|
"type": "I",
|
|
20428
20470
|
"fields": {
|
|
20429
|
-
"
|
|
20430
|
-
"type": "pushwoosh.
|
|
20471
|
+
"item": {
|
|
20472
|
+
"type": "pushwoosh.rpc.popup_forms.v3.PopupForm"
|
|
20431
20473
|
}
|
|
20432
20474
|
}
|
|
20433
20475
|
},
|
|
20434
|
-
"pushwoosh.
|
|
20476
|
+
"pushwoosh.rpc.popup_forms.v3.CreateRequest": {
|
|
20435
20477
|
"type": "I",
|
|
20436
20478
|
"fields": {
|
|
20437
20479
|
"application": {
|
|
@@ -20468,7 +20510,7 @@ export const data = {
|
|
|
20468
20510
|
}
|
|
20469
20511
|
}
|
|
20470
20512
|
},
|
|
20471
|
-
"pushwoosh.
|
|
20513
|
+
"pushwoosh.rpc.popup_forms.v3.CreateResponse": {
|
|
20472
20514
|
"type": "I",
|
|
20473
20515
|
"fields": {
|
|
20474
20516
|
"code": {
|
|
@@ -20476,48 +20518,58 @@ export const data = {
|
|
|
20476
20518
|
}
|
|
20477
20519
|
}
|
|
20478
20520
|
},
|
|
20479
|
-
"pushwoosh.
|
|
20521
|
+
"pushwoosh.rpc.popup_forms.v3.UpdateRequest": {
|
|
20480
20522
|
"type": "I",
|
|
20481
20523
|
"fields": {
|
|
20482
20524
|
"code": {
|
|
20483
20525
|
"type": "string"
|
|
20484
20526
|
},
|
|
20485
20527
|
"name": {
|
|
20486
|
-
"type": "string"
|
|
20528
|
+
"type": "string",
|
|
20529
|
+
"optional": true
|
|
20487
20530
|
},
|
|
20488
20531
|
"description": {
|
|
20489
20532
|
"type": "string",
|
|
20490
20533
|
"optional": true
|
|
20491
20534
|
},
|
|
20492
20535
|
"popupFormContentCode": {
|
|
20493
|
-
"type": "string"
|
|
20536
|
+
"type": "string",
|
|
20537
|
+
"optional": true
|
|
20494
20538
|
},
|
|
20495
20539
|
"deviceType": {
|
|
20496
|
-
"type": "string"
|
|
20540
|
+
"type": "string",
|
|
20541
|
+
"optional": true
|
|
20497
20542
|
},
|
|
20498
20543
|
"visitorsType": {
|
|
20499
|
-
"type": "string"
|
|
20544
|
+
"type": "string",
|
|
20545
|
+
"optional": true
|
|
20546
|
+
},
|
|
20547
|
+
"updateMatchingPages": {
|
|
20548
|
+
"type": "boolean"
|
|
20500
20549
|
},
|
|
20501
20550
|
"matchingPages": {
|
|
20502
20551
|
"type": "string",
|
|
20503
20552
|
"array": true
|
|
20504
20553
|
},
|
|
20505
20554
|
"delay": {
|
|
20506
|
-
"type": "number"
|
|
20555
|
+
"type": "number",
|
|
20556
|
+
"optional": true
|
|
20507
20557
|
},
|
|
20508
20558
|
"frequency": {
|
|
20509
|
-
"type": "string"
|
|
20559
|
+
"type": "string",
|
|
20560
|
+
"optional": true
|
|
20510
20561
|
},
|
|
20511
20562
|
"status": {
|
|
20512
|
-
"type": "string"
|
|
20563
|
+
"type": "string",
|
|
20564
|
+
"optional": true
|
|
20513
20565
|
}
|
|
20514
20566
|
}
|
|
20515
20567
|
},
|
|
20516
|
-
"pushwoosh.
|
|
20568
|
+
"pushwoosh.rpc.popup_forms.v3.UpdateResponse": {
|
|
20517
20569
|
"type": "I",
|
|
20518
20570
|
"fields": {}
|
|
20519
20571
|
},
|
|
20520
|
-
"pushwoosh.
|
|
20572
|
+
"pushwoosh.rpc.popup_forms.v3.DeleteRequest": {
|
|
20521
20573
|
"type": "I",
|
|
20522
20574
|
"fields": {
|
|
20523
20575
|
"code": {
|
|
@@ -20525,11 +20577,11 @@ export const data = {
|
|
|
20525
20577
|
}
|
|
20526
20578
|
}
|
|
20527
20579
|
},
|
|
20528
|
-
"pushwoosh.
|
|
20580
|
+
"pushwoosh.rpc.popup_forms.v3.DeleteResponse": {
|
|
20529
20581
|
"type": "I",
|
|
20530
20582
|
"fields": {}
|
|
20531
20583
|
},
|
|
20532
|
-
"pushwoosh.
|
|
20584
|
+
"pushwoosh.rpc.popup_forms.v3.DeactivateRequest": {
|
|
20533
20585
|
"type": "I",
|
|
20534
20586
|
"fields": {
|
|
20535
20587
|
"code": {
|
|
@@ -20537,11 +20589,11 @@ export const data = {
|
|
|
20537
20589
|
}
|
|
20538
20590
|
}
|
|
20539
20591
|
},
|
|
20540
|
-
"pushwoosh.
|
|
20592
|
+
"pushwoosh.rpc.popup_forms.v3.DeactivateResponse": {
|
|
20541
20593
|
"type": "I",
|
|
20542
20594
|
"fields": {}
|
|
20543
20595
|
},
|
|
20544
|
-
"pushwoosh.
|
|
20596
|
+
"pushwoosh.rpc.popup_forms.v3.ActivateRequest": {
|
|
20545
20597
|
"type": "I",
|
|
20546
20598
|
"fields": {
|
|
20547
20599
|
"code": {
|
|
@@ -20549,7 +20601,7 @@ export const data = {
|
|
|
20549
20601
|
}
|
|
20550
20602
|
}
|
|
20551
20603
|
},
|
|
20552
|
-
"pushwoosh.
|
|
20604
|
+
"pushwoosh.rpc.popup_forms.v3.ActivateResponse": {
|
|
20553
20605
|
"type": "I",
|
|
20554
20606
|
"fields": {}
|
|
20555
20607
|
},
|
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
|
|
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:
|
|
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
|
@@ -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 = {};
|
|
File without changes
|