@pushwoosh/rpc-gateway-ai-assistant 0.1.534 → 0.1.536

package/data.js

@@ -769,6 +769,27 @@ export const data = {
             }
         }
     },
+    "pushwoosh.aibuilder.v1.SubscriptionAction": {
+        "type": "E",
+        "values": [
+            "SUBSCRIPTION_ACTION_UNSPECIFIED",
+            "SUBSCRIPTION_ACTION_CONFIRM_UNSUBSCRIBE",
+            "SUBSCRIPTION_ACTION_UNSUBSCRIBE_ALL",
+            "SUBSCRIPTION_ACTION_SAVE_PREFERENCES",
+            "SUBSCRIPTION_ACTION_RESUBSCRIBE",
+            "SUBSCRIPTION_ACTION_MANAGE_PREFERENCES",
+            "SUBSCRIPTION_ACTION_SURVEY_SEND",
+            "SUBSCRIPTION_ACTION_SURVEY_SKIP"
+        ]
+    },
+    "pushwoosh.aibuilder.v1.ButtonActionSubscription": {
+        "type": "I",
+        "fields": {
+            "action": {
+                "type": "pushwoosh.aibuilder.v1.SubscriptionAction"
+            }
+        }
+    },
     "pushwoosh.aibuilder.v1.ButtonAction": {
         "type": "I",
         "fields": {
@@ -777,13 +798,17 @@ export const data = {
             },
             "js": {
                 "type": "pushwoosh.aibuilder.v1.ButtonActionJs"
+            },
+            "subscription": {
+                "type": "pushwoosh.aibuilder.v1.ButtonActionSubscription"
             }
         },
         "oneofs": {
             "action": {
                 "oneof": [
                     "href",
-                    "js"
+                    "js",
+                    "subscription"
                 ]
             }
         }
@@ -992,6 +1017,84 @@ export const data = {
             }
         }
     },
