@pushwoosh/rpc-v2-http-api-data 0.2.372 → 0.2.374
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 +41 -26
- package/deeplinks.d.ts +10 -0
- package/events.d.ts +17 -19
- package/package.json +1 -1
package/data.js
CHANGED
|
@@ -11795,6 +11795,12 @@ export const data = {
|
|
|
11795
11795
|
"method": "delete",
|
|
11796
11796
|
"path": "/api/deeplinks/{code}"
|
|
11797
11797
|
},
|
|
11798
|
+
"DeleteDeeplinks": {
|
|
11799
|
+
"request": "pushwoosh.rpc_v2.deeplinks.DeleteDeeplinksRequest",
|
|
11800
|
+
"response": "pushwoosh.rpc_v2.deeplinks.DeleteDeeplinksResponse",
|
|
11801
|
+
"method": "post",
|
|
11802
|
+
"path": "/api/deeplinks/delete"
|
|
11803
|
+
},
|
|
11798
11804
|
"GetLinkContent": {
|
|
11799
11805
|
"request": "pushwoosh.rpc_v2.deeplinks.GetLinkContentRequest",
|
|
11800
11806
|
"response": "pushwoosh.rpc_v2.deeplinks.GetLinkContentResponse",
|
|
@@ -11945,6 +11951,22 @@ export const data = {
|
|
|
11945
11951
|
}
|
|
11946
11952
|
}
|
|
11947
11953
|
},
|
|
11954
|
+
"pushwoosh.rpc_v2.deeplinks.DeleteDeeplinksRequest": {
|
|
11955
|
+
"type": "I",
|
|
11956
|
+
"fields": {
|
|
11957
|
+
"application": {
|
|
11958
|
+
"type": "string"
|
|
11959
|
+
},
|
|
11960
|
+
"codes": {
|
|
11961
|
+
"type": "string",
|
|
11962
|
+
"array": true
|
|
11963
|
+
}
|
|
11964
|
+
}
|
|
11965
|
+
},
|
|
11966
|
+
"pushwoosh.rpc_v2.deeplinks.DeleteDeeplinksResponse": {
|
|
11967
|
+
"type": "I",
|
|
11968
|
+
"fields": {}
|
|
11969
|
+
},
|
|
11948
11970
|
"pushwoosh.rpc_v2.deeplinks.DeleteDeeplinkResponse": {
|
|
11949
11971
|
"type": "I",
|
|
11950
11972
|
"fields": {}
|
|
@@ -14399,17 +14421,17 @@ export const data = {
|
|
|
14399
14421
|
"method": "post",
|
|
14400
14422
|
"path": "/api/events:getRevenueStatistics"
|
|
14401
14423
|
},
|
|
14402
|
-
"
|
|
14403
|
-
"request": "pushwoosh.rpc_v2.events.
|
|
14404
|
-
"response": "pushwoosh.rpc_v2.events.
|
|
14424
|
+
"GetConversionEvents": {
|
|
14425
|
+
"request": "pushwoosh.rpc_v2.events.GetConversionEventsRequest",
|
|
14426
|
+
"response": "pushwoosh.rpc_v2.events.ConversionEvents",
|
|
14405
14427
|
"method": "get",
|
|
14406
|
-
"path": "/api/events:conversion-
|
|
14428
|
+
"path": "/api/events:conversion-events"
|
|
14407
14429
|
},
|
|
14408
|
-
"
|
|
14409
|
-
"request": "pushwoosh.rpc_v2.events.
|
|
14410
|
-
"response": "pushwoosh.rpc_v2.events.
|
|
14430
|
+
"SaveConversionEvents": {
|
|
14431
|
+
"request": "pushwoosh.rpc_v2.events.SaveConversionEventsRequest",
|
|
14432
|
+
"response": "pushwoosh.rpc_v2.events.ConversionEvents",
|
|
14411
14433
|
"method": "put",
|
|
14412
|
-
"path": "/api/events:conversion-
|
|
14434
|
+
"path": "/api/events:conversion-events"
|
|
14413
14435
|
}
|
|
14414
14436
|
}
|
|
14415
14437
|
},
|
|
@@ -14956,38 +14978,30 @@ export const data = {
|
|
|
14956
14978
|
}
|
|
14957
14979
|
}
|
|
14958
14980
|
},
|
|
14959
|
-
"pushwoosh.rpc_v2.events.ContactType": {
|
|
14960
|
-
"type": "E",
|
|
14961
|
-
"values": [
|
|
14962
|
-
"CONTACT_TYPE_UNSPECIFIED",
|
|
14963
|
-
"CONTACT_TYPE_CLICK",
|
|
14964
|
-
"CONTACT_TYPE_SENT"
|
|
14965
|
-
]
|
|
14966
|
-
},
|
|
14967
14981
|
"pushwoosh.rpc_v2.events.ConversionEvent": {
|
|
14968
14982
|
"type": "I",
|
|
14969
14983
|
"fields": {
|
|
14970
14984
|
"name": {
|
|
14971
14985
|
"type": "string"
|
|
14972
14986
|
},
|
|
14973
|
-
"
|
|
14974
|
-
"type": "
|
|
14987
|
+
"revenueMapping": {
|
|
14988
|
+
"type": "pushwoosh.rpc_v2.events.RevenueMapping"
|
|
14989
|
+
},
|
|
14990
|
+
"isDefault": {
|
|
14991
|
+
"type": "boolean"
|
|
14975
14992
|
}
|
|
14976
14993
|
}
|
|
14977
14994
|
},
|
|
14978
|
-
"pushwoosh.rpc_v2.events.
|
|
14995
|
+
"pushwoosh.rpc_v2.events.ConversionEvents": {
|
|
14979
14996
|
"type": "I",
|
|
14980
14997
|
"fields": {
|
|
14981
14998
|
"events": {
|
|
14982
14999
|
"type": "pushwoosh.rpc_v2.events.ConversionEvent",
|
|
14983
15000
|
"array": true
|
|
14984
|
-
},
|
|
14985
|
-
"contactType": {
|
|
14986
|
-
"type": "pushwoosh.rpc_v2.events.ContactType"
|
|
14987
15001
|
}
|
|
14988
15002
|
}
|
|
14989
15003
|
},
|
|
14990
|
-
"pushwoosh.rpc_v2.events.
|
|
15004
|
+
"pushwoosh.rpc_v2.events.GetConversionEventsRequest": {
|
|
14991
15005
|
"type": "I",
|
|
14992
15006
|
"fields": {
|
|
14993
15007
|
"application": {
|
|
@@ -14995,14 +15009,15 @@ export const data = {
|
|
|
14995
15009
|
}
|
|
14996
15010
|
}
|
|
14997
15011
|
},
|
|
14998
|
-
"pushwoosh.rpc_v2.events.
|
|
15012
|
+
"pushwoosh.rpc_v2.events.SaveConversionEventsRequest": {
|
|
14999
15013
|
"type": "I",
|
|
15000
15014
|
"fields": {
|
|
15001
15015
|
"application": {
|
|
15002
15016
|
"type": "string"
|
|
15003
15017
|
},
|
|
15004
|
-
"
|
|
15005
|
-
"type": "pushwoosh.rpc_v2.events.
|
|
15018
|
+
"events": {
|
|
15019
|
+
"type": "pushwoosh.rpc_v2.events.ConversionEvent",
|
|
15020
|
+
"array": true
|
|
15006
15021
|
}
|
|
15007
15022
|
}
|
|
15008
15023
|
},
|
package/deeplinks.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ export type DeeplinksService_Get = RpcMethod<GetDeeplinkRequest, GetDeeplinkResp
|
|
|
4
4
|
export type DeeplinksService_Create = RpcMethod<CreateDeeplinkRequest, CreateDeeplinkResponse>;
|
|
5
5
|
export type DeeplinksService_Update = RpcMethod<UpdateDeeplinkRequest, UpdateDeeplinkResponse>;
|
|
6
6
|
export type DeeplinksService_Delete = RpcMethod<DeleteDeeplinkRequest, DeleteDeeplinkResponse>;
|
|
7
|
+
export type DeeplinksService_DeleteDeeplinks = RpcMethod<DeleteDeeplinksRequest, DeleteDeeplinksResponse>;
|
|
7
8
|
export type DeeplinksService_GetLinkContent = RpcMethod<GetLinkContentRequest, GetLinkContentResponse>;
|
|
8
9
|
export interface DeeplinksService {
|
|
9
10
|
/** Lists deeplinks configured for an application (code XXXXX-XXXXX), ordered by name or creation date, with paging and an optional name/code/template substring filter. Use to browse deeplinks or find a deeplink code before fetching or editing one. */
|
|
@@ -16,6 +17,8 @@ export interface DeeplinksService {
|
|
|
16
17
|
Update: DeeplinksService_Update;
|
|
17
18
|
/** Permanently deletes a deeplink by deeplink code. Only deeplinks owned by the caller's account can be deleted, and the removal cannot be undone. */
|
|
18
19
|
Delete: DeeplinksService_Delete;
|
|
20
|
+
/** Permanently deletes several deeplinks of an application (code XXXXX-XXXXX) by deeplink codes in one request, up to 1000 codes. All codes must belong to the application and the caller's account, otherwise nothing is deleted and NotFound is returned. Use delete_deeplink for a single deeplink. */
|
|
21
|
+
DeleteDeeplinks: DeeplinksService_DeleteDeeplinks;
|
|
19
22
|
/**
|
|
20
23
|
* Fetches the given http(s) URL and returns an HTML head fragment containing only its og:* meta tags. Use to preview link metadata (title/image) when building a deeplink; reaches out to the external URL.
|
|
21
24
|
* POST is used instead of GET because the uri parameter may contain
|
|
@@ -81,6 +84,13 @@ export type DeleteDeeplinkRequest = {
|
|
|
81
84
|
/** Deeplink code identifying the deeplink to delete. */
|
|
82
85
|
code?: string;
|
|
83
86
|
};
|
|
87
|
+
export type DeleteDeeplinksRequest = {
|
|
88
|
+
/** Application code (XXXXX-XXXXX) the deeplinks belong to. */
|
|
89
|
+
application?: string;
|
|
90
|
+
/** Deeplink codes to delete. */
|
|
91
|
+
codes?: string[];
|
|
92
|
+
};
|
|
93
|
+
export type DeleteDeeplinksResponse = {};
|
|
84
94
|
export type DeleteDeeplinkResponse = {};
|
|
85
95
|
export type GetLinkContentRequest = {
|
|
86
96
|
/** Absolute http(s) URL to fetch and extract og:* meta tags from. */
|
package/events.d.ts
CHANGED
|
@@ -9,8 +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
|
|
13
|
-
export type
|
|
12
|
+
export type EventsService_GetConversionEvents = RpcMethod<GetConversionEventsRequest, ConversionEvents>;
|
|
13
|
+
export type EventsService_SaveConversionEvents = RpcMethod<SaveConversionEventsRequest, ConversionEvents>;
|
|
14
14
|
export interface EventsService {
|
|
15
15
|
/** Returns one custom event by name for an application, including its attributes, store-days and revenue mapping. Use after list_events to inspect a single event's definition. */
|
|
16
16
|
Get: EventsService_Get;
|
|
@@ -32,10 +32,10 @@ export interface EventsService {
|
|
|
32
32
|
GetTotalStatistics: EventsService_GetTotalStatistics;
|
|
33
33
|
/** 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
34
|
GetRevenueStatistics: EventsService_GetRevenueStatistics;
|
|
35
|
-
/** Returns
|
|
36
|
-
|
|
37
|
-
/** Replaces the
|
|
38
|
-
|
|
35
|
+
/** Returns the events counted as conversions on the Conversions board, PW_Conversion first, each with its revenue attributes when it tracks revenue. */
|
|
36
|
+
GetConversionEvents: EventsService_GetConversionEvents;
|
|
37
|
+
/** 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. */
|
|
38
|
+
SaveConversionEvents: EventsService_SaveConversionEvents;
|
|
39
39
|
}
|
|
40
40
|
export type GetEventRequest = {
|
|
41
41
|
/** Application code (format XXXXX-XXXXX) the event belongs to. */
|
|
@@ -276,27 +276,25 @@ export type GetRevenueStatisticsResponse_EventRevenue = {
|
|
|
276
276
|
export type GetRevenueStatisticsResponse = {
|
|
277
277
|
metrics: GetRevenueStatisticsResponse_EventRevenue[];
|
|
278
278
|
};
|
|
279
|
-
/** ContactType is the touch a conversion is counted from: the click on the message (default) or the send itself. */
|
|
280
|
-
export type ContactType = 'CONTACT_TYPE_UNSPECIFIED' | 'CONTACT_TYPE_CLICK' | 'CONTACT_TYPE_SENT';
|
|
281
279
|
export type ConversionEvent = {
|
|
282
|
-
/** Name of the application's
|
|
280
|
+
/** Name of the application's event that counts as a conversion. */
|
|
283
281
|
name: string;
|
|
284
|
-
/**
|
|
285
|
-
|
|
282
|
+
/** Where the event keeps its amount and currency; unset for an event counted without revenue. */
|
|
283
|
+
revenueMapping: RevenueMapping;
|
|
284
|
+
/** PW_Conversion: always listed, always tracks revenue, cannot be removed. */
|
|
285
|
+
isDefault: boolean;
|
|
286
286
|
};
|
|
287
|
-
export type
|
|
288
|
-
/**
|
|
287
|
+
export type ConversionEvents = {
|
|
288
|
+
/** Events counted as conversions, PW_Conversion first. */
|
|
289
289
|
events: ConversionEvent[];
|
|
290
|
-
/** Contact type shared by all events of the application; UNSPECIFIED reads as CLICK. */
|
|
291
|
-
contactType: ContactType;
|
|
292
290
|
};
|
|
293
|
-
export type
|
|
291
|
+
export type GetConversionEventsRequest = {
|
|
294
292
|
/** Application code (format XXXXX-XXXXX). */
|
|
295
293
|
application?: string;
|
|
296
294
|
};
|
|
297
|
-
export type
|
|
295
|
+
export type SaveConversionEventsRequest = {
|
|
298
296
|
/** Application code (format XXXXX-XXXXX). */
|
|
299
297
|
application?: string;
|
|
300
|
-
/** Full replacement of the application's conversion
|
|
301
|
-
|
|
298
|
+
/** Full replacement of the application's conversion events; events left out stop counting. */
|
|
299
|
+
events?: ConversionEvent[];
|
|
302
300
|
};
|