@pushwoosh/rpc-v2-http-api-data 0.1.394

package/pushwoosh_channels_messagingApi_v2.d.ts

@@ -0,0 +1,365 @@
+import { Duration } from './commonTypes';
+import { FilterExpression as pushwoosh_objects_filters_v1_FilterExpression } from './pushwoosh_objects_filters_v1';
+export type ErrorReason = 'ERROR_REASON_UNSPECIFIED' | 'EMPTY_REQUEST' | 'EMPTY_SCHEDULE' | 'EMPTY_SEND_DATE' | 'EMPTY_PAYLOAD' | 'SEND_DATE_TOO_FAR_IN_FUTURE' | 'EMPTY_TARGET' | 'SEGMENT_NOT_FOUND' | 'SEGLANG_ERROR' | 'EMPTY_APPLICATION' | 'APPLICATION_NOT_FOUND' | 'INVALID_PAST_TIMEZONES_BEHAVIOUR' | 'EMPTY_HWIDS_LIST' | 'TOO_MANY_HWIDS' | 'EMPTY_USERS_LIST' | 'TOO_MANY_USERS' | 'EMPTY_PUSH_TOKENS_LIST' | 'TOO_MANY_PUSH_TOKENS' | 'TEST_DEVICES_FALSE' | 'TEST_DEVICES_FOLLOW_USER_TIMEZONE' | 'APPLICATION_IS_REQUIRED_FOR_TRANSACTIONAL' | 'NO_RECIPIENTS_FOUND' | 'PAST_TIMEZONES_BEHAVIOUR_NOT_IMPLEMENTED' | 'NO_ACTIVE_TEST_DEVICES' | 'SILENT_UNSUPPORTED_PLATFORM' | 'INVALID_IOS_BADGE' | 'INVALID_ANDROID_BADGE' | 'INVALID_HUAWEI_ANDROID_BADGE' | 'INVALID_BAIDU_ANDROID_BADGE' | 'INVALID_LIVE_ACTIVITY' | 'INVALID_IOS_TIME_TO_LIVE' | 'INVALID_ANDROID_TIME_TO_LIVE' | 'INVALID_HUAWEI_ANDROID_TIME_TO_LIVE' | 'INVALID_BAIDU_ANDROID_TIME_TO_LIVE' | 'INVALID_IOS_INTERRUPTION_LEVEL' | 'INVALID_MAC_OS_BADGE' | 'INVALID_SAFARI_BADGE' | 'INVALID_MAC_OS_TIME_TO_LIVE' | 'INVALID_ANDROID_LED' | 'INVALID_HUAWEI_ANDROID_LED' | 'INVALID_BAIDU_ANDROID_LED' | 'INVALID_ANDROID_ICON_BACKGROUND_COLOR' | 'INVALID_HUAWEI_ANDROID_ICON_BACKGROUND_COLOR' | 'INVALID_BAIDU_ANDROID_ICON_BACKGROUND_COLOR' | 'INVALID_ANDROID_PRIORITY' | 'INVALID_HUAWEI_ANDROID_PRIORITY' | 'INVALID_BAIDU_ANDROID_PRIORITY' | 'INVALID_CHROME_TIME_TO_LIVE' | 'INVALID_CHROME_DURATION' | 'INVALID_SAFARI_TIME_TO_LIVE' | 'INVALID_AMAZON_TIME_TO_LIVE' | 'INVALID_XIAOMI_TIME_TO_LIVE' | 'INVALID_IE_BADGE' | 'PRESET_NOT_FOUND' | 'FREQUENCY_CAPPING_NOT_ALLOWED' | 'INVALID_FREQUENCY_CAPPING_DAYS' | 'INVALID_FREQUENCY_CAPPING_COUNT' | 'CAMPAIGN_NOT_FOUND' | 'INVALID_PLATFORMS' | 'DEEP_LINK_NOT_FOUND' | 'RICH_MEDIA_NOT_FOUND' | 'EMPTY_URL' | 'INVALID_WINDOWS_TIME_TO_LIVE' | 'INVALID_WINDOWS_CONTENT_BASE64' | 'INVALID_WINDOWS_CONTENT_XML' | 'INVALID_WINDOWS_TEMPLATE_NAME' | 'INVALID_WINDOWS_CONTENT_BODY_EMPTY';
+export interface MessagingService {
+    Notify(request: NotifyRequest): Promise<NotifyResponse>;
+    NotifyBulk(request: NotifyBulkRequest): Promise<NotifyBulkResponse>;
+    NotifyStream(request: NotifyStreamRequest): Promise<NotifyStreamResponse>;
+}
+export type NotifyRequest_kind_segment = {
+    segment: NotifySegment;
+};
+export type NotifyRequest_kind_transactional = {
+    transactional: NotifyTransactional;
+};
+export type NotifyRequest_kind = NotifyRequest_kind_segment | NotifyRequest_kind_transactional;
+export type NotifyRequest = {} & NotifyRequest_kind;
+export type NotifyResponse = {
+    result: NotifyResult;
+};
+export type NotifyBulkRequest = {
+    requests?: NotifyRequest[];
+};
+export type NotifyBulkResponse = {
+    result: NotifyResult[];
+};
+export type NotifyStreamRequest = {
+    request?: NotifyRequest;
+};
+export type NotifyStreamResponse = {};
+export type NotifyResult = {
+    messageCode: string;
+    unknownIdentifiers: string[];
+};
+export type Platform = 'UNKNOWN' | 'IOS' | 'ANDROID' | 'OSX' | 'WINDOWS' | 'AMAZON' | 'SAFARI' | 'CHROME' | 'FIREFOX' | 'IE' | 'EMAIL' | 'BAIDU_ANDROID' | 'HUAWEI_ANDROID' | 'SMS' | 'XIAOMI';
+export type NotifySegment_target_code = {
+    code: string;
+};
+export type NotifySegment_target_expression = {
+    expression: string;
+};
+export type NotifySegment_target_filterExpression = {
+    filterExpression: pushwoosh_objects_filters_v1_FilterExpression;
+};
+export type NotifySegment_target = NotifySegment_target_code | NotifySegment_target_expression | NotifySegment_target_filterExpression;
+export type NotifySegment = {
+    schedule: Schedule;
+    application: string;
+    platforms: Platform[];
+    payload: Payload;
+    frequencyCapping: FrequencyCapping;
+    campaign: string;
+} & NotifySegment_target;
+export type NotifyTransactional_HwidsList = {
+    list: string[];
+};
+export type NotifyTransactional_UsersList = {
+    list: string[];
+};
+export type NotifyTransactional_PushTokensList = {
+    list: string[];
+};
+export type NotifyTransactional_target_testDevices = {
+    testDevices: boolean;
+};
+export type NotifyTransactional_target_hwids = {
+    hwids: NotifyTransactional_HwidsList;
+};
+export type NotifyTransactional_target_users = {
+    users: NotifyTransactional_UsersList;
+};
+export type NotifyTransactional_target_pushTokens = {
+    pushTokens: NotifyTransactional_PushTokensList;
+};
+export type NotifyTransactional_target = NotifyTransactional_target_testDevices | NotifyTransactional_target_hwids | NotifyTransactional_target_users | NotifyTransactional_target_pushTokens;
+export type NotifyTransactional = {
+    schedule: Schedule;
+    application: string;
+    platforms: Platform[];
+    payload: Payload;
+    returnUnknownIdentifiers: boolean;
+    frequencyCapping: FrequencyCapping;
+    campaign: string;
+} & NotifyTransactional_target;
+export type Schedule_PastTimezonesBehaviour = 'PAST_TIMEZONES_BEHAVIOUR_DEFAULT' | 'PAST_TIMEZONES_BEHAVIOUR_SEND_IMMEDIATELY' | 'PAST_TIMEZONES_BEHAVIOUR_DO_NOT_SEND' | 'PAST_TIMEZONES_BEHAVIOUR_NEXT_DAY';
+export type Schedule_sendDate_at = {
+    at: Date;
+};
+export type Schedule_sendDate_after = {
+    after: Duration;
+};
+export type Schedule_sendDate = Schedule_sendDate_at | Schedule_sendDate_after;
+export type Schedule = {
+    followUserTimezone: boolean;
+    pastTimezonesBehaviour: Schedule_PastTimezonesBehaviour;
+} & Schedule_sendDate;
+export type FrequencyCapping = {
+    days: number;
+    count: number;
+    exclude: boolean;
+    avoid: boolean;
+};
+export type DeliveryPriority = 'NORMAL' | 'HIGH';
+export type NotificationPriority = 'PRIORITY_UNSPECIFIED' | 'PRIORITY_MIN' | 'PRIORITY_LOW' | 'PRIORITY_DEFAULT' | 'PRIORITY_HIGH' | 'PRIORITY_MAX';
+export type LiveActivity = {
+    event: string;
+    dismissalDate: number;
+    contentState: object;
+};
+export type Link_Shortener = 'NONE' | 'BITLY';
+export type Link = {
+    url: string;
+    shortener: Link_Shortener;
+};
+export type RichMedia_kind_code = {
+    code: string;
+};
+export type RichMedia_kind_url = {
+    url: string;
+};
+export type RichMedia_kind = RichMedia_kind_code | RichMedia_kind_url;
+export type RichMedia = {} & RichMedia_kind;
+export type DeepLink = {
+    code: string;
+    params: Record<string, string>;
+};
+export type OpenAction_kind_richMedia = {
+    richMedia: RichMedia;
+};
+export type OpenAction_kind_deepLink = {
+    deepLink: DeepLink;
+};
+export type OpenAction_kind_link = {
+    link: Link;
+};
+export type OpenAction_kind = OpenAction_kind_richMedia | OpenAction_kind_deepLink | OpenAction_kind_link;
+export type OpenAction = {} & OpenAction_kind;
+export type Inbox = {
+    imageUrl: string;
+    expirationDate: Date;
+};
+export type Content_PlatformPropertiesIos = {
+    title: string;
+    subtitle: string;
+    body: string;
+    timeToLive: Duration;
+    isCritical: boolean;
+    attachment: string;
+    sound: string;
+    threadId: string;
+    badges: string;
+    trimContent: boolean;
+    categoryId: string;
+    soundEnabled: boolean;
+    interruptionLevel: string;
+    rootParams: object;
+    liveActivity: LiveActivity;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesAndroid = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    banner: string;
+    deliveryPriority: DeliveryPriority;
+    vibration: boolean;
+    badges: string;
+    sound: string;
+    ledColor: string;
+    soundEnabled: boolean;
+    iconBackgroundColor: string;
+    showOnLockscreen: boolean;
+    rootParams: object;
+    customIcon: string;
+    priority: NotificationPriority;
+    groupId: string;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesChrome = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    image: string;
+    rootParams: object;
+    duration: Duration;
+    buttonText1: string;
+    buttonUrl1: string;
+    buttonText2: string;
+    buttonUrl2: string;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesFirefox = {
+    title: string;
+    body: string;
+    icon: string;
+    rootParams: object;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesSafari = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    action: string;
+    urlArguments: string[];
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesMacOS = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    action: string;
+    sound: string;
+    soundEnabled: boolean;
+    badges: string;
+    rootParams: object;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesAmazon = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    banner: string;
+    sound: string;
+    soundEnabled: boolean;
+    rootParams: object;
+    icon: string;
+    customIcon: string;
+    priority: NotificationPriority;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesBaiduAndroid = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    banner: string;
+    deliveryPriority: DeliveryPriority;
+    vibration: boolean;
+    badges: string;
+    sound: string;
+    ledColor: string;
+    soundEnabled: boolean;
+    iconBackgroundColor: string;
+    showOnLockscreen: boolean;
+    rootParams: object;
+    customIcon: string;
+    priority: NotificationPriority;
+    groupId: string;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesHuaweiAndroid = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    banner: string;
+    deliveryPriority: DeliveryPriority;
+    vibration: boolean;
+    badges: string;
+    sound: string;
+    ledColor: string;
+    soundEnabled: boolean;
+    iconBackgroundColor: string;
+    showOnLockscreen: boolean;
+    rootParams: object;
+    customIcon: string;
+    priority: NotificationPriority;
+    groupId: string;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesXiaomi = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    vibration: boolean;
+    sound: string;
+    rootParams: object;
+    groupId: string;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesIE = {
+    title: string;
+    iconBadge: string;
+    openAction: OpenAction;
+    inbox: Inbox;
+    customData: object;
+};
+export type Content_PlatformPropertiesWindows_Raw = {
+    content: string;
+};
+export type Content_PlatformPropertiesWindows_Template = {
+    title: string;
+    subtitle: string;
+    body: string;
+    imageUrl: string;
+};
+export type Content_PlatformPropertiesWindows_Type = 'TILE' | 'TOAST' | 'BADGE';
+export type Content_PlatformPropertiesWindows_content_raw = {
+    raw: Content_PlatformPropertiesWindows_Raw;
+};
+export type Content_PlatformPropertiesWindows_content_template = {
+    template: Content_PlatformPropertiesWindows_Template;
+};
+export type Content_PlatformPropertiesWindows_content = Content_PlatformPropertiesWindows_content_raw | Content_PlatformPropertiesWindows_content_template;
+export type Content_PlatformPropertiesWindows = {
+    type: Content_PlatformPropertiesWindows_Type;
+    tag: string;
+    cache: boolean;
+    timeToLive: Duration;
+    openAction: OpenAction;
+    customData: object;
+} & Content_PlatformPropertiesWindows_content;
+export type Content_PlatformPropertiesEmail = {};
+export type Content_PlatformPropertiesSMS = {};
+export type Content = {
+    ios: Content_PlatformPropertiesIos;
+    android: Content_PlatformPropertiesAndroid;
+    macOs: Content_PlatformPropertiesMacOS;
+    amazon: Content_PlatformPropertiesAmazon;
+    safari: Content_PlatformPropertiesSafari;
+    chrome: Content_PlatformPropertiesChrome;
+    firefox: Content_PlatformPropertiesFirefox;
+    baiduAndroid: Content_PlatformPropertiesBaiduAndroid;
+    huaweiAndroid: Content_PlatformPropertiesHuaweiAndroid;
+    xiaomi: Content_PlatformPropertiesXiaomi;
+    ie: Content_PlatformPropertiesIE;
+    windows: Content_PlatformPropertiesWindows;
+};
+export type LocalizedContent = {
+    localizedContent: Record<string, Content>;
+};
+export type Payload_kind_content = {
+    content: LocalizedContent;
+};
+export type Payload_kind_silent = {
+    silent: boolean;
+};
+export type Payload_kind = Payload_kind_content | Payload_kind_silent;
+export type Payload = {
+    preset: string;
+    metaData: object;
+    dynamicContentPlaceholders: Record<string, string>;
+} & Payload_kind;

package/pushwoosh_channels_messagingApi_v2.js

@@ -0,0 +1,2 @@
+/* eslint-disable */
+export {};