@pushwoosh/rpc-v2-http-api-data 0.2.149 → 0.2.151

package/applications_alerts.d.ts

@@ -9,7 +9,7 @@ export type AlertError = 'ALERT_ERROR_UNSPECIFIED'
 /** warnings */
  | 'SUBSCRIBERS_QUOTA_ALMOST_REACHED' | 'EMAIL_QUOTA_ALMOST_REACHED'
 /** errors */
- | 'EMAIL_QUOTA_REACHED' | 'SUSPENDED_ACCOUNT' | 'MANUALLY_SUSPENDED_ACCOUNT' | 'APPLE_CERTIFICATE_EXPIRED' | 'PAYMENT_FAILED' | 'PLATFORM_DISABLED' | 'PAYMENT_OVERDUE' | 'PAYMENT_ATTEMPT_FAILED' | 'EMAIL_CONFIGURATION_NOT_COMPLETED'
+ | 'EMAIL_QUOTA_REACHED' | 'SUSPENDED_ACCOUNT' | 'MANUALLY_SUSPENDED_ACCOUNT' | 'APPLE_CERTIFICATE_EXPIRED' | 'PAYMENT_FAILED' | 'PLATFORM_DISABLED' | 'PAYMENT_OVERDUE' | 'PAYMENT_ATTEMPT_FAILED' | 'EMAIL_CONFIGURATION_NOT_COMPLETED' | 'EMAIL_SENDING_PAUSED_COMPLAINT_RATE' | 'EMAIL_SENDING_PAUSED_HARD_BOUNCE_RATE' | 'EMAIL_SENDING_PAUSED_BOTH_RATES'
 /** recommendation */
  | 'SDK_INTEGRATION' | 'THIRD_PARTY_INTEGRATION';
 export type Alert = {

package/data.js

@@ -1599,6 +1599,36 @@ export const data = {
                 "response": "pushwoosh.accounts.alerts.v1.DeleteResponse",
                 "method": "delete",
                 "path": "/api/v1/delete"
+            },
+            "Get": {
+                "request": "pushwoosh.accounts.alerts.v1.GetRequest",
+                "response": "pushwoosh.accounts.alerts.v1.GetResponse",
+                "method": "get",
+                "path": "/api/v1/get"
+            },
+            "ListGroup": {
+                "request": "pushwoosh.accounts.alerts.v1.ListGroupRequest",
+                "response": "pushwoosh.accounts.alerts.v1.ListGroupResponse",
+                "method": "get",
+                "path": "/api/v1/list-group"
+            },
+            "UpdateUnread": {
+                "request": "pushwoosh.accounts.alerts.v1.UpdateUnreadRequest",
+                "response": "pushwoosh.accounts.alerts.v1.UpdateUnreadResponse",
+                "method": "put",
+                "path": "/api/v1/update-unread"
+            },
+            "Recall": {
+                "request": "pushwoosh.accounts.alerts.v1.RecallRequest",
+                "response": "pushwoosh.accounts.alerts.v1.RecallResponse",
+                "method": "post",
+                "path": "/api/v1/recall"
+            },
+            "UpdateGroup": {
+                "request": "pushwoosh.accounts.alerts.v1.UpdateGroupRequest",
+                "response": "pushwoosh.accounts.alerts.v1.UpdateGroupResponse",
+                "method": "put",
+                "path": "/api/v1/update-group"
             }
         }
     },
@@ -1619,6 +1649,18 @@ export const data = {
             "actionLinkLabel": {
                 "type": "string",
                 "optional": true
+            },
+            "imageUrl": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLinkLabel": {
+                "type": "string",
+                "optional": true
             }
         }
     },
@@ -1644,7 +1686,8 @@ export const data = {
             "ALERT_TYPE_UNSPECIFIED",
             "ALERT_TYPE_BLOCKING",
             "ALERT_TYPE_DISMISSABLE",
-            "ALERT_TYPE_TOP_BANNER"
+            "ALERT_TYPE_TOP_BANNER",
+            "ALERT_TYPE_PRODUCT_UPDATE"
         ]
     },
     "pushwoosh.accounts.alerts.v1.AlertStatus": {
@@ -1704,6 +1747,13 @@ export const data = {
             },
             "accountId": {
                 "type": "number"
+            },
+            "userId": {
+                "type": "number"
+            },
+            "excludeTypes": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertType",
+                "array": true
             }
         }
     },
