@pushwoosh/rpc-v2-http-api-data 0.2.469 → 0.2.471

package/applications_configurations.d.ts

@@ -422,6 +422,10 @@ export type SendTestSmsRequest = {
     code?: string;
     phone?: string;
     text?: string;
+    /** Twilio Content template sent over RCS instead of text; text may then be empty. */
+    rcsContentSid?: string;
+    /** JSON object of the template variables. */
+    rcsContentVariables?: string;
 };
 export type SendTestSmsResponse = {
     accepted: boolean;

package/data.js

@@ -7135,6 +7135,12 @@ export const data = {
             },
             "text": {
                 "type": "string"
+            },
+            "rcsContentSid": {
+                "type": "string"
+            },
+            "rcsContentVariables": {
+                "type": "string"
             }
         }
     },
@@ -36838,6 +36844,12 @@ export const data = {
                 "method": "put",
                 "path": "/api/sms_presets/{code}"
             },
+            "ListRcsTemplates": {
+                "request": "pushwoosh.rpc_v2.sms_presets.ListSmsRcsTemplatesRequest",
+                "response": "pushwoosh.rpc_v2.sms_presets.ListSmsRcsTemplatesResponse",
+                "method": "get",
+                "path": "/api/sms_presets:rcs_templates"
+            },
             "Delete": {
                 "request": "pushwoosh.rpc_v2.sms_presets.DeleteSmsPresetRequest",
                 "response": "pushwoosh.rpc_v2.sms_presets.DeleteSmsPresetResponse",
@@ -36903,6 +36915,32 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.sms_presets.SmsPresetRcs": {
+        "type": "I",
+        "fields": {
+            "contentSid": {
+                "type": "string"
+            },
+            "contentVariables": {
+                "type": "string"
+            },
+            "quickReplies": {
+                "type": "pushwoosh.rpc_v2.sms_presets.SmsRcsQuickReply",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_presets.SmsRcsQuickReply": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.sms_presets.SmsProductsSource.Rule": {
         "type": "I",
         "fields": {
@@ -37021,6 +37059,10 @@ export const data = {
             },
             "productsSource": {
                 "type": "pushwoosh.rpc_v2.sms_presets.SmsProductsSource"
+            },
+            "localizedRcs": {
+                "type": "pushwoosh.rpc_v2.sms_presets.SmsPresetRcs",
+                "mapKeyType": "string"
             }
         }
     },
@@ -37081,6 +37123,10 @@ export const data = {
             },
             "productsSource": {
                 "type": "pushwoosh.rpc_v2.sms_presets.SmsProductsSource"
+            },
+            "localizedRcs": {
+                "type": "pushwoosh.rpc_v2.sms_presets.SmsPresetRcs",
+                "mapKeyType": "string"
             }
         }
     },
@@ -37118,6 +37164,10 @@ export const data = {
             },
             "resetCategories": {
                 "type": "boolean"
+            },
+            "localizedRcs": {
+                "type": "pushwoosh.rpc_v2.sms_presets.SmsPresetRcs",
+                "mapKeyType": "string"
             }
         }
     },
