@pushwoosh/rpc-v2-http-api-data 0.2.444 → 0.2.446
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/applications_configurations.d.ts +15 -0
- package/data.js +125 -0
- package/events.d.ts +45 -1
- package/package.json +1 -1
|
@@ -3,6 +3,7 @@ export type ApplicationsConfigurationsService_Configure = RpcMethod<Configuratio
|
|
|
3
3
|
export type ApplicationsConfigurationsService_ListSmsProviders = RpcMethod<ListSmsProvidersRequest, ListSmsProvidersResponse>;
|
|
4
4
|
export type ApplicationsConfigurationsService_SendTestSms = RpcMethod<SendTestSmsRequest, SendTestSmsResponse>;
|
|
5
5
|
export type ApplicationsConfigurationsService_EnablePlatform = RpcMethod<EnablePlatformRequest, EnablePlatformResponse>;
|
|
6
|
+
export type ApplicationsConfigurationsService_CreatePassKitSigningRequest = RpcMethod<CreatePassKitSigningRequestRequest, CreatePassKitSigningRequestResponse>;
|
|
6
7
|
export interface ApplicationsConfigurationsService {
|
|
7
8
|
/** Saves the provider credentials for one delivery platform or channel of an application (code XXXXX-XXXXX) — APNs/FCM push keys, an SMS provider, email sender, Telegram/Viber token, Google Wallet, etc. — then enables that platform. Pick the matching kind in the oneof; some providers (Telegram, Huawei) also call the external provider API to register a webhook or validate the token. */
|
|
8
9
|
Configure: ApplicationsConfigurationsService_Configure;
|
|
@@ -12,6 +13,8 @@ export interface ApplicationsConfigurationsService {
|
|
|
12
13
|
SendTestSms: ApplicationsConfigurationsService_SendTestSms;
|
|
13
14
|
/** Enables or disables a single delivery platform (by numeric platform id) for an application (code XXXXX-XXXXX) without touching its stored credentials. Use to toggle a channel on or off; update_platform_configuration already enables a platform after saving its credentials. */
|
|
14
15
|
EnablePlatform: ApplicationsConfigurationsService_EnablePlatform;
|
|
16
|
+
/** Starts an Apple Wallet setup without a Mac: generates and keeps the private key for an application (code XXXXX-XXXXX) and returns the certificate signing request to upload to Apple when creating a Pass Type ID Certificate. Hand the .cer Apple issues back to update_platform_configuration (ios_passkit_configuration, key file only, no password). Calling again returns a request for the same key, so a file already uploaded to Apple keeps matching; rotate starts over with a new key. */
|
|
17
|
+
CreatePassKitSigningRequest: ApplicationsConfigurationsService_CreatePassKitSigningRequest;
|
|
15
18
|
}
|
|
16
19
|
export type AndroidConfiguration = {
|
|
17
20
|
androidFramework: string;
|
|
@@ -85,6 +88,7 @@ export type IOSVoIPConfiguration = {
|
|
|
85
88
|
* to api.push.apple.com.
|
|
86
89
|
*/
|
|
87
90
|
export type IOSPassKitConfiguration = {
|
|
91
|
+
/** Either a .p12 with its password, or the bare .cer Apple issued for a request from create_passkit_signing_request (password left empty). */
|
|
88
92
|
iosPasskitKeyFile: string;
|
|
89
93
|
iosPasskitCertPassword: string;
|
|
90
94
|
};
|
|
@@ -386,6 +390,17 @@ export type EnablePlatformRequest = {
|
|
|
386
390
|
enable?: boolean;
|
|
387
391
|
};
|
|
388
392
|
export type EnablePlatformResponse = {};
|
|
393
|
+
export type CreatePassKitSigningRequestRequest = {
|
|
394
|
+
/** Application code (format XXXXX-XXXXX) to set Apple Wallet up for. */
|
|
395
|
+
code?: string;
|
|
396
|
+
/** Start over with a new key; a request given earlier stops matching. */
|
|
397
|
+
rotate?: boolean;
|
|
398
|
+
};
|
|
399
|
+
export type CreatePassKitSigningRequestResponse = {
|
|
400
|
+
/** PEM certificate signing request; save it as file_name and upload it to Apple. */
|
|
401
|
+
csr: string;
|
|
402
|
+
fileName: string;
|
|
403
|
+
};
|
|
389
404
|
export type ListSmsProvidersRequest = {};
|
|
390
405
|
export type ListSmsProvidersResponse = {
|
|
391
406
|
providers: SmsProvider[];
|
package/data.js
CHANGED
|
@@ -6231,6 +6231,12 @@ export const data = {
|
|
|
6231
6231
|
"response": "pushwoosh.rpc_v2.applications_configurations.EnablePlatformResponse",
|
|
6232
6232
|
"method": "post",
|
|
6233
6233
|
"path": "/api/applications_configurations:enable/{code}"
|
|
6234
|
+
},
|
|
6235
|
+
"CreatePassKitSigningRequest": {
|
|
6236
|
+
"request": "pushwoosh.rpc_v2.applications_configurations.CreatePassKitSigningRequestRequest",
|
|
6237
|
+
"response": "pushwoosh.rpc_v2.applications_configurations.CreatePassKitSigningRequestResponse",
|
|
6238
|
+
"method": "post",
|
|
6239
|
+
"path": "/api/applications_configurations:passkit_signing_request/{code}"
|
|
6234
6240
|
}
|
|
6235
6241
|
}
|
|
6236
6242
|
},
|
|
@@ -6917,6 +6923,28 @@ export const data = {
|
|
|
6917
6923
|
"type": "I",
|
|
6918
6924
|
"fields": {}
|
|
6919
6925
|
},
|
|
6926
|
+
"pushwoosh.rpc_v2.applications_configurations.CreatePassKitSigningRequestRequest": {
|
|
6927
|
+
"type": "I",
|
|
6928
|
+
"fields": {
|
|
6929
|
+
"code": {
|
|
6930
|
+
"type": "string"
|
|
6931
|
+
},
|
|
6932
|
+
"rotate": {
|
|
6933
|
+
"type": "boolean"
|
|
6934
|
+
}
|
|
6935
|
+
}
|
|
6936
|
+
},
|
|
6937
|
+
"pushwoosh.rpc_v2.applications_configurations.CreatePassKitSigningRequestResponse": {
|
|
6938
|
+
"type": "I",
|
|
6939
|
+
"fields": {
|
|
6940
|
+
"csr": {
|
|
6941
|
+
"type": "string"
|
|
6942
|
+
},
|
|
6943
|
+
"fileName": {
|
|
6944
|
+
"type": "string"
|
|
6945
|
+
}
|
|
6946
|
+
}
|
|
6947
|
+
},
|
|
6920
6948
|
"pushwoosh.rpc_v2.applications_configurations.ListSmsProvidersRequest": {
|
|
6921
6949
|
"type": "I",
|
|
6922
6950
|
"fields": {}
|
|
@@ -14909,6 +14937,18 @@ export const data = {
|
|
|
14909
14937
|
"method": "delete",
|
|
14910
14938
|
"path": "/api/events/{name}"
|
|
14911
14939
|
},
|
|
14940
|
+
"DeleteEvents": {
|
|
14941
|
+
"request": "pushwoosh.rpc_v2.events.DeleteEventsRequest",
|
|
14942
|
+
"response": "pushwoosh.rpc_v2.events.DeleteEventsResponse",
|
|
14943
|
+
"method": "post",
|
|
14944
|
+
"path": "/api/events:delete"
|
|
14945
|
+
},
|
|
14946
|
+
"GetEventsUsage": {
|
|
14947
|
+
"request": "pushwoosh.rpc_v2.events.GetEventsUsageRequest",
|
|
14948
|
+
"response": "pushwoosh.rpc_v2.events.GetEventsUsageResponse",
|
|
14949
|
+
"method": "post",
|
|
14950
|
+
"path": "/api/events:usage"
|
|
14951
|
+
},
|
|
14912
14952
|
"GetAttributeValues": {
|
|
14913
14953
|
"request": "pushwoosh.rpc_v2.events.GetAttributeValuesRequest",
|
|
14914
14954
|
"response": "pushwoosh.rpc_v2.events.GetAttributeValuesResponse",
|
|
@@ -15189,6 +15229,91 @@ export const data = {
|
|
|
15189
15229
|
"type": "I",
|
|
15190
15230
|
"fields": {}
|
|
15191
15231
|
},
|
|
15232
|
+
"pushwoosh.rpc_v2.events.DeleteEventsRequest": {
|
|
15233
|
+
"type": "I",
|
|
15234
|
+
"fields": {
|
|
15235
|
+
"application": {
|
|
15236
|
+
"type": "string"
|
|
15237
|
+
},
|
|
15238
|
+
"names": {
|
|
15239
|
+
"type": "string",
|
|
15240
|
+
"array": true
|
|
15241
|
+
}
|
|
15242
|
+
}
|
|
15243
|
+
},
|
|
15244
|
+
"pushwoosh.rpc_v2.events.DeleteEventsResponse": {
|
|
15245
|
+
"type": "I",
|
|
15246
|
+
"fields": {}
|
|
15247
|
+
},
|
|
15248
|
+
"pushwoosh.rpc_v2.events.GetEventsUsageRequest": {
|
|
15249
|
+
"type": "I",
|
|
15250
|
+
"fields": {
|
|
15251
|
+
"application": {
|
|
15252
|
+
"type": "string"
|
|
15253
|
+
},
|
|
15254
|
+
"names": {
|
|
15255
|
+
"type": "string",
|
|
15256
|
+
"array": true
|
|
15257
|
+
}
|
|
15258
|
+
}
|
|
15259
|
+
},
|
|
15260
|
+
"pushwoosh.rpc_v2.events.EventUser.Kind": {
|
|
15261
|
+
"type": "E",
|
|
15262
|
+
"values": [
|
|
15263
|
+
"KIND_UNSPECIFIED",
|
|
15264
|
+
"KIND_SYSTEM",
|
|
15265
|
+
"KIND_JOURNEY",
|
|
15266
|
+
"KIND_SEGMENT",
|
|
15267
|
+
"KIND_IN_APP",
|
|
15268
|
+
"KIND_INBOUND_WEBHOOK",
|
|
15269
|
+
"KIND_RFM",
|
|
15270
|
+
"KIND_DASHBOARD_WIDGET",
|
|
15271
|
+
"KIND_GEOZONE",
|
|
15272
|
+
"KIND_CONVERSION"
|
|
15273
|
+
]
|
|
15274
|
+
},
|
|
15275
|
+
"pushwoosh.rpc_v2.events.EventUser": {
|
|
15276
|
+
"type": "I",
|
|
15277
|
+
"fields": {
|
|
15278
|
+
"kind": {
|
|
15279
|
+
"type": "pushwoosh.rpc_v2.events.EventUser.Kind"
|
|
15280
|
+
},
|
|
15281
|
+
"code": {
|
|
15282
|
+
"type": "string"
|
|
15283
|
+
},
|
|
15284
|
+
"name": {
|
|
15285
|
+
"type": "string"
|
|
15286
|
+
},
|
|
15287
|
+
"status": {
|
|
15288
|
+
"type": "string"
|
|
15289
|
+
}
|
|
15290
|
+
}
|
|
15291
|
+
},
|
|
15292
|
+
"pushwoosh.rpc_v2.events.EventUsage": {
|
|
15293
|
+
"type": "I",
|
|
15294
|
+
"fields": {
|
|
15295
|
+
"name": {
|
|
15296
|
+
"type": "string"
|
|
15297
|
+
},
|
|
15298
|
+
"blockers": {
|
|
15299
|
+
"type": "pushwoosh.rpc_v2.events.EventUser",
|
|
15300
|
+
"array": true
|
|
15301
|
+
},
|
|
15302
|
+
"deletes": {
|
|
15303
|
+
"type": "pushwoosh.rpc_v2.events.EventUser",
|
|
15304
|
+
"array": true
|
|
15305
|
+
}
|
|
15306
|
+
}
|
|
15307
|
+
},
|
|
15308
|
+
"pushwoosh.rpc_v2.events.GetEventsUsageResponse": {
|
|
15309
|
+
"type": "I",
|
|
15310
|
+
"fields": {
|
|
15311
|
+
"usages": {
|
|
15312
|
+
"type": "pushwoosh.rpc_v2.events.EventUsage",
|
|
15313
|
+
"array": true
|
|
15314
|
+
}
|
|
15315
|
+
}
|
|
15316
|
+
},
|
|
15192
15317
|
"pushwoosh.rpc_v2.events.GetAttributeValuesRequest": {
|
|
15193
15318
|
"type": "I",
|
|
15194
15319
|
"fields": {
|
package/events.d.ts
CHANGED
|
@@ -4,6 +4,8 @@ export type EventsService_List = RpcMethod<ListEventsRequest, ListEventsResponse
|
|
|
4
4
|
export type EventsService_Create = RpcMethod<CreateEventRequest, CreateEventResponse>;
|
|
5
5
|
export type EventsService_Update = RpcMethod<UpdateEventRequest, UpdateEventResponse>;
|
|
6
6
|
export type EventsService_Delete = RpcMethod<DeleteEventRequest, DeleteEventResponse>;
|
|
7
|
+
export type EventsService_DeleteEvents = RpcMethod<DeleteEventsRequest, DeleteEventsResponse>;
|
|
8
|
+
export type EventsService_GetEventsUsage = RpcMethod<GetEventsUsageRequest, GetEventsUsageResponse>;
|
|
7
9
|
export type EventsService_GetAttributeValues = RpcMethod<GetAttributeValuesRequest, GetAttributeValuesResponse>;
|
|
8
10
|
export type EventsService_GetTriggeredCount = RpcMethod<GetTriggeredCountRequest, GetTriggeredCountResponse>;
|
|
9
11
|
export type EventsService_GetDetailedStatistics = RpcMethod<GetDetailedStatisticsRequest, GetDetailedStatisticsResponse>;
|
|
@@ -22,8 +24,12 @@ export interface EventsService {
|
|
|
22
24
|
Create: EventsService_Create;
|
|
23
25
|
/** Overwrites a custom event's description, attribute set and revenue mapping (the name is immutable). Fully replaces the attribute list, so resend every attribute you want to keep. */
|
|
24
26
|
Update: EventsService_Update;
|
|
25
|
-
/** Deletes a custom event and its attributes from an application
|
|
27
|
+
/** Deletes a custom event and its attributes from an application, with the checks of delete_events: a system event, a journey, segment, in-app, inbound webhook, RFM config, dashboard widget or geozone using it refuses the delete; its conversion settings go with it. Not undoable. */
|
|
26
28
|
Delete: EventsService_Delete;
|
|
29
|
+
/** Deletes up to 100 custom events of an application, all or nothing. A system event, or one used by a draft, running or paused journey, a segment, an in-app, an inbound webhook, an RFM config, a dashboard widget or a geozone, blocks the whole batch. Conversion settings and revenue mappings are deleted with their events. Check get_events_usage first. */
|
|
30
|
+
DeleteEvents: EventsService_DeleteEvents;
|
|
31
|
+
/** Lists, for up to 100 custom events of an application, what blocks deleting each of them and what is deleted with it. Events missing from the answer are free or not found. */
|
|
32
|
+
GetEventsUsage: EventsService_GetEventsUsage;
|
|
27
33
|
/** Returns distinct recorded values of one attribute of a custom event, with paging and a value search. Use to populate attribute-value pickers when building event-based filters. */
|
|
28
34
|
GetAttributeValues: EventsService_GetAttributeValues;
|
|
29
35
|
/** Returns all-time total and unique triggered counts for the named custom events in an application. Use for a quick per-event volume check; for a time series use get_event_detailed_statistics. */
|
|
@@ -135,6 +141,44 @@ export type DeleteEventRequest = {
|
|
|
135
141
|
application?: string;
|
|
136
142
|
};
|
|
137
143
|
export type DeleteEventResponse = {};
|
|
144
|
+
export type DeleteEventsRequest = {
|
|
145
|
+
/** Application code (format XXXXX-XXXXX) the events belong to. */
|
|
146
|
+
application?: string;
|
|
147
|
+
/** Names of the custom events to delete, at most 100. */
|
|
148
|
+
names?: string[];
|
|
149
|
+
};
|
|
150
|
+
export type DeleteEventsResponse = {};
|
|
151
|
+
export type GetEventsUsageRequest = {
|
|
152
|
+
/** Application code (format XXXXX-XXXXX) the events belong to. */
|
|
153
|
+
application?: string;
|
|
154
|
+
/** Names of the custom events to check, at most 100. */
|
|
155
|
+
names?: string[];
|
|
156
|
+
};
|
|
157
|
+
export type EventUser_Kind = 'KIND_UNSPECIFIED'
|
|
158
|
+
/** The event is built into the platform. */
|
|
159
|
+
| 'KIND_SYSTEM' | 'KIND_JOURNEY' | 'KIND_SEGMENT' | 'KIND_IN_APP' | 'KIND_INBOUND_WEBHOOK' | 'KIND_RFM' | 'KIND_DASHBOARD_WIDGET' | 'KIND_GEOZONE'
|
|
160
|
+
/** Conversion settings and revenue mapping of the event itself. */
|
|
161
|
+
| 'KIND_CONVERSION';
|
|
162
|
+
/** EventUser is something that uses an event. */
|
|
163
|
+
export type EventUser = {
|
|
164
|
+
kind: EventUser_Kind;
|
|
165
|
+
/** Code, uuid or id of the user, as its own page addresses it. */
|
|
166
|
+
code: string;
|
|
167
|
+
name: string;
|
|
168
|
+
/** Current status of the user where it has one, in lower case (e.g. running, draft, active). */
|
|
169
|
+
status: string;
|
|
170
|
+
};
|
|
171
|
+
export type EventUsage = {
|
|
172
|
+
name: string;
|
|
173
|
+
/** What refuses the delete of this event. */
|
|
174
|
+
blockers: EventUser[];
|
|
175
|
+
/** What is deleted together with the event. */
|
|
176
|
+
deletes: EventUser[];
|
|
177
|
+
};
|
|
178
|
+
export type GetEventsUsageResponse = {
|
|
179
|
+
/** Only the events that have a user, sorted by name. */
|
|
180
|
+
usages: EventUsage[];
|
|
181
|
+
};
|
|
138
182
|
export type GetAttributeValuesRequest = {
|
|
139
183
|
/** Application code (format XXXXX-XXXXX) the event belongs to. */
|
|
140
184
|
application?: string;
|