@@ -1755,6 +1805,18 @@ export const data = {
             "actionLinkLabel": {
                 "type": "string",
                 "optional": true
+            },
+            "imageUrl": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLinkLabel": {
+                "type": "string",
+                "optional": true
             }
         }
     },
@@ -1809,6 +1871,13 @@ export const data = {
             "uniqueKey": {
                 "type": "string",
                 "optional": true
+            },
+            "accountIds": {
+                "type": "number",
+                "array": true
+            },
+            "allAccounts": {
+                "type": "boolean"
             }
         }
     },
@@ -1829,6 +1898,9 @@ export const data = {
             "alerts": {
                 "type": "pushwoosh.accounts.alerts.v1.UpdateStatusRequest.Alert",
                 "array": true
+            },
+            "userId": {
+                "type": "number"
             }
         }
     },
@@ -1838,7 +1910,226 @@ export const data = {
     },
     "pushwoosh.accounts.alerts.v1.SendResponse": {
         "type": "I",
-        "fields": {}
+        "fields": {
+            "groupUuid": {
+                "type": "string"
+            },
+            "created": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.UpdateUnreadRequest": {
+        "type": "I",
+        "fields": {
+            "groupUuid": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string",
+                "optional": true
+            },
+            "content": {
+                "type": "string",
+                "optional": true
+            },
+            "actionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "actionLinkLabel": {
+                "type": "string",
+                "optional": true
+            },
+            "severity": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertSeverity",
+                "optional": true
+            },
+            "expiry": {
+                "type": "Date",
+                "optional": true
+            },
+            "imageUrl": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLinkLabel": {
+                "type": "string",
+                "optional": true
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.UpdateUnreadResponse": {
+        "type": "I",
+        "fields": {
+            "updated": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.UpdateGroupRequest": {
+        "type": "I",
+        "fields": {
+            "groupUuid": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string",
+                "optional": true
+            },
+            "content": {
+                "type": "string",
+                "optional": true
+            },
+            "actionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "actionLinkLabel": {
+                "type": "string",
+                "optional": true
+            },
+            "severity": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertSeverity",
+                "optional": true
+            },
+            "expiry": {
+                "type": "Date",
+                "optional": true
+            },
+            "imageUrl": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLinkLabel": {
+                "type": "string",
+                "optional": true
+            },
+            "type": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertType",
+                "optional": true
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.UpdateGroupResponse": {
+        "type": "I",
+        "fields": {
+            "updated": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.ListGroupRequest": {
+        "type": "I",
+        "fields": {
+            "status": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertStatus"
+            },
+            "titleSearch": {
+                "type": "string",
+                "optional": true
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "orderBy": {
+                "type": "pushwoosh.accounts.alerts.v1.OrderBy"
+            },
+            "orderDirection": {
+                "type": "pushwoosh.accounts.alerts.v1.OrderDirection"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.ListGroupResponse.AlertGroup": {
+        "type": "I",
+        "fields": {
+            "groupUuid": {
+                "type": "string"
+            },
+            "type": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertType"
+            },
+            "severity": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertSeverity"
+            },
+            "title": {
+                "type": "string"
+            },
+            "content": {
+                "type": "string",
+                "optional": true
+            },
+            "created": {
+                "type": "Date",
+                "optional": true
+            },
+            "expiry": {
+                "type": "Date",
+                "optional": true
+            },
+            "actionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "actionLinkLabel": {
+                "type": "string",
+                "optional": true
+            },
+            "recipientsCount": {
+                "type": "number"
+            },
+            "unreadCount": {
+                "type": "number"
+            },
+            "readCount": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.ListGroupResponse": {
+        "type": "I",
+        "fields": {
+            "groups": {
+                "type": "pushwoosh.accounts.alerts.v1.ListGroupResponse.AlertGroup",
+                "array": true
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.RecallRequest": {
+        "type": "I",
+        "fields": {
+            "groupUuid": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.RecallResponse": {
+        "type": "I",
+        "fields": {
+            "recalled": {
+                "type": "number"
+            }
+        }
     },
     "pushwoosh.accounts.alerts.v1.GetHighestSeverityRequest": {
         "type": "I",
@@ -1848,6 +2139,13 @@ export const data = {
             },
             "status": {
                 "type": "pushwoosh.accounts.alerts.v1.AlertStatus"
+            },
+            "userId": {
+                "type": "number"
+            },
+            "excludeTypes": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertType",
+                "array": true
             }
         }
     },
@@ -1879,6 +2177,94 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.accounts.alerts.v1.GetRequest": {
+        "type": "I",
+        "fields": {
+            "uuid": {
+                "type": "string"
+            },
+            "uniqueKey": {
+                "type": "string"
+            },
+            "accountId": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.GetResponse.Alert": {
+        "type": "I",
+        "fields": {
+            "type": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertType"
+            },
+            "status": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertStatus"
+            },
+            "severity": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertSeverity"
+            },
+            "title": {
+                "type": "string"
+            },
+            "content": {
+                "type": "string",
+                "optional": true
+            },
+            "created": {
+                "type": "Date",
+                "optional": true
+            },
+            "expiry": {
+                "type": "Date",
+                "optional": true
+            },
+            "uuid": {
+                "type": "string"
+            },
+            "uniqueKey": {
+                "type": "string"
+            },
+            "accountId": {
+                "type": "number"
+            },
+            "applicationId": {
+                "type": "number",
+                "optional": true
+            },
+            "meta": {
+                "type": "object",
+                "optional": true
+            },
+            "actionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "actionLinkLabel": {
+                "type": "string",
+                "optional": true
+            },
+            "imageUrl": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLinkLabel": {
+                "type": "string",
+                "optional": true
+            }
+        }
+    },
+    "pushwoosh.accounts.alerts.v1.GetResponse": {
+        "type": "I",
+        "fields": {
+            "alert": {
+                "type": "pushwoosh.accounts.alerts.v1.GetResponse.Alert"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.accounts_get_auth_info.GetAuthInfoService": {
         "type": "S",
         "key": "getAuthInfo",
@@ -5428,6 +5814,9 @@ export const data = {
             "PAYMENT_OVERDUE",
             "PAYMENT_ATTEMPT_FAILED",
             "EMAIL_CONFIGURATION_NOT_COMPLETED",
+            "EMAIL_SENDING_PAUSED_COMPLAINT_RATE",
+            "EMAIL_SENDING_PAUSED_HARD_BOUNCE_RATE",
+            "EMAIL_SENDING_PAUSED_BOTH_RATES",
             "SDK_INTEGRATION",
             "THIRD_PARTY_INTEGRATION"
         ]
@@ -16385,6 +16774,10 @@ export const data = {
             },
             "orderDirection": {
                 "type": "pushwoosh.accounts.alerts.v1.OrderDirection"
+            },
+            "excludeTypes": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertType",
+                "array": true
             }
         }
     },
