@pushwoosh/rpc-gateway-messaging 0.6.105 → 0.6.107

package/data.js

@@ -1,105 +1,6 @@
 /* eslint-disable */
 /* Autogenerated code */
 export const data = {
-    "pushwoosh.channels.messagingApi.v2.MessagesInProgressService": {
-        "type": "S",
-        "key": "messagesInProgress",
-        "methods": {}
-    },
-    "pushwoosh.channels.messagingApi.v2.MessageStalledStatusState": {
-        "type": "E",
-        "values": [
-            "MESSAGE_STATUS_STATE_UNKNOWN",
-            "MESSAGE_STATUS_STATE_ALIVE",
-            "MESSAGE_STATUS_STATE_STUCK",
-            "MESSAGE_STATUS_STATE_DEAD"
-        ]
-    },
-    "pushwoosh.channels.messagingApi.v2.MessageStalled": {
-        "type": "I",
-        "fields": {
-            "messageCode": {
-                "type": "string"
-            },
-            "clientId": {
-                "type": "string"
-            },
-            "state": {
-                "type": "pushwoosh.channels.messagingApi.v2.MessageStalledStatusState"
-            },
-            "processed": {
-                "type": "number"
-            },
-            "isClientAlive": {
-                "type": "boolean"
-            },
-            "accountId": {
-                "type": "number"
-            },
-            "lastUpdated": {
-                "type": "Date"
-            },
-            "lastResend": {
-                "type": "Date"
-            },
-            "sendDate": {
-                "type": "Date"
-            }
-        }
-    },
-    "pushwoosh.channels.messagingApi.v2.ListRequest": {
-        "type": "I",
-        "fields": {}
-    },
-    "pushwoosh.channels.messagingApi.v2.ListResponse": {
-        "type": "I",
-        "fields": {
-            "messages": {
-                "type": "pushwoosh.channels.messagingApi.v2.MessageStalled",
-                "array": true
-            }
-        }
-    },
-    "pushwoosh.channels.messagingApi.v2.GetStalledMessageRequest": {
-        "type": "I",
-        "fields": {
-            "messageCode": {
-                "type": "string"
-            }
-        }
-    },
-    "pushwoosh.channels.messagingApi.v2.GetStalledMessageResponse": {
-        "type": "I",
-        "fields": {
-            "message": {
-                "type": "pushwoosh.channels.messagingApi.v2.MessageStalled"
-            }
-        }
-    },
-    "pushwoosh.channels.messagingApi.v2.ResendMessageRequest": {
-        "type": "I",
-        "fields": {
-            "messageCode": {
-                "type": "string"
-            }
-        }
-    },
-    "pushwoosh.channels.messagingApi.v2.ResendMessageResponse": {
-        "type": "I",
-        "fields": {}
-    },
-    "pushwoosh.channels.messagingApi.v2.ClearMessageRequest": {
-        "type": "I",
-        "fields": {
-            "messageCode": {
-                "type": "string"
-            }
-        }
-    },
-    "pushwoosh.channels.messagingApi.v2.ClearMessageResponse": {
-        "type": "I",
-        "fields": {}
-    },
     "pushwoosh.channels.messagingApi.v2.MessagingService": {
         "type": "S",
         "key": "messaging",
@@ -110,6 +11,12 @@ export const data = {
                 "method": "post",
                 "path": "/messaging/v2/notify"
             },
+            "NotifyBatch": {
+                "request": "pushwoosh.channels.messagingApi.v2.NotifyBatchRequest",
+                "response": "pushwoosh.channels.messagingApi.v2.NotifyBatchResponse",
+                "method": "post",
+                "path": "/messaging/v2/notify/batch"
+            },
             "Cancel": {
                 "request": "pushwoosh.channels.messagingApi.v2.CancelRequest",
                 "response": "pushwoosh.channels.messagingApi.v2.CancelResponse",
@@ -172,6 +79,75 @@ export const data = {
             }
         }
     },
+    "pushwoosh.channels.messagingApi.v2.NotifyBatchRequest": {
+        "type": "I",
+        "fields": {
+            "items": {
+                "type": "pushwoosh.channels.messagingApi.v2.NotifyBatchItem",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.channels.messagingApi.v2.NotifyBatchItem": {
+        "type": "I",
+        "fields": {
+            "itemId": {
+                "type": "string"
+            },
+            "request": {
+                "type": "pushwoosh.channels.messagingApi.v2.NotifyRequest"
+            }
+        }
+    },
+    "pushwoosh.channels.messagingApi.v2.NotifyBatchResponse": {
+        "type": "I",
+        "fields": {
+            "results": {
+                "type": "pushwoosh.channels.messagingApi.v2.NotifyBatchResult",
+                "array": true
+            },
+            "succeeded": {
+                "type": "number"
+            },
+            "failed": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.channels.messagingApi.v2.NotifyBatchResult": {
+        "type": "I",
+        "fields": {
+            "itemId": {
+                "type": "string"
+            },
+            "index": {
+                "type": "number"
+            },
+            "result": {
+                "type": "pushwoosh.channels.messagingApi.v2.NotifyResult"
+            },
+            "error": {
+                "type": "pushwoosh.channels.messagingApi.v2.NotifyBatchError"
+            }
+        }
+    },
+    "pushwoosh.channels.messagingApi.v2.NotifyBatchError": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "number"
+            },
+            "message": {
+                "type": "string"
+            },
+            "reason": {
+                "type": "string"
+            },
+            "domain": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.channels.messagingApi.v2.CancelRequest": {
         "type": "I",
         "fields": {
@@ -289,6 +265,9 @@ export const data = {
             "smsPayload": {
                 "type": "pushwoosh.channels.messagingApi.v2.SMSPayload"
             },
+            "appInboxPayload": {
+                "type": "pushwoosh.channels.messagingApi.v2.AppInboxPayload"
+            },
             "frequencyCapping": {
                 "type": "pushwoosh.channels.messagingApi.v2.FrequencyCapping"
             },
@@ -327,7 +306,8 @@ export const data = {
                 "oneof": [
                     "payload",
                     "emailPayload",
-                    "smsPayload"
+                    "smsPayload",
+                    "appInboxPayload"
                 ]
             }
         }
@@ -393,6 +373,9 @@ export const data = {
             "smsPayload": {
                 "type": "pushwoosh.channels.messagingApi.v2.SMSPayload"
             },
+            "appInboxPayload": {
+                "type": "pushwoosh.channels.messagingApi.v2.AppInboxPayload"
+            },
             "returnUnknownIdentifiers": {
                 "type": "boolean"
             },
@@ -441,7 +424,8 @@ export const data = {
                 "oneof": [
                     "payload",
                     "emailPayload",
-                    "smsPayload"
+                    "smsPayload",
+                    "appInboxPayload"
                 ]
             }
         }
@@ -1202,6 +1186,29 @@ export const data = {
             }
         }
     },
+    "pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesAppInbox": {
+        "type": "I",
+        "fields": {
+            "title": {
+                "type": "string"
+            },
+            "body": {
+                "type": "string"
+            },
+            "iconUrl": {
+                "type": "string"
+            },
+            "bannerUrl": {
+                "type": "string"
+            },
+            "openAction": {
+                "type": "pushwoosh.channels.messagingApi.v2.OpenAction"
+            },
+            "customData": {
+                "type": "object"
+            }
+        }
+    },
     "pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesSMS": {
         "type": "I",
         "fields": {
@@ -1359,6 +1366,9 @@ export const data = {
             },
             "viber": {
                 "type": "pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesViber"
+            },
+            "appInbox": {
+                "type": "pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesAppInbox"
             }
         }
     },
@@ -1462,6 +1472,31 @@ export const data = {
             }
         }
     },