@@ -37141,6 +37191,52 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.sms_presets.ListSmsRcsTemplatesRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_presets.SmsRcsTemplate": {
+        "type": "I",
+        "fields": {
+            "contentSid": {
+                "type": "string"
+            },
+            "friendlyName": {
+                "type": "string"
+            },
+            "language": {
+                "type": "string"
+            },
+            "types": {
+                "type": "string",
+                "array": true
+            },
+            "variables": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "hasSmsFallback": {
+                "type": "boolean"
+            },
+            "quickReplies": {
+                "type": "pushwoosh.rpc_v2.sms_presets.SmsRcsQuickReply",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_presets.ListSmsRcsTemplatesResponse": {
+        "type": "I",
+        "fields": {
+            "templates": {
+                "type": "pushwoosh.rpc_v2.sms_presets.SmsRcsTemplate",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplatesService": {
         "type": "S",
         "key": "smsProviderTemplates",

package/package.json

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

package/sms_presets.d.ts

@@ -3,6 +3,7 @@ export type smsPresetsService_List = RpcMethod<ListSmsPresetsRequest, ListSmsPre
 export type smsPresetsService_Get = RpcMethod<GetSmsPresetRequest, GetSmsPresetResponse>;
 export type smsPresetsService_Create = RpcMethod<CreateSmsPresetRequest, CreateSmsPresetResponse>;
 export type smsPresetsService_Update = RpcMethod<UpdateSmsPresetRequest, UpdateSmsPresetResponse>;
+export type smsPresetsService_ListRcsTemplates = RpcMethod<ListSmsRcsTemplatesRequest, ListSmsRcsTemplatesResponse>;
 export type smsPresetsService_Delete = RpcMethod<DeleteSmsPresetRequest, DeleteSmsPresetResponse>;
 export interface smsPresetsService {
     /** Lists SMS presets (reusable SMS message templates) for an application, with paging, ordering and optional name/category filters. Use to browse presets or find an SMS preset code before fetching, updating or deleting one. */
@@ -13,6 +14,8 @@ export interface smsPresetsService {
     Create: smsPresetsService_Create;
     /** Updates an existing SMS preset identified by its preset code, overwriting name, categories, per-locale content and the per-locale MMS part. Use to edit a template found via list_sms_presets. */
     Update: smsPresetsService_Update;
+    /** Lists the application's Twilio Content templates usable for RCS (card, carousel, quick reply, call to action, media), read with the application's own Twilio credentials. Use to pick the content_sid of a preset's localized_rcs; has_sms_fallback tells whether the template carries the SMS text Twilio falls back to. */
+    ListRcsTemplates: smsPresetsService_ListRcsTemplates;
     /** Permanently deletes an SMS preset by its preset code. Fails if the preset is used by a running or paused journey; deletion cannot be undone. */
     Delete: smsPresetsService_Delete;
 }
@@ -41,6 +44,25 @@ export type SmsPresetMms = {
     /** Index of the attachment the body is shown after. */
     messageAt: number;
 };
+/**
+ * RCS part of one locale: a Twilio Content template sent over RCS instead of the body; Twilio
+ * falls back to the template's own SMS text. Locales absent here are sent as plain SMS.
+ */
+export type SmsPresetRcs = {
+    /** Twilio Content template SID, HX followed by 32 hex characters. */
+    contentSid: string;
+    /** JSON object of template variables, e.g. {"1": "{FirstName|regular|}"}; values may hold tags and Liquid. */
+    contentVariables: string;
+    /** Read only: the template's reply buttons as of the last save; a journey branches on their ids. */
+    quickReplies: SmsRcsQuickReply[];
+};
+/** One RCS reply button of a Twilio Content template. */
+export type SmsRcsQuickReply = {
+    /** Button id from the template; Twilio returns it as ButtonPayload when the button is tapped. */
+    id: string;
+    /** Text shown on the button. */
+    title: string;
+};
 export type SmsProductsSource_Rule = {
     /** Catalog category to pick from; empty = any category. */
     category: string;
@@ -115,6 +137,8 @@ export type SmsPreset = {
     localizedMms: Record<string, SmsPresetMms>;
     /** Set when localized_content was assembled from a catalog rule. */
     productsSource: SmsProductsSource;
+    /** rcs map {"en": {...}...}; locales absent here are sent as plain SMS */
+    localizedRcs: Record<string, SmsPresetRcs>;
 };
 export type ListSmsPresetsResponse = {
     presets: SmsPreset[];
@@ -143,6 +167,8 @@ export type CreateSmsPresetRequest = {
      * for a hand-written body.
      */
     productsSource?: SmsProductsSource;
+    /** rcs map {"en": {...}...}; omit for a preset without RCS */
+    localizedRcs?: Record<string, SmsPresetRcs>;
 };
 export type CreateSmsPresetResponse = {
     preset: SmsPreset;
@@ -164,6 +190,8 @@ export type UpdateSmsPresetRequest = {
     productsSource?: SmsProductsSource;
     /** Drops every category of the preset; an empty categories list cannot say this, it reads as "leave them alone". */
     resetCategories?: boolean;
+    /** rcs map {"en": {...}...}; omitted leaves the stored RCS untouched */
+    localizedRcs?: Record<string, SmsPresetRcs>;
 };
 export type UpdateSmsPresetResponse = {
     preset: SmsPreset;
@@ -173,3 +201,25 @@ export type DeleteSmsPresetRequest = {
     code?: string;
 };
 export type DeleteSmsPresetResponse = {};
+export type ListSmsRcsTemplatesRequest = {
+    /** Application code (XXXXX-XXXXX) whose Twilio account holds the templates. */
+    application?: string;
+};
+export type SmsRcsTemplate = {
+    /** Twilio Content template SID (HX...), the value for SmsPresetRcs.content_sid. */
+    contentSid: string;
+    friendlyName: string;
+    /** Two-letter language code of the template. */
+    language: string;
+    /** Twilio content types the template defines, e.g. twilio/card, twilio/text. */
+    types: string[];
+    /** Template variables with their default values. */
+    variables: Record<string, string>;
+    /** True when the template has a twilio/text variant, the SMS a phone without RCS receives. */
+    hasSmsFallback: boolean;
+    /** Reply buttons of the template (quick replies of quick-reply, card and carousel types). */
+    quickReplies: SmsRcsQuickReply[];
+};
+export type ListSmsRcsTemplatesResponse = {
+    templates: SmsRcsTemplate[];
+};