@pushwoosh/rpc-v2-http-api-data 0.2.417 → 0.2.419
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 +95 -0
- package/news.d.ts +4 -0
- package/package.json +1 -1
- package/rich_medias.d.ts +40 -1
package/data.js
CHANGED
|
@@ -25257,6 +25257,9 @@ export const data = {
|
|
|
25257
25257
|
},
|
|
25258
25258
|
"updated": {
|
|
25259
25259
|
"type": "Date"
|
|
25260
|
+
},
|
|
25261
|
+
"category": {
|
|
25262
|
+
"type": "string"
|
|
25260
25263
|
}
|
|
25261
25264
|
}
|
|
25262
25265
|
},
|
|
@@ -25334,6 +25337,9 @@ export const data = {
|
|
|
25334
25337
|
"sendRate": {
|
|
25335
25338
|
"type": "number",
|
|
25336
25339
|
"optional": true
|
|
25340
|
+
},
|
|
25341
|
+
"category": {
|
|
25342
|
+
"type": "string"
|
|
25337
25343
|
}
|
|
25338
25344
|
}
|
|
25339
25345
|
},
|
|
@@ -33604,6 +33610,18 @@ export const data = {
|
|
|
33604
33610
|
"response": "pushwoosh.rpc_v2.rich_medias.GetEventsResponse",
|
|
33605
33611
|
"method": "get",
|
|
33606
33612
|
"path": "/api/rich-medias/{code}:getEvents"
|
|
33613
|
+
},
|
|
33614
|
+
"DeleteRichMedias": {
|
|
33615
|
+
"request": "pushwoosh.rpc_v2.rich_medias.DeleteRichMediasRequest",
|
|
33616
|
+
"response": "pushwoosh.rpc_v2.rich_medias.DeleteRichMediasResponse",
|
|
33617
|
+
"method": "post",
|
|
33618
|
+
"path": "/api/rich-medias/delete"
|
|
33619
|
+
},
|
|
33620
|
+
"GetRichMediasUsage": {
|
|
33621
|
+
"request": "pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageRequest",
|
|
33622
|
+
"response": "pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageResponse",
|
|
33623
|
+
"method": "post",
|
|
33624
|
+
"path": "/api/rich-medias/usage"
|
|
33607
33625
|
}
|
|
33608
33626
|
}
|
|
33609
33627
|
},
|
|
@@ -34464,6 +34482,83 @@ export const data = {
|
|
|
34464
34482
|
}
|
|
34465
34483
|
}
|
|
34466
34484
|
},
|
|
34485
|
+
"pushwoosh.rpc_v2.rich_medias.DeleteRichMediasRequest": {
|
|
34486
|
+
"type": "I",
|
|
34487
|
+
"fields": {
|
|
34488
|
+
"codes": {
|
|
34489
|
+
"type": "string",
|
|
34490
|
+
"array": true
|
|
34491
|
+
}
|
|
34492
|
+
}
|
|
34493
|
+
},
|
|
34494
|
+
"pushwoosh.rpc_v2.rich_medias.DeleteRichMediasResponse": {
|
|
34495
|
+
"type": "I",
|
|
34496
|
+
"fields": {}
|
|
34497
|
+
},
|
|
34498
|
+
"pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageRequest": {
|
|
34499
|
+
"type": "I",
|
|
34500
|
+
"fields": {
|
|
34501
|
+
"codes": {
|
|
34502
|
+
"type": "string",
|
|
34503
|
+
"array": true
|
|
34504
|
+
}
|
|
34505
|
+
}
|
|
34506
|
+
},
|
|
34507
|
+
"pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser": {
|
|
34508
|
+
"type": "I",
|
|
34509
|
+
"fields": {
|
|
34510
|
+
"code": {
|
|
34511
|
+
"type": "string"
|
|
34512
|
+
},
|
|
34513
|
+
"name": {
|
|
34514
|
+
"type": "string"
|
|
34515
|
+
}
|
|
34516
|
+
}
|
|
34517
|
+
},
|
|
34518
|
+
"pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaJourney": {
|
|
34519
|
+
"type": "I",
|
|
34520
|
+
"fields": {
|
|
34521
|
+
"uuid": {
|
|
34522
|
+
"type": "string"
|
|
34523
|
+
},
|
|
34524
|
+
"title": {
|
|
34525
|
+
"type": "string"
|
|
34526
|
+
}
|
|
34527
|
+
}
|
|
34528
|
+
},
|
|
34529
|
+
"pushwoosh.rpc_v2.rich_medias.RichMediaUsage": {
|
|
34530
|
+
"type": "I",
|
|
34531
|
+
"fields": {
|
|
34532
|
+
"code": {
|
|
34533
|
+
"type": "string"
|
|
34534
|
+
},
|
|
34535
|
+
"inApps": {
|
|
34536
|
+
"type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser",
|
|
34537
|
+
"array": true
|
|
34538
|
+
},
|
|
34539
|
+
"pushPresets": {
|
|
34540
|
+
"type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser",
|
|
34541
|
+
"array": true
|
|
34542
|
+
},
|
|
34543
|
+
"inboxPresets": {
|
|
34544
|
+
"type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser",
|
|
34545
|
+
"array": true
|
|
34546
|
+
},
|
|
34547
|
+
"journeys": {
|
|
34548
|
+
"type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaJourney",
|
|
34549
|
+
"array": true
|
|
34550
|
+
}
|
|
34551
|
+
}
|
|
34552
|
+
},
|
|
34553
|
+
"pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageResponse": {
|
|
34554
|
+
"type": "I",
|
|
34555
|
+
"fields": {
|
|
34556
|
+
"usages": {
|
|
34557
|
+
"type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage",
|
|
34558
|
+
"array": true
|
|
34559
|
+
}
|
|
34560
|
+
}
|
|
34561
|
+
},
|
|
34467
34562
|
"pushwoosh.rpc_v2.segment_statistics.SegmentStatisticsService": {
|
|
34468
34563
|
"type": "S",
|
|
34469
34564
|
"key": "segmentStatistics",
|
package/news.d.ts
CHANGED
|
@@ -115,6 +115,8 @@ export type NewsFeedCampaign = {
|
|
|
115
115
|
lastSentTitle: string;
|
|
116
116
|
created: Date;
|
|
117
117
|
updated: Date;
|
|
118
|
+
/** Article category (rubric) the campaign sends; empty sends every article of the feed. */
|
|
119
|
+
category: string;
|
|
118
120
|
};
|
|
119
121
|
export type ListNewsFeedCampaignsRequest = {
|
|
120
122
|
/** Pushwoosh application code (XXXXX-XXXXX). */
|
|
@@ -153,6 +155,8 @@ export type SetNewsFeedCampaignRequest = {
|
|
|
153
155
|
ttlSeconds?: number;
|
|
154
156
|
/** 1..10000 messages per second. Absent uses the account send rate. */
|
|
155
157
|
sendRate?: number;
|
|
158
|
+
/** One of the feed's categories as news-categories.json lists them; empty means every article. */
|
|
159
|
+
category?: string;
|
|
156
160
|
};
|
|
157
161
|
export type SetNewsFeedCampaignResponse = {
|
|
158
162
|
campaign: NewsFeedCampaign;
|
package/package.json
CHANGED
package/rich_medias.d.ts
CHANGED
|
@@ -14,6 +14,8 @@ export type RichMediaService_GetDetailedActionStatistics = RpcMethod<GetDetailed
|
|
|
14
14
|
export type RichMediaService_GetSendChannels = RpcMethod<GetSendChannelsRequest, GetSendChannelsResponse>;
|
|
15
15
|
export type RichMediaService_GetDevices = RpcMethod<GetDevicesRequest, GetDevicesResponse>;
|
|
16
16
|
export type RichMediaService_GetEvents = RpcMethod<GetEventsRequest, GetEventsResponse>;
|
|
17
|
+
export type RichMediaService_DeleteRichMedias = RpcMethod<DeleteRichMediasRequest, DeleteRichMediasResponse>;
|
|
18
|
+
export type RichMediaService_GetRichMediasUsage = RpcMethod<GetRichMediasUsageRequest, GetRichMediasUsageResponse>;
|
|
17
19
|
export interface RichMediaService {
|
|
18
20
|
/** Creates a new rich media for the account, either block-based (built from an empty template) or from an uploaded base64 zip; the server persists it and returns the generated rich media code. Use for HTML/zip rich media; use create_native_rich_media for SDK-rendered native content. */
|
|
19
21
|
Create: RichMediaService_Create;
|
|
@@ -23,7 +25,7 @@ export interface RichMediaService {
|
|
|
23
25
|
UpdateNative: RichMediaService_UpdateNative;
|
|
24
26
|
/** Duplicates an existing rich media (by code) under a new name, copying its content, and returns the new rich media code. Use to start a new rich media from an existing one without editing the original. */
|
|
25
27
|
Clone: RichMediaService_Clone;
|
|
26
|
-
/** Permanently deletes a rich media by code, removing its DB record and content files. Rejected
|
|
28
|
+
/** Permanently deletes a rich media by code, removing its DB record and content files. Rejected while an in-app message, a push preset, an App Inbox preset or a running or paused journey still uses it; check get_rich_medias_usage first. */
|
|
27
29
|
Delete: RichMediaService_Delete;
|
|
28
30
|
/** Returns a single rich media by code, including its rendered content (index.html or native-config.json), params, created type and metadata. Use to inspect one rich media; use list_rich_medias to browse. */
|
|
29
31
|
Get: RichMediaService_Get;
|
|
@@ -45,6 +47,10 @@ export interface RichMediaService {
|
|
|
45
47
|
GetDevices: RichMediaService_GetDevices;
|
|
46
48
|
/** Returns per-event triggered and unique-triggered counts fired from within a rich media by code over a date range, by platform. Use to measure custom events emitted by a rich media's content. */
|
|
47
49
|
GetEvents: RichMediaService_GetEvents;
|
|
50
|
+
/** Permanently deletes several rich medias of the account in one request, up to 1000 codes, like delete_rich_media. All-or-nothing: if any code is not found or is used by an in-app message, a push preset, an App Inbox preset or a running or paused journey, nothing is deleted; check get_rich_medias_usage first. */
|
|
51
|
+
DeleteRichMedias: RichMediaService_DeleteRichMedias;
|
|
52
|
+
/** Lists which of the given rich medias of the account, up to 1000 codes, are used by in-app messages, push presets, App Inbox presets or running or paused journeys, with those users. Rich medias missing from the answer are not in use or not found. Use before delete_rich_medias. */
|
|
53
|
+
GetRichMediasUsage: RichMediaService_GetRichMediasUsage;
|
|
48
54
|
}
|
|
49
55
|
export type ActionType = 'ACTION_TYPE_UNSPECIFIED' | 'ELEMENT_CLICK' | 'FORM_SUBMIT' | 'OPEN' | 'CLOSE';
|
|
50
56
|
export type RichMediaSendChannel = 'RichMediaSendChannel_UNDEFINED' | 'IN_APP' | 'CJ' | 'PUSH';
|
|
@@ -412,3 +418,36 @@ export type LocalizationChange = {
|
|
|
412
418
|
updatedKeys: string[];
|
|
413
419
|
removedKeys: string[];
|
|
414
420
|
};
|
|
421
|
+
export type DeleteRichMediasRequest = {
|
|
422
|
+
/** Rich media codes to delete. */
|
|
423
|
+
codes?: string[];
|
|
424
|
+
};
|
|
425
|
+
export type DeleteRichMediasResponse = {};
|
|
426
|
+
export type GetRichMediasUsageRequest = {
|
|
427
|
+
/** Rich media codes to check. */
|
|
428
|
+
codes?: string[];
|
|
429
|
+
};
|
|
430
|
+
export type RichMediaUsage_RichMediaUser = {
|
|
431
|
+
code: string;
|
|
432
|
+
name: string;
|
|
433
|
+
};
|
|
434
|
+
export type RichMediaUsage_RichMediaJourney = {
|
|
435
|
+
uuid: string;
|
|
436
|
+
title: string;
|
|
437
|
+
};
|
|
438
|
+
export type RichMediaUsage = {
|
|
439
|
+
/** Rich media code. */
|
|
440
|
+
code: string;
|
|
441
|
+
/** In-app messages showing the rich media, in any status. */
|
|
442
|
+
inApps: RichMediaUsage_RichMediaUser[];
|
|
443
|
+
/** Push presets opening the rich media. */
|
|
444
|
+
pushPresets: RichMediaUsage_RichMediaUser[];
|
|
445
|
+
/** App Inbox presets opening the rich media on tap. */
|
|
446
|
+
inboxPresets: RichMediaUsage_RichMediaUser[];
|
|
447
|
+
/** Running or paused journeys sending the rich media. */
|
|
448
|
+
journeys: RichMediaUsage_RichMediaJourney[];
|
|
449
|
+
};
|
|
450
|
+
export type GetRichMediasUsageResponse = {
|
|
451
|
+
/** Only the rich medias that are in use, sorted by rich media code. */
|
|
452
|
+
usages: RichMediaUsage[];
|
|
453
|
+
};
|