@zyphr-dev/node-sdk 0.1.5 → 0.1.6
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/dist/src/models/Device.d.ts +9 -21
- package/dist/src/models/Device.d.ts.map +1 -1
- package/dist/src/models/Device.js +11 -20
- package/dist/src/models/Device.js.map +1 -1
- package/dist/src/models/DeviceStats.d.ts +6 -0
- package/dist/src/models/DeviceStats.d.ts.map +1 -1
- package/dist/src/models/DeviceStats.js +4 -2
- package/dist/src/models/DeviceStats.js.map +1 -1
- package/dist/src/models/PushMessage.d.ts +35 -14
- package/dist/src/models/PushMessage.d.ts.map +1 -1
- package/dist/src/models/PushMessage.js +24 -17
- package/dist/src/models/PushMessage.js.map +1 -1
- package/dist/src/models/PushMessageDetail.d.ts +44 -36
- package/dist/src/models/PushMessageDetail.d.ts.map +1 -1
- package/dist/src/models/PushMessageDetail.js +29 -25
- package/dist/src/models/PushMessageDetail.js.map +1 -1
- package/dist/src/models/PushMessageDetailAllOfActionButtons.d.ts +51 -0
- package/dist/src/models/PushMessageDetailAllOfActionButtons.d.ts.map +1 -0
- package/dist/src/models/PushMessageDetailAllOfActionButtons.js +55 -0
- package/dist/src/models/PushMessageDetailAllOfActionButtons.js.map +1 -0
- package/dist/src/models/RegisterDeviceRequest.d.ts +7 -35
- package/dist/src/models/RegisterDeviceRequest.d.ts.map +1 -1
- package/dist/src/models/RegisterDeviceRequest.js +6 -14
- package/dist/src/models/RegisterDeviceRequest.js.map +1 -1
- package/dist/src/models/SendPushRequest.d.ts +83 -29
- package/dist/src/models/SendPushRequest.d.ts.map +1 -1
- package/dist/src/models/SendPushRequest.js +35 -27
- package/dist/src/models/SendPushRequest.js.map +1 -1
- package/dist/src/models/{PushPayload.d.ts → SendPushRequestActionButtonsInner.d.ts} +17 -43
- package/dist/src/models/SendPushRequestActionButtonsInner.d.ts.map +1 -0
- package/dist/src/models/{PushPayload.js → SendPushRequestActionButtonsInner.js} +22 -30
- package/dist/src/models/SendPushRequestActionButtonsInner.js.map +1 -0
- package/dist/src/models/index.d.ts +2 -1
- package/dist/src/models/index.d.ts.map +1 -1
- package/dist/src/models/index.js +2 -1
- package/dist/src/models/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +2 -1
- package/src/src/models/Device.ts +17 -34
- package/src/src/models/DeviceStats.ts +10 -2
- package/src/src/models/PushMessage.ts +47 -22
- package/src/src/models/PushMessageDetail.ts +66 -50
- package/src/src/models/PushMessageDetailAllOfActionButtons.ts +89 -0
- package/src/src/models/RegisterDeviceRequest.ts +10 -49
- package/src/src/models/SendPushRequest.ts +118 -52
- package/src/src/models/SendPushRequestActionButtonsInner.ts +91 -0
- package/src/src/models/index.ts +2 -1
- package/dist/src/models/PushPayload.d.ts.map +0 -1
- package/dist/src/models/PushPayload.js.map +0 -1
- package/src/src/models/PushPayload.ts +0 -123
|
@@ -13,23 +13,14 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.
|
|
16
|
+
exports.PushMessageDetailStatusEnum = exports.PushMessageDetailPlatformEnum = void 0;
|
|
17
17
|
exports.instanceOfPushMessageDetail = instanceOfPushMessageDetail;
|
|
18
18
|
exports.PushMessageDetailFromJSON = PushMessageDetailFromJSON;
|
|
19
19
|
exports.PushMessageDetailFromJSONTyped = PushMessageDetailFromJSONTyped;
|
|
20
20
|
exports.PushMessageDetailToJSON = PushMessageDetailToJSON;
|
|
21
21
|
exports.PushMessageDetailToJSONTyped = PushMessageDetailToJSONTyped;
|
|
22
22
|
const PushEvent_1 = require("./PushEvent");
|
|
23
|
-
|
|
24
|
-
* @export
|
|
25
|
-
*/
|
|
26
|
-
exports.PushMessageDetailStatusEnum = {
|
|
27
|
-
PENDING: 'pending',
|
|
28
|
-
QUEUED: 'queued',
|
|
29
|
-
SENT: 'sent',
|
|
30
|
-
DELIVERED: 'delivered',
|
|
31
|
-
FAILED: 'failed'
|
|
32
|
-
};
|
|
23
|
+
const PushMessageDetailAllOfActionButtons_1 = require("./PushMessageDetailAllOfActionButtons");
|
|
33
24
|
/**
|
|
34
25
|
* @export
|
|
35
26
|
*/
|
|
@@ -38,6 +29,17 @@ exports.PushMessageDetailPlatformEnum = {
|
|
|
38
29
|
ANDROID: 'android',
|
|
39
30
|
WEB: 'web'
|
|
40
31
|
};
|
|
32
|
+
/**
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
exports.PushMessageDetailStatusEnum = {
|
|
36
|
+
QUEUED: 'queued',
|
|
37
|
+
SENDING: 'sending',
|
|
38
|
+
SENT: 'sent',
|
|
39
|
+
DELIVERED: 'delivered',
|
|
40
|
+
FAILED: 'failed',
|
|
41
|
+
EXPIRED: 'expired'
|
|
42
|
+
};
|
|
41
43
|
/**
|
|
42
44
|
* Check if a given object implements the PushMessageDetail interface.
|
|
43
45
|
*/
|
|
@@ -54,25 +56,26 @@ function PushMessageDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
54
56
|
return {
|
|
55
57
|
'id': json['id'] == null ? undefined : json['id'],
|
|
56
58
|
'deviceId': json['device_id'] == null ? undefined : json['device_id'],
|
|
57
|
-
'
|
|
59
|
+
'userId': json['user_id'] == null ? undefined : json['user_id'],
|
|
60
|
+
'platform': json['platform'] == null ? undefined : json['platform'],
|
|
58
61
|
'title': json['title'] == null ? undefined : json['title'],
|
|
59
62
|
'body': json['body'] == null ? undefined : json['body'],
|
|
63
|
+
'data': json['data'] == null ? undefined : json['data'],
|
|
60
64
|
'status': json['status'] == null ? undefined : json['status'],
|
|
61
|
-
'
|
|
62
|
-
'
|
|
65
|
+
'tags': json['tags'] == null ? undefined : json['tags'],
|
|
66
|
+
'queuedAt': json['queued_at'] == null ? undefined : (new Date(json['queued_at'])),
|
|
63
67
|
'sentAt': json['sent_at'] == null ? undefined : (new Date(json['sent_at'])),
|
|
64
68
|
'deliveredAt': json['delivered_at'] == null ? undefined : (new Date(json['delivered_at'])),
|
|
69
|
+
'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
|
|
65
70
|
'batchId': json['batch_id'] == null ? undefined : json['batch_id'],
|
|
66
|
-
'userId': json['user_id'] == null ? undefined : json['user_id'],
|
|
67
|
-
'data': json['data'] == null ? undefined : json['data'],
|
|
68
71
|
'badge': json['badge'] == null ? undefined : json['badge'],
|
|
69
72
|
'sound': json['sound'] == null ? undefined : json['sound'],
|
|
70
73
|
'imageUrl': json['image_url'] == null ? undefined : json['image_url'],
|
|
74
|
+
'contentAvailable': json['content_available'] == null ? undefined : json['content_available'],
|
|
75
|
+
'actionButtons': json['action_buttons'] == null ? undefined : (json['action_buttons'].map(PushMessageDetailAllOfActionButtons_1.PushMessageDetailAllOfActionButtonsFromJSON)),
|
|
71
76
|
'statusReason': json['status_reason'] == null ? undefined : json['status_reason'],
|
|
72
77
|
'providerMessageId': json['provider_message_id'] == null ? undefined : json['provider_message_id'],
|
|
73
|
-
'tags': json['tags'] == null ? undefined : json['tags'],
|
|
74
78
|
'metadata': json['metadata'] == null ? undefined : json['metadata'],
|
|
75
|
-
'queuedAt': json['queued_at'] == null ? undefined : (new Date(json['queued_at'])),
|
|
76
79
|
'failedAt': json['failed_at'] == null ? undefined : (new Date(json['failed_at'])),
|
|
77
80
|
'events': json['events'] == null ? undefined : (json['events'].map(PushEvent_1.PushEventFromJSON)),
|
|
78
81
|
};
|
|
@@ -87,25 +90,26 @@ function PushMessageDetailToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
87
90
|
return {
|
|
88
91
|
'id': value['id'],
|
|
89
92
|
'device_id': value['deviceId'],
|
|
90
|
-
'
|
|
93
|
+
'user_id': value['userId'],
|
|
94
|
+
'platform': value['platform'],
|
|
91
95
|
'title': value['title'],
|
|
92
96
|
'body': value['body'],
|
|
97
|
+
'data': value['data'],
|
|
93
98
|
'status': value['status'],
|
|
94
|
-
'
|
|
95
|
-
'
|
|
99
|
+
'tags': value['tags'],
|
|
100
|
+
'queued_at': value['queuedAt'] == null ? undefined : (value['queuedAt'].toISOString()),
|
|
96
101
|
'sent_at': value['sentAt'] == null ? undefined : (value['sentAt'].toISOString()),
|
|
97
102
|
'delivered_at': value['deliveredAt'] == null ? undefined : (value['deliveredAt'].toISOString()),
|
|
103
|
+
'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
|
|
98
104
|
'batch_id': value['batchId'],
|
|
99
|
-
'user_id': value['userId'],
|
|
100
|
-
'data': value['data'],
|
|
101
105
|
'badge': value['badge'],
|
|
102
106
|
'sound': value['sound'],
|
|
103
107
|
'image_url': value['imageUrl'],
|
|
108
|
+
'content_available': value['contentAvailable'],
|
|
109
|
+
'action_buttons': value['actionButtons'] == null ? undefined : (value['actionButtons'].map(PushMessageDetailAllOfActionButtons_1.PushMessageDetailAllOfActionButtonsToJSON)),
|
|
104
110
|
'status_reason': value['statusReason'],
|
|
105
111
|
'provider_message_id': value['providerMessageId'],
|
|
106
|
-
'tags': value['tags'],
|
|
107
112
|
'metadata': value['metadata'],
|
|
108
|
-
'queued_at': value['queuedAt'] == null ? undefined : (value['queuedAt'].toISOString()),
|
|
109
113
|
'failed_at': value['failedAt'] == null ? undefined : (value['failedAt'].toISOString()),
|
|
110
114
|
'events': value['events'] == null ? undefined : (value['events'].map(PushEvent_1.PushEventToJSON)),
|
|
111
115
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PushMessageDetail.js","sourceRoot":"","sources":["../../../src/src/models/PushMessageDetail.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;
|
|
1
|
+
{"version":3,"file":"PushMessageDetail.js","sourceRoot":"","sources":["../../../src/src/models/PushMessageDetail.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAsMH,kEAEC;AAED,8DAEC;AAED,wEA+BC;AAED,0DAEC;AAED,oEAgCC;AA/QD,2CAKqB;AAErB,+FAK+C;AA2J/C;;GAEG;AACU,QAAA,6BAA6B,GAAG;IACzC,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,SAAS;IAClB,GAAG,EAAE,KAAK;CACJ,CAAC;AAGX;;GAEG;AACU,QAAA,2BAA2B,GAAG;IACvC,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;CACZ,CAAC;AAIX;;GAEG;AACH,SAAgB,2BAA2B,CAAC,KAAa;IACrD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,yBAAyB,CAAC,IAAS;IAC/C,OAAO,8BAA8B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACvD,CAAC;AAED,SAAgB,8BAA8B,CAAC,IAAS,EAAE,mBAA4B;IAClF,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjD,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;QACrE,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QAC/D,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC7D,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QACjF,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3E,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAC1F,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACpF,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QAClE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;QACrE,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC7F,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,gBAAgB,CAAgB,CAAC,GAAG,CAAC,iFAA2C,CAAC,CAAC;QACvJ,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QACjF,mBAAmB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAClG,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnE,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QACjF,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,QAAQ,CAAgB,CAAC,GAAG,CAAC,6BAAiB,CAAC,CAAC;KACzG,CAAC;AACN,CAAC;AAED,SAAgB,uBAAuB,CAAC,IAAS;IAC7C,OAAO,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACrD,CAAC;AAED,SAAgB,4BAA4B,CAAC,KAAgC,EAAE,sBAA+B,KAAK;IAC/G,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;QACjB,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC;QAC9B,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC;QAC1B,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,UAAU,CAAS,CAAC,WAAW,EAAE,CAAC;QAC/F,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,QAAQ,CAAS,CAAC,WAAW,EAAE,CAAC;QACzF,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,aAAa,CAAS,CAAC,WAAW,EAAE,CAAC;QACxG,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3F,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC;QAC5B,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC;QAC9B,mBAAmB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAC9C,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,eAAe,CAAgB,CAAC,GAAG,CAAC,+EAAyC,CAAC,CAAC;QACtJ,eAAe,EAAE,KAAK,CAAC,cAAc,CAAC;QACtC,qBAAqB,EAAE,KAAK,CAAC,mBAAmB,CAAC;QACjD,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,UAAU,CAAS,CAAC,WAAW,EAAE,CAAC;QAC/F,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,QAAQ,CAAgB,CAAC,GAAG,CAAC,2BAAe,CAAC,CAAC;KACzG,CAAC;AACN,CAAC"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Zyphr API
|
|
3
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: support@zyphr.dev
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface PushMessageDetailAllOfActionButtons
|
|
16
|
+
*/
|
|
17
|
+
export interface PushMessageDetailAllOfActionButtons {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof PushMessageDetailAllOfActionButtons
|
|
22
|
+
*/
|
|
23
|
+
id?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof PushMessageDetailAllOfActionButtons
|
|
28
|
+
*/
|
|
29
|
+
title?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof PushMessageDetailAllOfActionButtons
|
|
34
|
+
*/
|
|
35
|
+
action?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof PushMessageDetailAllOfActionButtons
|
|
40
|
+
*/
|
|
41
|
+
deepLink?: string;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the PushMessageDetailAllOfActionButtons interface.
|
|
45
|
+
*/
|
|
46
|
+
export declare function instanceOfPushMessageDetailAllOfActionButtons(value: object): value is PushMessageDetailAllOfActionButtons;
|
|
47
|
+
export declare function PushMessageDetailAllOfActionButtonsFromJSON(json: any): PushMessageDetailAllOfActionButtons;
|
|
48
|
+
export declare function PushMessageDetailAllOfActionButtonsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PushMessageDetailAllOfActionButtons;
|
|
49
|
+
export declare function PushMessageDetailAllOfActionButtonsToJSON(json: any): PushMessageDetailAllOfActionButtons;
|
|
50
|
+
export declare function PushMessageDetailAllOfActionButtonsToJSONTyped(value?: PushMessageDetailAllOfActionButtons | null, ignoreDiscriminator?: boolean): any;
|
|
51
|
+
//# sourceMappingURL=PushMessageDetailAllOfActionButtons.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PushMessageDetailAllOfActionButtons.d.ts","sourceRoot":"","sources":["../../../src/src/models/PushMessageDetailAllOfActionButtons.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAChD;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,6CAA6C,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,mCAAmC,CAEzH;AAED,wBAAgB,2CAA2C,CAAC,IAAI,EAAE,GAAG,GAAG,mCAAmC,CAE1G;AAED,wBAAgB,gDAAgD,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,mCAAmC,CAW7I;AAED,wBAAgB,yCAAyC,CAAC,IAAI,EAAE,GAAG,GAAG,mCAAmC,CAExG;AAED,wBAAgB,8CAA8C,CAAC,KAAK,CAAC,EAAE,mCAAmC,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CAY5J"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Zyphr API
|
|
6
|
+
* Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: support@zyphr.dev
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfPushMessageDetailAllOfActionButtons = instanceOfPushMessageDetailAllOfActionButtons;
|
|
17
|
+
exports.PushMessageDetailAllOfActionButtonsFromJSON = PushMessageDetailAllOfActionButtonsFromJSON;
|
|
18
|
+
exports.PushMessageDetailAllOfActionButtonsFromJSONTyped = PushMessageDetailAllOfActionButtonsFromJSONTyped;
|
|
19
|
+
exports.PushMessageDetailAllOfActionButtonsToJSON = PushMessageDetailAllOfActionButtonsToJSON;
|
|
20
|
+
exports.PushMessageDetailAllOfActionButtonsToJSONTyped = PushMessageDetailAllOfActionButtonsToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the PushMessageDetailAllOfActionButtons interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfPushMessageDetailAllOfActionButtons(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function PushMessageDetailAllOfActionButtonsFromJSON(json) {
|
|
28
|
+
return PushMessageDetailAllOfActionButtonsFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function PushMessageDetailAllOfActionButtonsFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'id': json['id'] == null ? undefined : json['id'],
|
|
36
|
+
'title': json['title'] == null ? undefined : json['title'],
|
|
37
|
+
'action': json['action'] == null ? undefined : json['action'],
|
|
38
|
+
'deepLink': json['deep_link'] == null ? undefined : json['deep_link'],
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function PushMessageDetailAllOfActionButtonsToJSON(json) {
|
|
42
|
+
return PushMessageDetailAllOfActionButtonsToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function PushMessageDetailAllOfActionButtonsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'id': value['id'],
|
|
50
|
+
'title': value['title'],
|
|
51
|
+
'action': value['action'],
|
|
52
|
+
'deep_link': value['deepLink'],
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=PushMessageDetailAllOfActionButtons.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PushMessageDetailAllOfActionButtons.js","sourceRoot":"","sources":["../../../src/src/models/PushMessageDetailAllOfActionButtons.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;AAsCH,sGAEC;AAED,kGAEC;AAED,4GAWC;AAED,8FAEC;AAED,wGAYC;AAxCD;;GAEG;AACH,SAAgB,6CAA6C,CAAC,KAAa;IACvE,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,2CAA2C,CAAC,IAAS;IACjE,OAAO,gDAAgD,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACzE,CAAC;AAED,SAAgB,gDAAgD,CAAC,IAAS,EAAE,mBAA4B;IACpG,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjD,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC7D,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;KACxE,CAAC;AACN,CAAC;AAED,SAAgB,yCAAyC,CAAC,IAAS;IAC/D,OAAO,8CAA8C,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC;AAED,SAAgB,8CAA8C,CAAC,KAAkD,EAAE,sBAA+B,KAAK;IACnJ,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;QACjB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC;KACjC,CAAC;AACN,CAAC"}
|
|
@@ -16,17 +16,11 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface RegisterDeviceRequest {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* User or subscriber ID to associate with the device
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof RegisterDeviceRequest
|
|
22
22
|
*/
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* External ID to look up subscriber
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof RegisterDeviceRequest
|
|
28
|
-
*/
|
|
29
|
-
externalUserId?: string;
|
|
23
|
+
userId: string;
|
|
30
24
|
/**
|
|
31
25
|
*
|
|
32
26
|
* @type {string}
|
|
@@ -40,35 +34,13 @@ export interface RegisterDeviceRequest {
|
|
|
40
34
|
*/
|
|
41
35
|
token: string;
|
|
42
36
|
/**
|
|
43
|
-
*
|
|
44
|
-
* @type {string}
|
|
45
|
-
* @memberof RegisterDeviceRequest
|
|
46
|
-
*/
|
|
47
|
-
appVersion?: string;
|
|
48
|
-
/**
|
|
49
|
-
*
|
|
50
|
-
* @type {string}
|
|
51
|
-
* @memberof RegisterDeviceRequest
|
|
52
|
-
*/
|
|
53
|
-
deviceModel?: string;
|
|
54
|
-
/**
|
|
55
|
-
*
|
|
56
|
-
* @type {string}
|
|
57
|
-
* @memberof RegisterDeviceRequest
|
|
58
|
-
*/
|
|
59
|
-
osVersion?: string;
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @type {string}
|
|
63
|
-
* @memberof RegisterDeviceRequest
|
|
64
|
-
*/
|
|
65
|
-
timezone?: string;
|
|
66
|
-
/**
|
|
67
|
-
*
|
|
68
|
-
* @type {string}
|
|
37
|
+
* Additional device metadata
|
|
38
|
+
* @type {{ [key: string]: any; }}
|
|
69
39
|
* @memberof RegisterDeviceRequest
|
|
70
40
|
*/
|
|
71
|
-
|
|
41
|
+
metadata?: {
|
|
42
|
+
[key: string]: any;
|
|
43
|
+
};
|
|
72
44
|
}
|
|
73
45
|
/**
|
|
74
46
|
* @export
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RegisterDeviceRequest.d.ts","sourceRoot":"","sources":["../../../src/src/models/RegisterDeviceRequest.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,
|
|
1
|
+
{"version":3,"file":"RegisterDeviceRequest.d.ts","sourceRoot":"","sources":["../../../src/src/models/RegisterDeviceRequest.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,EAAE,iCAAiC,CAAC;IAC5C;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CACtC;AAGD;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;CAIpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,OAAO,iCAAiC,CAAC,MAAM,OAAO,iCAAiC,CAAC,CAAC;AAGzI;;GAEG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,qBAAqB,CAK7F;AAED,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,GAAG,GAAG,qBAAqB,CAE9E;AAED,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,qBAAqB,CAWjH;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,GAAG,GAAG,qBAAqB,CAE5E;AAED,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE,qBAAqB,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CAYhI"}
|
|
@@ -31,6 +31,8 @@ exports.RegisterDeviceRequestPlatformEnum = {
|
|
|
31
31
|
* Check if a given object implements the RegisterDeviceRequest interface.
|
|
32
32
|
*/
|
|
33
33
|
function instanceOfRegisterDeviceRequest(value) {
|
|
34
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
35
|
+
return false;
|
|
34
36
|
if (!('platform' in value) || value['platform'] === undefined)
|
|
35
37
|
return false;
|
|
36
38
|
if (!('token' in value) || value['token'] === undefined)
|
|
@@ -45,15 +47,10 @@ function RegisterDeviceRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
45
47
|
return json;
|
|
46
48
|
}
|
|
47
49
|
return {
|
|
48
|
-
'
|
|
49
|
-
'externalUserId': json['external_user_id'] == null ? undefined : json['external_user_id'],
|
|
50
|
+
'userId': json['user_id'],
|
|
50
51
|
'platform': json['platform'],
|
|
51
52
|
'token': json['token'],
|
|
52
|
-
'
|
|
53
|
-
'deviceModel': json['device_model'] == null ? undefined : json['device_model'],
|
|
54
|
-
'osVersion': json['os_version'] == null ? undefined : json['os_version'],
|
|
55
|
-
'timezone': json['timezone'] == null ? undefined : json['timezone'],
|
|
56
|
-
'locale': json['locale'] == null ? undefined : json['locale'],
|
|
53
|
+
'metadata': json['metadata'] == null ? undefined : json['metadata'],
|
|
57
54
|
};
|
|
58
55
|
}
|
|
59
56
|
function RegisterDeviceRequestToJSON(json) {
|
|
@@ -64,15 +61,10 @@ function RegisterDeviceRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
64
61
|
return value;
|
|
65
62
|
}
|
|
66
63
|
return {
|
|
67
|
-
'
|
|
68
|
-
'external_user_id': value['externalUserId'],
|
|
64
|
+
'user_id': value['userId'],
|
|
69
65
|
'platform': value['platform'],
|
|
70
66
|
'token': value['token'],
|
|
71
|
-
'
|
|
72
|
-
'device_model': value['deviceModel'],
|
|
73
|
-
'os_version': value['osVersion'],
|
|
74
|
-
'timezone': value['timezone'],
|
|
75
|
-
'locale': value['locale'],
|
|
67
|
+
'metadata': value['metadata'],
|
|
76
68
|
};
|
|
77
69
|
}
|
|
78
70
|
//# sourceMappingURL=RegisterDeviceRequest.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RegisterDeviceRequest.js","sourceRoot":"","sources":["../../../src/src/models/RegisterDeviceRequest.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;
|
|
1
|
+
{"version":3,"file":"RegisterDeviceRequest.js","sourceRoot":"","sources":["../../../src/src/models/RegisterDeviceRequest.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAkDH,0EAKC;AAED,sEAEC;AAED,gFAWC;AAED,kEAEC;AAED,4EAYC;AAtDD;;GAEG;AACU,QAAA,iCAAiC,GAAG;IAC7C,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,SAAS;IAClB,GAAG,EAAE,KAAK;CACJ,CAAC;AAIX;;GAEG;AACH,SAAgB,+BAA+B,CAAC,KAAa;IACzD,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,CAAC,CAAC,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC5E,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,6BAA6B,CAAC,IAAS;IACnD,OAAO,kCAAkC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAAgB,kCAAkC,CAAC,IAAS,EAAE,mBAA4B;IACtF,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;QAC5B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QACtB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;KACtE,CAAC;AACN,CAAC;AAED,SAAgB,2BAA2B,CAAC,IAAS;IACjD,OAAO,gCAAgC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACzD,CAAC;AAED,SAAgB,gCAAgC,CAAC,KAAoC,EAAE,sBAA+B,KAAK;IACvH,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC;QAC1B,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;KAChC,CAAC;AACN,CAAC"}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { SendPushRequestActionButtonsInner } from './SendPushRequestActionButtonsInner';
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
@@ -17,47 +17,81 @@ import type { PushPayload } from './PushPayload';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface SendPushRequest {
|
|
19
19
|
/**
|
|
20
|
-
* Send to
|
|
20
|
+
* Send to all devices for a user
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof SendPushRequest
|
|
23
|
+
*/
|
|
24
|
+
userId?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Send to a specific device
|
|
21
27
|
* @type {string}
|
|
22
28
|
* @memberof SendPushRequest
|
|
23
29
|
*/
|
|
24
30
|
deviceId?: string;
|
|
25
31
|
/**
|
|
26
|
-
*
|
|
27
|
-
* @type {
|
|
32
|
+
* Push notification title
|
|
33
|
+
* @type {string}
|
|
28
34
|
* @memberof SendPushRequest
|
|
29
35
|
*/
|
|
30
|
-
|
|
36
|
+
title?: string;
|
|
31
37
|
/**
|
|
32
|
-
*
|
|
38
|
+
* Push notification body text
|
|
33
39
|
* @type {string}
|
|
34
40
|
* @memberof SendPushRequest
|
|
35
41
|
*/
|
|
36
|
-
|
|
42
|
+
body?: string;
|
|
37
43
|
/**
|
|
38
|
-
*
|
|
44
|
+
* Custom data payload
|
|
45
|
+
* @type {{ [key: string]: any; }}
|
|
46
|
+
* @memberof SendPushRequest
|
|
47
|
+
*/
|
|
48
|
+
data?: {
|
|
49
|
+
[key: string]: any;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* Badge count (iOS)
|
|
53
|
+
* @type {number}
|
|
54
|
+
* @memberof SendPushRequest
|
|
55
|
+
*/
|
|
56
|
+
badge?: number;
|
|
57
|
+
/**
|
|
58
|
+
* Notification sound
|
|
39
59
|
* @type {string}
|
|
40
60
|
* @memberof SendPushRequest
|
|
41
61
|
*/
|
|
42
|
-
|
|
62
|
+
sound?: string;
|
|
43
63
|
/**
|
|
44
|
-
*
|
|
45
|
-
* @type {
|
|
64
|
+
* Image URL for rich notifications
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof SendPushRequest
|
|
67
|
+
*/
|
|
68
|
+
imageUrl?: string;
|
|
69
|
+
/**
|
|
70
|
+
* Silent/background push notification
|
|
71
|
+
* @type {boolean}
|
|
46
72
|
* @memberof SendPushRequest
|
|
47
73
|
*/
|
|
48
|
-
|
|
74
|
+
contentAvailable?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Interactive notification buttons (max 3)
|
|
77
|
+
* @type {Array<SendPushRequestActionButtonsInner>}
|
|
78
|
+
* @memberof SendPushRequest
|
|
79
|
+
*/
|
|
80
|
+
actionButtons?: Array<SendPushRequestActionButtonsInner>;
|
|
49
81
|
/**
|
|
50
82
|
*
|
|
51
|
-
* @type {string}
|
|
83
|
+
* @type {Array<string>}
|
|
52
84
|
* @memberof SendPushRequest
|
|
53
85
|
*/
|
|
54
|
-
|
|
86
|
+
tags?: Array<string>;
|
|
55
87
|
/**
|
|
56
|
-
*
|
|
57
|
-
* @type {
|
|
88
|
+
*
|
|
89
|
+
* @type {{ [key: string]: any; }}
|
|
58
90
|
* @memberof SendPushRequest
|
|
59
91
|
*/
|
|
60
|
-
|
|
92
|
+
metadata?: {
|
|
93
|
+
[key: string]: any;
|
|
94
|
+
};
|
|
61
95
|
/**
|
|
62
96
|
* Replace previous notification with same key
|
|
63
97
|
* @type {string}
|
|
@@ -65,22 +99,42 @@ export interface SendPushRequest {
|
|
|
65
99
|
*/
|
|
66
100
|
collapseKey?: string;
|
|
67
101
|
/**
|
|
68
|
-
*
|
|
102
|
+
* Subscriber ID for preference checking
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof SendPushRequest
|
|
105
|
+
*/
|
|
106
|
+
subscriberId?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Subscriber external ID for preference checking
|
|
109
|
+
* @type {string}
|
|
110
|
+
* @memberof SendPushRequest
|
|
111
|
+
*/
|
|
112
|
+
subscriberExternalId?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Notification category for preference checking
|
|
115
|
+
* @type {string}
|
|
116
|
+
* @memberof SendPushRequest
|
|
117
|
+
*/
|
|
118
|
+
category?: string;
|
|
119
|
+
/**
|
|
120
|
+
* Skip subscriber preference checks
|
|
121
|
+
* @type {boolean}
|
|
122
|
+
* @memberof SendPushRequest
|
|
123
|
+
*/
|
|
124
|
+
force?: boolean;
|
|
125
|
+
/**
|
|
126
|
+
* Schedule for future delivery (ISO 8601)
|
|
69
127
|
* @type {Date}
|
|
70
128
|
* @memberof SendPushRequest
|
|
71
129
|
*/
|
|
72
|
-
|
|
130
|
+
sendAt?: Date;
|
|
131
|
+
/**
|
|
132
|
+
* Delay in seconds before sending
|
|
133
|
+
* @type {number}
|
|
134
|
+
* @memberof SendPushRequest
|
|
135
|
+
*/
|
|
136
|
+
delay?: number;
|
|
73
137
|
}
|
|
74
|
-
/**
|
|
75
|
-
* @export
|
|
76
|
-
*/
|
|
77
|
-
export declare const SendPushRequestPriorityEnum: {
|
|
78
|
-
readonly LOW: "low";
|
|
79
|
-
readonly NORMAL: "normal";
|
|
80
|
-
readonly HIGH: "high";
|
|
81
|
-
readonly URGENT: "urgent";
|
|
82
|
-
};
|
|
83
|
-
export type SendPushRequestPriorityEnum = typeof SendPushRequestPriorityEnum[keyof typeof SendPushRequestPriorityEnum];
|
|
84
138
|
/**
|
|
85
139
|
* Check if a given object implements the SendPushRequest interface.
|
|
86
140
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SendPushRequest.d.ts","sourceRoot":"","sources":["../../../src/src/models/SendPushRequest.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"SendPushRequest.d.ts","sourceRoot":"","sources":["../../../src/src/models/SendPushRequest.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAQ7F;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IAC/B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACzD;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,eAAe,CAEjF;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAElE;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,eAAe,CA0BrG;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAEhE;AAED,wBAAgB,0BAA0B,CAAC,KAAK,CAAC,EAAE,eAAe,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CA2BpH"}
|