@pushwoosh/rpc-gateway-statistics-api 1.3.689

package/pushwoosh_statistics_statistics_v1.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/pushwoosh_statistics_statistics_v2.d.ts

@@ -0,0 +1,189 @@
+import { RpcMethod, JsonObject } from './commonTypes';
+import { Platform as pushwoosh_statistics_types_Platform } from './pushwoosh_statistics_types';
+import { DateRange as pushwoosh_statistics_types_DateRange } from './pushwoosh_statistics_types';
+import { Source as pushwoosh_statistics_types_Source } from './pushwoosh_statistics_types';
+import { MessageType as pushwoosh_statistics_types_MessageType } from './pushwoosh_statistics_types';
+export type MessagesService_List = RpcMethod<ListRequest, ListResponse>;
+export type MessagesService_LoadByCodes = RpcMethod<LoadByCodesRequest, LoadByCodesResponse>;
+export type MessagesService_GetByIDs = RpcMethod<GetByIDsRequest, GetByIDsResponse>;
+export type MessagesService_LoadByCode = RpcMethod<LoadByCodeRequest, LoadByCodeResponse>;
+export type MessagesService_GetByID = RpcMethod<GetByIDRequest, GetByIDResponse>;
+export type MessagesService_Load = RpcMethod<LoadRequest, LoadResponse>;
+export interface MessagesService {
+    List: MessagesService_List;
+    LoadByCodes: MessagesService_LoadByCodes;
+    GetByIDs: MessagesService_GetByIDs;
+    LoadByCode: MessagesService_LoadByCode;
+    GetByID: MessagesService_GetByID;
+    Load: MessagesService_Load;
+}
+export type ListRequest_Filter = {
+    platforms: pushwoosh_statistics_types_Platform[];
+    dateRange: pushwoosh_statistics_types_DateRange;
+    source: pushwoosh_statistics_types_Source;
+    campaign: string;
+    messagesIds: number[];
+    messagesCodes: string[];
+    application: string;
+    messageType: pushwoosh_statistics_types_MessageType;
+};
+export type ListRequest_Params = {
+    withDetails: boolean;
+    withMetrics: boolean;
+};
+export type ListRequest = {
+    filters: ListRequest_Filter;
+    params: ListRequest_Params;
+    perPage: number;
+    page: number;
+};
+export type PushDetails_PlatformParameters = {
+    androidHeader: string;
+    androidRootParams: Record<string, string>;
+    iosTitle: string;
+    iosSubtitle: string;
+    iosRootParams: Record<string, string>;
+    chromeHeader: string;
+    chromeRootParams: Record<string, string>;
+    firefoxHeader: string;
+    firefoxRootParams: Record<string, string>;
+};
+export type PushDetails = {
+    filterName: string;
+    filterCode: string;
+    content: Record<string, string>;
+    title: Record<string, string>;
+    platformParameters: PushDetails_PlatformParameters;
+    followUserTimezone: boolean;
+    conditions: string;
+    data: JsonObject;
+    conditionsOperator: string;
+    filterConditions: string;
+    devicesFilter: string;
+};
+export type EmailDetails = {
+    template: string;
+    filterName: string;
+    filterCode: string;
+    subject: Record<string, string>;
+    fromName: string;
+    fromEmail: string;
+    replyName: string;
+    replyEmail: string;
+    followUserTimezone: boolean;
+    conditions: string;
+    conditionsOperator: string;
+    filterConditions: string;
+    devicesFilter: string;
+    data: string;
+};
+export type PushMetrics = {
+    sends: number;
+    opens: number;
+    deliveries: number;
+    inboxOpens: number;
+    unshowableSends: number;
+    errors: number;
+    platform: number;
+};
+export type EmailMetrics = {
+    sends: number;
+    opens: number;
+    deliveries: number;
+    hardBounces: number;
+    softBounces: number;
+    rejects: number;
+    confirmedSends: number;
+    unsubs: number;
+    complaints: number;
+    errors: number;
+};
+export type PushInfo = {
+    details: PushDetails;
+    metrics: PushMetrics[];
+};
+export type EmailInfo = {
+    details: EmailDetails;
+    metrics: EmailMetrics[];
+};
+export type ListResponseItem_info_pushInfo = {
+    type: 'pushInfo';
+    data: PushInfo;
+};
+export type ListResponseItem_info_emailInfo = {
+    type: 'emailInfo';
+    data: EmailInfo;
+};
+export type ListResponseItem_info = ListResponseItem_info_pushInfo | ListResponseItem_info_emailInfo;
+export type ListResponseItem = {
+    id: number;
+    code: string;
+    createdDate: string;
+    sendDate: string;
+    status: string;
+    platforms: number[];
+    source: string;
+    info: ListResponseItem_info;
+};
+export type ListResponse = {
+    total: number;
+    items: ListResponseItem[];
+};
+export type Message_Status = 'status_unknown' | 'creating' | 'waiting' | 'pending' | 'processing' | 'done' | 'canceled' | 'fail';
+export type Message_Type = 'type_unknown' | 'broadcast' | 'devices' | 'users';
+export type Message = {
+    id: number;
+    code: string;
+    accountId: number;
+    campaignId: number;
+    applicationIds: number[];
+    platforms: number[];
+    status: Message_Status;
+    sendType: Message_Type;
+    isCanceled: boolean;
+    icon: string;
+    banner: string;
+    createdVia: pushwoosh_statistics_types_Source;
+    title: Record<string, string>;
+    subtitle: Record<string, string>;
+    content: Record<string, string>;
+    createdTimestamp: Date;
+    updatedTimestamp: Date;
+    sentTimestamp: Date;
+    properties: Record<string, string>;
+    childMessages: Message[];
+};
+export type LoadByCodesRequest = {
+    codes: string[];
+};
+export type LoadByCodesResponse = {
+    messages: Message[];
+};
+export type GetByIDsRequest = {
+    ids: number[];
+};
+export type GetByIDsResponse = {
+    messages: Message[];
+};
+export type LoadByCodeRequest = {
+    code: string;
+};
+export type LoadByCodeResponse = {
+    message: Message;
+};
+export type GetByIDRequest = {
+    id: number;
+};
+export type GetByIDResponse = {
+    message: Message;
+};
+export type LoadRequest = {
+    application: string;
+    code: string;
+    id: number;
+    relationUuid: string;
+    relationParentUuid: string;
+};
+export type LoadResponse = {
+    message: Message;
+};

