@pushwoosh/rpc-v2-http-api-data 0.1.882 → 0.1.884

package/account_groups.d.ts

@@ -24,11 +24,13 @@ export type ListRequest = {
     perPage?: number;
     orderBy?: ListRequest_OrderBy;
     orderDirection?: ListRequest_OrderDirection;
+    /** like '%name%' */
     searchByName?: string;
 };
 export type ListResponse_AccountGroup = {
     name: string;
     rights: Record<string, boolean>;
+    /** the number of the members belongs to the group */
     memberCount: number;
 };
 export type ListResponse = {
@@ -39,16 +41,19 @@ export type ListResponse = {
 };
 export type CreateRequest = {
     name?: string;
+    /** right name => enabled */
     rights?: Record<string, boolean>;
 };
 export type CreateResponse = {};
 export type UpdateRequest = {
     name?: string;
+    /** right name => enabled */
     rights?: Record<string, boolean>;
 };
 export type UpdateResponse = {};
 export type DeleteRequest = {
     name?: string;
+    /** contains group name, all users will be reassigned to this group */
     reassignGroup?: string;
 };
 export type DeleteResponse = {};
@@ -65,14 +70,18 @@ export type ListGroupMembersResponse = {
 };
 export type UpdateGroupMembersRequest = {
     name?: string;
+    /** username/email => enabled */
     members?: Record<string, boolean>;
 };
 export type UpdateGroupMembersResponse = {};
 export type UpdateUserMembershipRequest = {
+    /** username/email */
     username?: string;
+    /** contains account group names in which the user must be a member */
     groupMembership?: string[];
 };
 export type UpdateUserMembershipResponse = {
+    /** contains account group names in which the user is a member */
     groupMembership: string[];
 };
 export type GetRequest = {

package/account_invites.d.ts

@@ -16,6 +16,7 @@ export type ListRequest = {
     perPage?: number;
     orderBy?: ListRequest_OrderBy;
     orderDirection?: ListRequest_OrderDirection;
+    /** like '%email%' */
     searchByEmail?: string;
 };
 export type ListResponse_Invite = {
@@ -35,6 +36,7 @@ export type ResendRequest = {
 };
 export type ResendResponse = {};
 export type CreateRequest = {
+    /** name of the account group */
     group?: string;
     email?: string;
 };

package/account_overview.d.ts

@@ -4,39 +4,50 @@ export interface AccountOverviewService {
     GetAccountEntitiesOverview: AccountOverviewService_GetAccountEntitiesOverview;
 }
 export type GetAccountEntitiesOverviewRequest = {};
+/** Basic account information */
 export type GetAccountEntitiesOverviewResponse_AccountInfo = {
     name: string;
 };
 export type GetAccountEntitiesOverviewResponse_ApplicationsSummary_ApplicationInfo = {
     title: string;
+    /** list of platform IDs configured */
     configuredPlatforms: number[];
+    /** total push-enabled subscribers */
     totalSubscribers: number;
     isDemo: boolean;
+    /** entities summary for application */
     entities: GetAccountEntitiesOverviewResponse_EntitiesOverview;
 };
+/** Applications summary */
 export type GetAccountEntitiesOverviewResponse_ApplicationsSummary = {
     totalCount: number;
     applications: GetAccountEntitiesOverviewResponse_ApplicationsSummary_ApplicationInfo[];
 };
+/** Users and groups */
 export type GetAccountEntitiesOverviewResponse_UsersSummary = {
     totalUsers: number;
     totalGroups: number;
 };
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_MessagesSummary_MessageInfo = {
+    /** message name/title/content preview */
     name: string;
+    /** "push" or "email" */
     type: string;
     status: string;
 };
+/** Messages */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_MessagesSummary = {
     total: number;
     pushCount: number;
     emailCount: number;
+    /** latest messages for overview */
     recentMessages: GetAccountEntitiesOverviewResponse_EntitiesOverview_MessagesSummary_MessageInfo[];
 };
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_CampaignsSummary_CampaignInfo = {
     name: string;
     description: string;
 };
+/** Campaigns */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_CampaignsSummary = {
     total: number;
     campaigns: GetAccountEntitiesOverviewResponse_EntitiesOverview_CampaignsSummary_CampaignInfo[];
@@ -44,6 +55,7 @@ export type GetAccountEntitiesOverviewResponse_EntitiesOverview_CampaignsSummary
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_PresetsSummary_PresetInfo = {
     name: string;
 };
+/** Presets */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_PresetsSummary = {
     total: number;
     pushPresets: number;
@@ -57,6 +69,7 @@ export type GetAccountEntitiesOverviewResponse_EntitiesOverview_PresetsSummary =
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_RichMediasSummary_RichMediaInfo = {
     name: string;
 };
+/** Rich Media */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_RichMediasSummary = {
     total: number;
     richMedias: GetAccountEntitiesOverviewResponse_EntitiesOverview_RichMediasSummary_RichMediaInfo[];
@@ -65,6 +78,7 @@ export type GetAccountEntitiesOverviewResponse_EntitiesOverview_EmailTemplatesSu
     name: string;
     label: string;
 };
+/** Email Templates */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_EmailTemplatesSummary = {
     total: number;
     emailTemplates: GetAccountEntitiesOverviewResponse_EntitiesOverview_EmailTemplatesSummary_EmailTemplateInfo[];
@@ -73,6 +87,7 @@ export type GetAccountEntitiesOverviewResponse_EntitiesOverview_InAppMessagesSum
     name: string;
     status: string;
 };
+/** InApp Messages */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_InAppMessagesSummary = {
     total: number;
     inappMessages: GetAccountEntitiesOverviewResponse_EntitiesOverview_InAppMessagesSummary_InAppMessageInfo[];
@@ -81,6 +96,7 @@ export type GetAccountEntitiesOverviewResponse_EntitiesOverview_EventsSummary_Ev
     name: string;
     description: string;
 };
+/** Events */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_EventsSummary = {
     total: number;
     events: GetAccountEntitiesOverviewResponse_EntitiesOverview_EventsSummary_EventInfo[];
@@ -89,6 +105,7 @@ export type GetAccountEntitiesOverviewResponse_EntitiesOverview_GeozonesSummary_
     name: string;
     isActive: boolean;
 };
+/** Geozones */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_GeozonesSummary = {
     total: number;
     geozones: GetAccountEntitiesOverviewResponse_EntitiesOverview_GeozonesSummary_GeozoneInfo[];
@@ -98,10 +115,12 @@ export type GetAccountEntitiesOverviewResponse_EntitiesOverview_CustomerJourneys
     title: string;
     status: number;
 };
+/** Customer Journeys */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview_CustomerJourneysSummary = {
     total: number;
     customerJourneys: GetAccountEntitiesOverviewResponse_EntitiesOverview_CustomerJourneysSummary_CustomerJourneyInfo[];
 };
+/** Entities with names and details */
 export type GetAccountEntitiesOverviewResponse_EntitiesOverview = {
     messages: GetAccountEntitiesOverviewResponse_EntitiesOverview_MessagesSummary;
     campaigns: GetAccountEntitiesOverviewResponse_EntitiesOverview_CampaignsSummary;
@@ -117,6 +136,7 @@ export type GetAccountEntitiesOverviewResponse_TagsSummary_TagInfo = {
     name: string;
     type: string;
 };
+/** Tags */
 export type GetAccountEntitiesOverviewResponse_TagsSummary = {
     total: number;
     tags: GetAccountEntitiesOverviewResponse_TagsSummary_TagInfo[];
@@ -124,6 +144,7 @@ export type GetAccountEntitiesOverviewResponse_TagsSummary = {
 export type GetAccountEntitiesOverviewResponse_SegmentsSummary_FilterInfo = {
     name: string;
 };
+/** Filters (Segments) */
 export type GetAccountEntitiesOverviewResponse_SegmentsSummary = {
     total: number;
     filters: GetAccountEntitiesOverviewResponse_SegmentsSummary_FilterInfo[];

package/account_users.d.ts

@@ -12,11 +12,14 @@ export type ListRequest = {
     perPage?: number;
     orderBy?: ListRequest_OrderBy;
     orderDirection?: ListRequest_OrderDirection;
+    /** like '%email%' */
     searchByEmail?: string;
+    /** users who has given group membership */
     searchByGroup?: string;
 };
 export type ListResponse_AccountUser = {
     email: string;
+    /** map with groups with IsMember flag: "Admins": true, "Marketing": false, ...etc */
     userGroups: Record<string, boolean>;
 };
 export type ListResponse = {

package/accounts.d.ts

@@ -34,6 +34,7 @@ export interface AccountsService {
     GetAuthHistory: AccountsService_GetAuthHistory;
 }
 export type GetEmailStatisticCountRequest = {
+    /** only for billing usage, optional */
     dateFrom?: Date;
     dateTo?: Date;
 };
@@ -45,9 +46,11 @@ export type GetEmailStatisticCountResponse = {
     freeEmailQuota: number;
     freeEmailLimit: number;
     billingMonthEmailSendsStat: number;
+    /** calculates only if date in request given */
     requestDateEmailStat: number;
 };
 export type GetActiveDevicesCountRequest = {
+    /** only for billing usage, optional */
     dateFrom?: Date;
     dateTo?: Date;
 };
@@ -55,6 +58,7 @@ export type GetActiveDevicesCountResponse = {
     monthlyActiveDevices: number;
     calendarMonthlyActiveDevices: number;
     previousMonthActiveDevices: number;
+    /** calculates only if date in request given */
     requestDateActiveDevices: number;
 };
 export type GetSubscribersCountRequest = {
@@ -65,6 +69,7 @@ export type GetSubscribersCountResponse = {
     pushDisabled: number;
 };
 export type GetActiveUsersCountRequest = {
+    /** only for billing usage, optional */
     dateFrom?: Date;
     dateTo?: Date;
 };
@@ -72,6 +77,7 @@ export type GetActiveUsersCountResponse = {
     monthlyActiveUsers: number;
     calendarMonthlyActiveUsers: number;
     previousMonthActiveUsers: number;
+    /** calculates only if date in request given */
     requestDateActiveUsers: number;
 };
 export type SetDebugModeRequest = {
@@ -99,6 +105,7 @@ export type UpdateOnboardingInfoRequest_answer_list = {
 export type UpdateOnboardingInfoRequest = {
     plan?: string;
     step?: string;
+    /** map[string][]string. survey questions->answers map */
     survey?: Record<string, UpdateOnboardingInfoRequest_answer_list>;
 };
 export type UpdateOnboardingInfoResponse = {};
@@ -107,6 +114,7 @@ export type GetTotalEmailSubscribersCountResponse = {
     totalEmailSubscribers: number;
 };
 export type GetUnifiedMAUCountRequest = {
+    /** if date range is not valid or empty - calendar month is the default date range */
     dateFrom?: Date;
     dateTo?: Date;
 };
@@ -189,6 +197,7 @@ export type ListChildRequest = {
     orderDirection?: ListChildRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
 };
 export type ListChildResponse_ChildAccount = {
@@ -208,6 +217,7 @@ export type GetAuthHistoryRequest = {
     orderDirection?: GetAuthHistoryRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like '%email%' */
     searchByEmail?: string;
 };
 export type GetAuthHistoryResponse_AuthRecord_AuthStatus = 'SUCCESS' | 'FAILED';
@@ -301,26 +311,39 @@ export type EmailContent_SenderInfo = {
     replyTo: EmailContent_SenderInfo_Address;
 };
 export type EmailContent_Unlayer = {
+    /** Raw html */
     html: string;
+    /** Localization map {"en": {"variable":"value"}...} */
     localizationData: object;
+    /** Unlayer specific config */
     editorConfig: object;
 };
 export type EmailContent_Pushwoosh = {
+    /** Raw html */
     html: string;
+    /** Localization map {"en": {"variable":"value"}...} */
     localizationData: object;
 };
 export type EmailContent_Raw = {
+    /** html map {"en": "html_content"...} */
     html: Record<string, string>;
 };
 export type EmailContent_Mjml = {
+    /** Raw html */
     html: string;
+    /** Localization map {"en": {"variable":"value"}...} */
     localizationData: object;
+    /** MJML template source */
     mjml: string;
+    /** MJML editor settings */
     settings: object;
 };
 export type EmailContent_Smartcards = {
+    /** Raw html */
     html: string;
+    /** Localization map {"en": {"variable":"value"}...} */
     localizationData: object;
+    /** Smartcards editor content */
     content: object;
 };
 export type EmailContent_kind_unlayer = {
@@ -346,6 +369,7 @@ export type EmailContent_kind_smartcards = {
 export type EmailContent_kind = EmailContent_kind_unlayer | EmailContent_kind_pushwoosh | EmailContent_kind_raw | EmailContent_kind_mjml | EmailContent_kind_smartcards;
 export type EmailContent = {
     senderInfo: EmailContent_SenderInfo;
+    /** subject map {"en": "subject_content"...} */
     subject: Record<string, string>;
     kind: EmailContent_kind;
 };
@@ -363,9 +387,13 @@ export type ListEmailTemplatesRequest = {
     orderDirection?: ListEmailTemplatesRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
+    /** like %label% */
     searchByLabel?: string;
+    /** uses eq for label search */
     strictSearchByLabel?: boolean;
+    /** in ['category'] */
     searchByCategory?: string[];
 };
 export type ListEmailTemplatesResponse = {
@@ -406,6 +434,7 @@ export type MigrateRequest_SenderInfo = {
 export type MigrateRequest = {
     code?: string;
     application?: string;
+    /** subject map {"en": "subject_content"...} */
     subject?: Record<string, string>;
     senderInfo?: MigrateRequest_SenderInfo;
     categories?: string[];

package/accounts_get_auth_info.d.ts

@@ -2,6 +2,10 @@ import { RpcMethod } from './commonTypes';
 import { BillingAddress as pushwoosh_rpc_v2_accounts_BillingAddress } from './accounts';
 import { RestrictionValue as pushwoosh_objects_restrictionValues_v1_RestrictionValue } from './pushwoosh_objects_restrictionValues_v1';
 export type GetAuthInfoService_GetAuthInfo = RpcMethod<GetAuthInfoRequest, GetAuthInfoResponse>;
+/**
+ * Прям отдельный сервис под этот один запрос. Потому что он страшный и должен быть разобран.
+ * Пока что просто переношу как есть.
+ */
 export interface GetAuthInfoService {
     GetAuthInfo: GetAuthInfoService_GetAuthInfo;
 }

package/api_tokens.d.ts

@@ -60,6 +60,7 @@ export type ListApiTokensRequest = {
     orderDirection?: ListApiTokensRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
 };
 export type ListApiTokensResponse_ApiToken = {

package/applications.d.ts

@@ -129,17 +129,20 @@ export type SendEmailVerificationRequest = {
 export type SendEmailVerificationResponse = {};
 export type AccountGroupPermissions = {
     groupName: string;
+    /** ace rights */
     see: boolean;
     modify: boolean;
     send: boolean;
 };
 export type GetAccountGroupPermissionsRequest = {
+    /** application code */
     code?: string;
 };
 export type GetAccountGroupPermissionsResponse = {
     permissions: AccountGroupPermissions[];
 };
 export type SaveAccountGroupPermissionsRequest = {
+    /** application code */
     code?: string;
     permissions?: AccountGroupPermissions[];
 };
@@ -152,10 +155,14 @@ export type GetControlGroupSettingsRequest = {
 export type GetControlGroupSettingsResponse = {
     percentage: number;
     enabled: boolean;
+    /** All users in the application */
     totalUsers: number;
+    /** Users with PW_ControlGroup = true */
     controlGroupUsers: number;
     calculationStatus: ControlGroupTaskStatus;
+    /** Last time control group settings were modified */
     lastModifiedAt: Date;
+    /** Email of user who last modified settings */
     lastModifiedBy: string;
 };
 export type UpdateControlGroupPercentageRequest = {

package/applications_alerts.d.ts

@@ -4,7 +4,13 @@ export interface ApplicationsAlertsService {
     List: ApplicationsAlertsService_List;
 }
 export type AlertType = 'INFO' | 'WARNING' | 'ERROR';
-export type AlertError = 'ALERT_ERROR_UNSPECIFIED' | 'SUBSCRIBERS_QUOTA_ALMOST_REACHED' | 'EMAIL_QUOTA_ALMOST_REACHED' | 'EMAIL_QUOTA_REACHED' | 'SUSPENDED_ACCOUNT' | 'MANUALLY_SUSPENDED_ACCOUNT' | 'APPLE_CERTIFICATE_EXPIRED' | 'PAYMENT_FAILED' | 'PLATFORM_DISABLED' | 'PAYMENT_OVERDUE' | 'PAYMENT_ATTEMPT_FAILED' | 'EMAIL_CONFIGURATION_NOT_COMPLETED' | 'SDK_INTEGRATION' | 'THIRD_PARTY_INTEGRATION';
+export type AlertError = 'ALERT_ERROR_UNSPECIFIED'
+/** warnings */
+ | 'SUBSCRIBERS_QUOTA_ALMOST_REACHED' | 'EMAIL_QUOTA_ALMOST_REACHED'
+/** errors */
+ | 'EMAIL_QUOTA_REACHED' | 'SUSPENDED_ACCOUNT' | 'MANUALLY_SUSPENDED_ACCOUNT' | 'APPLE_CERTIFICATE_EXPIRED' | 'PAYMENT_FAILED' | 'PLATFORM_DISABLED' | 'PAYMENT_OVERDUE' | 'PAYMENT_ATTEMPT_FAILED' | 'EMAIL_CONFIGURATION_NOT_COMPLETED'
+/** recommendation */
+ | 'SDK_INTEGRATION' | 'THIRD_PARTY_INTEGRATION';
 export type Alert = {
     name: string;
     description: string;

package/applications_groups.d.ts

@@ -41,6 +41,7 @@ export type ListApplicationsGroupsResponse = {
 };
 export type CreateApplicationsGroupRequest = {
     title?: string;
+    /** priority is determined by the order of the apps (highest first) */
     applications?: string[];
 };
 export type CreateApplicationsGroupResponse = {
@@ -49,6 +50,7 @@ export type CreateApplicationsGroupResponse = {
 export type UpdateApplicationsGroupRequest = {
     code?: string;
     title?: string;
+    /** priority is determined by the order of the apps (highest first) */
     applications?: string[];
 };
 export type UpdateApplicationsGroupResponse = {};

package/applications_statistics.d.ts

@@ -6,55 +6,83 @@ export type ApplicationsStatisticsService_GetPushApplicationStatistics = RpcMeth
 export type ApplicationsStatisticsService_GetEmailApplicationStatistics = RpcMethod<GetEmailApplicationStatisticsRequest, GetEmailApplicationStatisticsResponse>;
 export interface ApplicationsStatisticsService {
     GetUsersStatistics: ApplicationsStatisticsService_GetUsersStatistics;
+    /** GetMAUStatistics returns mau statistics with time series data */
     GetMAUStatistics: ApplicationsStatisticsService_GetMAUStatistics;
+    /** GetDAUStatistics returns dau statistics with time series data */
     GetDAUStatistics: ApplicationsStatisticsService_GetDAUStatistics;
+    /** GetPushApplicationStatistics returns push application statistics with time series data */
     GetPushApplicationStatistics: ApplicationsStatisticsService_GetPushApplicationStatistics;
+    /** GetEmailApplicationStatistics returns email application statistics with time series data */
     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?: string;
 };
 export type GetUsersStatisticsResponse = {
+    /** Time points for the series */
     timestamps: Date[];
+    /** Total users for each timestamp */
     usersCount: number[];
+    /** Time interval for grouping data */
     interval: TimeInterval;
 };
 export type GetMAUStatisticsRequest = {
+    /** Application Code */
     application?: string;
 };
 export type GetMAUStatisticsResponse = {
+    /** Time points for the series */
     timestamps: Date[];
+    /** monthly active users for each timestamp */
     usersCount: number[];
 };
 export type GetDAUStatisticsRequest = {
+    /** Application Code */
     application?: string;
 };
 export type GetDAUStatisticsResponse = {
+    /** Time points for the series */
     timestamps: Date[];
+    /** daily active users for each timestamp */
     usersCount: number[];
 };
 export type GetPushApplicationStatisticsRequest = {
+    /** Application Code */
     application?: string;
 };
 export type PlatformStatistics = {
+    /** Platform name */
     platform: string;
+    /** Values for each timestamp */
     values: number[];
 };
 export type GetPushApplicationStatisticsResponse = {
+    /** Time points for the series */
     timestamps: Date[];
+    /** Total devices for each timestamp by platform */
     totalDevices: PlatformStatistics[];
+    /** Total sends for each timestamp by platform */
     sends: PlatformStatistics[];
+    /** Open rate for each timestamp by platform */
     openRate: PlatformStatistics[];
+    /** Time interval for grouping data */
     interval: TimeInterval;
 };
 export type GetEmailApplicationStatisticsRequest = {
+    /** Application Code */
     application?: string;
 };
 export type GetEmailApplicationStatisticsResponse = {
+    /** Time points for the series */
     timestamps: Date[];
+    /** Total devices for each timestamp by platform */
     totalDevices: PlatformStatistics[];
+    /** Total sends for each timestamp by platform */
     sends: PlatformStatistics[];
+    /** Open rate for each timestamp by platform */
     openRate: PlatformStatistics[];
+    /** Time interval for grouping data */
     interval: TimeInterval;
 };

package/categories.d.ts

@@ -11,6 +11,7 @@ export type ListCategoriesRequest = {
     orderDirection?: ListCategoriesRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
 };
 export type ListCategoriesResponse = {

package/cloud_pages.d.ts

@@ -21,7 +21,9 @@ export type ListCloudPagesRequest = {
     orderDirection?: ListCloudPagesRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
+    /** in ['category'] */
     searchByCategory?: string[];
 };
 export type CloudPage = {