@pushwoosh/rpc-v2-http-api-data 0.2.453 → 0.2.455

package/data.js

@@ -15854,9 +15854,306 @@ export const data = {
                 "response": "pushwoosh.export_messages.v2.GetLastTasksResponse",
                 "method": "post",
                 "path": "/api/export_messages/statistics_export/lastTasks"
+            },
+            "ListReports": {
+                "request": "pushwoosh.rpc_v2.export_messages.ListReportsRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.ListReportsResponse",
+                "method": "get",
+                "path": "/api/export_messages/applications/{application_code}/reports"
+            },
+            "GetReport": {
+                "request": "pushwoosh.rpc_v2.export_messages.GetReportRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.GetReportResponse",
+                "method": "get",
+                "path": "/api/export_messages/applications/{application_code}/reports/{code}"
+            },
+            "CreateReport": {
+                "request": "pushwoosh.rpc_v2.export_messages.CreateReportRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.CreateReportResponse",
+                "method": "post",
+                "path": "/api/export_messages/applications/{application_code}/reports"
+            },
+            "UpdateReport": {
+                "request": "pushwoosh.rpc_v2.export_messages.UpdateReportRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.UpdateReportResponse",
+                "method": "post",
+                "path": "/api/export_messages/applications/{application_code}/reports/{code}"
+            },
+            "DeleteReport": {
+                "request": "pushwoosh.rpc_v2.export_messages.DeleteReportRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.DeleteReportResponse",
+                "method": "delete",
+                "path": "/api/export_messages/applications/{application_code}/reports/{code}"
+            },
+            "PauseReport": {
+                "request": "pushwoosh.rpc_v2.export_messages.PauseReportRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.PauseReportResponse",
+                "method": "post",
+                "path": "/api/export_messages/applications/{application_code}/reports/{code}/pause"
+            },
+            "ResumeReport": {
+                "request": "pushwoosh.rpc_v2.export_messages.ResumeReportRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.ResumeReportResponse",
+                "method": "post",
+                "path": "/api/export_messages/applications/{application_code}/reports/{code}/resume"
+            },
+            "SendReportNow": {
+                "request": "pushwoosh.rpc_v2.export_messages.SendReportNowRequest",
+                "response": "pushwoosh.rpc_v2.export_messages.SendReportNowResponse",
+                "method": "post",
+                "path": "/api/export_messages/applications/{application_code}/reports/{code}/send_now"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.ReportFrequency": {
+        "type": "E",
+        "values": [
+            "REPORT_FREQUENCY_UNSPECIFIED",
+            "REPORT_FREQUENCY_DAILY",
+            "REPORT_FREQUENCY_WEEKLY",
+            "REPORT_FREQUENCY_MONTHLY"
+        ]
+    },
+    "pushwoosh.rpc_v2.export_messages.ReportStatus": {
+        "type": "E",
+        "values": [
+            "REPORT_STATUS_UNSPECIFIED",
+            "REPORT_STATUS_ACTIVE",
+            "REPORT_STATUS_PAUSED"
+        ]
+    },
+    "pushwoosh.rpc_v2.export_messages.ReportSchedule": {
+        "type": "I",
+        "fields": {
+            "frequency": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportFrequency"
+            },
+            "day": {
+                "type": "number"
+            },
+            "time": {
+                "type": "string"
+            },
+            "timezone": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.ReportFilters": {
+        "type": "I",
+        "fields": {
+            "channels": {
+                "type": "string",
+                "array": true
+            },
+            "sources": {
+                "type": "string",
+                "array": true
+            },
+            "messageType": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.ReportForm": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "filters": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportFilters"
+            },
+            "schedule": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportSchedule"
+            },
+            "recipients": {
+                "type": "string",
+                "array": true
             }
         }
     },
