@pushwoosh/rpc-gateway-journey-data 0.26.321 → 0.26.322

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-gateway-journey-data",
3
- "version": "0.26.321",
3
+ "version": "0.26.322",
4
4
  "description": "CJ api gateway HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -45,7 +45,7 @@ export interface Journey {
45
45
  GetWhatsAppPresetsByAppCode(request: GetWhatsAppPresetsByAppCodeRequest): Promise<GetWhatsAppPresetsByAppCodeResponse>;
46
46
  }
47
47
  export type GetPlaceholdersRequest = {
48
- templateCode: string;
48
+ templateCode?: string;
49
49
  };
50
50
  export type GetPlaceholdersResponse = {
51
51
  items: string[];
@@ -63,9 +63,9 @@ export type GetTagsResponse = {
63
63
  payload: TagResponse[];
64
64
  };
65
65
  export type TagsAutocompleteRequest = {
66
- query: string;
67
- tagName: string;
68
- tagType: TagType;
66
+ query?: string;
67
+ tagName?: string;
68
+ tagType?: TagType;
69
69
  };
70
70
  export type TagsAutocompleteResponse = {
71
71
  payload: TagsAutocompleteResponsePayload;
@@ -95,19 +95,19 @@ export type AutocompleteValue = {
95
95
  };
96
96
  export type WinnerStrategy = 'ANY_GOAL' | 'SPECIFIC_GOAL';
97
97
  export type UpdateABSSplitterParamsRequest = {
98
- journeyUuid: string;
99
- pointUuid: string;
100
- params: number[];
101
- autoSelectWinner: boolean;
102
- winnerStrategy: WinnerStrategy;
103
- goalUuid: string;
98
+ journeyUuid?: string;
99
+ pointUuid?: string;
100
+ params?: number[];
101
+ autoSelectWinner?: boolean;
102
+ winnerStrategy?: WinnerStrategy;
103
+ goalUuid?: string;
104
104
  };
105
105
  export type CloneJourneysRequest = {
106
- journeyUuids: string[];
107
- sourceAppCode: string;
108
- destAppCodes: string[];
109
- cloneWithContent: boolean;
110
- title: string;
106
+ journeyUuids?: string[];
107
+ sourceAppCode?: string;
108
+ destAppCodes?: string[];
109
+ cloneWithContent?: boolean;
110
+ title?: string;
111
111
  };
112
112
  export type CloneJourneysResponse = {
113
113
  clonedJourneys: Record<string, JourneyUUIDs>;
@@ -116,9 +116,9 @@ export type JourneyUUIDs = {
116
116
  journeyUuids: string[];
117
117
  };
118
118
  export type GetJourneyQuickStatsByPointsRequest = {
119
- uuid: string;
120
- fromDate: string;
121
- toDate: string;
119
+ uuid?: string;
120
+ fromDate?: string;
121
+ toDate?: string;
122
122
  };
123
123
  export type GetJourneyQuickStatsByPointsResponse = {
124
124
  metadata: JourneyStatsByPointMeta;
@@ -254,7 +254,7 @@ export type PointStatDelay = {};
254
254
  export type PointStatBooleanSplitter = {};
255
255
  export type PointStatWaitEvent = {};
256
256
  export type GetJourneyStatsRequest = {
257
- journeyIds: string[];
257
+ journeyIds?: string[];
258
258
  };
259
259
  export type GetJourneyStatsResponse = {
260
260
  metadata: JourneyStatsMeta;
@@ -272,23 +272,23 @@ export type JourneySummaryStats = {
272
272
  avrCTR: number;
273
273
  };
274
274
  export type RenameRequest = {
275
- uuid: string;
276
- title: string;
275
+ uuid?: string;
276
+ title?: string;
277
277
  };
278
278
  export type DeleteRequest = {
279
- uuid: string;
279
+ uuid?: string;
280
280
  };
281
281
  export type CreateRequest = {
282
- title: string;
283
- params: JourneyParams;
284
- points: Point[];
285
- comments: JourneyComment[];
282
+ title?: string;
283
+ params?: JourneyParams;
284
+ points?: Point[];
285
+ comments?: JourneyComment[];
286
286
  };
287
287
  export type GetHistoryRequest = {
288
- uuid: string;
289
- userId: number;
290
- pageSize: number;
291
- page: number;
288
+ uuid?: string;
289
+ userId?: number;
290
+ pageSize?: number;
291
+ page?: number;
292
292
  };
293
293
  export type GetHistoryResponse = {
294
294
  items: HistoryItem[];
@@ -407,30 +407,30 @@ export type CommentsChangelog = {
407
407
  commentPositions: ChangelogRecords;
408
408
  };
409
409
  export type UpdateJourneyRequest = {
410
- uuid: string;
411
- title: string;
412
- params: JourneyParams;
413
- points: Point[];
414
- comments: JourneyComment[];
415
- autosave: boolean;
410
+ uuid?: string;
411
+ title?: string;
412
+ params?: JourneyParams;
413
+ points?: Point[];
414
+ comments?: JourneyComment[];
415
+ autosave?: boolean;
416
416
  };
417
417
  export type GetJourneysListRequest = {
418
- applicationCode: string;
419
- statuses: JourneyStatus[];
420
- categoryUuids: string[];
421
- filterTitle: string;
422
- sorting: Sorting[];
423
- page: number;
424
- pageSize: number;
425
- campaignTypes: CampaignType[];
426
- uuidList: string[];
418
+ applicationCode?: string;
419
+ statuses?: JourneyStatus[];
420
+ categoryUuids?: string[];
421
+ filterTitle?: string;
422
+ sorting?: Sorting[];
423
+ page?: number;
424
+ pageSize?: number;
425
+ campaignTypes?: CampaignType[];
426
+ uuidList?: string[];
427
427
  };
428
428
  export type GetJourneysListResponse = {
429
429
  journeys: Info[];
430
430
  total: number;
431
431
  };
432
432
  export type GetJourneyByUUIDRequest = {
433
- uuid: string;
433
+ uuid?: string;
434
434
  };
435
435
  export type GetJourneyByUUIDResponse = {
436
436
  info: Info;
@@ -496,61 +496,61 @@ export type UpdateAndResumeJourneyResponseV2 = {
496
496
  validation: ValidateJourneyResponse;
497
497
  };
498
498
  export type StartJourneyV2Request = {
499
- uuid: string;
499
+ uuid?: string;
500
500
  };
501
501
  export type PauseJourneyV2Request = {
502
- uuid: string;
502
+ uuid?: string;
503
503
  };
504
504
  export type FinishJourneyV2Request = {
505
- uuid: string;
505
+ uuid?: string;
506
506
  };
507
507
  export type DraftJourneyV2Request = {
508
- uuid: string;
508
+ uuid?: string;
509
509
  };
510
510
  export type ArchiveJourneyV2Request = {
511
- uuid: string;
511
+ uuid?: string;
512
512
  };
513
513
  export type UpdateJourneyV2Request = {
514
- uuid: string;
515
- title: string;
516
- params: JourneyParams;
517
- points: Point[];
518
- comments: JourneyComment[];
519
- autosave: boolean;
514
+ uuid?: string;
515
+ title?: string;
516
+ params?: JourneyParams;
517
+ points?: Point[];
518
+ comments?: JourneyComment[];
519
+ autosave?: boolean;
520
520
  };
521
521
  export type UpdateAndResumeJourneyV2Request = {
522
- uuid: string;
523
- title: string;
524
- params: JourneyParams;
525
- points: Point[];
526
- comments: JourneyComment[];
527
- autosave: boolean;
522
+ uuid?: string;
523
+ title?: string;
524
+ params?: JourneyParams;
525
+ points?: Point[];
526
+ comments?: JourneyComment[];
527
+ autosave?: boolean;
528
528
  };
529
529
  export type CreateV2Request = {
530
- title: string;
531
- params: JourneyParams;
532
- points: Point[];
533
- comments: JourneyComment[];
530
+ title?: string;
531
+ params?: JourneyParams;
532
+ points?: Point[];
533
+ comments?: JourneyComment[];
534
534
  };
535
535
  export type RenameV2Request = {
536
- uuid: string;
537
- title: string;
536
+ uuid?: string;
537
+ title?: string;
538
538
  };
539
539
  export type UpdateABSSplitterParamsV2Request = {
540
- journeyUuid: string;
541
- pointUuid: string;
542
- params: number[];
543
- autoSelectWinner: boolean;
544
- winnerStrategy: WinnerStrategy;
545
- goalUuid: string;
540
+ journeyUuid?: string;
541
+ pointUuid?: string;
542
+ params?: number[];
543
+ autoSelectWinner?: boolean;
544
+ winnerStrategy?: WinnerStrategy;
545
+ goalUuid?: string;
546
546
  };
547
547
  export type ValidateJourneyV2Request = {
548
- uuid: string;
548
+ uuid?: string;
549
549
  };
550
550
  export type MoveJourneysToCategoryRequest = {
551
- journeyUuids: string[];
552
- categoryUuid: string;
553
- applicationCode: string;
551
+ journeyUuids?: string[];
552
+ categoryUuid?: string;
553
+ applicationCode?: string;
554
554
  };
555
555
  export type MoveJourneysToCategoryResponse = {
556
556
  journeys: Info[];
@@ -568,8 +568,8 @@ export type PointValidationError = {
568
568
  message: string;
569
569
  };
570
570
  export type GetUserFlowRequest = {
571
- uuid: string;
572
- userId: string;
571
+ uuid?: string;
572
+ userId?: string;
573
573
  };
574
574
  export type GetUserFlowResponse_Status = 'success' | 'error' | 'break_path';
575
575
  export type GetUserFlowResponse_Point = {
@@ -1278,9 +1278,9 @@ export type InboxOptions = {
1278
1278
  richMediaCode: string;
1279
1279
  };
1280
1280
  export type GetJourneyStatsByPointsExternalRequest = {
1281
- uuid: string;
1282
- fromDate: string;
1283
- toDate: string;
1281
+ uuid?: string;
1282
+ fromDate?: string;
1283
+ toDate?: string;
1284
1284
  };
1285
1285
  export type GetJourneyStatsByPointsExternalResponse = {
1286
1286
  payload: JourneyStatsByPointsExternalResponsePayload;
@@ -1296,9 +1296,9 @@ export type JourneyStatsByPointsExternalItemGet = {
1296
1296
  pointStat: PointStat;
1297
1297
  };
1298
1298
  export type GetJourneyStatsByPointRequest = {
1299
- uuid: string;
1300
- fromDate: string;
1301
- toDate: string;
1299
+ uuid?: string;
1300
+ fromDate?: string;
1301
+ toDate?: string;
1302
1302
  };
1303
1303
  export type GetJourneyStatsByPointResponse = {
1304
1304
  metadata: JourneyStatsByPointMeta;
@@ -1395,10 +1395,10 @@ export type AccountRestrictionValues = {
1395
1395
  allowCjLine: boolean;
1396
1396
  };
1397
1397
  export type GetJourneyGeneralTimeStatisticsRequest = {
1398
- uuid: string;
1399
- application: string;
1400
- timestampFrom: string;
1401
- timestampTo: string;
1398
+ uuid?: string;
1399
+ application?: string;
1400
+ timestampFrom?: string;
1401
+ timestampTo?: string;
1402
1402
  };
1403
1403
  export type GetJourneyGeneralTimeStatisticsResponse_MetricTimeseries = {
1404
1404
  breakdown: string;
@@ -1417,13 +1417,13 @@ export type GetJourneyGeneralTimeStatisticsResponse = {
1417
1417
  recipients: number;
1418
1418
  };
1419
1419
  export type GetJourneyUsersRequest = {
1420
- uuid: string;
1421
- application: string;
1422
- search: string;
1423
- timestampFrom: string;
1424
- timestampTo: string;
1425
- pageSize: number;
1426
- page: number;
1420
+ uuid?: string;
1421
+ application?: string;
1422
+ search?: string;
1423
+ timestampFrom?: string;
1424
+ timestampTo?: string;
1425
+ pageSize?: number;
1426
+ page?: number;
1427
1427
  };
1428
1428
  export type UserStatus = 'unknown' | 'inJourneyNow' | 'exited' | 'droppedOff' | 'goalReached';
1429
1429
  export type GetJourneyUsersResponse_UserPoint = {
@@ -1440,12 +1440,12 @@ export type GetJourneyUsersResponse = {
1440
1440
  };
1441
1441
  export type Channel = 'CHANNEL_UNSPECIFIED' | 'PUSH' | 'EMAIL' | 'WHATSAPP' | 'SMS' | 'IN_APP';
1442
1442
  export type GetJourneyMetricsRequest = {
1443
- uuid: string;
1444
- application: string;
1445
- timestampFrom: Date;
1446
- timestampTo: Date;
1447
- timezone: string;
1448
- channels: Channel[];
1443
+ uuid?: string;
1444
+ application?: string;
1445
+ timestampFrom?: Date;
1446
+ timestampTo?: Date;
1447
+ timezone?: string;
1448
+ channels?: Channel[];
1449
1449
  };
1450
1450
  export type GetJourneyMetricsResponse_PushMetrics = {
1451
1451
  sends: number[];
@@ -1530,12 +1530,12 @@ export type GetJourneyMetricsResponse = {
1530
1530
  totals: GetJourneyMetricsResponse_ChannelTotals;
1531
1531
  };
1532
1532
  export type GetJourneyDeliveryReportRequest = {
1533
- application: string;
1534
- uuid: string;
1535
- timestampFrom: Date;
1536
- timestampTo: Date;
1537
- timezone: string;
1538
- channels: Channel[];
1533
+ application?: string;
1534
+ uuid?: string;
1535
+ timestampFrom?: Date;
1536
+ timestampTo?: Date;
1537
+ timezone?: string;
1538
+ channels?: Channel[];
1539
1539
  };
1540
1540
  export type GetJourneyDeliveryReportResponse_DeliveryError = {
1541
1541
  name: string;
@@ -1558,7 +1558,7 @@ export type AttributeEntry = {
1558
1558
  attributeName: string;
1559
1559
  };
1560
1560
  export type GetVoucherPoolsRequest = {
1561
- applicationCode: string;
1561
+ applicationCode?: string;
1562
1562
  };
1563
1563
  export type GetVoucherPoolsResponse = {
1564
1564
  payload: VoucherPool[];
@@ -1567,7 +1567,7 @@ export type VoucherPool = {
1567
1567
  name: string;
1568
1568
  };
1569
1569
  export type GetWhatsAppPresetsByAppCodeRequest = {
1570
- code: string;
1570
+ code?: string;
1571
1571
  };
1572
1572
  export type GetWhatsAppPresetsByAppCodeResponse = {
1573
1573
  payload: WhatsAppPresetsByAppCodePayload;
@@ -5,30 +5,30 @@ export interface Category {
5
5
  DeleteCategory(request: DeleteCategoryRequest): Promise<DeleteCategoryResponse>;
6
6
  }
7
7
  export type GetCategoriesListRequest = {
8
- applicationCode: string;
9
- page: number;
10
- pageSize: number;
8
+ applicationCode?: string;
9
+ page?: number;
10
+ pageSize?: number;
11
11
  };
12
12
  export type GetCategoriesListResponse = {
13
13
  categories: Info[];
14
14
  };
15
15
  export type CreateCategoryRequest = {
16
- applicationCode: string;
17
- title: string;
16
+ applicationCode?: string;
17
+ title?: string;
18
18
  };
19
19
  export type CreateCategoryResponse = {
20
20
  category: Info;
21
21
  };
22
22
  export type UpdateCategoryRequest = {
23
- applicationCode: string;
24
- title: string;
25
- uuid: string;
23
+ applicationCode?: string;
24
+ title?: string;
25
+ uuid?: string;
26
26
  };
27
27
  export type UpdateCategoryResponse = {
28
28
  category: Info;
29
29
  };
30
30
  export type DeleteCategoryRequest = {
31
- uuid: string;
31
+ uuid?: string;
32
32
  };
33
33
  export type DeleteCategoryResponse = {
34
34
  affectedJourneyUuids: string[];
@@ -248,163 +248,163 @@ export interface FiltersCrudService {
248
248
  UpdateDeviceLoadPolicy(request: UpdateDeviceLoadPolicyRequest): Promise<{}>;
249
249
  }
250
250
  export type CreateRequest = {
251
- Code: string;
252
- AccountID: number;
253
- Name: string;
254
- ApplicationID: number;
255
- IsFiltrationInProgress: boolean;
256
- FiltrationStartedAt: Date;
257
- FiltrationLastFilteredAt: Date;
258
- FiltrationLastCheckedAt: Date;
259
- FiltrationScheduledAt: Date;
260
- CheckerScheduledAt: Date;
261
- IsSystem: boolean;
262
- ExpirationDate: Date;
263
- Created: Date;
264
- FilterExpressionRaw: string;
265
- FiltrationID: string;
266
- Updated: Date;
267
- Description: string;
268
- DeviceLoadPolicy: string;
251
+ Code?: string;
252
+ AccountID?: number;
253
+ Name?: string;
254
+ ApplicationID?: number;
255
+ IsFiltrationInProgress?: boolean;
256
+ FiltrationStartedAt?: Date;
257
+ FiltrationLastFilteredAt?: Date;
258
+ FiltrationLastCheckedAt?: Date;
259
+ FiltrationScheduledAt?: Date;
260
+ CheckerScheduledAt?: Date;
261
+ IsSystem?: boolean;
262
+ ExpirationDate?: Date;
263
+ Created?: Date;
264
+ FilterExpressionRaw?: string;
265
+ FiltrationID?: string;
266
+ Updated?: Date;
267
+ Description?: string;
268
+ DeviceLoadPolicy?: string;
269
269
  };
270
270
  export type CreateResponse = {
271
271
  filter: Filter;
272
272
  };
273
273
  export type CreateManyRequest = {
274
- filters: CreateRequest[];
274
+ filters?: CreateRequest[];
275
275
  };
276
276
  export type CreateManyResponse = {
277
277
  filters: CreateResponse[];
278
278
  };
279
279
  export type DeleteRequest = {
280
- ID: number;
280
+ ID?: number;
281
281
  };
282
282
  export type DeleteManyRequest = {
283
- where: LogicExpression;
283
+ where?: LogicExpression;
284
284
  };
285
285
  export type DeleteManyResponse = {
286
286
  count: number;
287
287
  };
288
288
  export type CountRequest = {
289
- where: LogicExpression;
289
+ where?: LogicExpression;
290
290
  };
291
291
  export type CountResponse = {
292
292
  count: number;
293
293
  };
294
294
  export type GetPageRequest = {
295
- where: LogicExpression;
296
- sort: SortExpression;
297
- pageSize: number;
298
- pageNum: number;
299
- forLock: ForExpression;
295
+ where?: LogicExpression;
296
+ sort?: SortExpression;
297
+ pageSize?: number;
298
+ pageNum?: number;
299
+ forLock?: ForExpression;
300
300
  };
301
301
  export type GetPageResponse = {
302
302
  filters: Filter[];
303
303
  total: number;
304
304
  };
305
305
  export type ListRequest = {
306
- where: LogicExpression;
307
- sort: SortExpression;
308
- pageSize: number;
309
- forLock: ForExpression;
306
+ where?: LogicExpression;
307
+ sort?: SortExpression;
308
+ pageSize?: number;
309
+ forLock?: ForExpression;
310
310
  };
311
311
  export type ListResponse = {
312
312
  paginationToken: string;
313
313
  };
314
314
  export type PaginateRequest = {
315
- nextPageToken: string;
315
+ nextPageToken?: string;
316
316
  };
317
317
  export type PaginateResponse = {
318
318
  filters: Filter[];
319
319
  nextPageToken: string;
320
320
  };
321
321
  export type UpdateCodeRequest = {
322
- ID: number;
323
- value: string;
322
+ ID?: number;
323
+ value?: string;
324
324
  };
325
325
  export type UpdateAccountIDRequest = {
326
- ID: number;
327
- value: number;
326
+ ID?: number;
327
+ value?: number;
328
328
  };
329
329
  export type UpdateNameRequest = {
330
- ID: number;
331
- value: string;
330
+ ID?: number;
331
+ value?: string;
332
332
  };
333
333
  export type UpdateApplicationIDRequest = {
334
- ID: number;
335
- value: number;
334
+ ID?: number;
335
+ value?: number;
336
336
  };
337
337
  export type UpdateIsFiltrationInProgressRequest = {
338
- ID: number;
339
- value: boolean;
338
+ ID?: number;
339
+ value?: boolean;
340
340
  };
341
341
  export type UpdateFiltrationStartedAtRequest = {
342
- ID: number;
343
- value: Date;
342
+ ID?: number;
343
+ value?: Date;
344
344
  };
345
345
  export type UpdateFiltrationLastFilteredAtRequest = {
346
- ID: number;
347
- value: Date;
346
+ ID?: number;
347
+ value?: Date;
348
348
  };
349
349
  export type UpdateFiltrationLastCheckedAtRequest = {
350
- ID: number;
351
- value: Date;
350
+ ID?: number;
351
+ value?: Date;
352
352
  };
353
353
  export type UpdateFiltrationScheduledAtRequest = {
354
- ID: number;
355
- value: Date;
354
+ ID?: number;
355
+ value?: Date;
356
356
  };
357
357
  export type UpdateCheckerScheduledAtRequest = {
358
- ID: number;
359
- value: Date;
358
+ ID?: number;
359
+ value?: Date;
360
360
  };
361
361
  export type UpdateIsSystemRequest = {
362
- ID: number;
363
- value: boolean;
362
+ ID?: number;
363
+ value?: boolean;
364
364
  };
365
365
  export type UpdateExpirationDateRequest = {
366
- ID: number;
367
- value: Date;
366
+ ID?: number;
367
+ value?: Date;
368
368
  };
369
369
  export type UpdateCreatedRequest = {
370
- ID: number;
371
- value: Date;
370
+ ID?: number;
371
+ value?: Date;
372
372
  };
373
373
  export type UpdateFilterExpressionRawRequest = {
374
- ID: number;
375
- value: string;
374
+ ID?: number;
375
+ value?: string;
376
376
  };
377
377
  export type UpdateFiltrationIDRequest = {
378
- ID: number;
379
- value: string;
378
+ ID?: number;
379
+ value?: string;
380
380
  };
381
381
  export type UpdateUpdatedRequest = {
382
- ID: number;
383
- value: Date;
382
+ ID?: number;
383
+ value?: Date;
384
384
  };
385
385
  export type UpdateDescriptionRequest = {
386
- ID: number;
387
- value: string;
386
+ ID?: number;
387
+ value?: string;
388
388
  };
389
389
  export type UpdateDeviceLoadPolicyRequest = {
390
- ID: number;
391
- value: string;
390
+ ID?: number;
391
+ value?: string;
392
392
  };
393
393
  export type GetRequest = {
394
- ID: number;
394
+ ID?: number;
395
395
  };
396
396
  export type GetResponse = {
397
397
  filter: Filter;
398
398
  };
399
399
  export type LoadByCodeRequest = {
400
- Code: string;
400
+ Code?: string;
401
401
  };
402
402
  export type LoadByCodeResponse = {
403
403
  filter: Filter;
404
404
  };
405
405
  export type LoadByAccountIDNameRequest = {
406
- AccountID: number;
407
- Name: string;
406
+ AccountID?: number;
407
+ Name?: string;
408
408
  };
409
409
  export type LoadByAccountIDNameResponse = {
410
410
  filter: Filter;