@@ -16432,6 +16825,18 @@ export const data = {
             "actionLinkLabel": {
                 "type": "string",
                 "optional": true
+            },
+            "imageUrl": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLink": {
+                "type": "string",
+                "optional": true
+            },
+            "secondaryActionLinkLabel": {
+                "type": "string",
+                "optional": true
             }
         }
     },
@@ -16482,6 +16887,10 @@ export const data = {
         "fields": {
             "status": {
                 "type": "pushwoosh.accounts.alerts.v1.AlertStatus"
+            },
+            "excludeTypes": {
+                "type": "pushwoosh.accounts.alerts.v1.AlertType",
+                "array": true
             }
         }
     },

package/internal_alerts.d.ts

@@ -30,6 +30,8 @@ export type ListRequest = {
     orderBy?: pushwoosh_accounts_alerts_v1_OrderBy;
     /** Ascending or descending order. */
     orderDirection?: pushwoosh_accounts_alerts_v1_OrderDirection;
+    /** Optional filter: drop alerts of these types from the result. */
+    excludeTypes?: pushwoosh_accounts_alerts_v1_AlertType[];
 };
 export type Alert = {
     type: pushwoosh_accounts_alerts_v1_AlertType;
@@ -44,6 +46,10 @@ export type Alert = {
     application?: string;
     actionLink?: string;
     actionLinkLabel?: string;
+    /** Illustration of a product update card; empty means the client draws its own fallback. */
+    imageUrl?: string;
+    secondaryActionLink?: string;
+    secondaryActionLinkLabel?: string;
 };
 export type ListResponse = {
     alerts: Alert[];
@@ -65,6 +71,8 @@ export type UpdateStatusResponse = {};
 export type GetHighestSeverityRequest = {
     /** Optional filter: consider only alerts in this status (e.g. read/unread). */
     status?: pushwoosh_accounts_alerts_v1_AlertStatus;
+    /** Optional filter: ignore alerts of these types when picking the severity. */
+    excludeTypes?: pushwoosh_accounts_alerts_v1_AlertType[];
 };
 export type GetHighestSeverityResponse = {
     severity: pushwoosh_accounts_alerts_v1_AlertSeverity;

package/package.json

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

package/pushwoosh_accounts_alerts_v1.d.ts

@@ -4,25 +4,38 @@ export type AlertsService_Send = RpcMethod<SendRequest, SendResponse>;
 export type AlertsService_UpdateStatus = RpcMethod<UpdateStatusRequest, UpdateStatusResponse>;
 export type AlertsService_GetHighestSeverity = RpcMethod<GetHighestSeverityRequest, GetHighestSeverityResponse>;
 export type AlertsService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
+export type AlertsService_Get = RpcMethod<GetRequest, GetResponse>;
+export type AlertsService_ListGroup = RpcMethod<ListGroupRequest, ListGroupResponse>;
+export type AlertsService_UpdateUnread = RpcMethod<UpdateUnreadRequest, UpdateUnreadResponse>;
+export type AlertsService_Recall = RpcMethod<RecallRequest, RecallResponse>;
+export type AlertsService_UpdateGroup = RpcMethod<UpdateGroupRequest, UpdateGroupResponse>;
 export interface AlertsService {
     List: AlertsService_List;
     Send: AlertsService_Send;
     UpdateStatus: AlertsService_UpdateStatus;
     GetHighestSeverity: AlertsService_GetHighestSeverity;
     Delete: AlertsService_Delete;
+    Get: AlertsService_Get;
+    ListGroup: AlertsService_ListGroup;
+    UpdateUnread: AlertsService_UpdateUnread;
+    Recall: AlertsService_Recall;
+    UpdateGroup: AlertsService_UpdateGroup;
 }
 export type AlertBanner = {
     type: AlertType;
     content?: string;
     actionLink?: string;
     actionLinkLabel?: string;
+    imageUrl?: string;
+    secondaryActionLink?: string;
+    secondaryActionLinkLabel?: string;
 };
 export type AlertEmail = {
     to: string[];
     template: string;
     placeholders: Record<string, any>;
 };
-export type AlertType = 'ALERT_TYPE_UNSPECIFIED' | 'ALERT_TYPE_BLOCKING' | 'ALERT_TYPE_DISMISSABLE' | 'ALERT_TYPE_TOP_BANNER';
+export type AlertType = 'ALERT_TYPE_UNSPECIFIED' | 'ALERT_TYPE_BLOCKING' | 'ALERT_TYPE_DISMISSABLE' | 'ALERT_TYPE_TOP_BANNER' | 'ALERT_TYPE_PRODUCT_UPDATE';
 export type AlertStatus = 'ALERT_STATUS_UNSPECIFIED' | 'ALERT_STATUS_READ' | 'ALERT_STATUS_UNREAD';
 export type AlertSeverity = 'ALERT_SEVERITY_UNSPECIFIED' | 'ALERT_SEVERITY_INFO' | 'ALERT_SEVERITY_WARNING' | 'ALERT_SEVERITY_CRITICAL';
 export type OrderBy = 'ORDER_BY_CREATED' | 'ORDER_BY_SEVERITY';
@@ -36,6 +49,10 @@ export type ListRequest = {
     orderBy?: OrderBy;
     orderDirection?: OrderDirection;
     accountId?: number;
+    /** Read state is resolved for this user; 0 keeps the account-wide read flag. */
+    userId?: number;
+    /** Drops alerts of these types from the result; `type` above still selects a single type. */
+    excludeTypes?: AlertType[];
 };
 export type ListResponse_Alert = {
     type: AlertType;
@@ -51,6 +68,9 @@ export type ListResponse_Alert = {
     meta?: object;
     actionLink?: string;
     actionLinkLabel?: string;
+    imageUrl?: string;
+    secondaryActionLink?: string;
+    secondaryActionLinkLabel?: string;
 };
 export type ListResponse = {
     alerts: ListResponse_Alert[];
@@ -69,6 +89,16 @@ export type SendRequest = {
     meta?: object;
     /** check unique alert within the `unique_key` in the provided request */
     uniqueKey?: string;
+    /**
+     * When non-empty, takes precedence over `account_id` and one alert is created per id.
+     * Server generates a shared `group_id` (UUID) so the batch can be patched / recalled later.
+     */
+    accountIds?: number[];
+    /**
+     * When true, the server enumerates all active accounts itself and creates one alert
+     * per account (shared group_uuid), ignoring `account_id` and `account_ids`.
+     */
+    allAccounts?: boolean;
 };
 export type UpdateStatusRequest_Alert = {
     id: number;
@@ -76,12 +106,92 @@ export type UpdateStatusRequest_Alert = {
 };
 export type UpdateStatusRequest = {
     alerts?: UpdateStatusRequest_Alert[];
+    /** Marks the alerts read/unread for this user; 0 keeps the account-wide read flag. */
+    userId?: number;
 };
 export type UpdateStatusResponse = {};
-export type SendResponse = {};
+export type SendResponse = {
+    groupUuid: string;
+    created: number;
+};
+export type UpdateUnreadRequest = {
+    groupUuid?: string;
+    /** Patch fields. Only set fields are applied. */
+    title?: string;
+    content?: string;
+    actionLink?: string;
+    actionLinkLabel?: string;
+    severity?: AlertSeverity;
+    expiry?: Date;
+    imageUrl?: string;
+    secondaryActionLink?: string;
+    secondaryActionLinkLabel?: string;
+};
+export type UpdateUnreadResponse = {
+    updated: number;
+};
+/**
+ * UpdateGroup patches every alert of the group, read ones included, unlike UpdateUnread.
+ * Content-only edits (picture, CTA, type) stay correct after a user has seen the card.
+ */
+export type UpdateGroupRequest = {
+    groupUuid?: string;
+    /** Patch fields. Only set fields are applied. */
+    title?: string;
+    content?: string;
+    actionLink?: string;
+    actionLinkLabel?: string;
+    severity?: AlertSeverity;
+    expiry?: Date;
+    imageUrl?: string;
+    secondaryActionLink?: string;
+    secondaryActionLinkLabel?: string;
+    type?: AlertType;
+};
+export type UpdateGroupResponse = {
+    updated: number;
+};
+export type ListGroupRequest = {
+    status?: AlertStatus;
+    titleSearch?: string;
+    page?: number;
+    perPage?: number;
+    orderBy?: OrderBy;
+    orderDirection?: OrderDirection;
+};
+export type ListGroupResponse_AlertGroup = {
+    groupUuid: string;
+    type: AlertType;
+    severity: AlertSeverity;
+    title: string;
+    content?: string;
+    created?: Date;
+    expiry?: Date;
+    actionLink?: string;
+    actionLinkLabel?: string;
+    recipientsCount: number;
+    unreadCount: number;
+    readCount: number;
+};
+export type ListGroupResponse = {
+    groups: ListGroupResponse_AlertGroup[];
+    page: number;
+    perPage: number;
+    total: number;
+};
+export type RecallRequest = {
+    groupUuid?: string;
+};
+export type RecallResponse = {
+    recalled: number;
+};
 export type GetHighestSeverityRequest = {
     accountId?: number;
     status?: AlertStatus;
+    /** Read state is resolved for this user; 0 keeps the account-wide read flag. */
+    userId?: number;
+    /** Drops alerts of these types before picking the highest severity. */
+    excludeTypes?: AlertType[];
 };
 export type GetHighestSeverityResponse = {
     severity: AlertSeverity;
@@ -93,3 +203,34 @@ export type DeleteRequest = {
     accountId?: number;
 };
 export type DeleteResponse = {};
+export type GetRequest = {
+    /**
+     * any of identifier
+     * uuid has highest prior
+     */
+    uuid?: string;
+    uniqueKey?: string;
+    accountId?: number;
+};
+export type GetResponse_Alert = {
+    type: AlertType;
+    status: AlertStatus;
+    severity: AlertSeverity;
+    title: string;
+    content?: string;
+    created?: Date;
+    expiry?: Date;
+    uuid: string;
+    uniqueKey: string;
+    accountId: number;
+    applicationId?: number;
+    meta?: object;
+    actionLink?: string;
+    actionLinkLabel?: string;
+    imageUrl?: string;
+    secondaryActionLink?: string;
+    secondaryActionLinkLabel?: string;
+};
+export type GetResponse = {
+    alert: GetResponse_Alert;
+};