+    "pushwoosh.aibuilder.v1.EmailCategories": {
+        "type": "I",
+        "fields": {
+            "updatedText": {
+                "type": "string"
+            },
+            "updatedTextTranslations": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "errorText": {
+                "type": "string"
+            },
+            "errorTextTranslations": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "accentColor": {
+                "type": "string"
+            },
+            "rowGap": {
+                "type": "number"
+            },
+            "fontSize": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.aibuilder.v1.SurveyOption": {
+        "type": "I",
+        "fields": {
+            "text": {
+                "type": "string"
+            },
+            "translations": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "value": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.aibuilder.v1.UnsubscribeSurvey": {
+        "type": "I",
+        "fields": {
+            "options": {
+                "type": "pushwoosh.aibuilder.v1.SurveyOption",
+                "array": true
+            },
+            "otherEnabled": {
+                "type": "boolean"
+            },
+            "otherLabel": {
+                "type": "string"
+            },
+            "otherLabelTranslations": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "otherPlaceholder": {
+                "type": "string"
+            },
+            "otherPlaceholderTranslations": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "accentColor": {
+                "type": "string"
+            },
+            "rowGap": {
+                "type": "number"
+            },
+            "fontSize": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.aibuilder.v1.Timer": {
         "type": "I",
         "fields": {
@@ -1257,6 +1360,12 @@ export const data = {
             "barcode": {
                 "type": "pushwoosh.aibuilder.v1.Barcode"
             },
+            "emailCategories": {
+                "type": "pushwoosh.aibuilder.v1.EmailCategories"
+            },
+            "survey": {
+                "type": "pushwoosh.aibuilder.v1.UnsubscribeSurvey"
+            },
             "padding": {
                 "type": "pushwoosh.aibuilder.v1.EdgeInsets",
                 "optional": true
@@ -1291,7 +1400,9 @@ export const data = {
                     "menu",
                     "social",
                     "video",
-                    "barcode"
+                    "barcode",
+                    "emailCategories",
+                    "survey"
                 ]
             }
         }
@@ -2471,6 +2582,18 @@ export const data = {
                 "method": "post",
                 "path": "/api/v1/aigen/document-to-popup-html"
             },
+            "DocumentToSubscriptionPageHtml": {
+                "request": "pushwoosh.aigen.v1.AiGenDocumentToSubscriptionPageHtmlRequest",
+                "response": "pushwoosh.aigen.v1.AiGenDocumentToSubscriptionPageHtmlResponse",
+                "method": "post",
+                "path": "/api/v1/aigen/document-to-subscription-page-html"
+            },
+            "DefaultSubscriptionPage": {
+                "request": "pushwoosh.aigen.v1.AiGenDefaultSubscriptionPageRequest",
+                "response": "pushwoosh.aigen.v1.AiGenDefaultSubscriptionPageResponse",
+                "method": "get",
+                "path": "/api/v1/aigen/default-subscription-page"
+            },
             "GenerateMediaImage": {
                 "request": "pushwoosh.aigen.v1.AiGenMediaImageRequest",
                 "response": "pushwoosh.aigen.v1.AiGenMediaImageResponse",
@@ -2528,7 +2651,21 @@ export const data = {
             "AI_GEN_MODE_EMAIL",
             "AI_GEN_MODE_FULL",
             "AI_GEN_MODE_WEB_POPUP",
-            "AI_GEN_MODE_WEB_PAGE"
+            "AI_GEN_MODE_WEB_PAGE",
+            "AI_GEN_MODE_SUBSCRIPTION_PAGE"
+        ]
+    },
+    "pushwoosh.aigen.v1.SubscriptionPageKind": {
+        "type": "E",
+        "values": [
+            "SUBSCRIPTION_PAGE_KIND_UNSPECIFIED",
+            "SUBSCRIPTION_PAGE_KIND_PREFERENCE_CENTER",
+            "SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBE_CONFIRM",
+            "SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBE_SURVEY",
+            "SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBED_CATEGORY",
+            "SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBED_ALL",
+            "SUBSCRIPTION_PAGE_KIND_RESUBSCRIBED_CATEGORY",
+            "SUBSCRIPTION_PAGE_KIND_RESUBSCRIBED_ALL"
         ]
     },
     "pushwoosh.aigen.v1.AiGenBlockPath": {
@@ -3381,6 +3518,64 @@ export const data = {
             }
         }
     },
+    "pushwoosh.aigen.v1.AiGenDocumentToSubscriptionPageHtmlRequest": {
+        "type": "I",
+        "fields": {
+            "document": {
+                "type": "pushwoosh.aibuilder.v1.AiBuilderDocument"
+            },
+            "application": {
+                "type": "string"
+            },
+            "kind": {
+                "type": "pushwoosh.aigen.v1.SubscriptionPageKind"
+            },
+            "timerBaseUrl": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.aigen.v1.AiGenDocumentToSubscriptionPageHtmlResponse": {
+        "type": "I",
+        "fields": {
+            "html": {
+                "type": "string"
+            },
+            "localizationData": {
+                "type": "pushwoosh.aigen.v1.LocalizationLanguage",
+                "mapKeyType": "string"
+            },
+            "document": {
+                "type": "pushwoosh.aibuilder.v1.AiBuilderDocument"
+            }
+        }
+    },
+    "pushwoosh.aigen.v1.AiGenDefaultSubscriptionPageRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "kind": {
+                "type": "pushwoosh.aigen.v1.SubscriptionPageKind"
+            }
+        }
+    },
+    "pushwoosh.aigen.v1.AiGenDefaultSubscriptionPageResponse": {
+        "type": "I",
+        "fields": {
+            "document": {
+                "type": "pushwoosh.aibuilder.v1.AiBuilderDocument"
+            },
+            "html": {
+                "type": "string"
+            },
+            "localizationData": {
+                "type": "pushwoosh.aigen.v1.LocalizationLanguage",
+                "mapKeyType": "string"
+            }
+        }
+    },
     "pushwoosh.aigen.v1.AiGenDocumentToHtmlResponse": {
         "type": "I",
         "fields": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-ai-assistant",
-    "version": "0.1.534",
+    "version": "0.1.536",
     "description": "AI Assistant api gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_aibuilder_v1.d.ts

@@ -478,6 +478,21 @@ export type ButtonActionHref = {
 export type ButtonActionJs = {
     onClick: string;
 };
+/**
+ * What a button does on an email subscription page. The emitter writes it as
+ * data-pw-action; channels/gateway's runtime script performs it.
+ */
+export type SubscriptionAction = 'SUBSCRIPTION_ACTION_UNSPECIFIED'
+/** Applies the unsubscribe the signed link carries (category or all). */
+ | 'SUBSCRIPTION_ACTION_CONFIRM_UNSUBSCRIBE' | 'SUBSCRIPTION_ACTION_UNSUBSCRIBE_ALL'
+/** Saves the EmailCategories item's checkboxes. */
+ | 'SUBSCRIPTION_ACTION_SAVE_PREFERENCES' | 'SUBSCRIPTION_ACTION_RESUBSCRIBE' | 'SUBSCRIPTION_ACTION_MANAGE_PREFERENCES'
+/** Posts the UnsubscribeSurvey item's answer; SKIP leaves without one. */
+ | 'SUBSCRIPTION_ACTION_SURVEY_SEND' | 'SUBSCRIPTION_ACTION_SURVEY_SKIP';
+/** SUBSCRIPTION_PAGE only; the page kind decides which actions it may carry. */
+export type ButtonActionSubscription = {
+    action: SubscriptionAction;
+};
 export type ButtonAction_action_href = {
     type: 'href';
     data: ButtonActionHref;
@@ -486,7 +501,11 @@ export type ButtonAction_action_js = {
     type: 'js';
     data: ButtonActionJs;
 };
-export type ButtonAction_action = ButtonAction_action_href | ButtonAction_action_js;
+export type ButtonAction_action_subscription = {
+    type: 'subscription';
+    data: ButtonActionSubscription;
+};
+export type ButtonAction_action = ButtonAction_action_href | ButtonAction_action_js | ButtonAction_action_subscription;
 export type ButtonAction = {
     action: ButtonAction_action;
 };
@@ -630,6 +649,50 @@ export type Form = {
     submitLabel: string;
     submitStyles?: ButtonStyles;
 };
+/**
+ * Preference-center checkboxes (SUBSCRIPTION_PAGE only). The list is not stored:
+ * the emitter writes one row template, the gateway runtime fills it per subscriber.
+ */
+export type EmailCategories = {
+    /** Banner shown after a successful save; per-language overrides as TextBlock.translations. */
+    updatedText: string;
+    updatedTextTranslations: Record<string, string>;
+    /** Banner shown when the save fails. */
+    errorText: string;
+    errorTextTranslations: Record<string, string>;
+    /** Checkbox colour (#RGB / #RRGGBB); empty = the scheme's accent. */
+    accentColor: string;
+    /** Vertical gap between rows in px; 0 = 16. */
+    rowGap: number;
+    /** Row label size in px; 0 = 14. */
+    fontSize: number;
+};
+export type SurveyOption = {
+    text: string;
+    translations: Record<string, string>;
+    /**
+     * What a pick submits; empty = `text` in the default language. Never
+     * translated, so a reason reads the same whatever language the visitor saw.
+     */
+    value: string;
+};
+/**
+ * Unsubscribe-reason radio list (SUBSCRIPTION_PAGE only). The question above it
+ * is ordinary text; Send / Skip are ordinary buttons with SURVEY_SEND / SURVEY_SKIP.
+ */
+export type UnsubscribeSurvey = {
+    options: SurveyOption[];
+    /** Adds a free-text option below the fixed ones. */
+    otherEnabled: boolean;
+    otherLabel: string;
+    otherLabelTranslations: Record<string, string>;
+    otherPlaceholder: string;
+    otherPlaceholderTranslations: Record<string, string>;
+    /** Radio colour (#RGB / #RRGGBB); empty = the scheme's accent. */
+    accentColor: string;
+    rowGap: number;
+    fontSize: number;
+};
 /**
  * Countdown timer. Renders in email HTML as an animated GIF served by this
  * service's public /timer/v1/countdown.gif endpoint (regenerated per open).
@@ -843,7 +906,15 @@ export type ContentItem_item_barcode = {
     type: 'barcode';
     data: Barcode;
 };
-export type ContentItem_item = ContentItem_item_text | ContentItem_item_buttonGroup | ContentItem_item_list | ContentItem_item_image | ContentItem_item_form | ContentItem_item_timer | ContentItem_item_rawHtml | ContentItem_item_menu | ContentItem_item_social | ContentItem_item_video | ContentItem_item_barcode;
+export type ContentItem_item_emailCategories = {
+    type: 'emailCategories';
+    data: EmailCategories;
+};
+export type ContentItem_item_survey = {
+    type: 'survey';
+    data: UnsubscribeSurvey;
+};
+export type ContentItem_item = ContentItem_item_text | ContentItem_item_buttonGroup | ContentItem_item_list | ContentItem_item_image | ContentItem_item_form | ContentItem_item_timer | ContentItem_item_rawHtml | ContentItem_item_menu | ContentItem_item_social | ContentItem_item_video | ContentItem_item_barcode | ContentItem_item_emailCategories | ContentItem_item_survey;
 export type ContentItem = {
     /**
      * Container padding of the item. Unset = client's default inter-item gap;

package/pushwoosh_aigen_v1.d.ts

@@ -14,6 +14,8 @@ export type AiGenService_DocumentsToHtml = RpcMethod<AiGenDocumentsToHtmlRequest
 export type AiGenService_DocumentToPageHtml = RpcMethod<AiGenDocumentToPageHtmlRequest, AiGenDocumentToPageHtmlResponse>;
 export type AiGenService_DocumentToFragmentHtml = RpcMethod<AiGenDocumentToFragmentHtmlRequest, AiGenDocumentToFragmentHtmlResponse>;
 export type AiGenService_DocumentToPopupHtml = RpcMethod<AiGenDocumentToPopupHtmlRequest, AiGenDocumentToPopupHtmlResponse>;
+export type AiGenService_DocumentToSubscriptionPageHtml = RpcMethod<AiGenDocumentToSubscriptionPageHtmlRequest, AiGenDocumentToSubscriptionPageHtmlResponse>;
+export type AiGenService_DefaultSubscriptionPage = RpcMethod<AiGenDefaultSubscriptionPageRequest, AiGenDefaultSubscriptionPageResponse>;
 export type AiGenService_GenerateMediaImage = RpcMethod<AiGenMediaImageRequest, AiGenMediaImageResponse>;
 export type AiGenService_SearchStockPhotos = RpcMethod<AiGenStockSearchRequest, AiGenStockSearchResponse>;
 export type AiGenService_ImportStockPhoto = RpcMethod<AiGenStockImportRequest, AiGenStockImportResponse>;
@@ -152,6 +154,16 @@ export interface AiGenService {
      * display SDK rather than the email payload-builder, and it has no html type.
      */
     DocumentToPopupHtml: AiGenService_DocumentToPopupHtml;
+    /**
+     * Renders an email subscription page: page chrome as DocumentToPageHtml, tokens as
+     * DocumentToHtml, validated for `kind` first — see documents/subscription-pages.md.
+     */
+    DocumentToSubscriptionPageHtml: AiGenService_DocumentToSubscriptionPageHtml;
+    /**
+     * The page an application gets before it designs its own: the editor's starting
+     * point and what the gateway serves, from one source so they never drift.
+     */
+    DefaultSubscriptionPage: AiGenService_DefaultSubscriptionPage;
     /**
      * GenerateMediaImage generates ONE image from a prompt and stores it in
      * the application's media library — the media-gallery "Generate" tab.
@@ -241,7 +253,17 @@ export type AiGenMode = 'AI_GEN_MODE_UNSPECIFIED' | 'AI_GEN_MODE_EMAIL'
  * conversion + manual editing only — the generation pipeline is not
  * tuned for pages yet.
  */
- | 'AI_GEN_MODE_WEB_PAGE';
+ | 'AI_GEN_MODE_WEB_PAGE'
+/**
+ * Email subscription pages (preference center, unsubscribe flow). Manual editing
+ * only; the items and actions a page may carry depend on its SubscriptionPageKind.
+ */
+ | 'AI_GEN_MODE_SUBSCRIPTION_PAGE';
+/**
+ * The page's place in the email subscription flow. Mirrors
+ * uds/objects email_subscription_pages.kind.
+ */
+export type SubscriptionPageKind = 'SUBSCRIPTION_PAGE_KIND_UNSPECIFIED' | 'SUBSCRIPTION_PAGE_KIND_PREFERENCE_CENTER' | 'SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBE_CONFIRM' | 'SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBE_SURVEY' | 'SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBED_CATEGORY' | 'SUBSCRIPTION_PAGE_KIND_UNSUBSCRIBED_ALL' | 'SUBSCRIPTION_PAGE_KIND_RESUBSCRIBED_CATEGORY' | 'SUBSCRIPTION_PAGE_KIND_RESUBSCRIBED_ALL';
 /**
  * AiGenBlockPath wraps a block-addressing path so it can appear inside
  * repeated fields — proto3 disallows `repeated repeated`. Path is
@@ -1002,6 +1024,34 @@ export type AiGenDocumentToPopupHtmlResponse = {
     localizationData: Record<string, LocalizationLanguage>;
     document: pushwoosh_aibuilder_v1_AiBuilderDocument;
 };
+export type AiGenDocumentToSubscriptionPageHtmlRequest = {
+    /** The document to render. Required; must carry at least one page. */
+    document: pushwoosh_aibuilder_v1_AiBuilderDocument;
+    /** Application id. Required: it scopes the request to the caller's account. */
+    application: string;
+    /** Which page of the flow this is; decides the validation rules. Required. */
+    kind: SubscriptionPageKind;
+    timerBaseUrl: string;
+};
+export type AiGenDocumentToSubscriptionPageHtmlResponse = {
+    /**
+     * The complete page with {{key|html|}} / {{key|text|}} tokens, ready to store
+     * as email_subscription_pages.content.
+     */
+    html: string;
+    /** Every token's value for every language; stored as email_subscription_pages.localization. */
+    localizationData: Record<string, LocalizationLanguage>;
+    document: pushwoosh_aibuilder_v1_AiBuilderDocument;
+};
+export type AiGenDefaultSubscriptionPageRequest = {
+    application: string;
+    kind: SubscriptionPageKind;
+};
+export type AiGenDefaultSubscriptionPageResponse = {
+    document: pushwoosh_aibuilder_v1_AiBuilderDocument;
+    html: string;
+    localizationData: Record<string, LocalizationLanguage>;
+};
 export type AiGenDocumentToHtmlResponse = {
     /** The complete email document, ready to store as EmailContent.Smartcards.html. */
     html: string;