@pushwoosh/rpc-v2-http-api-data 0.2.414 → 0.2.416
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 +58 -0
- package/events.d.ts +33 -0
- package/package.json +1 -1
package/data.js
CHANGED
|
@@ -14810,6 +14810,18 @@ export const data = {
|
|
|
14810
14810
|
"method": "post",
|
|
14811
14811
|
"path": "/api/events:getRevenueStatistics"
|
|
14812
14812
|
},
|
|
14813
|
+
"GetRevenueSuggestions": {
|
|
14814
|
+
"request": "pushwoosh.rpc_v2.events.GetRevenueSuggestionsRequest",
|
|
14815
|
+
"response": "pushwoosh.rpc_v2.events.RevenueSuggestions",
|
|
14816
|
+
"method": "get",
|
|
14817
|
+
"path": "/api/events:revenue-suggestions"
|
|
14818
|
+
},
|
|
14819
|
+
"DismissRevenueSuggestions": {
|
|
14820
|
+
"request": "pushwoosh.rpc_v2.events.DismissRevenueSuggestionsRequest",
|
|
14821
|
+
"response": "pushwoosh.rpc_v2.events.DismissRevenueSuggestionsResponse",
|
|
14822
|
+
"method": "post",
|
|
14823
|
+
"path": "/api/events:dismiss-revenue-suggestions"
|
|
14824
|
+
},
|
|
14813
14825
|
"GetConversionEvents": {
|
|
14814
14826
|
"request": "pushwoosh.rpc_v2.events.GetConversionEventsRequest",
|
|
14815
14827
|
"response": "pushwoosh.rpc_v2.events.ConversionEvents",
|
|
@@ -15390,6 +15402,52 @@ export const data = {
|
|
|
15390
15402
|
}
|
|
15391
15403
|
}
|
|
15392
15404
|
},
|
|
15405
|
+
"pushwoosh.rpc_v2.events.RevenueSuggestion": {
|
|
15406
|
+
"type": "I",
|
|
15407
|
+
"fields": {
|
|
15408
|
+
"event": {
|
|
15409
|
+
"type": "string"
|
|
15410
|
+
},
|
|
15411
|
+
"valueAttr": {
|
|
15412
|
+
"type": "string"
|
|
15413
|
+
},
|
|
15414
|
+
"currencyAttr": {
|
|
15415
|
+
"type": "string"
|
|
15416
|
+
},
|
|
15417
|
+
"triggeredCount": {
|
|
15418
|
+
"type": "number"
|
|
15419
|
+
}
|
|
15420
|
+
}
|
|
15421
|
+
},
|
|
15422
|
+
"pushwoosh.rpc_v2.events.RevenueSuggestions": {
|
|
15423
|
+
"type": "I",
|
|
15424
|
+
"fields": {
|
|
15425
|
+
"suggestions": {
|
|
15426
|
+
"type": "pushwoosh.rpc_v2.events.RevenueSuggestion",
|
|
15427
|
+
"array": true
|
|
15428
|
+
}
|
|
15429
|
+
}
|
|
15430
|
+
},
|
|
15431
|
+
"pushwoosh.rpc_v2.events.GetRevenueSuggestionsRequest": {
|
|
15432
|
+
"type": "I",
|
|
15433
|
+
"fields": {
|
|
15434
|
+
"application": {
|
|
15435
|
+
"type": "string"
|
|
15436
|
+
}
|
|
15437
|
+
}
|
|
15438
|
+
},
|
|
15439
|
+
"pushwoosh.rpc_v2.events.DismissRevenueSuggestionsRequest": {
|
|
15440
|
+
"type": "I",
|
|
15441
|
+
"fields": {
|
|
15442
|
+
"application": {
|
|
15443
|
+
"type": "string"
|
|
15444
|
+
}
|
|
15445
|
+
}
|
|
15446
|
+
},
|
|
15447
|
+
"pushwoosh.rpc_v2.events.DismissRevenueSuggestionsResponse": {
|
|
15448
|
+
"type": "I",
|
|
15449
|
+
"fields": {}
|
|
15450
|
+
},
|
|
15393
15451
|
"pushwoosh.rpc_v2.events.GetConversionEventsRequest": {
|
|
15394
15452
|
"type": "I",
|
|
15395
15453
|
"fields": {
|
package/events.d.ts
CHANGED
|
@@ -9,6 +9,8 @@ export type EventsService_GetTriggeredCount = RpcMethod<GetTriggeredCountRequest
|
|
|
9
9
|
export type EventsService_GetDetailedStatistics = RpcMethod<GetDetailedStatisticsRequest, GetDetailedStatisticsResponse>;
|
|
10
10
|
export type EventsService_GetTotalStatistics = RpcMethod<GetTotalStatisticsRequest, GetTotalStatisticsResponse>;
|
|
11
11
|
export type EventsService_GetRevenueStatistics = RpcMethod<GetRevenueStatisticsRequest, GetRevenueStatisticsResponse>;
|
|
12
|
+
export type EventsService_GetRevenueSuggestions = RpcMethod<GetRevenueSuggestionsRequest, RevenueSuggestions>;
|
|
13
|
+
export type EventsService_DismissRevenueSuggestions = RpcMethod<DismissRevenueSuggestionsRequest, DismissRevenueSuggestionsResponse>;
|
|
12
14
|
export type EventsService_GetConversionEvents = RpcMethod<GetConversionEventsRequest, ConversionEvents>;
|
|
13
15
|
export type EventsService_SaveConversionEvents = RpcMethod<SaveConversionEventsRequest, ConversionEvents>;
|
|
14
16
|
export interface EventsService {
|
|
@@ -32,6 +34,10 @@ export interface EventsService {
|
|
|
32
34
|
GetTotalStatistics: EventsService_GetTotalStatistics;
|
|
33
35
|
/** Returns per-currency revenue totals and triggered counts for the revenue-mapped events of an application over a date range. Use to show how much revenue an event brought, kept in the original currencies. */
|
|
34
36
|
GetRevenueStatistics: EventsService_GetRevenueStatistics;
|
|
37
|
+
/** Returns the revenue mappings the daily cron suggests for an application: custom events that already carry a purchase amount and an ISO currency code and are not conversion events yet, best first, each with the two attribute names. An empty list means nothing suitable was found or the client dismissed the hint. */
|
|
38
|
+
GetRevenueSuggestions: EventsService_GetRevenueSuggestions;
|
|
39
|
+
/** Hides the suggested revenue mapping hint for an application for good; the suggestions are kept but no longer returned. */
|
|
40
|
+
DismissRevenueSuggestions: EventsService_DismissRevenueSuggestions;
|
|
35
41
|
/** Returns the events counted as conversions on the Conversions board, PW_Conversion first, each with its revenue attributes when it tracks revenue. */
|
|
36
42
|
GetConversionEvents: EventsService_GetConversionEvents;
|
|
37
43
|
/** Replaces the list of events counted as conversions on the Conversions board. Events left out of the request stop counting; PW_Conversion is always kept. Revenue attributes of an event are set through Update (revenue_mapping). A newly listed event is scheduled for a history recalculation. */
|
|
@@ -288,6 +294,33 @@ export type ConversionEvents = {
|
|
|
288
294
|
/** Events counted as conversions, PW_Conversion first. */
|
|
289
295
|
events: ConversionEvent[];
|
|
290
296
|
};
|
|
297
|
+
/**
|
|
298
|
+
* RevenueSuggestion is a revenue mapping found by the cron but not enabled yet: the event
|
|
299
|
+
* and the attributes that would feed PW_Conversion value and currency.
|
|
300
|
+
*/
|
|
301
|
+
export type RevenueSuggestion = {
|
|
302
|
+
/** Name of the suggested custom event. */
|
|
303
|
+
event: string;
|
|
304
|
+
/** Event attribute holding the purchase amount. */
|
|
305
|
+
valueAttr: string;
|
|
306
|
+
/** Event attribute holding the ISO currency code. */
|
|
307
|
+
currencyAttr: string;
|
|
308
|
+
/** How many times the event fired over the last 30 days when the suggestion was made. */
|
|
309
|
+
triggeredCount: number;
|
|
310
|
+
};
|
|
311
|
+
export type RevenueSuggestions = {
|
|
312
|
+
/** Candidate events best first: purchase-like names, then the most frequent. Empty when there is nothing to show. */
|
|
313
|
+
suggestions: RevenueSuggestion[];
|
|
314
|
+
};
|
|
315
|
+
export type GetRevenueSuggestionsRequest = {
|
|
316
|
+
/** Application code (format XXXXX-XXXXX). */
|
|
317
|
+
application?: string;
|
|
318
|
+
};
|
|
319
|
+
export type DismissRevenueSuggestionsRequest = {
|
|
320
|
+
/** Application code (format XXXXX-XXXXX). */
|
|
321
|
+
application?: string;
|
|
322
|
+
};
|
|
323
|
+
export type DismissRevenueSuggestionsResponse = {};
|
|
291
324
|
export type GetConversionEventsRequest = {
|
|
292
325
|
/** Application code (format XXXXX-XXXXX). */
|
|
293
326
|
application?: string;
|