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

package/applications_email_froms.d.ts

@@ -4,19 +4,26 @@ export type ApplicationEmailFromsService_Use = RpcMethod<UseRequest, UseResponse
 export type ApplicationEmailFromsService_GetEmailFooter = RpcMethod<GetEmailFooterRequest, GetEmailFooterResponse>;
 export type ApplicationEmailFromsService_SetEmailFooter = RpcMethod<SetEmailFooterRequest, SetEmailFooterResponse>;
 export interface ApplicationEmailFromsService {
+    /** Lists the sender ("From") email addresses previously used for an application's email sends, most-recently-used first. Use to populate the From-address picker before composing an email or calling use_email_from. */
     List: ApplicationEmailFromsService_List;
+    /** Records a sender ("From") email address for an application: bumps its last-used time if it already exists, otherwise validates its syntax and creates it. Call when a user picks or enters a From address so it appears in list_email_froms. */
     Use: ApplicationEmailFromsService_Use;
+    /** Returns the configured email footer (company name, address, copyright, unsubscribe label, nav/social links, app-store badges) for an application, or empty if none is set. Use before rendering or editing the footer shown at the bottom of the app's emails. */
     GetEmailFooter: ApplicationEmailFromsService_GetEmailFooter;
+    /** Creates or overwrites the email footer configuration for an application (company name, address, copyright, links, social, app-store badges). Use to save footer edits; replaces any existing footer and requires application-management permission. */
     SetEmailFooter: ApplicationEmailFromsService_SetEmailFooter;
 }
 export type ListRequest = {
+    /** Application code (format XXXXX-XXXXX) whose From addresses to list. */
     application?: string;
 };
 export type ListResponse = {
     emails: string[];
 };
 export type UseRequest = {
+    /** Application code (format XXXXX-XXXXX) to record the From address for. */
     application?: string;
+    /** Sender ("From") email address to record; validated for syntax when new. */
     email?: string;
 };
 export type UseResponse = {};
@@ -44,13 +51,16 @@ export type EmailFooter = {
     appBadges: AppBadge[];
 };
 export type GetEmailFooterRequest = {
+    /** Application code (format XXXXX-XXXXX) whose email footer to fetch. */
     application?: string;
 };
 export type GetEmailFooterResponse = {
     footer: EmailFooter;
 };
 export type SetEmailFooterRequest = {
+    /** Application code (format XXXXX-XXXXX) whose email footer to save. */
     application?: string;
+    /** Footer configuration to store; overwrites the current footer (omit to clear). */
     footer?: EmailFooter;
 };
 export type SetEmailFooterResponse = {};

package/applications_groups.d.ts

