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

package/send_rate.d.ts

@@ -2,7 +2,9 @@ import { RpcMethod } from './commonTypes';
 export type SendRateService_Get = RpcMethod<GetSendRateRequest, GetSendRateResponse>;
 export type SendRateService_Update = RpcMethod<UpdateSendRateRequest, UpdateSendRateResponse>;
 export interface SendRateService {
+    /** Returns the per-channel send-rate throttling limits (push, email, SMS, in-app) configured for an application, each as a count-per-seconds pair. Use to inspect how fast an application code XXXXX-XXXXX is allowed to dispatch messages before calling update_send_rate. */
     Get: SendRateService_Get;
+    /** Sets the per-channel send-rate throttling limits (push, email, SMS, in-app) for an application, creating the record if none exists and overwriting only the channels supplied. Use to change how many messages per second an application code XXXXX-XXXXX may dispatch. */
     Update: SendRateService_Update;
 }
 export type Info = {
@@ -16,6 +18,7 @@ export type SendRate = {
     inApp: Info;
 };
 export type GetSendRateRequest = {
+    /** Application code (XXXXX-XXXXX) whose send-rate limits to read. */
     application?: string;
 };
 export type GetSendRateResponse = {
@@ -32,10 +35,15 @@ export type CreateSendRateResponse = {
     sendRate: SendRate;
 };
 export type UpdateSendRateRequest = {
+    /** Application code (XXXXX-XXXXX) whose send-rate limits to set. */
     application?: string;
+    /** Push send-rate limit as count messages per seconds; omit to leave the push limit unchanged. */
     push?: Info;
+    /** Email send-rate limit as count messages per seconds; omit to leave the email limit unchanged. */
     email?: Info;
+    /** SMS send-rate limit as count messages per seconds; omit to leave the SMS limit unchanged. */
     sms?: Info;
+    /** In-app send-rate limit as count messages per seconds; omit to leave the in-app limit unchanged. */
     inApp?: Info;
 };
 export type UpdateSendRateResponse = {};

package/sms_presets.d.ts

@@ -5,23 +5,29 @@ export type smsPresetsService_Create = RpcMethod<CreateSmsPresetRequest, CreateS
 export type smsPresetsService_Update = RpcMethod<UpdateSmsPresetRequest, UpdateSmsPresetResponse>;
 export type smsPresetsService_Delete = RpcMethod<DeleteSmsPresetRequest, DeleteSmsPresetResponse>;
 export interface smsPresetsService {
+    /** Lists SMS presets (reusable SMS message templates) for an application, with paging, ordering and optional name/category filters. Use to browse presets or find an SMS preset code before fetching, updating or deleting one. */
     List: smsPresetsService_List;
+    /** Returns a single SMS preset by its preset code, including name, categories and per-locale content. Use after list_sms_presets to inspect one template. */
     Get: smsPresetsService_Get;
+    /** Creates a new SMS preset (reusable SMS template) in an application from a name, categories and per-locale content, returning the generated preset code. Additive — each call creates a distinct preset. */
     Create: smsPresetsService_Create;
+    /** Updates an existing SMS preset identified by its preset code, overwriting name, categories and per-locale content. Use to edit a template found via list_sms_presets. */
     Update: smsPresetsService_Update;
+    /** Permanently deletes an SMS preset by its preset code. Fails if the preset is used by a running or paused journey; deletion cannot be undone. */
     Delete: smsPresetsService_Delete;
 }
 export type ListSmsPresetsRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListSmsPresetsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListSmsPresetsRequest = {
+    /** Application code (XXXXX-XXXXX) whose SMS presets to list. */
     application?: string;
     orderBy?: ListSmsPresetsRequest_OrderBy;
     orderDirection?: ListSmsPresetsRequest_OrderDirection;
     page?: number;
     perPage?: number;
-    /** like %name% */
+    /** Free-text filter matched (case-insensitive substring) against preset name and code. */
     searchByName?: string;
-    /** in ['category'] */
+    /** Keep only presets tagged with one of these category names. */
     searchByCategory?: string[];
 };
 export type SmsPreset = {
@@ -40,12 +46,14 @@ export type ListSmsPresetsResponse = {
     total: number;
 };
 export type GetSmsPresetRequest = {
+    /** SMS preset code identifying the preset to fetch. */
     code?: string;
 };
 export type GetSmsPresetResponse = {
     preset: SmsPreset;
 };
 export type CreateSmsPresetRequest = {
+    /** Application code (XXXXX-XXXXX) the new preset belongs to. */
     application?: string;
     name?: string;
     categories?: string[];
@@ -56,6 +64,7 @@ export type CreateSmsPresetResponse = {
     preset: SmsPreset;
 };
 export type UpdateSmsPresetRequest = {
+    /** SMS preset code identifying the preset to update. */
     code?: string;
     name?: string;
     categories?: string[];
@@ -66,6 +75,7 @@ export type UpdateSmsPresetResponse = {
     preset: SmsPreset;
 };
 export type DeleteSmsPresetRequest = {
+    /** SMS preset code identifying the preset to delete. */
     code?: string;
 };
 export type DeleteSmsPresetResponse = {};

package/statistics_dashboards.d.ts

@@ -7,11 +7,17 @@ export type StatisticsDashboardsService_Update = RpcMethod<UpdateDashboardReques
 export type StatisticsDashboardsService_Delete = RpcMethod<DeleteDashboardRequest, DeleteDashboardResponse>;
 export type StatisticsDashboardsService_WidgetsList = RpcMethod<WidgetsListRequest, WidgetsListResponse>;
 export interface StatisticsDashboardsService {
+    /** Returns a single statistics dashboard by its dashboard code, with name and created/updated timestamps. Use to inspect one dashboard found via list_dashboards. */
     Load: StatisticsDashboardsService_Load;
+    /** Lists statistics dashboards of an application (application code XXXXX-XXXXX), sorted by name, with an optional free-text name filter. Use to browse dashboards or find a dashboard code before loading it or its widgets. */
     List: StatisticsDashboardsService_List;
+    /** Creates a new empty statistics dashboard with the given name in an application (application code XXXXX-XXXXX) and returns its generated code. Use to start a new dashboard before adding widgets. */
     Create: StatisticsDashboardsService_Create;
+    /** Renames an existing statistics dashboard identified by its dashboard code and bumps its updated timestamp. Use to change a dashboard's display name; overwrites the current name. */
     Update: StatisticsDashboardsService_Update;
+    /** Permanently deletes a statistics dashboard by its dashboard code. Irreversible; a second call for the same code errors because the dashboard no longer exists. */
     Delete: StatisticsDashboardsService_Delete;
+    /** Lists the widgets belonging to a statistics dashboard (by dashboard code), with their type, size, position and params. Legacy endpoint kept for older frontend clients; prefer the StatisticsDashboardsWidgets service for widget access. */
     WidgetsList: StatisticsDashboardsService_WidgetsList;
 }
 export type Dashboard = {
@@ -21,32 +27,41 @@ export type Dashboard = {
     updated: Date;
 };
 export type LoadDashboardRequest = {
+    /** Dashboard code to load. */
     code?: string;
 };
 export type ListDashboardRequest = {
+    /** Application code (XXXXX-XXXXX) whose dashboards to list. */
     application?: string;
+    /** Optional free-text substring; case-insensitively matches the dashboard name. */
     searchByName?: string;
 };
 export type ListDashboardResponse = {
     dashboards: Dashboard[];
 };
 export type CreateDashboardRequest = {
+    /** Display name for the new dashboard (max 128 characters). */
     name?: string;
+    /** Application code (XXXXX-XXXXX) the dashboard belongs to. */
     application?: string;
 };
 export type CreateDashboardResponse = {
     dashboard: Dashboard;
 };
 export type UpdateDashboardRequest = {
+    /** Dashboard code to update. */
     code?: string;
+    /** New display name (max 128 characters). */
     name?: string;
 };
 export type UpdateDashboardResponse = {};
 export type DeleteDashboardRequest = {
+    /** Dashboard code to delete. */
     code?: string;
 };
 export type DeleteDashboardResponse = {};
 export type WidgetsListRequest = {
+    /** Dashboard code whose widgets to list. */
     code?: string;
 };
 export type WidgetsListResponse = {

package/statistics_dashboards_widgets.d.ts

@@ -23,23 +23,25 @@ export type StatisticsDashboardsWidgetsService_GetCategoryTree = RpcMethod<GetCa
  * - If a breakdown is applied to a chart, that chart MUST display ONLY ONE metric.
  */
 export interface StatisticsDashboardsWidgetsService {
-    /** Load retrieves a single dashboard widget by its unique code identifier. */
+    /** Retrieves a single statistics dashboard widget (chart) by its widget code, including its metrics, filters and visualization settings. Use after list_dashboard_widgets to inspect one chart's full configuration. */
     Load: StatisticsDashboardsWidgetsService_Load;
-    /** List retrieves all widgets belonging to a specific dashboard. */
+    /** Lists all widgets (charts) belonging to a statistics dashboard, ordered by index_number. Use to enumerate a dashboard's charts before loading, updating or deleting one. */
     List: StatisticsDashboardsWidgetsService_List;
-    /** Create adds a new widget (chart) to a dashboard with specified metrics, filters, and visualization settings. */
+    /** Adds a new widget (chart) to a statistics dashboard for an application, with its metrics, filters, size and visualization type. Each call creates a distinct widget with a new generated code. */
     Create: StatisticsDashboardsWidgetsService_Create;
-    /** Update modifies an existing widget's configuration, including its name, type, size, metrics, and filters. */
+    /** Updates an existing dashboard widget identified by its widget code, overwriting the supplied name, type, size, index and chart params. Only non-empty fields are applied; re-sending the same values yields the same widget state. */
     Update: StatisticsDashboardsWidgetsService_Update;
-    /** Delete removes a widget from the dashboard permanently. */
+    /** Permanently removes a widget (chart) from its dashboard by widget code. Irreversible; a second call for the same code fails because the widget no longer exists. */
     Delete: StatisticsDashboardsWidgetsService_Delete;
-    /** GetLinearChartMetrics fetches time-series data for line and bar charts, returning data points over time. */
+    /** Fetches time-series data points over the requested time range for a chart's metrics, for rendering line and bar charts. Use for LINE/BARS widgets; use get_dashboard_widget_totals for pie/number aggregates and get_dashboard_widget_funnel for funnels. */
     GetLinearChartMetrics: StatisticsDashboardsWidgetsService_GetLinearChartMetrics;
-    /** GetTotalsChartMetrics fetches aggregated total values for pie charts and single-value metric widgets. */
+    /** Fetches aggregated total values (one number per metric/breakdown) for the requested time range, for pie charts and single-value NUMBER widgets. Use for PIE/NUMBER widgets instead of the linear (time-series) variant. */
     GetTotalsChartMetrics: StatisticsDashboardsWidgetsService_GetTotalsChartMetrics;
-    /** GetFunnel fetches funnel data showing sequential step conversion rates and user drop-off. */
+    /** Fetches funnel data (per-step user counts and conversion percentages) where the chart's metrics list defines the sequential funnel steps. Use for FUNNEL widgets to see drop-off between steps. */
     GetFunnel: StatisticsDashboardsWidgetsService_GetFunnel;
     /**
+     * Returns the hierarchical tree of standard metrics plus the application's custom events and account tags that can be selected when configuring a widget. Call first to discover valid metric IDs, event names, value types and available filters before creating or updating a widget.
+     *
      * GetCategoryTree returns the hierarchical tree of all available metrics, events, and tags that can be selected in widgets.
      * This includes:
      * - Standard metrics from the "Metrics tree" (Push Sends, Email Opens, Subscribers, DAU, MAU, etc.)

package/subscription_prompt.d.ts

@@ -4,23 +4,31 @@ export type SubscriptionPromptService_SetUseCase = RpcMethod<SetUseCaseRequest,
 export type SubscriptionPromptService_GetWidget = RpcMethod<GetWidgetRequest, GetWidgetResponse>;
 export type SubscriptionPromptService_SetWidget = RpcMethod<SetWidgetRequest, SetWidgetResponse>;
 export interface SubscriptionPromptService {
+    /** Returns the subscription-prompt use case configured for an application (one of not-used, default, topic-based, or not-set when unconfigured). Use to check how an application asks visitors for push permission. */
     GetUseCase: SubscriptionPromptService_GetUseCase;
+    /** Sets the subscription-prompt use case for an application (must be not-used, default or topic-based), overwriting any previous value. Use to switch how the application requests push subscription; get_subscription_prompt_use_case reads the current value. */
     SetUseCase: SubscriptionPromptService_SetUseCase;
+    /** Returns the subscription-prompt widget configured for an application, including its code, type and params, or empty when none is set. Use to inspect the current prompt widget before updating it. */
     GetWidget: SubscriptionPromptService_GetWidget;
+    /** Creates or overwrites the subscription-prompt widget for an application with the given type and params. Use to configure the prompt widget; when the use case is default it also syncs the widget into the application property. */
     SetWidget: SubscriptionPromptService_SetWidget;
 }
 export type GetUseCaseRequest = {
+    /** Application code (XXXXX-XXXXX) whose subscription-prompt use case is read. */
     applicationCode?: string;
 };
 export type GetUseCaseResponse = {
     useCase: string;
 };
 export type SetUseCaseRequest = {
+    /** Application code (XXXXX-XXXXX) whose subscription-prompt use case is set. */
     applicationCode?: string;
+    /** Use case to apply: not-used, default or topic-based. */
     useCase?: string;
 };
 export type SetUseCaseResponse = {};
 export type GetWidgetRequest = {
+    /** Application code (XXXXX-XXXXX) whose subscription-prompt widget is read. */
     applicationCode?: string;
 };
 export type GetWidgetResponse = {
@@ -29,8 +37,11 @@ export type GetWidgetResponse = {
     params: object;
 };
 export type SetWidgetRequest = {
+    /** Application code (XXXXX-XXXXX) whose subscription-prompt widget is created or overwritten. */
     applicationCode?: string;
+    /** Widget type identifier to store for the prompt. */
     type?: string;
+    /** Arbitrary widget configuration stored as JSON params. */
     params?: object;
 };
 export type SetWidgetResponse = {};

package/tags.d.ts

@@ -6,14 +6,21 @@ export type TagsService_List = RpcMethod<ListTagsRequest, ListTagsResponse>;
 export type TagsService_GetTagValues = RpcMethod<GetTagValuesRequest, GetTagValuesResponse>;
 export type TagsService_GetTagUsage = RpcMethod<GetTagUsageRequest, GetTagUsageResponse>;
 export interface TagsService {
+    /** Returns a single account tag (user/device attribute) by name, including its value type and whether it is system-defined or user-specific. Use after list_tags to inspect one tag before editing segments or profiles. */
     Get: TagsService_Get;
+    /** Creates a new account tag with the given name and value type. Fails if a tag of that name already exists; timezone-typed tags cannot be created here. */
     Create: TagsService_Create;
+    /** Permanently deletes an account tag by name. Refuses to delete system or reserved tags, or tags still referenced by any segment, in-app or journey; check get_tag_usage first. */
     Delete: TagsService_Delete;
+    /** Lists the account's tags, newest or name-ordered, with paging, name substring search and an optional type filter. Use to browse tags or find a tag name before fetching values or usage. */
     List: TagsService_List;
+    /** Returns the distinct stored values of a tag in an application with per-value subscriber counts, filtered by substring and paged. Use to see which values a string/list tag actually holds; integer and price tags return no values. */
     GetTagValues: TagsService_GetTagValues;
+    /** Returns the segments, in-apps and journeys that reference a tag by name. Use to find what would break before deleting or editing a tag. */
     GetTagUsage: TagsService_GetTagUsage;
 }
 export type GetTagRequest = {
+    /** Tag name to fetch. */
     name?: string;
 };
 export type Tag_Type = 'UNKNOWN' | 'INTEGER' | 'STRING' | 'LIST' | 'DATE' | 'BOOLEAN' | 'PRICE' | 'VERSION' | 'TIMEZONE';
@@ -25,14 +32,18 @@ export type Tag = {
     hasRightAceModify: boolean;
 };
 export type CreateTagRequest = {
+    /** Tag name to create (letters, digits, spaces and dashes; max 64 chars). */
     name?: string;
+    /** Value type of the tag; TIMEZONE is not allowed here. */
     type?: Tag_Type;
+    /** If true the tag is stored per user id rather than per device. */
     userSpecific?: boolean;
 };
 export type CreateTagResponse = {
     tag: Tag;
 };
 export type DeleteTagRequest = {
+    /** Tag name to delete. */
     name?: string;
 };
 export type DeleteTagResponse = {};
@@ -58,9 +69,11 @@ export type GetTagValuesRequest_OrderBy = 'VALUE' | 'COUNT';
 export type GetTagValuesRequest_OrderDirection = 'ASC' | 'DESC';
 export type GetTagValuesRequest_LikeOperator = 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS';
 export type GetTagValuesRequest = {
+    /** Application code (format XXXXX-XXXXX) whose stored tag values to count. */
     application?: string;
+    /** Tag name whose values to return. */
     name?: string;
-    /** filters values by regexp /.*{value}.*\/ */
+    /** Substring to filter values by, applied per like_op. */
     like?: string;
     likeOp?: GetTagValuesRequest_LikeOperator;
     orderBy?: GetTagValuesRequest_OrderBy;
@@ -82,6 +95,7 @@ export type GetTagValuesResponse = {
     perPage: number;
 };
 export type GetTagUsageRequest = {
+    /** Tag name whose references (segments, in-apps, journeys) to return. */
     name?: string;
 };
 export type GetTagUsageResponse_Journey = {

package/test_devices.d.ts

@@ -4,13 +4,13 @@ export type TestDevicesService_Verify = RpcMethod<VerifyRequest, VerifyResponse>
 export type TestDevicesService_List = RpcMethod<ListRequest, ListResponse>;
 export type TestDevicesService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
 export interface TestDevicesService {
-    /** Create creates a new test device. */
+    /** Registers a test device for an application by push token or HWID; for email, SMS, WhatsApp and LINE platforms it instead sends a verification code to the device and returns needs_verify=true, requiring verify_test_device to finish. Use to add a device that receives test sends. */
     Create: TestDevicesService_Create;
-    /** Verify verifies a new test device for email, SMS and whatsapp plaftorm. */
+    /** Confirms a pending email, SMS, WhatsApp or LINE test device using the verification code sent by create_test_device, then creates the test device record. Use only after create_test_device returned needs_verify=true. */
     Verify: TestDevicesService_Verify;
-    /** List returns a list of test devices for given application. */
+    /** Lists all test devices registered for an application (application code XXXXX-XXXXX) with name, push token, HWID and platform. Use to see which devices receive test sends before adding or removing one. */
     List: TestDevicesService_List;
-    /** Delete deletes an existing test device by application code and push token. */
+    /** Removes a test device from an application by HWID or push token and clears its PW_TestDevice tag on the device. Use to stop a device from receiving test sends; cannot be undone. */
     Delete: TestDevicesService_Delete;
 }
 export type TestDevice = {

package/users.d.ts

@@ -3,11 +3,15 @@ export type UsersService_UpdateUser = RpcMethod<UpdateUserRequest, UpdateUserRes
 export type UsersService_GetMailingSettings = RpcMethod<GetMailingSettingsRequest, GetMailingSettingsResponse>;
 export type UsersService_UpdateMailingSettings = RpcMethod<UpdateMailingSettingsRequest, UpdateMailingSettingsResponse>;
 export interface UsersService {
+    /** Updates the current dashboard user's own profile settings (currently the timezone), validating the value against IANA timezone names. Use to change the signed-in account user's timezone; affects only the caller, not devices or end users. */
     UpdateUser: UsersService_UpdateUser;
+    /** Returns the current dashboard user's email notification (mailing) preferences: newsletters, global daily stats, and per-category system notification toggles. Use to read which Pushwoosh emails the signed-in user has opted into. */
     GetMailingSettings: UsersService_GetMailingSettings;
+    /** Overwrites all of the current dashboard user's email notification (mailing) preferences with the supplied flags, and mirrors the marketing-newsletter opt-in as a device tag. Use to change which Pushwoosh emails the signed-in user receives; every flag is set to the request value, so omitted flags become false. */
     UpdateMailingSettings: UsersService_UpdateMailingSettings;
 }
 export type UpdateUserRequest = {
+    /** IANA timezone name (e.g. Europe/London) to set for the current user; leave empty to keep the existing timezone. */
     timezone?: string;
 };
 export type UpdateUserResponse = {};
@@ -21,11 +25,17 @@ export type GetMailingSettingsResponse = {
     allowNotificationDisablePlatform: boolean;
 };
 export type UpdateMailingSettingsRequest = {
+    /** Opt in to marketing newsletter emails. */
     allowNewsletters?: boolean;
+    /** Opt in to the daily statistics summary email across all applications. */
     allowDailyStatsGlobal?: boolean;
+    /** Opt in to new-subscribers notification emails. */
     allowNotificationSubscribers?: boolean;
+    /** Opt in to iOS certificate/license expiration notification emails. */
     allowNotificationIosLicense?: boolean;
+    /** Opt in to user-inactivity notification emails. */
     allowNotificationUserInactivity?: boolean;
+    /** Opt in to platform-disabled notification emails. */
     allowNotificationDisablePlatform?: boolean;
 };
 export type UpdateMailingSettingsResponse = {

package/viber_presets.d.ts

@@ -1,9 +1,11 @@
 import { RpcMethod } from './commonTypes';
 export type ViberPresetsService_List = RpcMethod<ListViberPresetsRequest, ListViberPresetsResponse>;
 export interface ViberPresetsService {
+    /** Lists approved Viber transactional message templates for an application, fetched live from the external MStat Omni Messaging provider. Use to pick a Viber template code before composing a Viber send; only templates in the approved status are returned. */
     List: ViberPresetsService_List;
 }
 export type ListViberPresetsRequest = {
+    /** Application code (format XXXXX-XXXXX) whose Viber transactional templates are listed. */
     application?: string;
 };
 export type ListViberPresetsResponse = {

package/vouchers.d.ts

@@ -7,31 +7,49 @@ export type VouchersService_GetPoolStats = RpcMethod<GetPoolStatsRequest, GetPoo
 export type VouchersService_DeleteVouchers = RpcMethod<DeleteVouchersRequest, DeleteVouchersResponse>;
 export type VouchersService_DeletePool = RpcMethod<DeletePoolRequest, DeletePoolResponse>;
 export interface VouchersService {
+    /** Lists voucher pools for an application (code XXXXX-XXXXX) with paging and an optional name search, returning each pool's total and free voucher counts. Use to browse pools or find a pool name before fetching stats, exporting, or adding vouchers. */
     GetPools: VouchersService_GetPools;
+    /** Creates a new voucher pool in an application (code XXXXX-XXXXX) with an optional expiry date and optional initial voucher codes. Use to set up a pool; use create_vouchers to add codes to an existing pool. */
     CreatePool: VouchersService_CreatePool;
+    /** Adds voucher codes to an existing pool in an application (code XXXXX-XXXXX), up to 10000 codes per request. Use to top up a pool created earlier; create_voucher_pool creates the pool itself. */
     AddVouchers: VouchersService_AddVouchers;
+    /** Generates a ZIP containing a CSV of every voucher in a pool (code, status, user id, used-at timestamp) and returns its download URL. Use to download the full contents of a pool for an application (code XXXXX-XXXXX). */
     ExportVouchers: VouchersService_ExportVouchers;
+    /** Returns total and free (unused) voucher counts for a single pool in an application (code XXXXX-XXXXX). Use for a quick availability check on one pool without listing all pools. */
     GetPoolStats: VouchersService_GetPoolStats;
+    /** Deletes specific voucher codes from a pool in an application (code XXXXX-XXXXX), up to 10000 codes per request. Removes only the listed codes; use delete_voucher_pool to remove the whole pool. */
     DeleteVouchers: VouchersService_DeleteVouchers;
+    /** Deletes an entire voucher pool and all of its vouchers from an application (code XXXXX-XXXXX). Irreversible; use delete_vouchers to remove only selected codes. */
     DeletePool: VouchersService_DeletePool;
 }
 export type CreatePoolRequest = {
+    /** Application code (XXXXX-XXXXX) the pool belongs to. */
     application?: string;
+    /** Name for the new voucher pool. */
     name?: string;
+    /** Optional expiry date after which the pool's vouchers are no longer valid; must be in the future. */
     expiry?: Date;
+    /** Optional initial voucher codes to seed the pool with. */
     vouchers?: string[];
 };
 export type CreatePoolResponse = {};
 export type AddVouchersRequest = {
+    /** Application code (XXXXX-XXXXX) the pool belongs to. */
     application?: string;
+    /** Name of the voucher pool to add codes to. */
     pool?: string;
+    /** Voucher codes to add to the pool. */
     vouchers?: string[];
 };
 export type AddVouchersResponse = {};
 export type GetPoolsRequest = {
+    /** Application code (XXXXX-XXXXX) whose pools to list. */
     application?: string;
+    /** Number of pools per page. */
     perPage?: number;
+    /** Zero-based page number. */
     page?: number;
+    /** Optional free-text filter matching pool names. */
     searchByName?: string;
 };
 export type GetPoolsResponse = {
@@ -46,7 +64,9 @@ export type Pool = {
     freeVouchers: number;
 };
 export type ExportVouchersRequest = {
+    /** Application code (XXXXX-XXXXX) the pool belongs to. */
     application?: string;
+    /** Name of the voucher pool to export. */
     pool?: string;
 };
 export type ExportVouchersResponse = {
@@ -54,7 +74,9 @@ export type ExportVouchersResponse = {
     filename: string;
 };
 export type GetPoolStatsRequest = {
+    /** Application code (XXXXX-XXXXX) the pool belongs to. */
     application?: string;
+    /** Name of the voucher pool to get stats for. */
     pool?: string;
 };
 export type GetPoolStatsResponse = {
@@ -62,13 +84,18 @@ export type GetPoolStatsResponse = {
     freeVouchers: number;
 };
 export type DeleteVouchersRequest = {
+    /** Application code (XXXXX-XXXXX) the pool belongs to. */
     application?: string;
+    /** Name of the voucher pool to delete codes from. */
     pool?: string;
+    /** Voucher codes to delete from the pool. */
     vouchers?: string[];
 };
 export type DeleteVouchersResponse = {};
 export type DeletePoolRequest = {
+    /** Application code (XXXXX-XXXXX) the pool belongs to. */
     application?: string;
+    /** Name of the voucher pool to delete. */
     pool?: string;
 };
 export type DeletePoolResponse = {};

package/whatsapp.d.ts

@@ -4,33 +4,37 @@ export type WhatsAppService_RegisterWABATwilio = RpcMethod<RegisterWABATwilioReq
 export type WhatsAppService_AuthResponseCode = RpcMethod<AuthResponseCodeRequest, AuthResponseCodeResponse>;
 export type WhatsAppService_FetchCatalog = RpcMethod<FetchCatalogRequest, FetchCatalogResponse>;
 export interface WhatsAppService {
+    /** Connects a WhatsApp Business Account to an application code via Meta Cloud API, storing the WABA and phone-number IDs, subscribing the number to Pushwoosh webhooks and registering it with Meta. Use for direct Meta onboarding; use connect_whatsapp_account_twilio for Twilio-routed senders. */
     RegisterWABA: WhatsAppService_RegisterWABA;
+    /** Connects a WhatsApp Business Account through Twilio for an application code, provisioning a Twilio subaccount, messaging service and sender. Use when the WhatsApp number is routed via Twilio rather than Meta Cloud API directly. */
     RegisterWABATwilio: WhatsAppService_RegisterWABATwilio;
-    /**
-     * When the user completes the login dialog flow we will redirect the user to your redirect URL and include a code.
-     * You must then exchange this code for an access token by performing a server-to-server call to Meta servers.
-     */
+    /** Completes WhatsApp embedded signup by exchanging the Meta OAuth authorization code for an access token and storing it on the application code. Call after the Meta login dialog redirects back with a code, before connect_whatsapp_account. */
     AuthResponseCode: WhatsAppService_AuthResponseCode;
-    /** Fetch WhatsApp Business catalog and its products */
+    /** Returns the WhatsApp Business catalog and its products for an application code by querying Meta. Use to list products available for WhatsApp product messages; a WABA has at most one catalog. */
     FetchCatalog: WhatsAppService_FetchCatalog;
 }
 export type RegisterWABARequest = {
     /** application code */
     application?: string;
+    /** WhatsApp Business Account (WABA) ID from Meta */
     wabaId?: string;
+    /** Meta phone number ID of the WhatsApp sender */
     phonenumberId?: string;
 };
 export type RegisterWABAResponse = {};
 export type AuthResponseCodeRequest = {
     /** application code */
     application?: string;
+    /** OAuth authorization code returned by the Meta login dialog */
     code?: string;
 };
 export type AuthResponseCodeResponse = {};
 export type RegisterWABATwilioRequest = {
     /** application code */
     application?: string;
+    /** WhatsApp Business Account (WABA) ID from Meta */
     wabaId?: string;
+    /** Meta phone number ID of the WhatsApp sender */
     phonenumberId?: string;
 };
 export type RegisterWABATwilioResponse = {};

package/whatsapp_presets.d.ts

@@ -2,12 +2,15 @@ import { RpcMethod } from './commonTypes';
 export type WhatsAppPresetsService_List = RpcMethod<ListWhatsAppPresetsRequest, ListWhatsAppPresetsResponse>;
 export type WhatsAppPresetsService_Get = RpcMethod<GetWhatsAppPresetRequest, GetWhatsAppPresetResponse>;
 export interface WhatsAppPresetsService {
+    /** Lists APPROVED WhatsApp message templates (presets) for an application by querying the Meta WhatsApp Business API, optionally filtered by name or body content. Use to browse a project's WhatsApp presets or find a preset code before fetching one with get_whatsapp_preset. */
     List: WhatsAppPresetsService_List;
+    /** Returns a single WhatsApp preset by its code (template name, format templateName:language) from the Meta WhatsApp Business API, including body text, header, buttons and variables. Use after list_whatsapp_presets to inspect one preset. */
     Get: WhatsAppPresetsService_Get;
 }
 export type ListWhatsAppPresetsRequest = {
+    /** Application code (format XXXXX-XXXXX) whose WhatsApp presets to list; must have the WhatsApp platform configured. */
     application?: string;
-    /** like %name% or content */
+    /** Free-text filter matched against preset name or body content (Meta name_or_content). */
     searchByName?: string;
 };
 export type WhatsAppPreset = {
@@ -44,7 +47,9 @@ export type ListWhatsAppPresetsResponse = {
     total: number;
 };
 export type GetWhatsAppPresetRequest = {
+    /** Preset code (WhatsApp template name, format templateName:language) to fetch. */
     code?: string;
+    /** Application code (format XXXXX-XXXXX) the preset belongs to; must have the WhatsApp platform configured. */
     application?: string;
 };
 export type GetWhatsAppPresetResponse = {