+    "pushwoosh.rpc_v2.export_messages.Report": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "filters": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportFilters"
+            },
+            "schedule": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportSchedule"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportStatus"
+            },
+            "recipients": {
+                "type": "string",
+                "array": true
+            },
+            "nextRunAt": {
+                "type": "Date"
+            },
+            "lastSentAt": {
+                "type": "Date"
+            },
+            "created": {
+                "type": "Date"
+            },
+            "updated": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.ListReportsRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.ListReportsResponse": {
+        "type": "I",
+        "fields": {
+            "reports": {
+                "type": "pushwoosh.rpc_v2.export_messages.Report",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.GetReportRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.GetReportResponse": {
+        "type": "I",
+        "fields": {
+            "report": {
+                "type": "pushwoosh.rpc_v2.export_messages.Report"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.CreateReportRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "form": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportForm"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.CreateReportResponse": {
+        "type": "I",
+        "fields": {
+            "report": {
+                "type": "pushwoosh.rpc_v2.export_messages.Report"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.UpdateReportRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            },
+            "form": {
+                "type": "pushwoosh.rpc_v2.export_messages.ReportForm"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.UpdateReportResponse": {
+        "type": "I",
+        "fields": {
+            "report": {
+                "type": "pushwoosh.rpc_v2.export_messages.Report"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.DeleteReportRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.DeleteReportResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.export_messages.PauseReportRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.PauseReportResponse": {
+        "type": "I",
+        "fields": {
+            "report": {
+                "type": "pushwoosh.rpc_v2.export_messages.Report"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.ResumeReportRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.ResumeReportResponse": {
+        "type": "I",
+        "fields": {
+            "report": {
+                "type": "pushwoosh.rpc_v2.export_messages.Report"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.SendReportNowRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.export_messages.SendReportNowResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.export_messages.v2.TaskType": {
         "type": "E",
         "values": [

package/export_messages.d.ts

@@ -15,6 +15,14 @@ export type ExportStatisticsService_StatisticsExport = RpcMethod<pushwoosh_expor
 export type ExportStatisticsService_StatisticsExportStatus = RpcMethod<pushwoosh_export_messages_v2_StatusRequest, pushwoosh_export_messages_v2_StatusResponse>;
 export type ExportStatisticsService_StatisticsExportResult = RpcMethod<pushwoosh_export_messages_v2_ResultRequest, pushwoosh_export_messages_v2_ResultResponse>;
 export type ExportStatisticsService_StatisticsExportLastTasks = RpcMethod<pushwoosh_export_messages_v2_GetLastTasksRequest, pushwoosh_export_messages_v2_GetLastTasksResponse>;
+export type ExportStatisticsService_ListReports = RpcMethod<ListReportsRequest, ListReportsResponse>;
+export type ExportStatisticsService_GetReport = RpcMethod<GetReportRequest, GetReportResponse>;
+export type ExportStatisticsService_CreateReport = RpcMethod<CreateReportRequest, CreateReportResponse>;
+export type ExportStatisticsService_UpdateReport = RpcMethod<UpdateReportRequest, UpdateReportResponse>;
+export type ExportStatisticsService_DeleteReport = RpcMethod<DeleteReportRequest, DeleteReportResponse>;
+export type ExportStatisticsService_PauseReport = RpcMethod<PauseReportRequest, PauseReportResponse>;
+export type ExportStatisticsService_ResumeReport = RpcMethod<ResumeReportRequest, ResumeReportResponse>;
+export type ExportStatisticsService_SendReportNow = RpcMethod<SendReportNowRequest, SendReportNowResponse>;
 export interface ExportStatisticsService {
     /** Starts an asynchronous export or computation task (CSV of message history, recipients, bounced emails, journey users, retention, or create-segment-from-message) and returns its numeric task uid. The task type and its args select what is produced; poll get_export_task_status, then fetch get_export_task_result. */
     Export: ExportStatisticsService_Export;
@@ -35,4 +43,128 @@ export interface ExportStatisticsService {
     StatisticsExportResult: ExportStatisticsService_StatisticsExportResult;
     /** Recent statistics export tasks of the application. Same right as their Export. */
     StatisticsExportLastTasks: ExportStatisticsService_StatisticsExportLastTasks;
+    /** Auto-reports: the CSV of the Overview export emailed on a schedule to up to 25 recipients. Lists them, newest first. */
+    ListReports: ExportStatisticsService_ListReports;
+    /** Returns one auto-report. */
+    GetReport: ExportStatisticsService_GetReport;
+    /** Creates an active auto-report. An application holds at most 25 of them, and no two share a name in any case. */
+    CreateReport: ExportStatisticsService_CreateReport;
+    /** Replaces the name, filters, schedule and recipients of an auto-report; the status is kept. */
+    UpdateReport: ExportStatisticsService_UpdateReport;
+    /** Deletes an auto-report; its recipients stop receiving it. */
+    DeleteReport: ExportStatisticsService_DeleteReport;
+    /** Stops sending an auto-report until it is resumed. */
+    PauseReport: ExportStatisticsService_PauseReport;
+    /** Resumes a paused auto-report from its next scheduled time. */
+    ResumeReport: ExportStatisticsService_ResumeReport;
+    /** Sends the report now for the same period as its schedule, outside the schedule. Once an hour per report. */
+    SendReportNow: ExportStatisticsService_SendReportNow;
 }
+export type ReportFrequency = 'REPORT_FREQUENCY_UNSPECIFIED' | 'REPORT_FREQUENCY_DAILY' | 'REPORT_FREQUENCY_WEEKLY' | 'REPORT_FREQUENCY_MONTHLY';
+export type ReportStatus = 'REPORT_STATUS_UNSPECIFIED' | 'REPORT_STATUS_ACTIVE' | 'REPORT_STATUS_PAUSED';
+/** Daily covers yesterday, weekly the last 7 full days, monthly the previous calendar month. */
+export type ReportSchedule = {
+    frequency: ReportFrequency;
+    /** Weekly: 1-7 from Monday. Monthly: 1-31, a day past the end of a month sends on its last day. Unused for daily. */
+    day: number;
+    /** HH:MM in timezone */
+    time: string;
+    /** IANA name, e.g. Europe/Berlin */
+    timezone: string;
+};
+/** The filters of the unified messages export. */
+export type ReportFilters = {
+    /** "push" and "email", at least one */
+    channels: string[];
+    /** "one-time" and "journey", at least one */
+    sources: string[];
+    /** "marketing" or "transactional"; empty keeps both */
+    messageType: string;
+};
+export type ReportForm = {
+    name: string;
+    filters: ReportFilters;
+    schedule: ReportSchedule;
+    /** 1-25 addresses */
+    recipients: string[];
+};
+export type Report = {
+    /** Report code (XXXXX-XXXXX). */
+    code: string;
+    name: string;
+    filters: ReportFilters;
+    schedule: ReportSchedule;
+    status: ReportStatus;
+    recipients: string[];
+    /** empty while paused */
+    nextRunAt: Date;
+    lastSentAt: Date;
+    created: Date;
+    updated: Date;
+};
+export type ListReportsRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+};
+export type ListReportsResponse = {
+    reports: Report[];
+};
+export type GetReportRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Report code (XXXXX-XXXXX). */
+    code?: string;
+};
+export type GetReportResponse = {
+    report: Report;
+};
+export type CreateReportRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    form?: ReportForm;
+};
+export type CreateReportResponse = {
+    report: Report;
+};
+export type UpdateReportRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Report code (XXXXX-XXXXX). */
+    code?: string;
+    form?: ReportForm;
+};
+export type UpdateReportResponse = {
+    report: Report;
+};
+export type DeleteReportRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Report code (XXXXX-XXXXX). */
+    code?: string;
+};
+export type DeleteReportResponse = {};
+export type PauseReportRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Report code (XXXXX-XXXXX). */
+    code?: string;
+};
+export type PauseReportResponse = {
+    report: Report;
+};
+export type ResumeReportRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Report code (XXXXX-XXXXX). */
+    code?: string;
+};
+export type ResumeReportResponse = {
+    report: Report;
+};
+export type SendReportNowRequest = {
+    /** Application code (XXXXX-XXXXX). */
+    applicationCode?: string;
+    /** Report code (XXXXX-XXXXX). */
+    code?: string;
+};
+export type SendReportNowResponse = {};

package/package.json

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