@pushwoosh/rpc-v2-http-api-data 0.2.178 → 0.2.180

package/data.js

@@ -30182,6 +30182,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.whatsapp.FetchCatalogResponse",
                 "method": "get",
                 "path": "/api/whatsapp/catalog"
+            },
+            "GetWelcomeMessage": {
+                "request": "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageRequest",
+                "response": "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageResponse",
+                "method": "get",
+                "path": "/api/whatsapp/welcome"
+            },
+            "UpdateWelcomeMessage": {
+                "request": "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageRequest",
+                "response": "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageResponse",
+                "method": "put",
+                "path": "/api/whatsapp/welcome"
             }
         }
     },
@@ -30299,6 +30311,71 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.whatsapp.WelcomeMessage": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "localizedContent": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "localizedAttachment": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "updated": {
+                "type": "Date"
+            },
+            "campaignCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.whatsapp.GetWelcomeMessageResponse": {
+        "type": "I",
+        "fields": {
+            "welcomeMessage": {
+                "type": "pushwoosh.rpc_v2.whatsapp.WelcomeMessage"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "enabled": {
+                "type": "boolean"
+            },
+            "localizedContent": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "localizedAttachment": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.whatsapp.UpdateWelcomeMessageResponse": {
+        "type": "I",
+        "fields": {
+            "welcomeMessage": {
+                "type": "pushwoosh.rpc_v2.whatsapp.WelcomeMessage"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.whatsapp_presets.WhatsAppPresetsService": {
         "type": "S",
         "key": "whatsAppPresets",

package/package.json

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

package/whatsapp.d.ts

@@ -3,6 +3,8 @@ export type WhatsAppService_RegisterWABA = RpcMethod<RegisterWABARequest, Regist
 export type WhatsAppService_RegisterWABATwilio = RpcMethod<RegisterWABATwilioRequest, RegisterWABATwilioResponse>;
 export type WhatsAppService_AuthResponseCode = RpcMethod<AuthResponseCodeRequest, AuthResponseCodeResponse>;
 export type WhatsAppService_FetchCatalog = RpcMethod<FetchCatalogRequest, FetchCatalogResponse>;
+export type WhatsAppService_GetWelcomeMessage = RpcMethod<GetWelcomeMessageRequest, GetWelcomeMessageResponse>;
+export type WhatsAppService_UpdateWelcomeMessage = RpcMethod<UpdateWelcomeMessageRequest, UpdateWelcomeMessageResponse>;
 export interface WhatsAppService {
     /** Connects a WhatsApp Business Account to an application code via Meta Cloud API, storing the WABA and phone-number IDs, subscribing the number to Pushwoosh webhooks and registering it with Meta. Use for direct Meta onboarding; use connect_whatsapp_account_twilio for Twilio-routed senders. */
     RegisterWABA: WhatsAppService_RegisterWABA;
@@ -12,6 +14,10 @@ export interface WhatsAppService {
     AuthResponseCode: WhatsAppService_AuthResponseCode;
     /** Returns the WhatsApp Business catalog and its products for an application code by querying Meta. Use to list products available for WhatsApp product messages; a WABA has at most one catalog. */
     FetchCatalog: WhatsAppService_FetchCatalog;
+    /** Returns the WhatsApp welcome message of an application: the text sent in reply to the first message of a new conversation, its localizations, attachment links and whether it is switched on. */
+    GetWelcomeMessage: WhatsAppService_GetWelcomeMessage;
+    /** Creates or updates the WhatsApp welcome message of an application. Sending it enables reporting: every greeting is reported under a service campaign created on the first save. */
+    UpdateWelcomeMessage: WhatsAppService_UpdateWelcomeMessage;
 }
 export type RegisterWABARequest = {
     /** application code */
@@ -62,3 +68,31 @@ export type Product = {
     price: string;
     brand: string;
 };
+export type WelcomeMessage = {
+    enabled: boolean;
+    /** text map {"default": "Hi!", "de": "Hallo!"}; the locale a device gets is picked by its Language tag */
+    localizedContent: Record<string, string>;
+    /** attachment link map {"default": "https://...jpg"}; the text of the same locale is sent as the media caption */
+    localizedAttachment: Record<string, string>;
+    updated: Date;
+    /** Campaign every greeting is reported under; the Message statistics screen takes it to show them together. */
+    campaignCode: string;
+};
+export type GetWelcomeMessageRequest = {
+    /** application code */
+    application?: string;
+};
+export type GetWelcomeMessageResponse = {
+    /** absent when the application has no welcome message yet */
+    welcomeMessage: WelcomeMessage;
+};
+export type UpdateWelcomeMessageRequest = {
+    /** application code */
+    application?: string;
+    enabled?: boolean;
+    localizedContent?: Record<string, string>;
+    localizedAttachment?: Record<string, string>;
+};
+export type UpdateWelcomeMessageResponse = {
+    welcomeMessage: WelcomeMessage;
+};