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

package/account_groups.d.ts

@@ -8,13 +8,21 @@ export type AccountGroupsService_ListGroupMembers = RpcMethod<ListGroupMembersRe
 export type AccountGroupsService_UpdateGroupMembers = RpcMethod<UpdateGroupMembersRequest, UpdateGroupMembersResponse>;
 export type AccountGroupsService_UpdateUserMembership = RpcMethod<UpdateUserMembershipRequest, UpdateUserMembershipResponse>;
 export interface AccountGroupsService {
+    /** Returns a single account permission group by name with its map of enabled account/application rights. Use after list_account_groups to inspect one group's permissions. */
     Get: AccountGroupsService_Get;
+    /** Lists the account's permission groups with paging and optional name search, each with its rights and member count. Use to browse groups before fetching or editing one. */
     List: AccountGroupsService_List;
+    /** Creates a new account permission group with the given name and set of enabled rights. Fails if a group with that name already exists; use update_account_group to change an existing group's rights. */
     Create: AccountGroupsService_Create;
+    /** Overwrites the enabled rights of an existing account group by name, granting the listed rights and revoking all others. Use to change a group's permissions; the group name itself is not changed. */
     Update: AccountGroupsService_Update;
+    /** Deletes an account group by name and reassigns all its members to reassign_group. Irreversible; the group's rights and its own membership records are removed. */
     Delete: AccountGroupsService_Delete;
+    /** Lists all users of the account with a flag showing whether each is a member of the named account group. Use to see who belongs to a group before editing membership. */
     ListGroupMembers: AccountGroupsService_ListGroupMembers;
+    /** Adds or removes users in a named account group according to a username/email to enabled map, granting membership where true and revoking it where false. Use to edit one group's member list. */
     UpdateGroupMembers: AccountGroupsService_UpdateGroupMembers;
+    /** Sets the full list of account groups a single user belongs to, granting the listed groups and revoking all others. Use to manage one user's group memberships across the account; returns the resulting membership list. */
     UpdateUserMembership: AccountGroupsService_UpdateUserMembership;
 }
 export type ListRequest_OrderBy = 'NAME';
