@pushwoosh/rpc-v2-http-api-data 0.2.518 → 0.2.519

package/data.js

@@ -38167,6 +38167,136 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.silent_hours.SilentHoursService": {
+        "type": "S",
+        "key": "silentHours",
+        "methods": {
+            "Get": {
+                "request": "pushwoosh.rpc_v2.silent_hours.GetSilentHoursRequest",
+                "response": "pushwoosh.rpc_v2.silent_hours.SilentHours",
+                "method": "get",
+                "path": "/api/silent_hours/{application}"
+            },
+            "Update": {
+                "request": "pushwoosh.rpc_v2.silent_hours.UpdateSilentHoursRequest",
+                "response": "pushwoosh.rpc_v2.silent_hours.UpdateSilentHoursResponse",
+                "method": "put",
+                "path": "/api/silent_hours/{application}"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.silent_hours.SilentHoursTimeOfDay": {
+        "type": "I",
+        "fields": {
+            "hour": {
+                "type": "number"
+            },
+            "minute": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "from": {
+                "type": "pushwoosh.rpc_v2.silent_hours.SilentHoursTimeOfDay"
+            },
+            "to": {
+                "type": "pushwoosh.rpc_v2.silent_hours.SilentHoursTimeOfDay"
+            },
+            "silentDays": {
+                "type": "boolean",
+                "array": true
+            },
+            "behavior": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.silent_hours.SilentHours": {
+        "type": "I",
+        "fields": {
+            "timezone": {
+                "type": "string"
+            },
+            "push": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "inApp": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "email": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "sms": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "whatsApp": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "line": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "kakao": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "telegram": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.silent_hours.GetSilentHoursRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.silent_hours.UpdateSilentHoursRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "timezone": {
+                "type": "string",
+                "optional": true
+            },
+            "push": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "inApp": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "email": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "sms": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "whatsApp": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "line": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "kakao": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            },
+            "telegram": {
+                "type": "pushwoosh.rpc_v2.silent_hours.ChannelSilentHours"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.silent_hours.UpdateSilentHoursResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.rpc_v2.sms_presets.smsPresetsService": {
         "type": "S",
         "key": "smsPresets",

package/index.d.ts

@@ -69,6 +69,7 @@ import { SdkIntegratorService as pushwoosh_rpc_v2_sdk_integrator_SdkIntegratorSe
 import { SegmentStatisticsService as pushwoosh_rpc_v2_segment_statistics_SegmentStatisticsService } from './segment_statistics';
 import { SegmentsService as pushwoosh_rpc_segments_v3_SegmentsService } from './pushwoosh_rpc_segments_v3';
 import { SendRateService as pushwoosh_rpc_v2_send_rate_SendRateService } from './send_rate';
+import { SilentHoursService as pushwoosh_rpc_v2_silent_hours_SilentHoursService } from './silent_hours';
 import { smsPresetsService as pushwoosh_rpc_v2_sms_presets_smsPresetsService } from './sms_presets';
 import { SmsProviderTemplatesService as pushwoosh_rpc_v2_sms_provider_templates_SmsProviderTemplatesService } from './sms_provider_templates';
 import { StatisticsDashboardsService as pushwoosh_rpc_v2_statistics_dashboards_StatisticsDashboardsService } from './statistics_dashboards';
@@ -154,6 +155,7 @@ export type API = {
     segmentStatistics: pushwoosh_rpc_v2_segment_statistics_SegmentStatisticsService;
     segments: pushwoosh_rpc_segments_v3_SegmentsService;
     sendRate: pushwoosh_rpc_v2_send_rate_SendRateService;
+    silentHours: pushwoosh_rpc_v2_silent_hours_SilentHoursService;
     smsPresets: pushwoosh_rpc_v2_sms_presets_smsPresetsService;
     smsProviderTemplates: pushwoosh_rpc_v2_sms_provider_templates_SmsProviderTemplatesService;
     statisticsDashboards: pushwoosh_rpc_v2_statistics_dashboards_StatisticsDashboardsService;

package/package.json

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

package/silent_hours.d.ts

@@ -0,0 +1,66 @@
+import { RpcMethod } from './commonTypes';
+export type SilentHoursService_Get = RpcMethod<GetSilentHoursRequest, SilentHours>;
+export type SilentHoursService_Update = RpcMethod<UpdateSilentHoursRequest, UpdateSilentHoursResponse>;
+export interface SilentHoursService {
+    /** Returns the application-level silent hours of an application code XXXXX-XXXXX, per channel (push, in-app, email, SMS, WhatsApp, LINE, Kakao, Telegram). Silent hours hold or drop marketing messages sent outside journeys during the configured window in the recipient's timezone. An application without settings returns every channel disabled. */
+    Get: SilentHoursService_Get;
+    /** Sets the application-level silent hours of an application code XXXXX-XXXXX, creating the settings if none exist. Only the channels present in the request are overwritten; the timezone is overwritten when supplied. */
+    Update: SilentHoursService_Update;
+}
+export type SilentHoursTimeOfDay = {
+    /** Hour of the day, 0-23. */
+    hour: number;
+    /** Minute of the hour, 0-59. */
+    minute: number;
+};
+export type ChannelSilentHours = {
+    /** Whether silent hours apply to the channel. */
+    enabled: boolean;
+    /** Start of the silent window in the recipient's local time. */
+    from: SilentHoursTimeOfDay;
+    /** End of the silent window in the recipient's local time; a window with from later than to spans midnight. */
+    to: SilentHoursTimeOfDay;
+    /** Seven flags indexed Sunday=0 ... Saturday=6; a set day is silent for the whole day. Empty means no whole silent days. */
+    silentDays: boolean[];
+    /** What happens to a message that falls into the window: "" (wait and send when the window ends, default) or "drop". */
+    behavior: string;
+};
+export type SilentHours = {
+    /** IANA timezone for recipients without an SDK device timezone (email, SMS and messenger-only users); empty means UTC. */
+    timezone: string;
+    push: ChannelSilentHours;
+    inApp: ChannelSilentHours;
+    email: ChannelSilentHours;
+    sms: ChannelSilentHours;
+    whatsApp: ChannelSilentHours;
+    line: ChannelSilentHours;
+    kakao: ChannelSilentHours;
+    telegram: ChannelSilentHours;
+};
+export type GetSilentHoursRequest = {
+    /** Application code XXXXX-XXXXX whose silent hours are read. */
+    application?: string;
+};
+export type UpdateSilentHoursRequest = {
+    /** Application code XXXXX-XXXXX whose silent hours are set. */
+    application?: string;
+    /** IANA timezone for recipients without an SDK device timezone; omit to leave it unchanged. */
+    timezone?: string;
+    /** Push channel; omit to leave it unchanged. */
+    push?: ChannelSilentHours;
+    /** In-app channel; omit to leave it unchanged. */
+    inApp?: ChannelSilentHours;
+    /** Email channel; omit to leave it unchanged. */
+    email?: ChannelSilentHours;
+    /** SMS channel; omit to leave it unchanged. */
+    sms?: ChannelSilentHours;
+    /** WhatsApp channel; omit to leave it unchanged. */
+    whatsApp?: ChannelSilentHours;
+    /** LINE channel; omit to leave it unchanged. */
+    line?: ChannelSilentHours;
+    /** Kakao channel; omit to leave it unchanged. */
+    kakao?: ChannelSilentHours;
+    /** Telegram channel; omit to leave it unchanged. */
+    telegram?: ChannelSilentHours;
+};
+export type UpdateSilentHoursResponse = {};

package/silent_hours.js

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