@pushwoosh/rpc-v2-http-api-data 0.2.470 → 0.2.472

package/chat_presets.d.ts

@@ -0,0 +1,128 @@
+import { RpcMethod } from './commonTypes';
+export type chatPresetsService_List = RpcMethod<ListChatPresetsRequest, ListChatPresetsResponse>;
+export type chatPresetsService_Get = RpcMethod<GetChatPresetRequest, GetChatPresetResponse>;
+export type chatPresetsService_Create = RpcMethod<CreateChatPresetRequest, CreateChatPresetResponse>;
+export type chatPresetsService_Update = RpcMethod<UpdateChatPresetRequest, UpdateChatPresetResponse>;
+export type chatPresetsService_Delete = RpcMethod<DeleteChatPresetRequest, DeleteChatPresetResponse>;
+export type chatPresetsService_Clone = RpcMethod<CloneChatPresetRequest, CloneChatPresetResponse>;
+export type chatPresetsService_Validate = RpcMethod<ValidateChatPresetRequest, ValidateChatPresetResponse>;
+export interface chatPresetsService {
+    /** Lists chat presets of an application: one rich message (cards, carousels, buttons, lists) shared by RCS, WhatsApp, Facebook Messenger and LINE, each with its per-channel compatibility. Use to browse presets or find a code before get, update, clone or delete. */
+    List: chatPresetsService_List;
+    /** Returns one chat preset by code with its localized content and the compatibility verdict for every chat channel. */
+    Get: chatPresetsService_Get;
+    /** Creates a chat preset from localized rich content, assigning a fresh code and button ids where they are missing. Each call makes a new preset; use update_chat_preset to change an existing one. */
+    Create: chatPresetsService_Create;
+    /** Overwrites the name, category and localized content of an existing chat preset and recomputes its channel compatibility. Button ids already set are kept as sent. */
+    Update: chatPresetsService_Update;
+    /** Permanently deletes a chat preset by code; the removal cannot be undone. */
+    Delete: chatPresetsService_Delete;
+    /** Copies a chat preset into a target application as a new preset with its own code. */
+    Clone: chatPresetsService_Clone;
+    /** Checks localized rich content against every chat channel without saving it and returns the per-channel compatibility the editor shows. */
+    Validate: chatPresetsService_Validate;
+}
+export type ChannelIssue = {
+    /** Field path inside the content, e.g. "cards[1].buttons[0].title". */
+    path: string;
+    /** Machine code, e.g. "too_long", "type_unsupported". */
+    code: string;
+    /** "error" blocks the channel, "fallback" sends the fallback text there, "warning" is informational. */
+    severity: string;
+    message: string;
+};
+export type ChannelCompat = {
+    /** "compatible", "partial" (some of it goes out as fallback text) or "incompatible". */
+    status: string;
+    /** Issues keyed by language prefix: "<lang>:<path>" in path when the preset has several languages. */
+    issues: ChannelIssue[];
+};
+export type ChatPreset = {
+    code: string;
+    name: string;
+    /** Application code (XXXXX-XXXXX) the preset belongs to. */
+    application: string;
+    /** WhatsApp template category: "marketing" or "utility". */
+    category: string;
+    /** Rich content per language, each value a JSON object of the channel-agnostic model (type, body, media, buttons, cards...). */
+    localizedContent: Record<string, string>;
+    /** Compatibility per channel: "rcs", "whatsapp", "fbmessenger", "line". */
+    compat: Record<string, ChannelCompat>;
+    created: Date;
+    updated: Date;
+};
+export type ListChatPresetsRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
+export type ListChatPresetsRequest_OrderDirection = 'ASC' | 'DESC';
+export type ListChatPresetsRequest = {
+    /** Application code (XXXXX-XXXXX) whose chat presets to list. */
+    application?: string;
+    orderBy?: ListChatPresetsRequest_OrderBy;
+    orderDirection?: ListChatPresetsRequest_OrderDirection;
+    page?: number;
+    perPage?: number;
+    /** Free-text substring matched against preset name OR preset code (case-insensitive). */
+    searchByName?: string;
+};
+export type ListChatPresetsResponse = {
+    presets: ChatPreset[];
+    page: number;
+    perPage: number;
+    total: number;
+};
+export type GetChatPresetRequest = {
+    /** Chat preset code to fetch. */
+    code?: string;
+};
+export type GetChatPresetResponse = {
+    preset: ChatPreset;
+};
+export type CreateChatPresetRequest = {
+    /** Application code (XXXXX-XXXXX) the new preset belongs to. */
+    application?: string;
+    name?: string;
+    /** WhatsApp template category: "marketing" or "utility"; empty means marketing. */
+    category?: string;
+    /** Rich content per language as JSON of the channel-agnostic model, e.g. {"default": "{\"type\":\"text\",\"body\":\"Hi\"}"}. */
+    localizedContent?: Record<string, string>;
+};
+export type CreateChatPresetResponse = {
+    preset: ChatPreset;
+};
+export type UpdateChatPresetRequest = {
+    /** Chat preset code to update. */
+    code?: string;
+    /** New name; empty keeps the current one. */
+    name?: string;
+    /** New WhatsApp category; empty keeps the current one. */
+    category?: string;
+    /** Replaces the whole localized content when set. */
+    localizedContent?: Record<string, string>;
+};
+export type UpdateChatPresetResponse = {
+    preset: ChatPreset;
+};
+export type DeleteChatPresetRequest = {
+    /** Chat preset code to delete. */
+    code?: string;
+};
+export type DeleteChatPresetResponse = {};
+export type CloneChatPresetRequest = {
+    /** Code of the source chat preset to copy. */
+    chatPresetCode?: string;
+    /** Application code (XXXXX-XXXXX) the copy is created in. */
+    applicationCode?: string;
+};
+export type CloneChatPresetResponse = {
+    chatPresetCode: string;
+};
+export type ValidateChatPresetRequest = {
+    /** Application code (XXXXX-XXXXX) the content is meant for. */
+    application?: string;
+    category?: string;
+    /** Rich content per language as JSON of the channel-agnostic model. */
+    localizedContent?: Record<string, string>;
+};
+export type ValidateChatPresetResponse = {
+    /** Compatibility per channel: "rcs", "whatsapp", "fbmessenger", "line". */
+    compat: Record<string, ChannelCompat>;
+};