package/pushwoosh_statistics_statistics_v2.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/pushwoosh_statistics_statistics_v2_dashboards.d.ts

@@ -0,0 +1,143 @@
+import { RpcMethod } from './commonTypes';
+import { TimeInterval as pushwoosh_statistics_types_TimeInterval } from './pushwoosh_statistics_types';
+export type DashboardsService_GetLinearChartMetrics = RpcMethod<GetLinearChartMetricsRequest, GetLinearChartMetricsResponse>;
+export type DashboardsService_GetTotalsChartMetrics = RpcMethod<GetTotalsChartMetricsRequest, GetTotalsChartMetricsResponse>;
+export type DashboardsService_GetFunnel = RpcMethod<GetFunnelRequest, GetFunnelResponse>;
+export interface DashboardsService {
+    /** GetLinearChartMetrics returns metrics for linear charts based on provided parameters */
+    GetLinearChartMetrics: DashboardsService_GetLinearChartMetrics;
+    /** GetTotalsChartMetrics returns total metrics for charts based on provided parameters */
+    GetTotalsChartMetrics: DashboardsService_GetTotalsChartMetrics;
+    /** GetFunnel returns funnel data based on provided parameters */
+    GetFunnel: DashboardsService_GetFunnel;
+}
+export type Breakdown = 'BREAKDOWN_UNKNOWN' | 'PLATFORMS' | 'EVENT_ATTRIBUTE' | 'TAG_VALUES' | 'CAMPAIGNS' | 'MESSAGES' | 'JOURNEYS';
+export type MathOperator = 'MATH_OPERATOR_UNSPECIFIED' | 'EQ' | 'NOT_EQ' | 'GTE' | 'LTE' | 'BETWEEN' | 'IN' | 'NOT_IN' | 'ANY' | 'NOT_SET';
+export type EventCalcType = 'EVENT_CALC_TYPE_ALL' | 'EVENT_CALC_TYPE_UNIQUE';
+export type Value_kind_string = {
+    type: 'string';
+    data: string;
+};
+export type Value_kind_integer = {
+    type: 'integer';
+    data: number;
+};
+export type Value_kind_decimal = {
+    type: 'decimal';
+    data: number;
+};
+export type Value_kind_boolean = {
+    type: 'boolean';
+    data: boolean;
+};
+export type Value_kind_list = {
+    type: 'list';
+    data: List;
+};
+export type Value_kind_date = {
+    type: 'date';
+    data: Date;
+};
+export type Value_kind = Value_kind_string | Value_kind_integer | Value_kind_decimal | Value_kind_boolean | Value_kind_list | Value_kind_date;
+export type Value = {
+    kind: Value_kind;
+};
+export type List = {
+    values: string[];
+};
+export type AttributeCondition = {
+    name: string;
+    operator: MathOperator;
+    values: Value[];
+};
+export type Metric = {
+    id: number;
+    eventName: string;
+    attributeConditions: AttributeCondition[];
+    tag: string;
+    eventCalcType: EventCalcType;
+};
+/** TypeFilter defines the type of filter to apply */
+export type ChartParams_TypeFilter = 'Platform' | 'Segment' | 'Push' | 'Email' | 'Campaign' | 'Journey';
+export type ChartParams_TimeRange = {
+    from: Date;
+    to: Date;
+    interval: pushwoosh_statistics_types_TimeInterval;
+};
+export type ChartParams_Filters = {
+    /** platforms - list of platform IDs to filter by */
+    platforms: number[];
+    messagesIds: number[];
+    campaignsCodes: string[];
+    attributeConditions: AttributeCondition[];
+    segment: string;
+};
+export type ChartParams_Filter = {
+    type: ChartParams_TypeFilter;
+    platforms: number[];
+    segment: string;
+    pushId: number;
+    emailId: number;
+    campaign: string;
+    journey: string;
+    jPoints: string[];
+    disabled: boolean;
+};
+export type ChartParams_BreakdownParams = {
+    type: Breakdown;
+    eventAttribute: string;
+    /** should be one of the metrics from the metrics array */
+    metric: Metric;
+};
+/** ChartParams defines the parameters for chart metrics requests */
+export type ChartParams = {
+    timeRange: ChartParams_TimeRange;
+    metrics: Metric[];
+    filters: ChartParams_Filters;
+    fltrs: ChartParams_Filter[];
+    breakdown: ChartParams_BreakdownParams;
+    application: string;
+    timezone: string;
+};
+export type GetLinearChartMetricsRequest = {
+    params: ChartParams;
+};
+export type GetLinearChartMetricsResponse_Breakdown = {
+    breakdown: string;
+    values: number[];
+    total: number;
+};
+export type GetLinearChartMetricsResponse_Metric = {
+    metric: string;
+    breakdowns: GetLinearChartMetricsResponse_Breakdown[];
+};
+export type GetLinearChartMetricsResponse = {
+    timestamps: Date[];
+    metrics: GetLinearChartMetricsResponse_Metric[];
+};
+export type GetTotalsChartMetricsRequest = {
+    params: ChartParams;
+};
+export type GetTotalsChartMetricsResponse_Breakdown = {
+    breakdown: string;
+    value: number;
+    total: number;
+};
+export type GetTotalsChartMetricsResponse_Metric = {
+    metric: string;
+    breakdowns: GetTotalsChartMetricsResponse_Breakdown[];
+};
+export type GetTotalsChartMetricsResponse = {
+    metrics: GetTotalsChartMetricsResponse_Metric[];
+};
+export type GetFunnelRequest = {
+    params: ChartParams;
+};
+export type GetFunnelResponse_Step = {
+    breakdown: string;
+    count: number;
+    percent: number;
+};
+export type GetFunnelResponse = {
+    steps: GetFunnelResponse_Step[];
+};

