@pushwoosh/rpc-v2-http-api-data 0.2.150 → 0.2.152

package/index.d.ts

@@ -11,6 +11,7 @@ import { ApplicationEmailFromsService as pushwoosh_rpc_v2_applications_email_fro
 import { ApplicationSoundsService as pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService } from './applications_sounds';
 import { ApplicationsAlertsService as pushwoosh_rpc_v2_applications_alerts_ApplicationsAlertsService } from './applications_alerts';
 import { ApplicationsConfigurationsService as pushwoosh_rpc_v2_applications_configurations_ApplicationsConfigurationsService } from './applications_configurations';
+import { ApplicationsControlGroupService as pushwoosh_rpc_v2_applications_controlgroup_ApplicationsControlGroupService } from './applications_controlgroup';
 import { ApplicationsGroupsService as pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService } from './applications_groups';
 import { ApplicationsInfoService as pushwoosh_rpc_v2_applications_info_ApplicationsInfoService } from './applications_info';
 import { ApplicationsStatisticsService as pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService } from './applications_statistics';
@@ -79,6 +80,7 @@ export type API = {
     applicationSounds: pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService;
     applicationsAlerts: pushwoosh_rpc_v2_applications_alerts_ApplicationsAlertsService;
     applicationsConfigurations: pushwoosh_rpc_v2_applications_configurations_ApplicationsConfigurationsService;
+    applicationsControlGroup: pushwoosh_rpc_v2_applications_controlgroup_ApplicationsControlGroupService;
     applicationsGroups: pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService;
     applicationsInfo: pushwoosh_rpc_v2_applications_info_ApplicationsInfoService;
     applicationsStatistics: pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService;

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.150",
+  "version": "0.2.152",
   "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;
+};