@@ -24,7 +32,7 @@ export type ListRequest = {
     perPage?: number;
     orderBy?: ListRequest_OrderBy;
     orderDirection?: ListRequest_OrderDirection;
-    /** like '%name%' */
+    /** Case-insensitive substring match on account group name (SQL ILIKE '%value%'). */
     searchByName?: string;
 };
 export type ListResponse_AccountGroup = {
@@ -40,24 +48,28 @@ export type ListResponse = {
     total: number;
 };
 export type CreateRequest = {
+    /** Name for the new account group; must be unique within the account. */
     name?: string;
     /** right name => enabled */
     rights?: Record<string, boolean>;
 };
 export type CreateResponse = {};
 export type UpdateRequest = {
+    /** Name of the existing account group to update. */
     name?: string;
     /** right name => enabled */
     rights?: Record<string, boolean>;
 };
 export type UpdateResponse = {};
 export type DeleteRequest = {
+    /** Name of the account group to delete. */
     name?: string;
     /** contains group name, all users will be reassigned to this group */
     reassignGroup?: string;
 };
 export type DeleteResponse = {};
 export type ListGroupMembersRequest = {
+    /** Account group name whose members to list. */
     name?: string;
 };
 export type ListGroupMembersResponse_AccountGroupMember = {
@@ -69,6 +81,7 @@ export type ListGroupMembersResponse = {
     accountGroupMembers: ListGroupMembersResponse_AccountGroupMember[];
 };
 export type UpdateGroupMembersRequest = {
+    /** Account group name whose members to update. */
     name?: string;
     /** username/email => enabled */
     members?: Record<string, boolean>;
@@ -85,6 +98,7 @@ export type UpdateUserMembershipResponse = {
     groupMembership: string[];
 };
 export type GetRequest = {
+    /** Account group name to fetch. */
     name?: string;
 };
 export type GetResponse_AccountGroup = {

package/account_invites.d.ts

@@ -4,9 +4,13 @@ export type AccountInvitesService_Resend = RpcMethod<ResendRequest, ResendRespon
 export type AccountInvitesService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
 export type AccountInvitesService_Create = RpcMethod<CreateRequest, CreateResponse>;
 export interface AccountInvitesService {
+    /** Lists pending team invitations for the current account, newest first, with paging and optional email substring search. Use to see who has been invited to join the account before resending or deleting an invite. */
     List: AccountInvitesService_List;
+    /** Re-sends the invitation email for an existing invite identified by its invite code, refreshing its last-sent date. Rate-limited to once per hour per invite; use when the invitee never received or lost the original signup email. */
     Resend: AccountInvitesService_Resend;
+    /** Revokes a pending team invitation for the current account, identified by the invitee email, so its signup link stops working. Use to cancel an outstanding invite; differs from resend_account_invite which re-emails it. */
     Delete: AccountInvitesService_Delete;
+    /** Invites a user by email to join the current account under a named account group, creating the invite and emailing them a signup link. Use to add a team member; fails if the email is already a user or already has a pending invite. */
     Create: AccountInvitesService_Create;
 }
 export type ListRequest_OrderBy = 'INVITE_DATE' | 'EMAIL' | 'STATUS';
@@ -16,7 +20,7 @@ export type ListRequest = {
     perPage?: number;
     orderBy?: ListRequest_OrderBy;
     orderDirection?: ListRequest_OrderDirection;
-    /** like '%email%' */
+    /** Case-insensitive substring match on invitee email (ILIKE %value%); omit to list all invites. */
     searchByEmail?: string;
 };
 export type ListResponse_Invite = {
@@ -32,16 +36,19 @@ export type ListResponse = {
     total: number;
 };
 export type ResendRequest = {
+    /** Invite code (token) identifying which invitation to re-send. */
     code?: string;
 };
 export type ResendResponse = {};
 export type CreateRequest = {
-    /** name of the account group */
+    /** Name of the account group (permission role) to assign the invited user to. */
     group?: string;
+    /** Email address of the person to invite. */
     email?: string;
 };
 export type CreateResponse = {};
 export type DeleteRequest = {
+    /** Invitee email address identifying which pending invite to revoke. */
     email?: string;
 };
 export type DeleteResponse = {};

package/account_overview.d.ts

@@ -1,6 +1,7 @@
 import { RpcMethod } from './commonTypes';
 export type AccountOverviewService_GetAccountEntitiesOverview = RpcMethod<GetAccountEntitiesOverviewRequest, GetAccountEntitiesOverviewResponse>;
 export interface AccountOverviewService {
+    /** Returns a read-only dashboard snapshot of the current account: its applications (configured platforms, subscriber counts) with per-application counts and recent messages, campaigns, presets, rich media, email templates, in-app messages, events, geozones and customer journeys, plus account-wide user, group, tag and segment summaries. Use for a single overview instead of calling each entity's list endpoint. */
     GetAccountEntitiesOverview: AccountOverviewService_GetAccountEntitiesOverview;
 }
 export type GetAccountEntitiesOverviewRequest = {};

package/account_users.d.ts

@@ -2,7 +2,9 @@ import { RpcMethod } from './commonTypes';
 export type AccountUsersService_List = RpcMethod<ListRequest, ListResponse>;
 export type AccountUsersService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
 export interface AccountUsersService {
+    /** Lists the team members (dashboard users) of the current account together with a per-group membership map, paged and optionally filtered by email substring or group name. Use to review who has access to the account and which permission groups they belong to. */
     List: AccountUsersService_List;
+    /** Removes a team member from the current account by email: revokes their permission-group membership, logs them out, and deletes the user entirely if they belong to no other account. Cannot delete the account owner; a second delete of the same email errors as not-assigned. */
     Delete: AccountUsersService_Delete;
 }
 export type ListRequest_OrderBy = 'EMAIL';
@@ -12,9 +14,9 @@ export type ListRequest = {
     perPage?: number;
     orderBy?: ListRequest_OrderBy;
     orderDirection?: ListRequest_OrderDirection;
-    /** like '%email%' */
+    /** Case-insensitive substring match on user email (SQL ILIKE '%value%'). */
     searchByEmail?: string;
-    /** users who has given group membership */
+    /** Keep only users who are members of the permission group with this exact name (e.g. "Admins", "Owner"). */
     searchByGroup?: string;
 };
 export type ListResponse_AccountUser = {
@@ -29,6 +31,7 @@ export type ListResponse = {
     total: number;
 };
 export type DeleteRequest = {
+    /** Email of the account team member to remove. */
     email?: string;
 };
 export type DeleteResponse = {};

package/accounts.d.ts

@@ -16,21 +16,37 @@ export type AccountsService_UpdateBillingInfo = RpcMethod<UpdateBillingInfoReque
 export type AccountsService_ListChild = RpcMethod<ListChildRequest, ListChildResponse>;
 export type AccountsService_GetAuthHistory = RpcMethod<GetAuthHistoryRequest, GetAuthHistoryResponse>;
 export interface AccountsService {
+    /** Returns the current account's email send counters and quotas (daily, monthly, billing-month sends plus paid/free quota and limit). Use for billing/usage views; pass a date range only to also get the count for that window. */
     GetEmailStatisticCount: AccountsService_GetEmailStatisticCount;
+    /** Returns monthly active device counts for the account (rolling-month, calendar-month and previous-month). Use for device-based MAU/billing views; pass a date range to also get the count for that window. */
     GetActiveDevicesCount: AccountsService_GetActiveDevicesCount;
+    /** Returns the account's push subscriber counts split into push-enabled and push-disabled, optionally restricted to given platform IDs. Use to see how many devices can receive push. */
     GetSubscribersCount: AccountsService_GetSubscribersCount;
+    /** Returns monthly active user counts for the account (rolling-month, calendar-month and previous-month). Use for user-based MAU/billing views; pass a date range to also get the count for that window. */
     GetActiveUsersCount: AccountsService_GetActiveUsersCount;
+    /** Turns the account's API debug mode on or off; enabling grants a one-hour window, disabling clears it. Requires the account to allow debug mode and the user to manage API access. Use get_account_debug_mode to read the current state. */
     SetDebugMode: AccountsService_SetDebugMode;
+    /** Returns whether the account's API debug mode is currently enabled and its expiry time. Use before set_account_debug_mode to check state. */
     GetDebugMode: AccountsService_GetDebugMode;
+    /** Returns the account's onboarding state: whether onboarding is active, whether to show the survey, and whether the account has a subscription and at least one application. Use to render the onboarding flow. */
     GetOnboardingInfo: AccountsService_GetOnboardingInfo;
+    /** Marks an onboarding step complete or records the chosen plan/survey answers for the account, recalculating whether onboarding stays active. Use to advance the onboarding flow one step at a time. */
     UpdateOnboardingInfo: AccountsService_UpdateOnboardingInfo;
+    /** Returns the total number of email subscribers across the account. Use for account-wide email audience size; differs from get_account_email_statistics which reports send counts and quotas. */
     GetTotalEmailSubscribersCount: AccountsService_GetTotalEmailSubscribersCount;
+    /** Returns the account's unified monthly active users (combined across channels) and the email-only MAU. Use for cross-channel billing/usage; without a valid date range it defaults to the calendar month. */
     GetUnifiedMAUCount: AccountsService_GetUnifiedMAUCount;
+    /** Returns the current account's profile (its name). Use to read the account name shown in the console. */
     GetAccount: AccountsService_GetAccount;
+    /** Updates the current account's name. Use to rename the account; the name must be non-empty. */
     UpdateAccount: AccountsService_UpdateAccount;
+    /** Returns the account's billing address (contact name, company, tax numbers, country, emails). Use to read the invoicing details shown on the billing page. */
     GetBillingInfo: AccountsService_GetBillingInfo;
+    /** Creates or overwrites the account's billing address; only the fields present in the request are changed (validates emails and name lengths). Use to save invoicing details. */
     UpdateBillingInfo: AccountsService_UpdateBillingInfo;
+    /** Lists the sub-accounts (child accounts) under the current account, paged and sortable, with optional name substring search. Use to browse a managed/parent account's children. */
     ListChild: AccountsService_ListChild;
+    /** Returns the account's login attempt history (email, success/failure, IP, timestamp), paged and sortable, with optional email substring search. Use to audit sign-in activity for the account's users. */
     GetAuthHistory: AccountsService_GetAuthHistory;
 }
 export type GetEmailStatisticCountRequest = {
@@ -62,6 +78,7 @@ export type GetActiveDevicesCountResponse = {
     requestDateActiveDevices: number;
 };
 export type GetSubscribersCountRequest = {
+    /** optional platform IDs to restrict the count to; empty = all platforms */
     platforms?: number[];
 };
 export type GetSubscribersCountResponse = {
@@ -81,6 +98,7 @@ export type GetActiveUsersCountResponse = {
     requestDateActiveUsers: number;
 };
 export type SetDebugModeRequest = {
+    /** true turns debug mode on for one hour; false turns it off */
     enabled?: boolean;
 };
 export type SetDebugModeResponse = {
@@ -103,7 +121,9 @@ export type UpdateOnboardingInfoRequest_answer_list = {
     answers: string[];
 };
 export type UpdateOnboardingInfoRequest = {
+    /** chosen plan name: free, developer, marketing or custom */
     plan?: string;
+    /** onboarding step to complete: IsActive, WelcomeScreen, PaywallPlan, GetStarted or ShowSurvey */
     step?: string;
     /** map[string][]string. survey questions->answers map */
     survey?: Record<string, UpdateOnboardingInfoRequest_answer_list>;
@@ -244,15 +264,25 @@ export type EmailTemplatesService_Test = RpcMethod<TestEmailTemplateRequest, Tes
 export type EmailTemplatesService_Migrate = RpcMethod<MigrateRequest, MigrateResponse>;
 export type EmailTemplatesService_Clone = RpcMethod<CloneEmailPresetsRequest, CloneEmailPresetsResponse>;
 export interface EmailTemplatesService {
+    /** Creates a new email template (editor content plus a connected email preset) in an application. Use to author a reusable email; returns the generated template code. */
     Create: EmailTemplatesService_Create;
+    /** Returns a single email template by its template code, including sender info, per-locale subjects and the full editor content. Use after list_email_templates to inspect one template's content. */
     Get: EmailTemplatesService_Get;
+    /** Lists an application's email templates (metadata only, no content) with paging, ordering and filtering by name, label or category. Use to browse templates or find a template code before fetching or editing one. */
     List: EmailTemplatesService_List;
+    /** Lists the account's legacy email templates that are not yet connected to a preset in the given application. Use to find legacy templates that can be adopted into an application via connect_legacy_email_template. */
     ListLegacyTemplates: EmailTemplatesService_ListLegacyTemplates;
+    /** Updates an existing email template by code, overwriting its name, label, categories, sender info, subjects and editor content. Use to edit a template; supplied fields replace the stored ones. */
     Update: EmailTemplatesService_Update;
+    /** Deletes an email template and its connected preset by code, removing the stored content files. Fails if the template is used in a journey; unlike update_email_template this cannot be undone. */
     Delete: EmailTemplatesService_Delete;
+    /** Returns the distinct label strings used across an application's email templates. Use to populate a label filter for list_email_templates. */
     GetEmailTemplateLabels: EmailTemplatesService_GetEmailTemplateLabels;
+    /** Sends a real test email of a template to one email address, rendering it with optional dynamic-content placeholders. If the app has no configured email platform the address must be a registered test device. Use to preview delivery before broadcasting. */
     Test: EmailTemplatesService_Test;
+    /** Connects a legacy email template to an application by creating an email preset for it, so it becomes editable and sendable there. Returns the existing preset code if one already links the template. Use after list_legacy_email_templates to adopt a legacy template. */
     Migrate: EmailTemplatesService_Migrate;
+    /** Clones an email template (its content and preset) into a destination application, optionally under a new name. Use to duplicate a template within or across applications; returns the new preset code. */
     Clone: EmailTemplatesService_Clone;
 }
 export type CloneEmailPresetsRequest = {

package/accounts_get_auth_info.d.ts

@@ -7,6 +7,7 @@ export type GetAuthInfoService_GetAuthInfo = RpcMethod<GetAuthInfoRequest, GetAu
  * Пока что просто переношу как есть.
  */
 export interface GetAuthInfoService {
+    /** Returns the current authenticated session context: the signed-in user's profile and notification preferences plus the active account's plan, permissions (ACE flags), restrictions and per-entity counts. Use to resolve who is logged in and what the account can do before other calls. */
     GetAuthInfo: GetAuthInfoService_GetAuthInfo;
 }
 export type GetAuthInfoRequest = {};

package/api_tokens.d.ts

@@ -9,31 +9,53 @@ export type ApiTokensService_GrantDeviceDataModificationRightOnApplication = Rpc
 export type ApiTokensService_GrantMessageRightAll = RpcMethod<GrantMessageRightAllRequest, GrantMessageRightAllResponse>;
 export type ApiTokensService_GrantDeviceDataModificationRightAll = RpcMethod<GrantDeviceDataModificationRightAllRequest, GrantDeviceDataModificationRightAllResponse>;
 export interface ApiTokensService {
+    /** Creates a new API access token (account-scoped or device-scoped) for the account, returning the generated token value once. Use to issue programmatic API credentials; the raw token value is only present in this response. */
     Create: ApiTokensService_Create;
+    /** Returns one API token by its token code, including type and the resolved application/group restrictions. Use after list_api_tokens to inspect a single token's scope. */
     Get: ApiTokensService_Get;
+    /** Lists the account's API tokens with paging, ordering and optional name search. Use to browse issued tokens or find a token code before get/update/delete. */
     List: ApiTokensService_List;
+    /** Updates an API token's name and/or restriction scope by token code, overwriting the stored restrictions. Use to rename a token or change which applications, groups and modify rights it carries. */
     Update: ApiTokensService_Update;
+    /** Permanently deletes an API token by token code, revoking its programmatic access. Cannot be undone; a second delete of the same code returns not-found. */
     Delete: ApiTokensService_Delete;
+    /** Grants one modify right (account, application, tag or message) or a specific application/group message right across all account-type API tokens of the account. Use to broaden existing account tokens' scope without editing each token individually. */
     GrantRightOnApplication: ApiTokensService_GrantRightOnApplication;
+    /** Grants device-data modification rights for one application code across all device-type API tokens of the account. Use to let existing device tokens modify data for a newly added application. */
     GrantDeviceDataModificationRightOnApplication: ApiTokensService_GrantDeviceDataModificationRightOnApplication;
+    /** Toggles message rights over all applications and groups on one account-type API token: select_all grants modify-message on every app/group, false revokes them all. Use to quickly select or clear all message scopes for a single token. */
     GrantMessageRightAll: ApiTokensService_GrantMessageRightAll;
+    /** Toggles device-data modification rights over all applications on one device-type API token: select_all grants every app, false revokes them all. Use to quickly select or clear all device-data scopes for a single token. */
     GrantDeviceDataModificationRightAll: ApiTokensService_GrantDeviceDataModificationRightAll;
 }
 export type Restrictions = {
+    /** Application codes (XXXXX-XXXXX) the token may send messages to */
     messageApplications: string[];
+    /** Application group codes the token may send messages to */
     messageGroups: string[];
+    /** Application codes (XXXXX-XXXXX) the token may modify device data for */
     deviceDataApplications: string[];
+    /** Allow modifying account resources */
     modifyAccount: boolean;
+    /** Allow modifying application resources */
     modifyApplication: boolean;
+    /** Allow sending/modifying messages */
     modifyMessage: boolean;
+    /** Allow modifying tags */
     modifyTag: boolean;
+    /** Grant all applications instead of an explicit message_applications list */
     applicationsSelectAll: boolean;
+    /** Grant all application groups instead of an explicit message_groups list */
     groupsSelectAll: boolean;
+    /** Grant all applications instead of an explicit device_data_applications list */
     deviceDataSelectAll: boolean;
 };
 export type CreateApiTokenRequest = {
+    /** Token display name (max 64 characters) */
     name?: string;
+    /** Token type: "account" for full API access or "device" for device-data only; defaults to account */
     type?: string;
+    /** Scope limits (applications, groups and modify rights) applied to the token */
     restrictions?: Restrictions;
 };
 export type CreateApiTokenResponse = {
@@ -44,6 +66,7 @@ export type CreateApiTokenResponse = {
     restrictions: Restrictions;
 };
 export type GetApiTokenRequest = {
+    /** API token code */
     code?: string;
 };
 export type GetApiTokenResponse = {
@@ -76,8 +99,11 @@ export type ListApiTokensResponse = {
     total: number;
 };
 export type UpdateApiTokenRequest = {
+    /** API token code */
     code?: string;
+    /** New token display name (max 64 characters) */
     name?: string;
+    /** New scope limits; overwrites the token's current restrictions */
     restrictions?: Restrictions;
 };
 export type UpdateApiTokenResponse = {
@@ -88,6 +114,7 @@ export type UpdateApiTokenResponse = {
     restrictions: Restrictions;
 };
 export type DeleteApiTokenRequest = {
+    /** API token code */
     code?: string;
 };
 export type DeleteApiTokenResponse = {};
@@ -96,9 +123,11 @@ export type GrantRightOnApplicationRequest_ModifyApplication = {};
 export type GrantRightOnApplicationRequest_ModifyTag = {};
 export type GrantRightOnApplicationRequest_ModifyMessage = {};
 export type GrantRightOnApplicationRequest_MessageApplications = {
+    /** Application code (XXXXX-XXXXX) to grant message rights on */
     applicationCode: string;
 };
 export type GrantRightOnApplicationRequest_MessageGroups = {
+    /** Application group code to grant message rights on */
     applicationGroupCode: string;
 };
 export type GrantRightOnApplicationRequest_kind_modifyAccount = {
@@ -131,6 +160,7 @@ export type GrantRightOnApplicationRequest = {
 };
 export type GrantRightOnApplicationResponse = {};
 export type GrantDeviceDataModificationRightOnApplicationRequest_DeviceDataApplications = {
+    /** Application code (XXXXX-XXXXX) to grant device-data modification on */
     applicationCode: string;
 };
 export type GrantDeviceDataModificationRightOnApplicationRequest_kind_deviceDataApplications = {
@@ -143,12 +173,16 @@ export type GrantDeviceDataModificationRightOnApplicationRequest = {
 };
 export type GrantDeviceDataModificationRightOnApplicationResponse = {};
 export type GrantMessageRightAllRequest = {
+    /** API token code */
     code?: string;
+    /** true grants message rights on all apps/groups, false revokes them all */
     selectAll?: boolean;
 };
 export type GrantMessageRightAllResponse = {};
 export type GrantDeviceDataModificationRightAllRequest = {
+    /** API token code */
     code?: string;
+    /** true grants device-data rights on all apps, false revokes them all */
     selectAll?: boolean;
 };
 export type GrantDeviceDataModificationRightAllResponse = {};

package/applications.d.ts

@@ -20,24 +20,43 @@ export type ApplicationsService_GetControlGroupAnalytics = RpcMethod<GetControlG
 export type ApplicationsService_GetDOIConfig = RpcMethod<GetDOIConfigRequest, GetDOIConfigResponse>;
 export type ApplicationsService_SetDOIConfig = RpcMethod<SetDOIConfigRequest, SetDOIConfigResponse>;
 export interface ApplicationsService {
+    /** Returns one Pushwoosh application by its code (format XXXXX-XXXXX) with platforms, subscriber counts, languages and permissions. Use to inspect a single app; use list_applications to browse many. */
     Get: ApplicationsService_Get;
+    /** Creates a new Pushwoosh application from a title and optional icon, seeding default properties, dashboards, events and frequency capping. Use to add an app to the current account; returns the new application code. */
     Create: ApplicationsService_Create;
+    /** Updates a Pushwoosh application (title, icon, website URL, daily-stat opt-in or Bitly shortener token) by code. Use to change app settings; a supplied bitly_configuration is validated against Bitly before saving. */
     Update: ApplicationsService_Update;
+    /** Lists the current account's applications (code, title, subscriber counts) with paging, ordering and free-text search. Use to browse apps or find an application code before calling get_application. */
     List: ApplicationsService_List;
+    /** Permanently deletes a Pushwoosh application by code, finishing its customer journeys and queuing a background purge of its data. Irreversible; system applications cannot be deleted. */
     Delete: ApplicationsService_Delete;
+    /** Stores the Bitly access token used to shorten links for an application, validating the token against Bitly before saving. Use to enable Bitly URL shortening for the app. */
     SetShortenerConfiguration: ApplicationsService_SetShortenerConfiguration;
+    /** Shortens a single URL for an application via the Pushwoosh link shortener, returning the original URL when the short link would not be shorter. Use to pre-shorten a link for message content. */
     ShortenURL: ApplicationsService_ShortenURL;
+    /** Overwrites the email URL query parameters (UTM-style map) stored for an application. Use to set tracking params appended to email links; sending an empty map clears them. */
     UpdateURLParams: ApplicationsService_UpdateURLParams;
+    /** Opens a Zendesk support ticket requesting manual verification to enable the email platform for an application. Use when an account must be approved by support before sending email; posts to Zendesk, not to the end user. */
     SendEmailVerification: ApplicationsService_SendEmailVerification;
+    /** Returns each account group's See/Modify/Send rights on an application (format XXXXX-XXXXX). Use to review which account groups can access an app before editing with set_application_account_group_permissions. */
     GetAccountGroupPermissions: ApplicationsService_GetAccountGroupPermissions;
+    /** Overwrites the See/Modify/Send rights that account groups have on an application, rebuilding each group's ACE rights. Use to grant or revoke group access to an app; returns the resulting permissions. */
     SaveAccountGroupPermissions: ApplicationsService_SaveAccountGroupPermissions;
+    /** Returns the global control-group settings for an application: hold-out percentage, enabled flag, total vs control user counts and calculation status. Use to display control-group config; get_control_group_calculation_status polls just the changing counts. */
     GetControlGroupSettings: ApplicationsService_GetControlGroupSettings;
+    /** Sets the global control-group hold-out percentage (1-99) for an application and records who changed it, creating the PW_ControlGroup tag if missing. Use to enable or resize the control group. */
     UpdateControlGroupPercentage: ApplicationsService_UpdateControlGroupPercentage;
+    /** Disables the global control group for an application, removing its percentage setting and queuing a background job to strip the PW_ControlGroup tag from all devices. Use to turn the hold-out group off. */
     DisableControlGroup: ApplicationsService_DisableControlGroup;
+    /** Kicks off a fresh recalculation of control-group and total user counts for an application, leaving the previously cached numbers in place until it finishes. Use to refresh stale size numbers on demand. */
     ForceUpdateControlGroupCalculation: ApplicationsService_ForceUpdateControlGroupCalculation;
+    /** Returns just the control-group counts and calculation status that change while a background size calc runs, for an application. Poll this on a timer instead of re-fetching get_control_group_settings. */
     GetControlGroupCalculationStatus: ApplicationsService_GetControlGroupCalculationStatus;
+    /** Returns precomputed control-vs-treatment analytics (conversions, uplift, statistical significance) per event for an application over a 3/7/30-day window. Use to measure the incremental impact of messaging. */
     GetControlGroupAnalytics: ApplicationsService_GetControlGroupAnalytics;
+    /** Returns the double opt-in (DOI) configuration for an application: whether DOI is enabled and the confirmation email preset code. Use to check DOI status before toggling with set_doi_config. */
     GetDOIConfig: ApplicationsService_GetDOIConfig;
+    /** Enables or disables double opt-in (DOI) for an application; enabling for the first time clones the confirmation email preset into the account. Use to require email confirmation before subscribing. */
     SetDOIConfig: ApplicationsService_SetDOIConfig;
 }
 export type ControlGroupTaskStatus = 'CONTROL_GROUP_TASK_STATUS_UNSPECIFIED' | 'CONTROL_GROUP_TASK_STATUS_NOT_STARTED' | 'CONTROL_GROUP_TASK_STATUS_IN_PROGRESS' | 'CONTROL_GROUP_TASK_STATUS_COMPLETED';
@@ -73,27 +92,37 @@ export type ApplicationSummary = {
     platforms: Record<number, pushwoosh_rpc_v2_applications_info_ApplicationPlatformsInfo_PlatformInfo>;
 };
 export type GetApplicationRequest = {
+    /** Application code (format XXXXX-XXXXX) to fetch. */
     code?: string;
 };
 export type GetApplicationResponse = {
     application: Application;
 };
 export type CreateApplicationRequest = {
+    /** Display name for the new application. */
     title?: string;
+    /** Optional icon image bytes (PNG/JPEG). */
     icon?: string;
 };
 export type CreateApplicationResponse = {
     application: Application;
 };
 export type UpdateApplicationRequest_BitlyConfiguration = {
+    /** Bitly API access token. */
     accessToken: string;
 };
 export type UpdateApplicationRequest = {
+    /** Application code (format XXXXX-XXXXX) to update. */
     code?: string;
+    /** New display name; leave empty to keep the current title. */
     title?: string;
+    /** New icon image bytes (PNG/JPEG); omit to keep the current icon. */
     icon?: string;
+    /** Application website URL; must start with http:// or https://. */
     websiteUrl?: string;
+    /** Whether this user receives the daily statistics email for the app. */
     allowDailyStat?: boolean;
+    /** Bitly link-shortener credentials; token is validated against Bitly before saving. */
     bitlyConfiguration?: UpdateApplicationRequest_BitlyConfiguration;
 };
 export type UpdateApplicationResponse = {
@@ -106,6 +135,7 @@ export type ListApplicationsRequest = {
     orderDirection?: ListApplicationsRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** Free-text search over application title. */
     search?: string;
 };
 export type ListApplicationsResponse = {
@@ -115,30 +145,41 @@ export type ListApplicationsResponse = {
     total: number;
 };
 export type DeleteApplicationRequest = {
+    /** Application code (format XXXXX-XXXXX) to permanently delete. */
     code?: string;
 };
 export type DeleteApplicationResponse = {};
 export type SetShortenerConfigurationRequest = {
+    /** Application code (format XXXXX-XXXXX) to configure. */
     code?: string;
+    /** Bitly API access token to validate and store. */
     bitlyAccessToken?: string;
 };
 export type SetShortenerConfigurationResponse = {};
 export type ShortenURLRequest = {
+    /** Application code (format XXXXX-XXXXX) the link belongs to. */
     code?: string;
+    /** Absolute URL (http:// or https://) to shorten. */
     url?: string;
 };
 export type ShortenURLResponse = {
     shortUrl: string;
 };
 export type UpdateURLParamsRequest = {
+    /** Application code (format XXXXX-XXXXX) to configure. */
     code?: string;
+    /** Email URL query parameters (key/value) to store; an empty map clears them. */
     params?: Record<string, string>;
 };
 export type UpdateURLParamsResponse = {};
 export type SendEmailVerificationRequest = {
+    /** Application code (format XXXXX-XXXXX) requesting email enablement. */
     code?: string;
+    /** Website URL the emails will be sent on behalf of. */
     website?: string;
+    /** Contact email address for the verification request. */
     email?: string;
+    /** Free-text description of the intended email use case. */
     description?: string;
 };
 export type SendEmailVerificationResponse = {};
@@ -159,12 +200,14 @@ export type GetAccountGroupPermissionsResponse = {
 export type SaveAccountGroupPermissionsRequest = {
     /** application code */
     code?: string;
+    /** Full set of per-group See/Modify/Send rights to apply (replaces existing). */
     permissions?: AccountGroupPermissions[];
 };
 export type SaveAccountGroupPermissionsResponse = {
     permissions: AccountGroupPermissions[];
 };
 export type GetControlGroupSettingsRequest = {
+    /** Application code (format XXXXX-XXXXX) whose control-group settings to fetch. */
     code?: string;
 };
 export type GetControlGroupSettingsResponse = {
@@ -183,19 +226,24 @@ export type GetControlGroupSettingsResponse = {
     hasData: boolean;
 };
 export type UpdateControlGroupPercentageRequest = {
+    /** Application code (format XXXXX-XXXXX) to configure. */
     code?: string;
+    /** Control-group hold-out size as a percentage, 1-99. */
     percentage?: number;
 };
 export type UpdateControlGroupPercentageResponse = {};
 export type DisableControlGroupRequest = {
+    /** Application code (format XXXXX-XXXXX) whose control group to disable. */
     code?: string;
 };
 export type DisableControlGroupResponse = {};
 export type ForceUpdateControlGroupCalculationRequest = {
+    /** Application code (format XXXXX-XXXXX) to recalculate control-group size for. */
     code?: string;
 };
 export type ForceUpdateControlGroupCalculationResponse = {};
 export type GetControlGroupCalculationStatusRequest = {
+    /** Application code (format XXXXX-XXXXX) to poll calculation status for. */
     code?: string;
 };
 /**
@@ -223,7 +271,9 @@ export type GetControlGroupAnalyticsRequest_WindowDays = 'WINDOW_DAYS_UNSPECIFIE
  * analytics for a window preset (3/7/30 days).
  */
 export type GetControlGroupAnalyticsRequest = {
+    /** Application code (format XXXXX-XXXXX) to report on. */
     code?: string;
+    /** Analytics lookback window preset (3, 7 or 30 days). */
     windowDays?: GetControlGroupAnalyticsRequest_WindowDays;
 };
 export type ControlGroupAnalyticsGroup = {
@@ -253,13 +303,16 @@ export type DoubleOptInConfig = {
     emailPreset: string;
 };
 export type GetDOIConfigRequest = {
+    /** Application code (format XXXXX-XXXXX) whose double opt-in config to fetch. */
     code?: string;
 };
 export type GetDOIConfigResponse = {
     doiConfig: DoubleOptInConfig;
 };
 export type SetDOIConfigRequest = {
+    /** Application code (format XXXXX-XXXXX) to configure. */
     code?: string;
+    /** Whether double opt-in is enabled for the application. */
     enabled?: boolean;
 };
 export type SetDOIConfigResponse = {};

package/applications_alerts.d.ts

@@ -1,6 +1,7 @@
 import { RpcMethod } from './commonTypes';
 export type ApplicationsAlertsService_List = RpcMethod<ListRequest, ListResponse>;
 export interface ApplicationsAlertsService {
+    /** Lists active dashboard alerts (errors, warnings and recommendations) for an account, optionally scoped to one application, covering subscriber and email quotas, suspension, failed payments, expiring Apple certificates, disabled platforms and email/SDK setup gaps. Pass an application code to include app-specific platform and certificate alerts; omit it for account-wide alerts only. */
     List: ApplicationsAlertsService_List;
 }
 export type AlertType = 'INFO' | 'WARNING' | 'ERROR';
@@ -18,6 +19,7 @@ export type Alert = {
     error: AlertError;
 };
 export type ListRequest = {
+    /** Application code (XXXXX-XXXXX) to scope alerts to; leave empty for account-wide alerts only. */
     application?: string;
 };
 export type ListResponse = {

package/applications_configurations.d.ts

@@ -2,7 +2,9 @@ import { RpcMethod } from './commonTypes';
 export type ApplicationsConfigurationsService_Configure = RpcMethod<ConfigurationRequest, ConfigurationResponse>;
 export type ApplicationsConfigurationsService_EnablePlatform = RpcMethod<EnablePlatformRequest, EnablePlatformResponse>;
 export interface ApplicationsConfigurationsService {
+    /** Saves the provider credentials for one delivery platform or channel of an application (code XXXXX-XXXXX) — APNs/FCM push keys, an SMS provider, email sender, Telegram/Viber token, Google Wallet, etc. — then enables that platform. Pick the matching kind in the oneof; some providers (Telegram, Huawei) also call the external provider API to register a webhook or validate the token. */
     Configure: ApplicationsConfigurationsService_Configure;
+    /** Enables or disables a single delivery platform (by numeric platform id) for an application (code XXXXX-XXXXX) without touching its stored credentials. Use to toggle a channel on or off; update_platform_configuration already enables a platform after saving its credentials. */
     EnablePlatform: ApplicationsConfigurationsService_EnablePlatform;
 }
 export type AndroidConfiguration = {
@@ -327,13 +329,17 @@ export type ConfigurationRequest_kind_viberConfiguration = {
 };
 export type ConfigurationRequest_kind = ConfigurationRequest_kind_androidConfiguration | ConfigurationRequest_kind_chromeConfiguration | ConfigurationRequest_kind_emailConfiguration | ConfigurationRequest_kind_huaweiConfiguration | ConfigurationRequest_kind_safariConfiguration | ConfigurationRequest_kind_windowsConfiguration | ConfigurationRequest_kind_amazonConfiguration | ConfigurationRequest_kind_osxConfiguration | ConfigurationRequest_kind_osxTokenConfiguration | ConfigurationRequest_kind_iosConfiguration | ConfigurationRequest_kind_iosTokenConfiguration | ConfigurationRequest_kind_iosVoipConfiguration | ConfigurationRequest_kind_iosPasskitConfiguration | ConfigurationRequest_kind_firefoxConfiguration | ConfigurationRequest_kind_baiduConfiguration | ConfigurationRequest_kind_lineConfiguration | ConfigurationRequest_kind_webConfiguration | ConfigurationRequest_kind_kakaoConfiguration | ConfigurationRequest_kind_telegramConfiguration | ConfigurationRequest_kind_googleWalletConfiguration | ConfigurationRequest_kind_smsConfiguration | ConfigurationRequest_kind_viberConfiguration;
 export type ConfigurationRequest = {
+    /** Application code (format XXXXX-XXXXX) whose platform/channel to configure. */
     code?: string;
     kind: ConfigurationRequest_kind;
 };
 export type ConfigurationResponse = {};
 export type EnablePlatformRequest = {
+    /** Application code (format XXXXX-XXXXX) whose platform to toggle. */
     code?: string;
+    /** Numeric platform id to enable or disable (e.g. iOS, Android, Web, Email, SMS). */
     platform?: number;
+    /** true to enable the platform, false to disable it. */
     enable?: boolean;
 };
 export type EnablePlatformResponse = {};