package/chat_presets.js

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

package/data.js

@@ -11477,6 +11477,293 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.chat_presets.chatPresetsService": {
+        "type": "S",
+        "key": "chatPresets",
+        "methods": {
+            "List": {
+                "request": "pushwoosh.rpc_v2.chat_presets.ListChatPresetsRequest",
+                "response": "pushwoosh.rpc_v2.chat_presets.ListChatPresetsResponse",
+                "method": "get",
+                "path": "/api/chat_presets"
+            },
+            "Get": {
+                "request": "pushwoosh.rpc_v2.chat_presets.GetChatPresetRequest",
+                "response": "pushwoosh.rpc_v2.chat_presets.GetChatPresetResponse",
+                "method": "get",
+                "path": "/api/chat_presets/{code}"
+            },
+            "Create": {
+                "request": "pushwoosh.rpc_v2.chat_presets.CreateChatPresetRequest",
+                "response": "pushwoosh.rpc_v2.chat_presets.CreateChatPresetResponse",
+                "method": "post",
+                "path": "/api/chat_presets"
+            },
+            "Update": {
+                "request": "pushwoosh.rpc_v2.chat_presets.UpdateChatPresetRequest",
+                "response": "pushwoosh.rpc_v2.chat_presets.UpdateChatPresetResponse",
+                "method": "put",
+                "path": "/api/chat_presets/{code}"
+            },
+            "Delete": {
+                "request": "pushwoosh.rpc_v2.chat_presets.DeleteChatPresetRequest",
+                "response": "pushwoosh.rpc_v2.chat_presets.DeleteChatPresetResponse",
+                "method": "delete",
+                "path": "/api/chat_presets/{code}"
+            },
+            "Clone": {
+                "request": "pushwoosh.rpc_v2.chat_presets.CloneChatPresetRequest",
+                "response": "pushwoosh.rpc_v2.chat_presets.CloneChatPresetResponse",
+                "method": "post",
+                "path": "/api/chat_presets:clone"
+            },
+            "Validate": {
+                "request": "pushwoosh.rpc_v2.chat_presets.ValidateChatPresetRequest",
+                "response": "pushwoosh.rpc_v2.chat_presets.ValidateChatPresetResponse",
+                "method": "post",
+                "path": "/api/chat_presets:validate"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.ChannelIssue": {
+        "type": "I",
+        "fields": {
+            "path": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            },
+            "severity": {
+                "type": "string"
+            },
+            "message": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.ChannelCompat": {
+        "type": "I",
+        "fields": {
+            "status": {
+                "type": "string"
+            },
+            "issues": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ChannelIssue",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.ChatPreset": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "application": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            },
+            "localizedContent": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "compat": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ChannelCompat",
+                "mapKeyType": "string"
+            },
+            "created": {
+                "type": "Date"
+            },
+            "updated": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.ListChatPresetsRequest.OrderBy": {
+        "type": "E",
+        "values": [
+            "NAME",
+            "CREATED",
+            "UPDATED"
+        ]
+    },
+    "pushwoosh.rpc_v2.chat_presets.ListChatPresetsRequest.OrderDirection": {
+        "type": "E",
+        "values": [
+            "ASC",
+            "DESC"
+        ]
+    },
+    "pushwoosh.rpc_v2.chat_presets.ListChatPresetsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "orderBy": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ListChatPresetsRequest.OrderBy"
+            },
+            "orderDirection": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ListChatPresetsRequest.OrderDirection"
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "searchByName": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.ListChatPresetsResponse": {
+        "type": "I",
+        "fields": {
+            "presets": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ChatPreset",
+                "array": true
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.GetChatPresetRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.GetChatPresetResponse": {
+        "type": "I",
+        "fields": {
+            "preset": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ChatPreset"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.CreateChatPresetRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            },
+            "localizedContent": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.CreateChatPresetResponse": {
+        "type": "I",
+        "fields": {
+            "preset": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ChatPreset"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.UpdateChatPresetRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            },
+            "localizedContent": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.UpdateChatPresetResponse": {
+        "type": "I",
+        "fields": {
+            "preset": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ChatPreset"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.DeleteChatPresetRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.DeleteChatPresetResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.chat_presets.CloneChatPresetRequest": {
+        "type": "I",
+        "fields": {
+            "chatPresetCode": {
+                "type": "string"
+            },
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.CloneChatPresetResponse": {
+        "type": "I",
+        "fields": {
+            "chatPresetCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.ValidateChatPresetRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            },
+            "localizedContent": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.chat_presets.ValidateChatPresetResponse": {
+        "type": "I",
+        "fields": {
+            "compat": {
+                "type": "pushwoosh.rpc_v2.chat_presets.ChannelCompat",
+                "mapKeyType": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.cloud_pages.CloudPagesService": {
         "type": "S",
         "key": "cloudPages",
@@ -36923,6 +37210,21 @@ export const data = {
             },
             "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"
             }
         }
     },
@@ -37206,6 +37508,10 @@ export const data = {
             },
             "hasSmsFallback": {
                 "type": "boolean"
+            },
+            "quickReplies": {
+                "type": "pushwoosh.rpc_v2.sms_presets.SmsRcsQuickReply",
+                "array": true
             }
         }
     },

package/index.d.ts

@@ -23,6 +23,7 @@ import { CatalogService as pushwoosh_rpc_v2_catalog_CatalogService } from './cat
 import { CategoriesService as pushwoosh_rpc_v2_categories_CategoriesService } from './categories';
 import { MessagesInProgressService as pushwoosh_channels_messagingApi_v2_MessagesInProgressService } from './pushwoosh_channels_messagingApi_v2';
 import { MessagingService as pushwoosh_channels_messagingApi_v2_MessagingService } from './pushwoosh_channels_messagingApi_v2';
+import { chatPresetsService as pushwoosh_rpc_v2_chat_presets_chatPresetsService } from './chat_presets';
 import { CloudPagesService as pushwoosh_rpc_v2_cloud_pages_CloudPagesService } from './cloud_pages';
 import { CustomerJourneyService as pushwoosh_rpc_v2_customer_journey_CustomerJourneyService } from './customer_journey';
 import { DataErasureService as pushwoosh_rpc_v2_data_erasure_DataErasureService } from './data_erasure';
@@ -106,6 +107,7 @@ export type API = {
     categories: pushwoosh_rpc_v2_categories_CategoriesService;
     messagesInProgress: pushwoosh_channels_messagingApi_v2_MessagesInProgressService;
     messaging: pushwoosh_channels_messagingApi_v2_MessagingService;
+    chatPresets: pushwoosh_rpc_v2_chat_presets_chatPresetsService;
     cloudPages: pushwoosh_rpc_v2_cloud_pages_CloudPagesService;
     customerJourney: pushwoosh_rpc_v2_customer_journey_CustomerJourneyService;
     dataErasure: pushwoosh_rpc_v2_data_erasure_DataErasureService;

package/package.json

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

package/sms_presets.d.ts

@@ -53,6 +53,15 @@ export type SmsPresetRcs = {
     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. */
@@ -208,6 +217,8 @@ export type SmsRcsTemplate = {
     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[];