@pushwoosh/rpc-v2-http-api-data 0.2.460 → 0.2.462

package/data.js

@@ -2959,6 +2959,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": {
@@ -2967,13 +2988,17 @@ export const data = {
             },
             "js": {
                 "type": "pushwoosh.aibuilder.v1.ButtonActionJs"
+            },
+            "subscription": {
+                "type": "pushwoosh.aibuilder.v1.ButtonActionSubscription"
             }
         },
         "oneofs": {
             "action": {
                 "oneof": [
                     "href",
-                    "js"
+                    "js",
+                    "subscription"
                 ]
             }
         }
@@ -3182,6 +3207,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": {
@@ -3447,6 +3550,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
@@ -3481,7 +3590,9 @@ export const data = {
                     "menu",
                     "social",
                     "video",
-                    "barcode"
+                    "barcode",
+                    "emailCategories",
+                    "survey"
                 ]
             }
         }
@@ -13573,6 +13684,182 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.email_subscription_pages.EmailSubscriptionPagesService": {
+        "type": "S",
+        "key": "emailSubscriptionPages",
+        "methods": {
+            "List": {
+                "request": "pushwoosh.rpc_v2.email_subscription_pages.ListRequest",
+                "response": "pushwoosh.rpc_v2.email_subscription_pages.ListResponse",
+                "method": "get",
+                "path": "/api/email_subscription_pages"
+            },
+            "Get": {
+                "request": "pushwoosh.rpc_v2.email_subscription_pages.GetRequest",
+                "response": "pushwoosh.rpc_v2.email_subscription_pages.GetResponse",
+                "method": "get",
+                "path": "/api/email_subscription_pages/{kind}"
+            },
+            "Set": {
+                "request": "pushwoosh.rpc_v2.email_subscription_pages.SetRequest",
+                "response": "pushwoosh.rpc_v2.email_subscription_pages.SetResponse",
+                "method": "put",
+                "path": "/api/email_subscription_pages/{kind}"
+            },
+            "Reset": {
+                "request": "pushwoosh.rpc_v2.email_subscription_pages.ResetRequest",
+                "response": "pushwoosh.rpc_v2.email_subscription_pages.ResetResponse",
+                "method": "delete",
+                "path": "/api/email_subscription_pages/{kind}"
+            },
+            "SetUnsubscribeFlow": {
+                "request": "pushwoosh.rpc_v2.email_subscription_pages.SetUnsubscribeFlowRequest",
+                "response": "pushwoosh.rpc_v2.email_subscription_pages.SetUnsubscribeFlowResponse",
+                "method": "post",
+                "path": "/api/email_subscription_pages/unsubscribe_flow"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.Page": {
+        "type": "I",
+        "fields": {
+            "kind": {
+                "type": "string"
+            },
+            "document": {
+                "type": "pushwoosh.aibuilder.v1.AiBuilderDocument"
+            },
+            "isCustom": {
+                "type": "boolean"
+            },
+            "updated": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.PageSummary": {
+        "type": "I",
+        "fields": {
+            "kind": {
+                "type": "string"
+            },
+            "isCustom": {
+                "type": "boolean"
+            },
+            "updated": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.UnsubscribeFlow": {
+        "type": "I",
+        "fields": {
+            "confirm": {
+                "type": "boolean"
+            },
+            "survey": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.ListRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.ListResponse": {
+        "type": "I",
+        "fields": {
+            "pages": {
+                "type": "pushwoosh.rpc_v2.email_subscription_pages.PageSummary",
+                "array": true
+            },
+            "unsubscribeFlow": {
+                "type": "pushwoosh.rpc_v2.email_subscription_pages.UnsubscribeFlow"
+            },
+            "preferenceCenterEnabled": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.GetRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "kind": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.GetResponse": {
+        "type": "I",
+        "fields": {
+            "page": {
+                "type": "pushwoosh.rpc_v2.email_subscription_pages.Page"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.SetRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "kind": {
+                "type": "string"
+            },
+            "document": {
+                "type": "pushwoosh.aibuilder.v1.AiBuilderDocument"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.SetResponse": {
+        "type": "I",
+        "fields": {
+            "page": {
+                "type": "pushwoosh.rpc_v2.email_subscription_pages.Page"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.ResetRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "kind": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.ResetResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.SetUnsubscribeFlowRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "unsubscribeFlow": {
+                "type": "pushwoosh.rpc_v2.email_subscription_pages.UnsubscribeFlow"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_subscription_pages.SetUnsubscribeFlowResponse": {
+        "type": "I",
+        "fields": {
+            "unsubscribeFlow": {
+                "type": "pushwoosh.rpc_v2.email_subscription_pages.UnsubscribeFlow"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionsService": {
         "type": "S",
         "key": "emailSuppressions",

package/email_subscription_pages.d.ts

@@ -0,0 +1,87 @@
+import { RpcMethod } from './commonTypes';
+import { AiBuilderDocument as pushwoosh_aibuilder_v1_AiBuilderDocument } from './pushwoosh_aibuilder_v1';
+export type EmailSubscriptionPagesService_List = RpcMethod<ListRequest, ListResponse>;
+export type EmailSubscriptionPagesService_Get = RpcMethod<GetRequest, GetResponse>;
+export type EmailSubscriptionPagesService_Set = RpcMethod<SetRequest, SetResponse>;
+export type EmailSubscriptionPagesService_Reset = RpcMethod<ResetRequest, ResetResponse>;
+export type EmailSubscriptionPagesService_SetUnsubscribeFlow = RpcMethod<SetUnsubscribeFlowRequest, SetUnsubscribeFlowResponse>;
+/**
+ * The pages a subscriber sees in the email unsubscribe flow and the preference center. Each application
+ * may design its own in the AI builder; until it does, a stock default serves.
+ */
+export interface EmailSubscriptionPagesService {
+    /** Lists the seven pages of the email subscription flow with whether each one is customised, plus the unsubscribe flow switches. Use to render the Subscription pages settings. */
+    List: EmailSubscriptionPagesService_List;
+    /** Returns one page's builder document by kind: the application's own, or the stock default when it has none. Use before editing a page. */
+    Get: EmailSubscriptionPagesService_Get;
+    /** Saves a page's builder document for an application; the HTML is rendered server-side and the previous version is replaced. The document must follow the kind's rules (required buttons, blocks). */
+    Set: EmailSubscriptionPagesService_Set;
+    /** Drops the application's own version of a page so the stock default serves again. Resetting a page that was never customised is a no-op. */
+    Reset: EmailSubscriptionPagesService_Reset;
+    /** Turns the unsubscribe confirmation step and the unsubscribe-reason survey on or off for an application. Switching the survey on creates the tag its answers are stored in. */
+    SetUnsubscribeFlow: EmailSubscriptionPagesService_SetUnsubscribeFlow;
+}
+/**
+ * Page kinds: preference_center, unsubscribe_confirm, unsubscribe_survey, unsubscribed_category,
+ * unsubscribed_all, resubscribed_category, resubscribed_all.
+ */
+export type Page = {
+    kind: string;
+    document: pushwoosh_aibuilder_v1_AiBuilderDocument;
+    /** False when the stock default is returned. */
+    isCustom: boolean;
+    /** Last save of the application's own version; unset for the default. */
+    updated: Date;
+};
+export type PageSummary = {
+    kind: string;
+    isCustom: boolean;
+    updated: Date;
+};
+export type UnsubscribeFlow = {
+    /** Ask before applying an unsubscribe link from an email; on by default. */
+    confirm: boolean;
+    /** Show the unsubscribe-reason survey after an unsubscribe; off by default. */
+    survey: boolean;
+};
+export type ListRequest = {
+    /** Application code XXXXX-XXXXX */
+    application?: string;
+};
+export type ListResponse = {
+    pages: PageSummary[];
+    unsubscribeFlow: UnsubscribeFlow;
+    /** The email categories feature; the preference center page serves only with it on. */
+    preferenceCenterEnabled: boolean;
+};
+export type GetRequest = {
+    /** Application code XXXXX-XXXXX */
+    application?: string;
+    kind?: string;
+};
+export type GetResponse = {
+    page: Page;
+};
+export type SetRequest = {
+    /** Application code XXXXX-XXXXX */
+    application?: string;
+    kind?: string;
+    document?: pushwoosh_aibuilder_v1_AiBuilderDocument;
+};
+export type SetResponse = {
+    page: Page;
+};
+export type ResetRequest = {
+    /** Application code XXXXX-XXXXX */
+    application?: string;
+    kind?: string;
+};
+export type ResetResponse = {};
+export type SetUnsubscribeFlowRequest = {
+    /** Application code XXXXX-XXXXX */
+    application?: string;
+    unsubscribeFlow?: UnsubscribeFlow;
+};
+export type SetUnsubscribeFlowResponse = {
+    unsubscribeFlow: UnsubscribeFlow;
+};

package/email_subscription_pages.js

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

package/index.d.ts

@@ -31,6 +31,7 @@ import { DeliverabilityCheckerService as pushwoosh_rpc_v2_deliverability_checker
 import { DevicesService as pushwoosh_rpc_v2_devices_DevicesService } from './devices';
 import { EmailAdsService as pushwoosh_rpc_v2_email_ads_EmailAdsService } from './email_ads';
 import { EmailCategoriesService as pushwoosh_rpc_v2_email_categories_EmailCategoriesService } from './email_categories';
+import { EmailSubscriptionPagesService as pushwoosh_rpc_v2_email_subscription_pages_EmailSubscriptionPagesService } from './email_subscription_pages';
 import { EmailSuppressionsService as pushwoosh_rpc_v2_email_suppressions_EmailSuppressionsService } from './email_suppressions';
 import { EmailTemplatesService as pushwoosh_rpc_v2_accounts_EmailTemplatesService } from './accounts';
 import { EmailsConfigurationsService as pushwoosh_rpc_v2_emails_configurations_EmailsConfigurationsService } from './emails_configurations';
@@ -113,6 +114,7 @@ export type API = {
     devices: pushwoosh_rpc_v2_devices_DevicesService;
     emailAds: pushwoosh_rpc_v2_email_ads_EmailAdsService;
     emailCategories: pushwoosh_rpc_v2_email_categories_EmailCategoriesService;
+    emailSubscriptionPages: pushwoosh_rpc_v2_email_subscription_pages_EmailSubscriptionPagesService;
     emailSuppressions: pushwoosh_rpc_v2_email_suppressions_EmailSuppressionsService;
     emailTemplates: pushwoosh_rpc_v2_accounts_EmailTemplatesService;
     emailsConfigurations: pushwoosh_rpc_v2_emails_configurations_EmailsConfigurationsService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.460",
+  "version": "0.2.462",
   "description": "RPC V2 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;