@@ -5,10 +5,15 @@ export type ApplicationsGroupsService_Create = RpcMethod<CreateApplicationsGroup
 export type ApplicationsGroupsService_Update = RpcMethod<UpdateApplicationsGroupRequest, UpdateApplicationsGroupResponse>;
 export type ApplicationsGroupsService_Delete = RpcMethod<DeleteApplicationsGroupRequest, DeleteApplicationsGroupResponse>;
 export interface ApplicationsGroupsService {
+    /** Returns a single application group by its group code, including the title and its member application codes ordered highest-priority first. Use to inspect one group after list_applications_groups. */
     GetByCode: ApplicationsGroupsService_GetByCode;
+    /** Lists the account's application groups, ordered by title or creation date, with paging and an optional title substring search. Use to browse groups or find a group code before fetching or editing one. */
     List: ApplicationsGroupsService_List;
+    /** Creates an application group with a title and an ordered list of member application codes (first = highest priority), and grants the account's existing API tokens message rights on the new group. Returns the new group code. */
     Create: ApplicationsGroupsService_Create;
+    /** Overwrites an application group's title and its ordered member application list (first = highest priority), replacing all previous members. Use to rename a group or change which applications belong to it. */
     Update: ApplicationsGroupsService_Update;
+    /** Deletes an application group by group code, removing its member application links and revoking the group from the account's API token restrictions. The group cannot be recovered. */
     Delete: ApplicationsGroupsService_Delete;
 }
 export type ApplicationsGroup_Application = {
@@ -22,6 +27,7 @@ export type ApplicationsGroup = {
     applications: ApplicationsGroup_Application[];
 };
 export type GetApplicationsGroupByCodeRequest = {
+    /** Application group code of the group to fetch. */
     code?: string;
 };
 export type ListApplicationsGroupsRequest_OrderBy = 'TITLE' | 'CREATED';
@@ -31,6 +37,7 @@ export type ListApplicationsGroupsRequest = {
     perPage?: number;
     orderBy?: ListApplicationsGroupsRequest_OrderBy;
     orderDirection?: ListApplicationsGroupsRequest_OrderDirection;
+    /** Case-insensitive substring match on the group title. */
     searchByTitle?: string;
 };
 export type ListApplicationsGroupsResponse = {
@@ -40,21 +47,25 @@ export type ListApplicationsGroupsResponse = {
     totalPages: number;
 };
 export type CreateApplicationsGroupRequest = {
+    /** Group title (max 32 characters; must not contain < > or &). */
     title?: string;
-    /** priority is determined by the order of the apps (highest first) */
+    /** Member application codes (format XXXXX-XXXXX); list order sets priority, first = highest. */
     applications?: string[];
 };
 export type CreateApplicationsGroupResponse = {
     code: string;
 };
 export type UpdateApplicationsGroupRequest = {
+    /** Application group code of the group to update. */
     code?: string;
+    /** Group title (max 32 characters; must not contain < > or &). */
     title?: string;
-    /** priority is determined by the order of the apps (highest first) */
+    /** Member application codes (format XXXXX-XXXXX); list order sets priority, first = highest. */
     applications?: string[];
 };
 export type UpdateApplicationsGroupResponse = {};
 export type DeleteApplicationsGroupRequest = {
+    /** Application group code of the group to delete. */
     code?: string;
 };
 export type DeleteApplicationsGroupResponse = {};

package/applications_info.d.ts

@@ -1,9 +1,11 @@
 import { RpcMethod, Duration } from './commonTypes';
 export type ApplicationsInfoService_GetPlatformsInfo = RpcMethod<GetPlatformsInfoRequest, GetPlatformsInfoResponse>;
 export interface ApplicationsInfoService {
+    /** Returns per-platform status for one or more application codes (XXXXX-XXXXX): whether each platform is configured and active, deactivation date/reason, push certificate time left and platform properties. Use to audit push setup or certificate expiry across an account's apps; for WhatsApp it also queries the Meta sender status live. */
     GetPlatformsInfo: ApplicationsInfoService_GetPlatformsInfo;
 }
 export type GetPlatformsInfoRequest = {
+    /** Application codes (XXXXX-XXXXX) to fetch platform info for; apps the caller cannot see are silently skipped. */
     applications?: string[];
 };
 export type GetPlatformsInfoResponse = {

package/applications_sounds.d.ts

@@ -1,10 +1,13 @@
 import { RpcMethod } from './commonTypes';
 export type ApplicationSoundsService_Get = RpcMethod<GetRequest, GetResponse>;
 export interface ApplicationSoundsService {
+    /** Lists the custom notification sound file names uploaded for an application (format XXXXX-XXXXX) on a given platform. Use to populate the sound picker when composing a push for that platform. */
     Get: ApplicationSoundsService_Get;
 }
 export type GetRequest = {
+    /** Application code (format XXXXX-XXXXX) whose sounds to list. */
     application?: string;
+    /** Platform id to filter sounds by (e.g. 1 iOS, 3 Android). */
     platform?: number;
 };
 export type GetResponse = {

package/applications_statistics.d.ts

@@ -5,19 +5,20 @@ export type ApplicationsStatisticsService_GetDAUStatistics = RpcMethod<GetDAUSta
 export type ApplicationsStatisticsService_GetPushApplicationStatistics = RpcMethod<GetPushApplicationStatisticsRequest, GetPushApplicationStatisticsResponse>;
 export type ApplicationsStatisticsService_GetEmailApplicationStatistics = RpcMethod<GetEmailApplicationStatisticsRequest, GetEmailApplicationStatisticsResponse>;
 export interface ApplicationsStatisticsService {
+    /** Returns the total registered-users time series for an application (application code XXXXX-XXXXX). Use for the overall audience-size trend; use get_application_mau_statistics or get_application_dau_statistics for active-user counts. */
     GetUsersStatistics: ApplicationsStatisticsService_GetUsersStatistics;
-    /** GetMAUStatistics returns mau statistics with time series data */
+    /** Returns the monthly active users (MAU) time series for an application (application code XXXXX-XXXXX). Use for monthly engagement; use get_application_dau_statistics for daily active users. */
     GetMAUStatistics: ApplicationsStatisticsService_GetMAUStatistics;
-    /** GetDAUStatistics returns dau statistics with time series data */
+    /** Returns the daily active users (DAU) time series for an application (application code XXXXX-XXXXX). Use for daily engagement; use get_application_mau_statistics for monthly active users. */
     GetDAUStatistics: ApplicationsStatisticsService_GetDAUStatistics;
-    /** GetPushApplicationStatistics returns push application statistics with time series data */
+    /** Returns per-platform push time series (total devices, sends, open rate) for an application (application code XXXXX-XXXXX). Use for the push channel dashboard; use get_application_email_statistics for the email channel. */
     GetPushApplicationStatistics: ApplicationsStatisticsService_GetPushApplicationStatistics;
-    /** GetEmailApplicationStatistics returns email application statistics with time series data */
+    /** Returns per-platform email time series (total devices, sends, open rate) for an application (application code XXXXX-XXXXX). Use for the email channel dashboard; use get_application_push_statistics for the push channel. */
     GetEmailApplicationStatistics: ApplicationsStatisticsService_GetEmailApplicationStatistics;
 }
 export type TimeInterval = 'TIME_INTERVAL_UNSPECIFIED' | 'TIME_INTERVAL_HOUR' | 'TIME_INTERVAL_DAY' | 'TIME_INTERVAL_WEEK' | 'TIME_INTERVAL_MONTH';
 export type GetUsersStatisticsRequest = {
-    /** Application Code */
+    /** Application code (format XXXXX-XXXXX) to fetch statistics for. */
     application?: string;
 };
 export type GetUsersStatisticsResponse = {
@@ -29,7 +30,7 @@ export type GetUsersStatisticsResponse = {
     interval: TimeInterval;
 };
 export type GetMAUStatisticsRequest = {
-    /** Application Code */
+    /** Application code (format XXXXX-XXXXX) to fetch statistics for. */
     application?: string;
 };
 export type GetMAUStatisticsResponse = {
@@ -39,7 +40,7 @@ export type GetMAUStatisticsResponse = {
     usersCount: number[];
 };
 export type GetDAUStatisticsRequest = {
-    /** Application Code */
+    /** Application code (format XXXXX-XXXXX) to fetch statistics for. */
     application?: string;
 };
 export type GetDAUStatisticsResponse = {
@@ -49,7 +50,7 @@ export type GetDAUStatisticsResponse = {
     usersCount: number[];
 };
 export type GetPushApplicationStatisticsRequest = {
-    /** Application Code */
+    /** Application code (format XXXXX-XXXXX) to fetch statistics for. */
     application?: string;
 };
 export type PlatformStatistics = {
@@ -71,7 +72,7 @@ export type GetPushApplicationStatisticsResponse = {
     interval: TimeInterval;
 };
 export type GetEmailApplicationStatisticsRequest = {
-    /** Application Code */
+    /** Application code (format XXXXX-XXXXX) to fetch statistics for. */
     application?: string;
 };
 export type GetEmailApplicationStatisticsResponse = {

package/campaigns.d.ts

@@ -5,10 +5,15 @@ export type CampaignsService_Update = RpcMethod<UpdateCampaignRequest, UpdateCam
 export type CampaignsService_List = RpcMethod<ListCampaignsRequest, ListCampaignsResponse>;
 export type CampaignsService_Delete = RpcMethod<DeleteCampaignRequest, DeleteCampaignResponse>;
 export interface CampaignsService {
+    /** Returns a single marketing campaign by its campaign code, including name, description and owning application code. Use to inspect one campaign after finding its code via list_campaigns. */
     Get: CampaignsService_Get;
+    /** Creates a new marketing campaign (name and optional description) under an application; each call yields a fresh campaign code. Use to add a campaign for grouping messages, not to edit one — use update_campaign for that. */
     Create: CampaignsService_Create;
+    /** Updates the name and/or description of an existing campaign identified by campaign code; unset fields are left unchanged. Repeating the call overwrites to the same values. */
     Update: CampaignsService_Update;
+    /** Lists an account's marketing campaigns, optionally scoped to one application code, with paging, free-text search and ordering. Excludes system and Customer Journey campaigns; use to browse campaigns or find a campaign code. */
     List: CampaignsService_List;
+    /** Permanently deletes a campaign by campaign code; fails if the campaign is still referenced by geozones or RSS feeds. Irreversible — the campaign record is removed. */
     Delete: CampaignsService_Delete;
 }
 export type Campaign = {
@@ -18,34 +23,44 @@ export type Campaign = {
     description: string;
 };
 export type GetCampaignRequest = {
+    /** Campaign code of the campaign to fetch. */
     code?: string;
 };
 export type GetCampaignResponse = {
     campaign: Campaign;
 };
 export type CreateCampaignRequest = {
+    /** Application code (format XXXXX-XXXXX) the campaign belongs to. */
     application?: string;
+    /** Campaign name (required, max 32 characters). */
     name?: string;
+    /** Optional campaign description (max 64 characters). */
     description?: string;
 };
 export type CreateCampaignResponse = {
     campaign: Campaign;
 };
 export type UpdateCampaignRequest = {
+    /** Campaign code of the campaign to update. */
     code?: string;
+    /** New campaign name (max 32 characters); omit to leave unchanged. */
     name?: string;
+    /** New campaign description (max 64 characters); omit to leave unchanged. */
     description?: string;
 };
 export type UpdateCampaignResponse = {};
 export type ListCampaignsRequest_OrderBy = 'NAME' | 'CREATED';
 export type ListCampaignsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListCampaignsRequest = {
+    /** Application code (format XXXXX-XXXXX) to scope the list to; leave empty for all applications in the account. */
     application?: string;
     orderBy?: ListCampaignsRequest_OrderBy;
     orderDirection?: ListCampaignsRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** Free-text search over campaign name, description and code. */
     search?: string;
+    /** Restrict to these campaign codes. */
     codes?: string[];
 };
 export type ListCampaignsResponse = {
@@ -55,6 +70,7 @@ export type ListCampaignsResponse = {
     total: number;
 };
 export type DeleteCampaignRequest = {
+    /** Campaign code of the campaign to delete. */
     code?: string;
 };
 export type DeleteCampaignResponse = {};

package/categories.d.ts

@@ -1,17 +1,19 @@
 import { RpcMethod } from './commonTypes';
 export type CategoriesService_List = RpcMethod<ListCategoriesRequest, ListCategoriesResponse>;
 export interface CategoriesService {
+    /** Lists the category names used to organize presets, rich media and templates in an application (application code XXXXX-XXXXX), with paging, name search and ordering. Use to discover existing categories before tagging or filtering content by category. */
     List: CategoriesService_List;
 }
 export type ListCategoriesRequest_OrderBy = 'NAME' | 'CREATED';
 export type ListCategoriesRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListCategoriesRequest = {
+    /** Application code (XXXXX-XXXXX) whose categories to list. */
     application?: string;
     orderBy?: ListCategoriesRequest_OrderBy;
     orderDirection?: ListCategoriesRequest_OrderDirection;
     page?: number;
     perPage?: number;
-    /** like %name% */
+    /** Case-insensitive substring match on category name (matched as %value%). */
     searchByName?: string;
 };
 export type ListCategoriesResponse = {

package/cloud_pages.d.ts

@@ -6,24 +6,31 @@ export type CloudPagesService_Update = RpcMethod<UpdateCloudPageRequest, UpdateC
 export type CloudPagesService_Delete = RpcMethod<DeleteCloudPageRequest, DeleteCloudPageResponse>;
 export type CloudPagesService_GetConfig = RpcMethod<GetCloudPageConfigRequest, GetCloudPageConfigResponse>;
 export interface CloudPagesService {
+    /** Lists Cloud Pages (hosted landing/subscription pages) for an application, newest-first by default, with paging, name/code search and a category filter. Use to browse pages or find a page code before get/update/delete. */
     List: CloudPagesService_List;
+    /** Returns a single Cloud Page by its page code, including HTML content, slug, redirect URL, categories and editor JSON. Use after list_cloud_pages to inspect one page. */
     Get: CloudPagesService_Get;
+    /** Creates a new Cloud Page under an application from name, content, slug and categories, returning the generated page code. Use to add a hosted page; update_cloud_page edits an existing one. */
     Create: CloudPagesService_Create;
+    /** Overwrites an existing Cloud Page (by page code) with new name, content, slug, redirect URL, categories and existing-user behavior. Use to edit a page; create_cloud_page adds a new one. */
     Update: CloudPagesService_Update;
+    /** Permanently deletes a Cloud Page by page code and detaches it from its categories. Cannot be undone; a second call for the same code returns not-found. */
     Delete: CloudPagesService_Delete;
+    /** Returns Cloud Pages configuration for an application: whether custom slugs are allowed and the slug domain. Use before create/update to know if a slug can be set. */
     GetConfig: CloudPagesService_GetConfig;
 }
 export type ListCloudPagesRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListCloudPagesRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListCloudPagesRequest = {
+    /** Application code (XXXXX-XXXXX) whose Cloud Pages to list. */
     application?: string;
     orderBy?: ListCloudPagesRequest_OrderBy;
     orderDirection?: ListCloudPagesRequest_OrderDirection;
     page?: number;
     perPage?: number;
-    /** like %name% */
+    /** Free-text filter matched against both page name and page code (case-insensitive substring). */
     searchByName?: string;
-    /** in ['category'] */
+    /** Keep only pages that belong to any of these categories. */
     searchByCategory?: string[];
 };
 export type ExistingUserBehavior = 'UPDATE' | 'SKIP' | 'ERROR';
@@ -46,42 +53,57 @@ export type ListCloudPagesResponse = {
     total: number;
 };
 export type GetCloudPageRequest = {
+    /** Cloud Page code identifying the page to fetch. */
     code?: string;
 };
 export type GetCloudPageResponse = {
     preset: CloudPage;
 };
 export type CreateCloudPageRequest = {
+    /** Application code (XXXXX-XXXXX) the new page belongs to. */
     application?: string;
     name?: string;
     categories?: string[];
+    /** Custom URL slug; applied only when slugs are allowed for the application (see get_cloud_page_config). */
     slug?: string;
+    /** Rendered HTML content of the page. */
     content?: string;
+    /** URL to redirect to instead of rendering content. */
     redirectUrl?: string;
+    /** Editor state JSON used to rebuild the page in the visual editor. */
     pushwooshJson?: string;
+    /** How to treat a submission from a user who already exists: UPDATE, SKIP or ERROR. */
     existingUserBehavior?: ExistingUserBehavior;
 };
 export type CreateCloudPageResponse = {
     preset: CloudPage;
 };
 export type UpdateCloudPageRequest = {
+    /** Cloud Page code identifying the page to overwrite. */
     code?: string;
     name?: string;
     categories?: string[];
+    /** Custom URL slug; applied only when slugs are allowed for the application (see get_cloud_page_config). */
     slug?: string;
+    /** Rendered HTML content of the page. */
     content?: string;
+    /** URL to redirect to instead of rendering content. */
     redirectUrl?: string;
+    /** Editor state JSON used to rebuild the page in the visual editor. */
     pushwooshJson?: string;
+    /** How to treat a submission from a user who already exists: UPDATE, SKIP or ERROR. */
     existingUserBehavior?: ExistingUserBehavior;
 };
 export type UpdateCloudPageResponse = {
     preset: CloudPage;
 };
 export type DeleteCloudPageRequest = {
+    /** Cloud Page code identifying the page to delete. */
     code?: string;
 };
 export type DeleteCloudPageResponse = {};
 export type GetCloudPageConfigRequest = {
+    /** Application code (XXXXX-XXXXX) whose Cloud Pages configuration to fetch. */
     application?: string;
 };
 export type GetCloudPageConfigResponse = {

package/customer_journey.d.ts

@@ -2,14 +2,19 @@ import { RpcMethod } from './commonTypes';
 export type CustomerJourneyService_GetDeviceEntries = RpcMethod<GetDeviceEntriesRequest, GetDeviceEntriesResponse>;
 export type CustomerJourneyService_GetCampaignPreset = RpcMethod<GetCampaignPresetRequest, GetCampaignPresetResponse>;
 export interface CustomerJourneyService {
+    /** Lists the customer journeys a single device (by HWID) has entered in an application, with each entry's status, enter/leave times and campaign type, paged. Use to reconstruct one device's journey participation history. */
     GetDeviceEntries: CustomerJourneyService_GetDeviceEntries;
+    /** Returns the message preset code and point type of the first send point of a journey campaign, looked up by campaign code. Use to find which push/email/SMS/WhatsApp preset a single-message journey campaign delivers. */
     GetCampaignPreset: CustomerJourneyService_GetCampaignPreset;
 }
 export type GetDeviceEntriesRequest = {
+    /** Device hardware id (HWID) whose journey entries to list. */
     hwid?: string;
+    /** Free-text search over journey title. */
     searchByName?: string;
     page?: number;
     perPage?: number;
+    /** Application code (format XXXXX-XXXXX) whose journeys to search. */
     application?: string;
 };
 export type GetDeviceEntriesResponse_JourneyEntry_Status = 'EXITED' | 'ERROR' | 'STILL_IN_JOURNEY';
@@ -31,6 +36,7 @@ export type GetDeviceEntriesResponse = {
     totalJourneys: number;
 };
 export type GetCampaignPresetRequest = {
+    /** Campaign code of the journey campaign whose first send point's preset to return. */
     campaign?: string;
 };
 export type PointType = 'MessageBus' | 'Delay' | 'Terminator' | 'SendPush' | 'GoalEvent' | 'SendEmail' | 'BooleanSplitter' | 'WaitEvent' | 'InApp' | 'StartBySegment' | 'ABSplitter' | 'SetTags' | 'WebHook' | 'Filter' | 'SendSms' | 'APIStart' | 'SendWhatsApp' | 'SendData';

package/deeplinks.d.ts

@@ -6,12 +6,18 @@ export type DeeplinksService_Update = RpcMethod<UpdateDeeplinkRequest, UpdateDee
 export type DeeplinksService_Delete = RpcMethod<DeleteDeeplinkRequest, DeleteDeeplinkResponse>;
 export type DeeplinksService_GetLinkContent = RpcMethod<GetLinkContentRequest, GetLinkContentResponse>;
 export interface DeeplinksService {
+    /** Lists deeplinks configured for an application (code XXXXX-XXXXX), ordered by name or creation date, with paging and an optional name/code/template substring filter. Use to browse deeplinks or find a deeplink code before fetching or editing one. */
     List: DeeplinksService_List;
+    /** Returns a single deeplink by its deeplink code, including name, URL template and system flag. Use after list_deeplinks to inspect one deeplink. */
     Get: DeeplinksService_Get;
+    /** Creates a deeplink in an application (code XXXXX-XXXXX) from a name and a URL template with {placeholder} tokens, returning the generated deeplink code. Use update_deeplink to edit an existing one instead. */
     Create: DeeplinksService_Create;
+    /** Updates a deeplink's name and/or URL template by deeplink code, overwriting the stored values (empty fields are left unchanged). Use create_deeplink to add a new deeplink. */
     Update: DeeplinksService_Update;
+    /** Permanently deletes a deeplink by deeplink code. Only deeplinks owned by the caller's account can be deleted, and the removal cannot be undone. */
     Delete: DeeplinksService_Delete;
     /**
+     * Fetches the given http(s) URL and returns an HTML head fragment containing only its og:* meta tags. Use to preview link metadata (title/image) when building a deeplink; reaches out to the external URL.
      * POST is used instead of GET because the uri parameter may contain
      * arbitrarily long URLs that exceed HTTP query-string length limits.
      */
@@ -20,12 +26,13 @@ export interface DeeplinksService {
 export type ListDeeplinksRequest_OrderBy = 'NAME' | 'CREATED';
 export type ListDeeplinksRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListDeeplinksRequest = {
+    /** Application code (format XXXXX-XXXXX) whose deeplinks to list. */
     application?: string;
     orderBy?: ListDeeplinksRequest_OrderBy;
     orderDirection?: ListDeeplinksRequest_OrderDirection;
     page?: number;
     perPage?: number;
-    /** like %name% */
+    /** Case-insensitive substring filter matched against deeplink name, code or template. */
     searchByName?: string;
 };
 export type Deeplink = {
@@ -42,15 +49,18 @@ export type ListDeeplinksResponse = {
     total: number;
 };
 export type GetDeeplinkRequest = {
+    /** Deeplink code identifying the deeplink to return. */
     code?: string;
 };
 export type GetDeeplinkResponse = {
     deeplink: Deeplink;
 };
 export type CreateDeeplinkRequest = {
+    /** Application code (format XXXXX-XXXXX) the deeplink belongs to. */
     application?: string;
+    /** Human-readable deeplink name, 1-32 characters. */
     name?: string;
-    /** template text */
+    /** URL template, 1-1024 chars, with {placeholder} tokens; must have a scheme and host. */
     template?: string;
     /** whether deeplink is system */
     system?: boolean;
@@ -59,16 +69,21 @@ export type CreateDeeplinkResponse = {
     deeplink: Deeplink;
 };
 export type UpdateDeeplinkRequest = {
+    /** Deeplink code identifying the deeplink to update. */
     code?: string;
+    /** New deeplink name, 1-32 characters; empty leaves the name unchanged. */
     name?: string;
+    /** New URL template with {placeholder} tokens; empty leaves the template unchanged. */
     template?: string;
 };
 export type UpdateDeeplinkResponse = {};
 export type DeleteDeeplinkRequest = {
+    /** Deeplink code identifying the deeplink to delete. */
     code?: string;
 };
 export type DeleteDeeplinkResponse = {};
 export type GetLinkContentRequest = {
+    /** Absolute http(s) URL to fetch and extract og:* meta tags from. */
     uri?: string;
 };
 export type GetLinkContentResponse = {

package/deliverability_checker.d.ts

@@ -2,13 +2,19 @@ import { RpcMethod } from './commonTypes';
 export type DeliverabilityCheckerService_CreateSandboxCheck = RpcMethod<CreateSandboxCheckRequest, CreateSandboxCheckResponse>;
 export type DeliverabilityCheckerService_GetSandboxResult = RpcMethod<GetSandboxResultRequest, GetSandboxResultResponse>;
 export interface DeliverabilityCheckerService {
+    /** Starts an email deliverability sandbox check: sends the email preset (preset code) as a real test email to a test device (HWID) and runs compliance and content checks. Returns a message code to poll with get_deliverability_result; run before a broadcast to catch spam-score, broken-link and unsubscribe issues. */
     CreateSandboxCheck: DeliverabilityCheckerService_CreateSandboxCheck;
+    /** Returns the state and, when finished, the delivery result and deliverability report (spam score, broken links, unsubscribe health) for a sandbox check by message code. Poll after create_deliverability_check until state is SANDBOX_DONE or SANDBOX_FAILED. */
     GetSandboxResult: DeliverabilityCheckerService_GetSandboxResult;
 }
 export type CreateSandboxCheckRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX) that owns the preset and test device. */
     applicationCode?: string;
+    /** Email preset code whose content is checked; required. */
     presetCode?: string;
+    /** Test device HWID that receives the sandbox test email; required. */
     testDeviceHwid?: string;
+    /** Optional from / reply-to / subject overrides applied to the preset before sending. */
     overrides?: EmailOverrides;
 };
 export type EmailOverrides = {
@@ -24,6 +30,7 @@ export type CreateSandboxCheckResponse = {
     messageCode: string;
 };
 export type GetSandboxResultRequest = {
+    /** Message code returned by create_deliverability_check identifying the sandbox check to fetch. */
     messageCode?: string;
 };
 export type GetSandboxResultResponse = {

package/devices.d.ts

@@ -1,7 +1,7 @@
 import { RpcMethod } from './commonTypes';
 export type DevicesService_SetTags = RpcMethod<SetTagsRequest, SetTagsResponse>;
 export interface DevicesService {
-    /** Set tags for existing device or user */
+    /** Sets or overwrites tag values on an existing device (by HWID) or user (by user_id) in an application. Send an empty string or null as a value to clear a tag; pass platform only when creating a device by HWID. */
     SetTags: DevicesService_SetTags;
 }
 export type SetTagsRequest = {

package/email_categories.d.ts

@@ -8,61 +8,87 @@ export type EmailCategoriesService_List = RpcMethod<ListRequest, ListResponse>;
 export type EmailCategoriesService_Enable = RpcMethod<EnableRequest, EnableResponse>;
 export type EmailCategoriesService_Info = RpcMethod<InfoRequest, InfoResponse>;
 export interface EmailCategoriesService {
+    /** Creates one email subscription category for an application (max 20 per app), optionally back-subscribing existing recipients. Use create_email_categories to add several at once. */
     Create: EmailCategoriesService_Create;
+    /** Creates several email subscription categories for an application in one call, rejecting duplicate or existing names and enforcing the 20-per-app limit. Use create_email_category to add just one. */
     CreateMany: EmailCategoriesService_CreateMany;
+    /** Returns a single email subscription category by its category code. Use after list_email_categories to inspect one category's name, description and subscribe settings. */
     Get: EmailCategoriesService_Get;
+    /** Updates an email subscription category (name, description, subscribe_new/subscribe_old flags) by category code, overwriting the current values. Enabling subscribe_old back-subscribes existing recipients. */
     Update: EmailCategoriesService_Update;
+    /** Soft-deletes an email subscription category by category code so it no longer applies to the application. Deleting an already-deleted or unknown category is a no-op success. */
     Delete: EmailCategoriesService_Delete;
+    /** Lists all email subscription categories for an application plus whether the feature is enabled and available. Use to browse categories or find a category code. */
     List: EmailCategoriesService_List;
+    /** Enables or disables the email categories feature for an application by setting an application property. Pass value=true to turn it on, value=false to turn it off; setting the current value again is a no-op. */
     Enable: EmailCategoriesService_Enable;
+    /** Returns per-category subscribed-user counts for an application plus the progress of the back-subscribe (subscribe_old) background job. Use to see how many recipients are subscribed to each email category. */
     Info: EmailCategoriesService_Info;
 }
 export type Category = {
+    /** Email category code */
     code: string;
+    /** Application code XXXXX-XXXXX */
     application: string;
+    /** Category display name (unique within the application) */
     name: string;
     description: string;
+    /** Auto-subscribe newly registered email recipients to this category */
     subscribeNew: boolean;
+    /** Back-subscribe existing email recipients to this category */
     subscribeOld: boolean;
     subscribeOldUpdated: Date;
 };
 export type CreateRequest = {
+    /** Application code XXXXX-XXXXX */
     application?: string;
+    /** Category display name (unique within the application) */
     name?: string;
     description?: string;
+    /** Auto-subscribe newly registered email recipients to this category */
     subscribeNew?: boolean;
+    /** Back-subscribe existing email recipients to this category */
     subscribeOld?: boolean;
 };
 export type CreateResponse = {
     category: Category;
 };
 export type CreateManyRequest = {
+    /** Application code XXXXX-XXXXX */
     application?: string;
+    /** Categories to create; names must be unique and not already exist */
     categories?: Category[];
 };
 export type CreateManyResponse = {
     categories: Category[];
 };
 export type GetRequest = {
+    /** Email category code */
     code?: string;
 };
 export type GetResponse = {
     category: Category;
 };
 export type UpdateRequest = {
+    /** Email category code */
     code?: string;
+    /** Category display name (unique within the application) */
     name?: string;
     description?: string;
+    /** Auto-subscribe newly registered email recipients to this category */
     subscribeNew?: boolean;
+    /** Back-subscribe existing email recipients to this category */
     subscribeOld?: boolean;
 };
 export type UpdateResponse = {};
 export type DeleteRequest = {
+    /** Email category code */
     code?: string;
 };
 export type DeleteResponse = {};
 /** only 20 categories is allowed per application */
 export type ListRequest = {
+    /** Application code XXXXX-XXXXX */
     application?: string;
 };
 export type ListResponse = {
@@ -71,11 +97,14 @@ export type ListResponse = {
     isAvailable: boolean;
 };
 export type EnableRequest = {
+    /** Application code XXXXX-XXXXX */
     application?: string;
+    /** true to enable the email categories feature, false to disable */
     value?: boolean;
 };
 export type EnableResponse = {};
 export type InfoRequest = {
+    /** Application code XXXXX-XXXXX */
     application?: string;
 };
 export type InfoResponse = {