@pushwoosh/rpc-v2-http-api-data 0.2.65 → 0.2.67

package/package.json

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

package/presets.d.ts

@@ -10,31 +10,35 @@ export type presetsService_Clone = RpcMethod<ClonePresetRequest, ClonePresetResp
 export type presetsService_Delete = RpcMethod<DeletePresetRequest, DeletePresetResponse>;
 export type presetsService_ValidateLiquid = RpcMethod<ValidateLiquidRequest, ValidateLiquidResponse>;
 export interface presetsService {
+    /** Lists push notification presets (reusable message templates) for an application, with paging, name/code search and category filter. Use to browse presets or find a preset code before fetching, cloning or editing one. */
     List: presetsService_List;
+    /** Returns a single push preset by its preset code, including platforms, localized content, deeplink, rich media and delivery settings. Use after list_push_presets to inspect one preset in full. */
     Get: presetsService_Get;
+    /** Creates a new push preset (reusable notification template) in an application from the supplied content and settings. Returns the created preset with its generated code; each call creates a distinct preset. */
     Create: presetsService_Create;
+    /** Overwrites an existing push preset (by preset code) with the supplied fields, replacing name, platforms, content and delivery settings. Use for full edits; use update_push_preset_partial to change only selected fields. */
     Update: presetsService_Update;
+    /** Updates only the supplied fields of an existing push preset (by preset code), leaving unset fields unchanged. Use for partial edits; use update_push_preset to overwrite the whole preset. */
     UpdatePartial: presetsService_UpdatePartial;
+    /** Duplicates an existing push preset (by preset code) into a new preset with the given name in the same application. Each call creates a new copy; the source preset is left unchanged. */
     Clone: presetsService_Clone;
+    /** Permanently deletes a push preset by its preset code. Fails if the preset is still used by a running or paused journey; remove it from the journey first. */
     Delete: presetsService_Delete;
-    /**
-     * ValidateLiquid checks the Liquid syntax of one or more template strings
-     * using the same engine the publisher uses at send time. It does not touch
-     * any preset or account data.
-     */
+    /** Checks the Liquid syntax of one or more template strings using the same engine the publisher uses at send time, returning per-field errors. Pure validation: it does not touch any preset or account data. */
     ValidateLiquid: presetsService_ValidateLiquid;
 }
 export type ListPresetsRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListPresetsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListPresetsRequest = {
+    /** Application code (format XXXXX-XXXXX) whose presets to list. */
     application?: string;
     orderBy?: ListPresetsRequest_OrderBy;
     orderDirection?: ListPresetsRequest_OrderDirection;
     page?: number;
     perPage?: number;
-    /** like %name% */
+    /** Case-insensitive substring match on preset name or code (SQL ILIKE %value%). */
     searchByName?: string;
-    /** in ['category'] */
+    /** Restrict to presets tagged with any of these category names. */
     searchByCategory?: string[];
     showHidden?: boolean;
     /** Deprecated: used only by the legacy send push form. */
@@ -120,14 +124,18 @@ export type ListPresetsResponse = {
     total: number;
 };
 export type GetPresetRequest = {
+    /** Preset code of the push preset to fetch. */
     code?: string;
 };
 export type GetPresetResponse = {
     preset: Preset;
 };
 export type CreatePresetRequest = {
+    /** Application code (format XXXXX-XXXXX) the preset belongs to. */
     application?: string;
+    /** Human-readable preset name. */
     name?: string;
+    /** Channel/send type of the preset (e.g. push, sms, email). */
     sendType?: string;
     platforms?: Record<number, boolean>;
     /** Localized properties map<string, Content> */
@@ -194,8 +202,11 @@ export type CreatePresetResponse = {
     preset: Preset;
 };
 export type UpdatePresetRequest = {
+    /** Preset code of the push preset to overwrite. */
     code?: string;
+    /** Human-readable preset name. */
     name?: string;
+    /** Channel/send type of the preset (e.g. push, sms, email). */
     sendType?: string;
     platforms?: Record<number, boolean>;
     /** Localized properties map<string, Content> */
@@ -255,8 +266,11 @@ export type UpdatePresetRequest = {
     isV2?: boolean;
 };
 export type UpdatePresetPartialRequest = {
+    /** Preset code of the push preset to patch. */
     code?: string;
+    /** Human-readable preset name. */
     name?: string;
+    /** Channel/send type of the preset (e.g. push, sms, email). */
     sendType?: string;
     platforms?: Record<number, boolean>;
     /** Localized properties map<string, Content> */
@@ -315,13 +329,16 @@ export type UpdatePresetResponse = {
     preset: Preset;
 };
 export type ClonePresetRequest = {
+    /** Preset code of the source push preset to duplicate. */
     code?: string;
+    /** Name for the new cloned preset (required). */
     name?: string;
 };
 export type ClonePresetResponse = {
     preset: Preset;
 };
 export type DeletePresetRequest = {
+    /** Preset code of the push preset to delete. */
     code?: string;
 };
 export type DeletePresetResponse = {};

package/pushwoosh_rpc_external_segments_v3.d.ts

@@ -182,28 +182,19 @@ export type ExternalSegmentsService_TestConnection = RpcMethodV3<TestConnectionR
  * assembles the proper connection string from the structured parameters.
  */
 export interface ExternalSegmentsService {
-    /** List external segments of the given application. */
+    /** Lists all external segments of an application (code XXXXX-XXXXX), each materialized from a user-supplied SQL/BigQuery query against an external database. Use to browse configured external segments before fetching one by code. */
     List: ExternalSegmentsService_List;
-    /** Get a single external segment by code. */
+    /** Returns one external segment by its code, including connection parameters (passwords/secrets omitted), the query, validity and last-refresh status. Use after list_external_segments to inspect a single segment. */
     Get: ExternalSegmentsService_Get;
-    /** Create a new external segment. */
+    /** Creates an external segment from structured DB connection parameters (PostgreSQL, MySQL or BigQuery) and a SQL query returning a user_id column, connecting to the external database to validate the query before saving. Use to define a new externally-sourced audience; the segment code is generated on creation. */
     Create: ExternalSegmentsService_Create;
-    /** Update an existing external segment. Only provided fields are changed. */
+    /** Updates an external segment's name, connection parameters or query by code; only provided fields change and the database type is immutable. Re-validates the connection against the external database before saving. */
     Update: ExternalSegmentsService_Update;
-    /** Delete an external segment. */
+    /** Deletes an external segment and its companion filter by code, allowed only when the filter is not referenced by in-apps, presets, journeys, other filters or popup forms. Irreversible; the segment stops being targetable. */
     Delete: ExternalSegmentsService_Delete;
-    /**
-     * CheckConnection connects to the segment's database and validates its stored
-     * query (SQL: executes it and reads the first row; BigQuery: dry-run), then
-     * stores the outcome in the segment's `valid` flag. Returns the result.
-     */
+    /** Connects to a stored external segment's database and runs its saved query, then records the outcome in the segment's valid flag. Use to re-check an existing segment; unlike test_external_segment_connection it persists the result. */
     CheckConnection: ExternalSegmentsService_CheckConnection;
-    /**
-     * TestConnection validates connection parameters supplied inline (not yet
-     * persisted), so the create/edit form can test before saving. When
-     * check_query is false it only connects and pings; when true it also
-     * validates the query. It never persists anything (unlike CheckConnection).
-     */
+    /** Tests external database connection parameters supplied inline (optionally backfilling secrets from a saved segment by code) without persisting anything. Use from the create/edit form before saving; set check_query to also validate the query, otherwise only connectivity is checked. */
     TestConnection: ExternalSegmentsService_TestConnection;
 }
 export type ExternalSegmentsService_Errors = {

package/pushwoosh_rpc_frequency_capping_disabled_users_v3.d.ts

@@ -2,17 +2,22 @@ import { RpcMethod } from './commonTypes';
 export type FrequencyCappingDisabledUsersService_Get = RpcMethod<GetRequest, GetResponse>;
 export type FrequencyCappingDisabledUsersService_Set = RpcMethod<SetRequest, SetResponse>;
 export interface FrequencyCappingDisabledUsersService {
+    /** Returns the user ids exempt from frequency capping in an application (application code XXXXX-XXXXX). Use to inspect which users bypass the app's send limits before editing that list with set_frequency_capping_disabled_users. */
     Get: FrequencyCappingDisabledUsersService_Get;
+    /** Overwrites the full list of user ids exempt from frequency capping for an application (application code XXXXX-XXXXX); the supplied list fully replaces any previous one. Use to grant or revoke send-limit exemptions in one call; pass an empty list to clear all exemptions. */
     Set: FrequencyCappingDisabledUsersService_Set;
 }
 export type GetRequest = {
+    /** Application code (XXXXX-XXXXX) whose frequency-capping exemption list is read. */
     application?: string;
 };
 export type GetResponse = {
     users: string[];
 };
 export type SetRequest = {
+    /** Application code (XXXXX-XXXXX) whose frequency-capping exemption list is overwritten. */
     application?: string;
+    /** Full set of user ids exempt from frequency capping; replaces the existing list. Empty clears all exemptions. */
     users?: string[];
 };
 export type SetResponse = {

package/pushwoosh_rpc_popup_forms_contents_v3.d.ts

@@ -91,15 +91,15 @@ export type PopupFormsContentsService_Delete = RpcMethodV3<DeleteRequest, Delete
     failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
 }>;
 export interface PopupFormsContentsService {
-    /** List Popup Forms Contents for given application and filters. */
+    /** Lists popup form contents (web subscription-popup designs) for an application code XXXXX-XXXXX, ordered by updated or name, with paging and free-text search over name and code. Use to browse designs or find a content code before get/update/delete. */
     List: PopupFormsContentsService_List;
-    /** Get Popup Form Content by code. */
+    /** Returns one popup form content by its content code, including the frontend-generated json and optional html. Use after list_popup_form_contents to inspect a single design. */
     Get: PopupFormsContentsService_Get;
-    /** Create new Popup Form Content. Popup Form Content code will be generated by server and returned in response. */
+    /** Creates a popup form content under an application code XXXXX-XXXXX from a name and frontend json; the server generates and returns the new content code. Name must be unique within the application, so a repeat call with the same name fails. */
     Create: PopupFormsContentsService_Create;
-    /** Update Popup Form Content. */
+    /** Overwrites a popup form content's name, json and html by content code. Use to save edits to an existing design; delete_popup_form_content removes it instead. */
     Update: PopupFormsContentsService_Update;
-    /** Delete Popup Form Content. */
+    /** Deletes a popup form content by content code. Fails if any popup form still references it; a repeat call after deletion returns not-found. */
     Delete: PopupFormsContentsService_Delete;
 }
 export type PopupFormsContentsService_Errors = {
@@ -184,7 +184,7 @@ export type ListResponse = {
     total: number;
 };
 export type GetRequest = {
-    /** Similar to the PopupFormContent. */
+    /** Popup Form Content code identifying the design to fetch. */
     code?: string;
 };
 export type GetResponse = {
@@ -206,7 +206,7 @@ export type CreateResponse = {
     code: string;
 };
 export type UpdateRequest = {
-    /** Similar to the PopupFormContent. */
+    /** Popup Form Content code identifying the design to overwrite. */
     code?: string;
     /** Similar to the PopupFormContent. */
     name?: string;
@@ -217,7 +217,7 @@ export type UpdateRequest = {
 };
 export type UpdateResponse = {};
 export type DeleteRequest = {
-    /** Similar to the PopupFormContent. */
+    /** Popup Form Content code identifying the design to delete. */
     code?: string;
 };
 export type DeleteResponse = {};

package/pushwoosh_rpc_popup_forms_v3.d.ts

@@ -112,19 +112,19 @@ export type PopupFormsService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
 export type PopupFormsService_Deactivate = RpcMethod<DeactivateRequest, DeactivateResponse>;
 export type PopupFormsService_Activate = RpcMethod<ActivateRequest, ActivateResponse>;
 export interface PopupFormsService {
-    /** List Popup Forms for given application and filters. */
+    /** Lists web popup forms for an application code, newest-published first, with paging, name/code search and an optional status filter; each item carries visitor and impression counts. Use to browse popup forms or find a popup form code before fetching details. */
     List: PopupFormsService_List;
-    /** Get Popup Form by code. */
+    /** Returns a single web popup form by its popup form code, including status, display rules, audience targeting and the associated content or subscription form. Use after list_popup_forms to inspect one form's full configuration. */
     Get: PopupFormsService_Get;
-    /** Create new Popup Form. Popup Form code will be generated by server and returned in response. */
+    /** Creates a new web popup form under an application code from either a popup form content code or a subscription form code (exactly one), returning the server-generated popup form code. The name must be unique within the application. */
     Create: PopupFormsService_Create;
-    /** Update Popup Form. */
+    /** Updates an existing web popup form by code, patching name, display rules, audience and page rules per explicit update_* flags. Use to change an existing form's configuration; the source type (content vs subscription form) is immutable. */
     Update: PopupFormsService_Update;
-    /** Delete Popup Form. */
+    /** Permanently deletes a web popup form by its popup form code. Irreversible; use disable_popup_form instead to only pause a form while keeping it. */
     Delete: PopupFormsService_Delete;
-    /** Deactivate Popup Form (set status to paused). */
+    /** Deactivates a web popup form by code, setting its status to paused so it stops showing to visitors. Reversible via enable_popup_form; errors if the form is already paused. */
     Deactivate: PopupFormsService_Deactivate;
-    /** Activate Popup Form (set status to active). */
+    /** Activates a web popup form by code, setting its status to active and stamping its published time so it starts showing to visitors. Reversible via disable_popup_form; errors if the form is already active. */
     Activate: PopupFormsService_Activate;
 }
 /**

package/pushwoosh_rpc_segments_v3.d.ts

@@ -138,15 +138,15 @@ export type SegmentsService_Delete = RpcMethodV3<DeleteRequest, DeleteResponse,
     failedPreconditions?: SegmentsService_Delete_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
 }>;
 export interface SegmentsService {
-    /** List segments for given application. */
+    /** Lists the segments (saved audience filters) belonging to an application. Use to browse an app's segments or find a segment code before fetching, updating or deleting one. */
     List: SegmentsService_List;
-    /** Get segment by code. */
+    /** Returns a single segment by its segment code, including name and conditions in both seglang and filter-expression form. Use after list_segments to inspect one segment's definition. */
     Get: SegmentsService_Get;
-    /** Create new segment. Segment code will be generated by server and returned in response. */
+    /** Creates a segment from seglang or a filter expression for an application; the server generates and returns the segment code. Use to save a new audience filter; optionally high-speed for faster sending. */
     Create: SegmentsService_Create;
-    /** Update segment. */
+    /** Updates an existing segment's name and/or conditions by segment code, replacing them with the supplied values. Use to rename or redefine a saved segment; for high-speed segments re-preparation takes time. */
     Update: SegmentsService_Update;
-    /** Delete segment. */
+    /** Deletes a segment by segment code and detaches it from in-app messages (moved to draft) and journey split/entry points. Irreversible; use only to permanently remove a segment. */
     Delete: SegmentsService_Delete;
 }
 export type SegmentsService_Errors = {
@@ -174,10 +174,12 @@ export type SegmentsService_Errors = {
  */
 export type DeviceLoadPolicy = 'FILTER' | 'ALL';
 export type ListRequest = {
+    /** Application code (format XXXXX-XXXXX) whose segments to list. */
     application?: string;
 };
 export type ListResponse = {};
 export type GetRequest = {
+    /** Segment code of the segment to fetch. */
     segment?: string;
 };
 /** Get segment response. Segment conditions are returned in both seglang and filter expression formats. */
@@ -283,7 +285,9 @@ export type UpdateRequest = {
 };
 export type UpdateResponse = {};
 export type DeleteRequest = {
+    /** Application code (format XXXXX-XXXXX) that owns the segment. */
     application?: string;
+    /** Segment code of the segment to delete. */
     segment?: string;
 };
 export type DeleteResponse = {};

package/referral_partners.d.ts

@@ -8,13 +8,21 @@ export type ReferralPartnerService_CreateWithdrawal = RpcMethod<CreateWithdrawal
 export type ReferralPartnerService_GetWithdrawalAdditionalInfo = RpcMethod<GetWithdrawalAdditionalInfoRequest, GetWithdrawalAdditionalInfoResponse>;
 export type ReferralPartnerService_GetCurrencies = RpcMethod<GetCurrenciesRequest, GetCurrenciesResponse>;
 export interface ReferralPartnerService {
+    /** Returns the referral-partner profile of the current account: referral hash, saved withdrawal info and status (active/blocked). Returns an empty profile when the account has not joined the program yet — call create_referral_partner first. */
     Get: ReferralPartnerService_Get;
+    /** Enrolls the current account into the referral-partner program and generates its referral hash. Use once to opt an account in; get_referral_partner then returns the created profile. */
     Create: ReferralPartnerService_Create;
+    /** Lists the current account's referral-payout withdrawals, each with date, amount, payout info and status (created/in-process/success/error). Use to show the partner's withdrawal history. */
     GetWithdrawalsHistory: ReferralPartnerService_GetWithdrawalsHistory;
+    /** Returns the current account's referral earnings totals: expected, available and total revenues plus the count of referred members. Use for the referral-program dashboard summary. */
     GetTotalStatistics: ReferralPartnerService_GetTotalStatistics;
+    /** Overwrites the current account's saved withdrawal (payout) details. Use before create_referral_withdrawal so payouts have destination info; replaces the previous value. */
     UpdateWithdrawalInfo: ReferralPartnerService_UpdateWithdrawalInfo;
+    /** Requests a payout of the given amount from the account's available referral balance. Use to withdraw earned referral revenue; each call creates a new withdrawal, so do not retry blindly. */
     CreateWithdrawal: ReferralPartnerService_CreateWithdrawal;
+    /** Computes a withdrawal quote for an amount and target currency: total fee, source and target amounts and optionally a payout form. Use to preview fees and conversion before create_referral_withdrawal. */
     GetWithdrawalAdditionalInfo: ReferralPartnerService_GetWithdrawalAdditionalInfo;
+    /** Lists the currencies available for referral withdrawals, with code, display name and whether decimals are supported. Use to populate the withdrawal currency selector. */
     GetCurrencies: ReferralPartnerService_GetCurrencies;
 }
 export type GetRequest = {};
@@ -46,16 +54,21 @@ export type GetTotalStatisticsResponse = {
     membersCount: number;
 };
 export type UpdateWithdrawalInfoRequest = {
+    /** Payout destination details (e.g. bank or PayPal info) saved on the partner profile. */
     withdrawalInfo?: string;
 };
 export type UpdateWithdrawalInfoResponse = {};
 export type CreateWithdrawalRequest = {
+    /** Amount to withdraw from the available referral balance. */
     amount?: number;
 };
 export type CreateWithdrawalResponse = {};
 export type GetWithdrawalAdditionalInfoRequest = {
+    /** Withdrawal amount to quote fees and conversion for. */
     amount?: number;
+    /** Target payout currency code (see list_referral_currencies). */
     currency?: string;
+    /** When true, also returns a prefilled payout form in the response. */
     withForm?: boolean;
 };
 export type GetWithdrawalAdditionalInfoResponse = {

package/restrictions.d.ts

@@ -2,6 +2,7 @@ import { RpcMethod } from './commonTypes';
 import { RestrictionValue as pushwoosh_objects_restrictionValues_v1_RestrictionValue } from './pushwoosh_objects_restrictionValues_v1';
 export type RestrictionsService_GetRestrictionValues = RpcMethod<GetRestrictionValuesRequest, GetRestrictionValuesResponse>;
 export interface RestrictionsService {
+    /** Returns the current authenticated account's plan restriction values (feature limits and quotas such as allowed applications, subscribers or messages). Use to check what caps apply to the account before offering or gating a feature. */
     GetRestrictionValues: RestrictionsService_GetRestrictionValues;
 }
 export type GetRestrictionValuesRequest = {};

package/rich_medias.d.ts

@@ -14,28 +14,33 @@ export type RichMediaService_GetSendChannels = RpcMethod<GetSendChannelsRequest,
 export type RichMediaService_GetDevices = RpcMethod<GetDevicesRequest, GetDevicesResponse>;
 export type RichMediaService_GetEvents = RpcMethod<GetEventsRequest, GetEventsResponse>;
 export interface RichMediaService {
+    /** Creates a new rich media for the account, either block-based (built from an empty template) or from an uploaded base64 zip; the server persists it and returns the generated rich media code. Use for HTML/zip rich media; use create_native_rich_media for SDK-rendered native content. */
     Create: RichMediaService_Create;
-    /**
-     * Create new native Rich Media. The server validates the payload and builds the zip archive
-     * (native-config.json + pushwoosh.json) from the request fields.
-     * Rich Media code will be generated by server and returned in response.
-     */
+    /** Creates a new native (SDK-rendered) rich media from a native-config.json content object plus localizations, returning the generated rich media code. Use for native display types (modal, carousel, stories, etc.); use create_rich_media for HTML/zip content. */
     CreateNative: RichMediaService_CreateNative;
-    /**
-     * Update existing native Rich Media, replacing its content.
-     * Fails if the Rich Media is not of the NATIVE created type.
-     */
+    /** Replaces the content, name and localizations of an existing native rich media identified by code. Fails if the rich media is not of the NATIVE created type; use save_rich_media_block_template for HTML/block-based content. */
     UpdateNative: RichMediaService_UpdateNative;
+    /** Duplicates an existing rich media (by code) under a new name, copying its content, and returns the new rich media code. Use to start a new rich media from an existing one without editing the original. */
     Clone: RichMediaService_Clone;
+    /** Permanently deletes a rich media by code, removing its DB record and content files. Rejected if any in-app message still references it; detach those in-apps first. */
     Delete: RichMediaService_Delete;
+    /** Returns a single rich media by code, including its rendered content (index.html or native-config.json), params, created type and metadata. Use to inspect one rich media; use list_rich_medias to browse. */
     Get: RichMediaService_Get;
+    /** Returns the block-editor payload of a rich media by code: html, editor_json, params, input_groups and default language extracted from its zip. Use to load a rich media into the block/AI builder for editing. */
     GetBlockTemplate: RichMediaService_GetBlockTemplate;
+    /** Saves block/AI-builder rich media content (html, editor_json, localization) for an existing rich media code, overwriting its stored zip. Rejects native rich media (use update_native_rich_media instead). */
     SaveBlockTemplate: RichMediaService_SaveBlockTemplate;
+    /** Lists an account's rich medias with paging, free-text search over name and code, category filter, and last-month aggregate metrics per item. Use to browse rich medias or find a code before fetching details or statistics. */
     List: RichMediaService_List;
+    /** Returns time-series show/interaction/skip metrics for one rich media (by code) over a date range, broken down by platform and aggregation interval, plus frequency-capping suppression counts. Use for the rich media statistics chart. */
     GetDetailedStatistics: RichMediaService_GetDetailedStatistics;
+    /** Returns per-element (element_id/path) action counts for a rich media by code over a date range, split by action type (click, form submit, open, close) and platform. Use to see which elements users interacted with. */
     GetDetailedActionStatistics: RichMediaService_GetDetailedActionStatistics;
+    /** Lists the send channels (in-app, journey, push messages) that used a rich media by code over a date range, with per-channel triggered counts, paged. Use to see where a rich media was delivered. */
     GetSendChannels: RichMediaService_GetSendChannels;
+    /** Lists the devices (hwid, platform, open time) that were shown a rich media by code over a date range, paged. Use to inspect the exact devices that saw a rich media. */
     GetDevices: RichMediaService_GetDevices;
+    /** Returns per-event triggered and unique-triggered counts fired from within a rich media by code over a date range, by platform. Use to measure custom events emitted by a rich media's content. */
     GetEvents: RichMediaService_GetEvents;
 }
 export type ActionType = 'ACTION_TYPE_UNSPECIFIED' | 'ELEMENT_CLICK' | 'FORM_SUBMIT' | 'OPEN' | 'CLOSE';
@@ -84,7 +89,9 @@ export type RichMedia = {
     closeButtonType: boolean;
 };
 export type GetRequest = {
+    /** Application code (format XXXXX-XXXXX). */
     application?: string;
+    /** Rich media code to fetch. */
     code?: string;
 };
 export type GetResponse = {
@@ -94,13 +101,16 @@ export type ListRequest_ListView = 'LIST' | 'TILES';
 export type ListRequest_OrderBy = 'CREATED_DATE';
 export type ListRequest_OrderType = 'ASC' | 'DESC';
 export type ListRequest = {
+    /** Free-text search over rich media name and code. */
     search?: string;
+    /** Application code (format XXXXX-XXXXX); scopes metrics. */
     application?: string;
     viewType?: ListRequest_ListView;
     withMetrics?: boolean;
     withContent?: boolean;
-    /** in ['category'] */
+    /** Restrict to rich medias in these categories. */
     searchByCategory?: string[];
+    /** Restrict to these rich media codes. */
     codes?: string[];
     orderBy?: ListRequest_OrderBy;
     orderType?: ListRequest_OrderType;
@@ -122,10 +132,15 @@ export type GetDetailedStatisticsRequest = {
     application?: string;
     dateFrom?: Date;
     dateTo?: Date;
+    /** Restrict stats to these send channels (in-app, journey, push). */
     sendChannels?: RichMediaSendChannel[];
+    /** Restrict stats to these platform ids. */
     platforms?: number[];
+    /** Scope stats to a single message send by its message code. */
     messageCode?: string;
+    /** Scope stats to a whole campaign by its campaign code. */
     campaignCode?: string;
+    /** Scope stats to a single in-app by its in-app code. */
     inAppCode?: string;
     aggregationInterval?: AggregationInterval;
 };
@@ -146,10 +161,15 @@ export type GetDetailedActionStatisticsRequest = {
     application?: string;
     dateFrom?: Date;
     dateTo?: Date;
+    /** Restrict stats to these send channels (in-app, journey, push). */
     sendChannels?: RichMediaSendChannel[];
+    /** Restrict stats to these platform ids. */
     platforms?: number[];
+    /** Scope stats to a single message send by its message code. */
     messageCode?: string;
+    /** Scope stats to a whole campaign by its campaign code. */
     campaignCode?: string;
+    /** Scope stats to a single in-app by its in-app code. */
     inAppCode?: string;
     aggregationInterval?: AggregationInterval;
 };
@@ -175,10 +195,15 @@ export type GetSendChannelsRequest = {
     application?: string;
     dateFrom?: Date;
     dateTo?: Date;
+    /** Restrict stats to these send channels (in-app, journey, push). */
     sendChannels?: RichMediaSendChannel[];
+    /** Restrict stats to these platform ids. */
     platforms?: number[];
+    /** Scope stats to a single message send by its message code. */
     messageCode?: string;
+    /** Scope stats to a whole campaign by its campaign code. */
     campaignCode?: string;
+    /** Scope stats to a single in-app by its in-app code. */
     inAppCode?: string;
     page?: number;
     perPage?: number;
@@ -202,10 +227,15 @@ export type GetDevicesRequest = {
     application?: string;
     dateFrom?: Date;
     dateTo?: Date;
+    /** Restrict stats to these send channels (in-app, journey, push). */
     sendChannels?: RichMediaSendChannel[];
+    /** Restrict stats to these platform ids. */
     platforms?: number[];
+    /** Scope stats to a single message send by its message code. */
     messageCode?: string;
+    /** Scope stats to a whole campaign by its campaign code. */
     campaignCode?: string;
+    /** Scope stats to a single in-app by its in-app code. */
     inAppCode?: string;
     page?: number;
     perPage?: number;
@@ -225,10 +255,15 @@ export type GetEventsRequest = {
     application?: string;
     dateFrom?: Date;
     dateTo?: Date;
+    /** Restrict stats to these send channels (in-app, journey, push). */
     sendChannels?: RichMediaSendChannel[];
+    /** Restrict stats to these platform ids. */
     platforms?: number[];
+    /** Scope stats to a single message send by its message code. */
     messageCode?: string;
+    /** Scope stats to a whole campaign by its campaign code. */
     campaignCode?: string;
+    /** Scope stats to a single in-app by its in-app code. */
     inAppCode?: string;
 };
 export type GetEventsResponse_EventStatistics = {
@@ -242,9 +277,13 @@ export type GetEventsResponse = {
 };
 export type CreateRequest_RichMediaType = 'BLOCK_BASED' | 'ZIP';
 export type CreateRequest = {
+    /** Name of the rich media. */
     name?: string;
+    /** BLOCK_BASED starts an empty block-editor template; ZIP imports from zip_content. */
     type?: CreateRequest_RichMediaType;
+    /** Whether the rich media shows a close button. */
     closeButtonType?: boolean;
+    /** Base64-encoded zip archive (must contain index.html, or native-config.json + pushwoosh.json). Used only when type is ZIP. */
     zipContent?: string;
 };
 export type CreateResponse = {
@@ -252,7 +291,7 @@ export type CreateResponse = {
     isBlockBased: boolean;
 };
 export type CreateNativeRequest = {
-    /** Name of Rich Media. */
+    /** Name of rich media. */
     name?: string;
     /** Content of native-config.json: json object with displayType and the matching display block. */
     content?: string;
@@ -266,13 +305,13 @@ export type CreateNativeRequest = {
     defaultLanguage?: string;
 };
 export type CreateNativeResponse = {
-    /** Code of the created Rich Media. */
+    /** Code of the created rich media. */
     code: string;
 };
 export type UpdateNativeRequest = {
-    /** Code of the Rich Media to update. Must be of NATIVE created type. */
+    /** Code of the rich media to update. Must be of NATIVE created type. */
     code?: string;
-    /** Name of Rich Media. */
+    /** Name of rich media. */
     name?: string;
     /** Content of native-config.json: json object with displayType and the matching display block. */
     content?: string;
@@ -286,11 +325,13 @@ export type UpdateNativeRequest = {
     defaultLanguage?: string;
 };
 export type UpdateNativeResponse = {
-    /** Code of the updated Rich Media. */
+    /** Code of the updated rich media. */
     code: string;
 };
 export type CloneRequest = {
+    /** Rich media code to duplicate. */
     code?: string;
+    /** Name for the new cloned rich media. */
     name?: string;
 };
 export type CloneResponse = {
@@ -298,10 +339,12 @@ export type CloneResponse = {
     isBlockBased: boolean;
 };
 export type DeleteRequest = {
+    /** Rich media code to delete. */
     code?: string;
 };
 export type DeleteResponse = {};
 export type GetBlockTemplateRequest = {
+    /** Rich media code whose block-editor payload to return. */
     code?: string;
 };
 export type GetBlockTemplateResponse = {
@@ -317,15 +360,23 @@ export type GetBlockTemplateResponse = {
     createdType: RichMedia_CreatedType;
 };
 export type SaveBlockTemplateRequest = {
+    /** Rich media code to overwrite. */
     code?: string;
+    /** Name of the rich media. */
     name?: string;
+    /** Rendered HTML written to index.html; required. */
     html?: string;
+    /** Builder design JSON stored in editor.json: an Unlayer design for BUILDER, an AI-builder document for SMARTCARDS. */
     editorJson?: string;
+    /** JSON object of per-language texts; required. */
     localization?: string;
+    /** Default language code, e.g. "en"; falls back to the first localization key if not present. */
     defaultLanguage?: string;
     styleSettings?: string;
+    /** Whether the rich media shows a close button. */
     closeButtonType?: boolean;
     inputGroups?: string;
+    /** Editor type: TEMPLATE, BUILDER (Unlayer) or SMARTCARDS (AI builder). NATIVE is rejected here. */
     createdType?: RichMedia_CreatedType;
 };
 export type SaveBlockTemplateResponse = {

package/segment_statistics.d.ts

@@ -3,16 +3,22 @@ export type SegmentStatisticsService_Prepare = RpcMethod<PrepareRequest, Prepare
 export type SegmentStatisticsService_Status = RpcMethod<StatusRequest, StatusResponse>;
 export type SegmentStatisticsService_GetSegmentSizeChanges = RpcMethod<GetSegmentSizeChangesRequest, GetSegmentSizeChangesResponse>;
 export interface SegmentStatisticsService {
+    /** Kicks off (or refreshes) background size calculation for the given segments of an application, so their sizes and history can later be read. Call this before get_segment_statistics_status / get_segment_size_changes to make sure the numbers are up to date. */
     Prepare: SegmentStatisticsService_Prepare;
+    /** Returns the calculation status (prepared, not_prepared, in_process or failed) and last-updated time for each prepared segment of an application. Use to poll whether a prepare_segment_statistics run has finished before reading sizes. */
     Status: SegmentStatisticsService_Status;
+    /** Returns a time series of how one segment's size changed (per-interval increase, decrease and net, plus running totals) over a time range. Use to chart audience growth for a single segment; the segment must have been prepared first. */
     GetSegmentSizeChanges: SegmentStatisticsService_GetSegmentSizeChanges;
 }
 export type PrepareRequest = {
+    /** Segment (filter) codes to prepare statistics for. */
     segments?: string[];
+    /** Application code (format XXXXX-XXXXX) that owns the segments. */
     application?: string;
 };
 export type PrepareResponse = {};
 export type StatusRequest = {
+    /** Application code (format XXXXX-XXXXX) whose prepared segments' statuses to return. */
     application?: string;
 };
 export type StatusResponse_Status = 'unknown' | 'prepared' | 'not_prepared' | 'in_process' | 'failed';
@@ -25,7 +31,9 @@ export type StatusResponse = {
     segments: StatusResponse_SegmentStatus[];
 };
 export type GetSegmentSizeChangesRequest = {
+    /** Application code (format XXXXX-XXXXX) that owns the segment. */
     application?: string;
+    /** Segment (filter) code whose size-change history to return. */
     filter?: string;
     timestampFrom?: Date;
     timestampTo?: Date;