+    "pushwoosh.channels.messagingApi.v2.AppInboxPayload": {
+        "type": "I",
+        "fields": {
+            "preset": {
+                "type": "string"
+            },
+            "content": {
+                "type": "pushwoosh.channels.messagingApi.v2.LocalizedContent"
+            },
+            "expirationDate": {
+                "type": "Date"
+            },
+            "expiresIn": {
+                "type": "Duration"
+            }
+        },
+        "oneofs": {
+            "expiration": {
+                "oneof": [
+                    "expirationDate",
+                    "expiresIn"
+                ]
+            }
+        }
+    },
     "pushwoosh.channels.messagingApi.v2.SMSPayload": {
         "type": "I",
         "fields": {

package/index.d.ts

@@ -1,8 +1,6 @@
-import { MessagesInProgressService as pushwoosh_channels_messagingApi_v2_MessagesInProgressService } from './pushwoosh_channels_messagingApi_v2';
 import { MessagingService as pushwoosh_channels_messagingApi_v2_MessagingService } from './pushwoosh_channels_messagingApi_v2';
 import { FiltersCrudService as pushwoosh_objects_filters_v1_FiltersCrudService } from './pushwoosh_objects_filters_v1';
 export type API = {
-    messagesInProgress: pushwoosh_channels_messagingApi_v2_MessagesInProgressService;
     messaging: pushwoosh_channels_messagingApi_v2_MessagingService;
     filtersCrud: pushwoosh_objects_filters_v1_FiltersCrudService;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-messaging",
-    "version": "0.6.105",
+    "version": "0.6.107",
     "description": "Channels Messaging API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_channels_messagingApi_v2.d.ts

@@ -1,55 +1,26 @@
 import { RpcMethod, Duration } from './commonTypes';
 import { FilterExpression as pushwoosh_objects_filters_v1_FilterExpression } from './pushwoosh_objects_filters_v1';
-/**
- * MessagesInProgressService is an INTERNAL service (exposed on the private gRPC
- * port only). It surfaces the in-flight messages that the publisher tracks in
- * Redis so operators can list stalled sends, inspect one, re-dispatch them, or
- * clear their records from the admin panel.
- *
- * It deliberately has no HTTP gateway annotations: it is reached over gRPC by
- * internal services (admin-grpc), never by public clients.
- */
-export interface MessagesInProgressService {
-}
-export type MessageStalledStatusState = 'MESSAGE_STATUS_STATE_UNKNOWN' | 'MESSAGE_STATUS_STATE_ALIVE' | 'MESSAGE_STATUS_STATE_STUCK' | 'MESSAGE_STATUS_STATE_DEAD';
-export type MessageStalled = {
-    messageCode: string;
-    clientId: string;
-    state: MessageStalledStatusState;
-    processed: number;
-    isClientAlive: boolean;
-    accountId: number;
-    /** Last progress update; unset if absent. */
-    lastUpdated: Date;
-    /** Last resend; unset if the message was never resent. */
-    lastResend: Date;
-    sendDate: Date;
-};
-export type ListRequest = {};
-export type ListResponse = {
-    messages: MessageStalled[];
-};
-export type GetStalledMessageRequest = {
-    messageCode: string;
-};
-export type GetStalledMessageResponse = {
-    message: MessageStalled;
-};
-export type ResendMessageRequest = {
-    messageCode: string;
-};
-export type ResendMessageResponse = {};
-export type ClearMessageRequest = {
-    messageCode: string;
-};
-export type ClearMessageResponse = {};
 export type MessagingService_Notify = RpcMethod<NotifyRequest, NotifyResponse>;
+export type MessagingService_NotifyBatch = RpcMethod<NotifyBatchRequest, NotifyBatchResponse>;
 export type MessagingService_Cancel = RpcMethod<CancelRequest, CancelResponse>;
 export type MessagingService_Update = RpcMethod<UpdateRequest, UpdateResponse>;
 export type MessagingService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
 export interface MessagingService {
     /** Notify creates a new message. Can be targeted to a segment or a list of users. */
     Notify: MessagingService_Notify;
+    /**
+     * NotifyBatch creates several messages in one call. Every item is an
+     * independent Notify: it is validated, authorized and sent on its own, and it
+     * gets its own result. The call itself succeeds even when every item failed,
+     * so the caller must read the per-item results and not just the status code.
+     *
+     * Intended for callers that cannot issue concurrent requests. It is not
+     * faster than the same items sent in parallel through Notify.
+     *
+     * Public API only: the fan-out re-enters through the public port, so calling
+     * this on the private port fails with Unimplemented.
+     */
+    NotifyBatch: MessagingService_NotifyBatch;
     /**
      * Cancel cancels a previously created message identified by message_code.
      * Only messages in a cancelable state (pending, waiting, processing) can be canceled.
@@ -96,6 +67,65 @@ export type NotifyResult = {
     /** Requested identifiers no device or user was found for. */
     unknownIdentifiers: string[];
 };
+export type NotifyBatchRequest = {
+    /**
+     * At most 500 entries; the exact limit is server-configured. Items are
+     * processed concurrently, but results come back in request order.
+     */
+    items: NotifyBatchItem[];
+};
+export type NotifyBatchItem = {
+    /**
+     * Caller-supplied correlation id, echoed back in the matching result and
+     * otherwise ignored. Optional.
+     */
+    itemId: string;
+    /**
+     * Same body as a single Notify, transaction_id included. Setting
+     * transaction_id per item is what makes retrying a batch safe.
+     */
+    request: NotifyRequest;
+};
+export type NotifyBatchResponse = {
+    /** One result per requested item, in the order the items were sent. */
+    results: NotifyBatchResult[];
+    /** Counts over results, so a caller can check the outcome without scanning. */
+    succeeded: number;
+    failed: number;
+};
+export type NotifyBatchResult = {
+    /** Echo of NotifyBatchItem.item_id. */
+    itemId: string;
+    /**
+     * Zero-based position of the item in the request, so results can be
+     * correlated even when item_id was left empty.
+     */
+    index: number;
+    /** Set when the item succeeded. */
+    result: NotifyResult;
+    /** Set when the item failed. */
+    error: NotifyBatchError;
+};
+/**
+ * NotifyBatchError carries what a single Notify would have returned as a gRPC
+ * error. It mirrors google.rpc.Status, but is declared here and with the
+ * ErrorInfo detail flattened into plain fields: the TypeScript client generator
+ * resolves only google.protobuf.* imports, and a flat shape spares REST callers
+ * from unpacking an Any.
+ */
+export type NotifyBatchError = {
+    /** gRPC status code, as in google.rpc.Code. */
+    code: number;
+    /** Developer-facing message, in English. */
+    message: string;
+    /**
+     * Short name of the messaging status code, same value a single Notify puts
+     * into the ErrorInfo detail. Empty when the failure carried no ErrorInfo.
+     */
+    reason: string;
+    /** Domain of the reason above. */
+    domain: string;
+};
 export type CancelRequest = {
     /** Code of the message to cancel (as returned by Notify in NotifyResult.message_code). */
     messageCode: string;
@@ -161,7 +191,11 @@ export type NotifySegment_messagePayload_smsPayload = {
     type: 'smsPayload';
     data: SMSPayload;
 };
-export type NotifySegment_messagePayload = NotifySegment_messagePayload_payload | NotifySegment_messagePayload_emailPayload | NotifySegment_messagePayload_smsPayload;
+export type NotifySegment_messagePayload_appInboxPayload = {
+    type: 'appInboxPayload';
+    data: AppInboxPayload;
+};
+export type NotifySegment_messagePayload = NotifySegment_messagePayload_payload | NotifySegment_messagePayload_emailPayload | NotifySegment_messagePayload_smsPayload | NotifySegment_messagePayload_appInboxPayload;
 /**
  * NotifySegment defines a request to send a message to a segment of users.
  * Segment can be defined either by a segment code or by a seglang expression.
@@ -236,7 +270,11 @@ export type NotifyTransactional_messagePayload_smsPayload = {
     type: 'smsPayload';
     data: SMSPayload;
 };
-export type NotifyTransactional_messagePayload = NotifyTransactional_messagePayload_payload | NotifyTransactional_messagePayload_emailPayload | NotifyTransactional_messagePayload_smsPayload;
+export type NotifyTransactional_messagePayload_appInboxPayload = {
+    type: 'appInboxPayload';
+    data: AppInboxPayload;
+};
+export type NotifyTransactional_messagePayload = NotifyTransactional_messagePayload_payload | NotifyTransactional_messagePayload_emailPayload | NotifyTransactional_messagePayload_smsPayload | NotifyTransactional_messagePayload_appInboxPayload;
 export type NotifyTransactional = {
     /** Message schedule. */
     schedule: Schedule;
@@ -748,6 +786,20 @@ export type Content_PlatformPropertiesWindows = {
     timeToLive: Duration;
     content: Content_PlatformPropertiesWindows_content;
 };
+export type Content_PlatformPropertiesAppInbox = {
+    /** Title of the inbox entry. */
+    title: string;
+    /** Body of the inbox entry. */
+    body: string;
+    /** Small image shown next to the entry. */
+    iconUrl: string;
+    /** Large image shown inside the entry. */
+    bannerUrl: string;
+    /** Action performed when the user taps the entry. */
+    openAction: OpenAction;
+    /** Free-form JSON delivered to the SDK with the entry. */
+    customData: object;
+};
 export type Content_PlatformPropertiesSMS = {
     /** Notification body text. */
     body: string;
@@ -877,6 +929,8 @@ export type Content = {
     sms: Content_PlatformPropertiesSMS;
     /** Viber message content. */
     viber: Content_PlatformPropertiesViber;
+    /** App Inbox message content. */
+    appInbox: Content_PlatformPropertiesAppInbox;
 };
 export type LocalizedContent = {
     /** Locale code (ISO 639-1, "zh-Hant"/"zh-Hans", or "default") to the content sent to devices in that language. */
@@ -938,6 +992,26 @@ export type EmailPayload = {
      */
     emailPreset: string;
 };
+export type AppInboxPayload_expiration_expirationDate = {
+    type: 'expirationDate';
+    data: Date;
+};
+export type AppInboxPayload_expiration_expiresIn = {
+    type: 'expiresIn';
+    data: Duration;
+};
+export type AppInboxPayload_expiration = AppInboxPayload_expiration_expirationDate | AppInboxPayload_expiration_expiresIn;
+/** AppInboxPayload is a message of the App Inbox channel. */
+export type AppInboxPayload = {
+    /**
+     * preset references a saved App Inbox preset by code. When set, messaging-api resolves the
+     * preset content into the per-language entry; inline content overrides the preset per language.
+     */
+    preset: string;
+    /** Per-locale content. The inbox entry is read from Content.app_inbox of each locale. */
+    content: LocalizedContent;
+    expiration: AppInboxPayload_expiration;
+};
 export type SMSPayload = {
     /**
      * preset references a saved SMS preset by code. When set, messaging-api resolves the