package/pushwoosh_statistics_statistics_v2_dashboards.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/pushwoosh_statistics_statistics_v2_overview.d.ts

@@ -0,0 +1,59 @@
+import { RpcMethod } from './commonTypes';
+export type OverviewService_Get = RpcMethod<GetRequest, GetResponse>;
+export type OverviewService_GetMessagesStatByApplications = RpcMethod<GetMessagesStatByApplicationsRequest, GetMessagesStatByApplicationsResponse>;
+export type OverviewService_GetAudienceStatByApplications = RpcMethod<GetAudienceStatByApplicationsRequest, GetAudienceStatByApplicationsResponse>;
+export interface OverviewService {
+    /** Get returns overview statistics for pushwoosh. */
+    Get: OverviewService_Get;
+    GetMessagesStatByApplications: OverviewService_GetMessagesStatByApplications;
+    GetAudienceStatByApplications: OverviewService_GetAudienceStatByApplications;
+}
+export type GetRequest = {
+    /**
+     * day to get statistics for.
+     * only year-month-day are used.
+     */
+    day: Date;
+};
+export type GetResponse = {
+    /** total sends by platform */
+    sends: Record<number, number>;
+};
+export type GetMessagesStatByApplicationsRequest = {
+    /**
+     * days to get statistics for.
+     * only year-month-day are used.
+     */
+    dayFrom: Date;
+    dayTo: Date;
+    applicationIds: number[];
+};
+export type GetMessagesStatByApplicationsResponse_Statistics = {
+    applicationId: number;
+    platform: number;
+    sends: number;
+    opens: number;
+};
+export type GetMessagesStatByApplicationsResponse = {
+    /** total metrics by apps and platforms */
+    statistics: GetMessagesStatByApplicationsResponse_Statistics[];
+};
+export type GetAudienceStatByApplicationsRequest = {
+    /**
+     * days to get statistics for.
+     * only year-month-day are used.
+     */
+    dayFrom: Date;
+    dayTo: Date;
+    applicationIds: number[];
+};
+export type GetAudienceStatByApplicationsResponse_Statistics = {
+    applicationId: number;
+    platform: number;
+    installs: number;
+    subscriptions: number;
+};
+export type GetAudienceStatByApplicationsResponse = {
+    /** total metrics by apps and platforms */
+    statistics: GetAudienceStatByApplicationsResponse_Statistics[];
+};

package/pushwoosh_statistics_statistics_v2_overview.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};