@pushwoosh/rpc-v2-http-api-data 0.2.109 → 0.2.110

package/data.js

@@ -15550,6 +15550,12 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.messages.GetDevicesListResponse",
                 "method": "post",
                 "path": "/api/messages/getDevicesList"
+            },
+            "GetUserInboxMessages": {
+                "request": "pushwoosh.rpc_v2.messages.GetUserInboxMessagesRequest",
+                "response": "pushwoosh.rpc_v2.messages.GetUserInboxMessagesResponse",
+                "method": "post",
+                "path": "/api/messages/getUserInboxMessages"
             }
         }
     },
@@ -16165,6 +16171,72 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.messages.GetUserInboxMessagesRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "userId": {
+                "type": "string"
+            },
+            "platform": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.messages.GetUserInboxMessagesResponse.InboxMessage.Status": {
+        "type": "E",
+        "values": [
+            "created",
+            "delivered",
+            "read",
+            "opened",
+            "deleted_by_user",
+            "deleted"
+        ]
+    },
+    "pushwoosh.rpc_v2.messages.GetUserInboxMessagesResponse.InboxMessage": {
+        "type": "I",
+        "fields": {
+            "inboxId": {
+                "type": "string"
+            },
+            "messageId": {
+                "type": "number"
+            },
+            "title": {
+                "type": "string"
+            },
+            "text": {
+                "type": "string"
+            },
+            "image": {
+                "type": "string"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.messages.GetUserInboxMessagesResponse.InboxMessage.Status"
+            },
+            "platform": {
+                "type": "number"
+            },
+            "sendDate": {
+                "type": "Date"
+            },
+            "expireAt": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.messages.GetUserInboxMessagesResponse": {
+        "type": "I",
+        "fields": {
+            "messages": {
+                "type": "pushwoosh.rpc_v2.messages.GetUserInboxMessagesResponse.InboxMessage",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.messages.GetDevicesListRequest": {
         "type": "I",
         "fields": {

package/messages.d.ts

@@ -9,6 +9,7 @@ export type MessagesService_GetDeliveryReport = RpcMethod<GetDeliveryReportReque
 export type MessagesService_FindRecipients = RpcMethod<FindRecipientsRequest, FindRecipientsResponse>;
 export type MessagesService_GetDeviceReceivedMessages = RpcMethod<GetDeviceReceivedMessagesRequest, GetDeviceReceivedMessagesResponse>;
 export type MessagesService_GetDevicesList = RpcMethod<GetDevicesListRequest, GetDevicesListResponse>;
+export type MessagesService_GetUserInboxMessages = RpcMethod<GetUserInboxMessagesRequest, GetUserInboxMessagesResponse>;
 export interface MessagesService {
     /** Lists messages (push, email or SMS sends) for an application, newest first, with paging, free-text search and an optional type filter. Use to browse sends or find a message code before fetching details or statistics. */
     List: MessagesService_List;
@@ -30,6 +31,8 @@ export interface MessagesService {
     GetDeviceReceivedMessages: MessagesService_GetDeviceReceivedMessages;
     /** Returns the device hwids and user ids targeted by a message code. Use to see the exact audience a message was sent to. */
     GetDevicesList: MessagesService_GetDevicesList;
+    /** Lists the message inbox of a single user (by user id): what the app's inbox screen would show, with per-message inbox status, send date and expiration. Use to check what a user still has in their inbox, as opposed to what was sent to their device. */
+    GetUserInboxMessages: MessagesService_GetUserInboxMessages;
 }
 export type Type = 'All' | 'Push' | 'Email' | 'Sms';
 export type PushInfo = {
@@ -261,6 +264,33 @@ export type GetDeviceReceivedMessagesResponse_Message = {
 export type GetDeviceReceivedMessagesResponse = {
     messages: GetDeviceReceivedMessagesResponse_Message[];
 };
+export type GetUserInboxMessagesRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+    /** Inbox owner: user id set by the SDK, or the device hwid for anonymous users. */
+    userId?: string;
+    /** Platform (device type) to filter by; 0 returns every platform. */
+    platform?: number;
+};
+/**
+ * Inbox lifecycle status reported by the SDK. Messages deleted by the user are
+ * dropped from the inbox, so they are never returned.
+ */
+export type GetUserInboxMessagesResponse_InboxMessage_Status = 'created' | 'delivered' | 'read' | 'opened' | 'deleted_by_user' | 'deleted';
+export type GetUserInboxMessagesResponse_InboxMessage = {
+    inboxId: string;
+    messageId: number;
+    title: string;
+    text: string;
+    image: string;
+    status: GetUserInboxMessagesResponse_InboxMessage_Status;
+    platform: number;
+    sendDate: Date;
+    expireAt: Date;
+};
+export type GetUserInboxMessagesResponse = {
+    messages: GetUserInboxMessagesResponse_InboxMessage[];
+};
 export type GetDevicesListRequest = {
     /** Message code whose targeted device hwids and user ids to return. */
     messageCode?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.109",
+  "version": "0.2.110",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",