@pushwoosh/rpc-v2-http-api-data 0.1.883 → 0.1.885

package/deeplinks.d.ts

@@ -19,6 +19,7 @@ export type ListDeeplinksRequest = {
     orderDirection?: ListDeeplinksRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
 };
 export type Deeplink = {
@@ -43,7 +44,9 @@ export type GetDeeplinkResponse = {
 export type CreateDeeplinkRequest = {
     application?: string;
     name?: string;
+    /** template text */
     template?: string;
+    /** whether deeplink is system */
     system?: boolean;
 };
 export type CreateDeeplinkResponse = {

package/devices.d.ts

@@ -1,13 +1,18 @@
 import { RpcMethod } from './commonTypes';
 export type DevicesService_SetTags = RpcMethod<SetTagsRequest, SetTagsResponse>;
 export interface DevicesService {
+    /** Set tags for existing device or user */
     SetTags: DevicesService_SetTags;
 }
 export type SetTagsRequest = {
+    /** application code */
     application?: string;
+    /** device or user hwid */
     hwid?: string;
+    /** to remove tag value, send empty string or null */
     tags?: object;
 };
 export type SetTagsResponse = {
+    /** map<string, value>, value -- string, []string */
     tags: object;
 };

package/email_categories.d.ts

@@ -61,6 +61,7 @@ export type DeleteRequest = {
     code?: string;
 };
 export type DeleteResponse = {};
+/** only 20 categories is allowed per application */
 export type ListRequest = {
     application?: string;
 };
@@ -79,4 +80,6 @@ export type InfoRequest = {
 };
 export type InfoResponse = {
     subscribedUsers: Record<string, number>;
+    isSubscribeOldInProgress: boolean;
+    subscribeOldInProgressPercent: number;
 };

package/emails_configurations.d.ts

@@ -51,6 +51,7 @@ export type DeleteDomainRequest = {
 };
 export type DeleteDomainResponse = {};
 export type GetCustomTrackingDomainRequest = {
+    /** application code */
     application?: string;
 };
 export type GetCustomTrackingDomainResponse = {

package/events.d.ts

@@ -39,6 +39,7 @@ export type ListEventsRequest_OrderBy = 'NAME' | 'CREATED';
 export type ListEventsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListEventsRequest = {
     application?: string;
+    /** like %name% */
     searchByName?: string;
     orderBy?: ListEventsRequest_OrderBy;
     orderDirection?: ListEventsRequest_OrderDirection;
@@ -64,7 +65,9 @@ export type CreateEventResponse = {
 export type UpdateEventRequest = {
     name?: string;
     application?: string;
+    /** new description */
     description?: string;
+    /** new event attributes */
     attributes?: EventAttribute[];
 };
 export type UpdateEventResponse = {};

package/filters.d.ts

@@ -34,17 +34,22 @@ export type ListFiltersRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListFiltersRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListFiltersRequest = {
     application?: string;
+    /** like %name% */
     searchByName?: string;
+    /** return only high speed filters */
     highSpeedOnly?: boolean;
     codes?: string[];
     orderBy?: ListFiltersRequest_OrderBy;
     orderDirection?: ListFiltersRequest_OrderDirection;
+    /** pagination */
     page?: number;
     perPage?: number;
 };
 export type DeviceLoadPolicy = 'FILTER' | 'ALL';
 export type Filter_Compiling = {
+    /** all devices count */
     size: number;
+    /** with push tokens */
     reachable: number;
     calculationStatus: string;
     calculationProgress: number;
@@ -74,11 +79,19 @@ export type Filter = {
     code: string;
     filterExpression: pushwoosh_objects_filters_v1_FilterExpression;
     seglang: string;
+    /** application for highspeed filter */
     highspeedApplication: string;
+    /** whether highspeed filter is ready for use */
     highspeedReady: boolean;
+    /** total amount of push tokens in highspeed filter */
     highspeedSubscribersTotal: number;
     hasRightAceModify: boolean;
     updated: Date;
+    /**
+     * what devices should be loaded while iterating over the filter
+     * filter - only devices matching the filter
+     * all - all user's devices
+     */
     deviceLoadPolicy: DeviceLoadPolicy;
     isSystem: boolean;
     type: Filter_type;
@@ -97,8 +110,18 @@ export type GetFilterRequest = {
 export type CreateFilterRequest = {
     name?: string;
     filterExpression?: pushwoosh_objects_filters_v1_FilterExpression;
+    /** application for high speed filter */
     highspeedApplication?: string;
+    /**
+     * expiration date. filter will be deleted after this date(in UTC time).
+     * format: YYYY-MM-DD
+     */
     expirationDate?: string;
+    /**
+     * what devices should be loaded while iterating over the filter
+     * filter - only devices matching the filter
+     * all - all user's devices
+     */
     deviceLoadPolicy?: DeviceLoadPolicy;
 };
 export type CreateFilterResponse = {
@@ -122,10 +145,13 @@ export type DeleteFilterRequest = {
     filter?: string;
 };
 export type DeleteFilterResponse = {};
+/** returns cities and their coordinates for the given country based on existing tag (City) values */
 export type GetCountryCitiesRequest = {
+    /** like %search_by_name% */
     searchByName?: string;
 };
 export type GetCountryCitiesResponse_City = {
+    /** country code, city name (ex: us,new york) */
     hash: string;
     name: string;
     latitude: number;
@@ -135,6 +161,7 @@ export type GetCountryCitiesResponse_City = {
 export type GetCountryCitiesResponse = {
     cities: GetCountryCitiesResponse_City[];
 };
+/** returns cities coordinates by cities hashes (country code, city name) */
 export type GetCitiesByHashesRequest = {
     hashes?: string[];
 };
@@ -164,6 +191,7 @@ export type GetMatchedSegmentsRequest = {
     hwid?: string;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
 };
 export type GetMatchedSegmentsResponse = {

package/inapp_messages.d.ts

@@ -19,11 +19,13 @@ export type ListInappMessagesRequest_OrderBy = 'CREATED' | 'NAME' | 'UPDATED';
 export type ListInappMessagesRequest_OrderDirection = 'DESC' | 'ASC';
 export type ListInappMessagesRequest = {
     application?: string;
+    /** like %name% or %code% */
     search?: string;
     page?: number;
     perPage?: number;
     orderBy?: ListInappMessagesRequest_OrderBy;
     orderDirection?: ListInappMessagesRequest_OrderDirection;
+    /** filter by statuses, empty means all */
     statuses?: Inapp_Status[];
 };
 export type Inapp_Status = 'UNDEFINED' | 'ACTIVE' | 'SCHEDULED' | 'COMPLETED' | 'DRAFT' | 'STOPPED';
@@ -68,18 +70,24 @@ export type DeleteInappMessageRequest = {
 };
 export type DeleteInappMessageResponse = {};
 export type CreateInappRequest_Action = 'SAVE_DRAFT' | 'PUBLISH';
+/** Create - create new inapp (draft or active based on action) */
 export type CreateInappRequest = {
     application?: string;
     action?: CreateInappRequest_Action;
     name?: string;
     description?: string;
     required?: boolean;
+    /** required for PUBLISH */
     richMediaCode?: string;
     filterName?: string;
     filterCode?: string;
+    /** JSON */
     segment?: string;
+    /** required for PUBLISH (either event_id or event_name) */
     eventId?: number;
+    /** required for PUBLISH (either event_id or event_name) */
     eventName?: string;
+    /** JSON */
     devicesFilter?: string;
     startDate?: Date;
     endDate?: Date;
@@ -88,6 +96,7 @@ export type CreateInappResponse = {
     code: string;
 };
 export type UpdateInappRequest_Action = 'UNKNOWN' | 'SAVE_DRAFT' | 'PUBLISH';
+/** Update - update existing inapp (both draft and active) */
 export type UpdateInappRequest = {
     code?: string;
     name?: string;
@@ -96,9 +105,11 @@ export type UpdateInappRequest = {
     richMediaCode?: string;
     filterName?: string;
     filterCode?: string;
+    /** JSON */
     segment?: string;
     eventId?: number;
     eventName?: string;
+    /** JSON */
     devicesFilter?: string;
     startDate?: Date;
     endDate?: Date;
@@ -106,12 +117,14 @@ export type UpdateInappRequest = {
     action?: UpdateInappRequest_Action;
 };
 export type UpdateInappResponse = {};
+/** Stop - convert active inapp to draft */
 export type StopInappRequest = {
     code?: string;
 };
 export type StopInappResponse = {
     code: string;
 };
+/** Publish - convert draft inapp to active with validation */
 export type PublishInappRequest = {
     code?: string;
 };

package/integrations.d.ts

@@ -23,20 +23,29 @@ export type IntegrationsService_ListMetaAdAccounts = RpcMethod<ListMetaAdAccount
 export type IntegrationsService_ConnectMetaAdAccounts = RpcMethod<ConnectMetaAdAccountsRequest, ConnectMetaAdAccountsResponse>;
 export type IntegrationsService_SetMetaTagMapping = RpcMethod<SetMetaTagMappingRequest, SetMetaTagMappingResponse>;
 export interface IntegrationsService {
+    /** lists configuration for each output integration (declared in Integration enums) */
     ListIntegrationsConfiguration: IntegrationsService_ListIntegrationsConfiguration;
+    /** webhook */
     GetWebhookConfiguration: IntegrationsService_GetWebhookConfiguration;
     CreateWebhookConfiguration: IntegrationsService_CreateWebhookConfiguration;
+    /** segment */
     GetSegmentConfiguration: IntegrationsService_GetSegmentConfiguration;
     CreateSegmentConfiguration: IntegrationsService_CreateSegmentConfiguration;
+    /** piano */
     GetPianoConfiguration: IntegrationsService_GetPianoConfiguration;
     CreatePianoConfiguration: IntegrationsService_CreatePianoConfiguration;
+    /** available only for piano to importing segments from piano to PW */
     ImportSegmentPiano: IntegrationsService_ImportSegmentPiano;
+    /** hubspot */
     GetHubspotConfiguration: IntegrationsService_GetHubspotConfiguration;
+    /** shopify */
     GetShopifyConfiguration: IntegrationsService_GetShopifyConfiguration;
+    /** stripe */
     GetStripeAuthURL: IntegrationsService_GetStripeAuthURL;
     HandleStripeAuthCallback: IntegrationsService_HandleStripeAuthCallback;
     GetStripeConfiguration: IntegrationsService_GetStripeConfiguration;
     DeleteStripeConfiguration: IntegrationsService_DeleteStripeConfiguration;
+    /** meta */
     GetMetaAuthURL: IntegrationsService_GetMetaAuthURL;
     HandleMetaAuthCallback: IntegrationsService_HandleMetaAuthCallback;
     GetMetaConfiguration: IntegrationsService_GetMetaConfiguration;
@@ -47,13 +56,17 @@ export interface IntegrationsService {
     ConnectMetaAdAccounts: IntegrationsService_ConnectMetaAdAccounts;
     SetMetaTagMapping: IntegrationsService_SetMetaTagMapping;
 }
+/** Integration contains all available integration for clients (to update props) */
 export type Integration = 'UNKNOWN' | 'SEGMENT' | 'PIANO' | 'WEBHOOK' | 'HUBSPOT' | 'SHOPIFY' | 'STRIPE' | 'META';
 export type ImportSegmentPianoRequest = {
+    /** application code */
     application?: string;
+    /** client segment name from piano */
     segmentKey?: string;
 };
 export type ImportSegmentPianoResponse = {};
 export type ListIntegrationsConfigurationRequest = {
+    /** application code */
     application?: string;
 };
 export type ListIntegrationsConfigurationResponse_Configuration = {
@@ -86,17 +99,24 @@ export type GetWebhookConfigurationRequest = {
     application?: string;
 };
 export type GetWebhookConfigurationResponse = {
+    /** webhook url */
     url: string;
+    /** authorization header */
     auth: string;
+    /** events that picked by client to receive */
     events: string[];
     filters: Filters;
     transport: WebhookIntegrationTransportType;
+    /** events that available to process */
     availableEvents: string[];
 };
 export type CreateWebhookConfigurationRequest = {
     application?: string;
+    /** webhook url */
     url?: string;
+    /** authorization header */
     auth?: string;
+    /** events names that picked by client to receive */
     events?: string[];
     filters?: Filters;
     transport?: WebhookIntegrationTransportType;
@@ -123,10 +143,15 @@ export type GetPianoConfigurationResponse = {
     collectionDomain: string;
     siteId: string;
     apiKey: string;
+    /** event names that picked by client to receive */
     events: string[];
+    /** if true - unique grouping feature turned on, false otherwise */
     uniqueEventsEnabled: boolean;
+    /** event names that picked by client for unique grouping feature */
     uniqueEvents: string[];
+    /** time frame for event grouping */
     uniqueEventsTimeframe: number;
+    /** event names that available to process */
     availableEvents: string[];
 };
 export type CreatePianoConfigurationRequest = {
@@ -134,9 +159,13 @@ export type CreatePianoConfigurationRequest = {
     collectionDomain?: string;
     siteId?: string;
     apiKey?: string;
+    /** event names that picked by client to receive */
     events?: string[];
+    /** if true - unique grouping feature turned on, false otherwise */
     uniqueEventsEnabled?: boolean;
+    /** event names that picked by client for unique grouping feature */
     uniqueEvents?: string[];
+    /** time frame for event grouping */
     uniqueEventsTimeframe?: number;
 };
 export type CreatePianoConfigurationResponse = {};
@@ -144,19 +173,27 @@ export type GetHubspotConfigurationRequest = {
     application?: string;
 };
 export type GetHubspotConfigurationResponse = {
+    /** access token */
     accessToken: string;
+    /** refresh token */
     refreshToken: string;
+    /** updated at */
     updated: string;
+    /** user id */
     userId: string;
 };
 export type GetShopifyConfigurationRequest = {
     application?: string;
 };
 export type GetShopifyConfigurationResponse = {
+    /** shop domain */
     shopDomain: string;
+    /** device api key */
     deviceApiKey: string;
+    /** true if main application, false otherwise */
     mainApplication: boolean;
 };
+/** Stripe messages */
 export type GetStripeAuthURLRequest = {
     redirectUri?: string;
 };
@@ -175,6 +212,7 @@ export type GetStripeConfigurationResponse = {
 };
 export type DeleteStripeConfigurationRequest = {};
 export type DeleteStripeConfigurationResponse = {};
+/** Meta messages */
 export type GetMetaAuthURLRequest = {
     redirectUri?: string;
 };

package/ios_categories.d.ts

@@ -19,6 +19,7 @@ export type ListIOSCategoriesRequest = {
     orderDirection?: ListIOSCategoriesRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
 };
 export type IOSCategory = {

package/kakao_presets.d.ts

@@ -23,7 +23,9 @@ export type ListKakaoPresetsRequest = {
     orderDirection?: ListKakaoPresetsRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
+    /** in ['category'] */
     searchByCategory?: string[];
 };
 export type KakaoPreset = {

package/line_presets.d.ts

@@ -21,7 +21,9 @@ export type ListLinePresetsRequest = {
     orderDirection?: ListLinePresetsRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
+    /** in ['category'] */
     searchByCategory?: string[];
 };
 export type Template_kind_image = {
@@ -56,6 +58,7 @@ export type LinePreset = {
     name: string;
     code: string;
     categories: string[];
+    /** content map {"en": "content"...} */
     localizedContent: Record<string, string>;
     created: Date;
     updated: Date;
@@ -77,6 +80,7 @@ export type CreateLinePresetRequest = {
     application?: string;
     name?: string;
     categories?: string[];
+    /** content map {"en": "content"...} */
     localizedContent?: Record<string, string>;
     localizedTemplate?: Record<string, Template>;
 };
@@ -87,6 +91,7 @@ export type UpdateLinePresetRequest = {
     code?: string;
     name?: string;
     categories?: string[];
+    /** content map {"en": "content"...} */
     localizedContent?: Record<string, string>;
     localizedTemplate?: Record<string, Template>;
 };

package/messages.d.ts

@@ -131,6 +131,11 @@ export type GetLinkClicksStatisticsResponse_LinkClick_Attributes = {
     attributes: string[];
     clicks: number;
 };
+/**
+ * example: 'https://google.com?name=sam&age=20'
+ * https://google.com it's link
+ * ['name=sam', 'age=20'] it's attributes
+ */
 export type GetLinkClicksStatisticsResponse_LinkClick = {
     link: string;
     clicks: number;
@@ -147,8 +152,16 @@ export type GetDeliveryReportRequest = {
     messageCode?: string;
     campaign?: string;
 };
-export type GetDeliveryReportResponse_ProcessingErrorsType = 'processing_unknown' | 'send' | 'publish';
-export type GetDeliveryReportResponse_MailboxErrorType = 'all' | 'complaints' | 'soft_bounces' | 'hard_bounces';
+export type GetDeliveryReportResponse_ProcessingErrorsType = 
+/** Any error types */
+'processing_unknown'
+/** Error during sending */
+ | 'send'
+/** Error during publishing */
+ | 'publish';
+export type GetDeliveryReportResponse_MailboxErrorType = 
+/** for compatibility with types in the export service */
+'all' | 'complaints' | 'soft_bounces' | 'hard_bounces';
 export type GetDeliveryReportResponse_DeliveryReport_ReportError = {
     error: string;
     tooltip: string;

package/package.json

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

package/presets.d.ts

@@ -25,7 +25,9 @@ export type ListPresetsRequest = {
     orderDirection?: ListPresetsRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
+    /** in ['category'] */
     searchByCategory?: string[];
     showHidden?: boolean;
 };
@@ -41,28 +43,46 @@ export type Preset = {
     name: string;
     code: string;
     platforms: Record<number, boolean>;
+    /** Localized properties map<string, Content> */
     localizedProperties: Record<string, pushwoosh_channels_messagingApi_v2_Content>;
+    /** title map {"en": "content"...} */
     localizedTitle: Record<string, string>;
+    /** subtitle map {"en": "content"...} */
     localizedSubtitle: Record<string, string>;
+    /** content map {"en": "content"...} */
     localizedContent: Record<string, string>;
+    /** deeplink code */
     deeplink: string;
+    /** map of params */
     deeplinkParams: Record<string, string>;
+    /** richmedia code */
     richmedia: string;
+    /** whether preset is system */
     system: boolean;
+    /** url */
     url: string;
+    /** inbox image */
     inboxImage: string;
+    /** inbox icon */
     inboxIcon: string;
+    /** inbox days */
     inboxDays: number;
+    /** inbox date */
     inboxDate: Date;
+    /** categories */
     categories: string[];
     created: Date;
     updated: Date;
+    /** userdata content map {"data": "content"...} */
     customData: object;
     isV2: boolean;
+    /** banner attachment */
     banner: string;
+    /** common icon */
     icon: string;
     journeyUuid: string;
     hidden: boolean;
+    /** open actions for platforms */
     openAction: pushwoosh_channels_messagingApi_v2_OpenAction;
     openActions: Record<number, pushwoosh_channels_messagingApi_v2_OpenAction>;
     platformProperties: Record<string, PlatformProperties>;
@@ -84,25 +104,43 @@ export type CreatePresetRequest = {
     name?: string;
     sendType?: string;
     platforms?: Record<number, boolean>;
+    /** Localized properties map<string, Content> */
     localizedProperties?: Record<string, pushwoosh_channels_messagingApi_v2_Content>;
+    /** title map {"en": "content"...} */
     localizedTitle?: Record<string, string>;
+    /** subtitle map {"en": "content"...} */
     localizedSubtitle?: Record<string, string>;
+    /** content map {"en": "content"...} */
     localizedContent?: Record<string, string>;
+    /** deeplink code */
     deeplink?: string;
+    /** map of params */
     deeplinkParams?: Record<string, string>;
+    /** richmedia code */
     richmedia?: string;
+    /** whether preset is system */
     system?: boolean;
+    /** url */
     url?: string;
+    /** inbox image */
     inboxImage?: string;
+    /** inbox icon */
     inboxIcon?: string;
+    /** inbox days */
     inboxDays?: number;
+    /** inbox date */
     inboxDate?: Date;
+    /** user data */
     customData?: object;
+    /** categories */
     categories?: string[];
+    /** banner attachment */
     banner?: string;
+    /** common icon */
     icon?: string;
     journeyUuid?: string;
     hidden?: boolean;
+    /** open actions for platforms */
     openAction?: pushwoosh_channels_messagingApi_v2_OpenAction;
     openActions?: Record<number, pushwoosh_channels_messagingApi_v2_OpenAction>;
     platformProperties?: Record<string, PlatformProperties>;
@@ -115,22 +153,39 @@ export type UpdatePresetRequest = {
     name?: string;
     sendType?: string;
     platforms?: Record<number, boolean>;
+    /** Localized properties map<string, Content> */
     localizedProperties?: Record<string, pushwoosh_channels_messagingApi_v2_Content>;
+    /** title map {"en": "content"...} */
     localizedTitle?: Record<string, string>;
+    /** subtitle map {"en": "content"...} */
     localizedSubtitle?: Record<string, string>;
+    /** content map {"en": "content"...} */
     localizedContent?: Record<string, string>;
+    /** deeplink code */
     deeplink?: string;
+    /** map of params */
     deeplinkParams?: Record<string, string>;
+    /** richmedia code */
     richmedia?: string;
+    /** url */
     url?: string;
+    /** inbox image */
     inboxImage?: string;
+    /** inbox icon */
     inboxIcon?: string;
+    /** inbox days */
     inboxDays?: number;
+    /** inbox date */
     inboxDate?: Date;
+    /** user data */
     customData?: object;
+    /** categories */
     categories?: string[];
+    /** banner attachment */
     banner?: string;
+    /** common icon */
     icon?: string;
+    /** open actions for platforms */
     openAction?: pushwoosh_channels_messagingApi_v2_OpenAction;
     openActions?: Record<number, pushwoosh_channels_messagingApi_v2_OpenAction>;
     platformProperties?: Record<string, PlatformProperties>;
@@ -140,21 +195,37 @@ export type UpdatePresetPartialRequest = {
     name?: string;
     sendType?: string;
     platforms?: Record<number, boolean>;
+    /** Localized properties map<string, Content> */
     localizedProperties?: Record<string, pushwoosh_channels_messagingApi_v2_Content>;
+    /** title map {"en": "content"...} */
     localizedTitle?: Record<string, string>;
+    /** subtitle map {"en": "content"...} */
     localizedSubtitle?: Record<string, string>;
+    /** content map {"en": "content"...} */
     localizedContent?: Record<string, string>;
+    /** deeplink code */
     deeplink?: string;
+    /** map of params */
     deeplinkParams?: Record<string, string>;
+    /** richmedia code */
     richmedia?: string;
+    /** url */
     url?: string;
+    /** inbox image */
     inboxImage?: string;
+    /** inbox icon */
     inboxIcon?: string;
+    /** inbox days */
     inboxDays?: number;
+    /** inbox date */
     inboxDate?: Date;
+    /** user data */
     customData?: object;
+    /** categories */
     categories?: string[];
+    /** banner attachment */
     banner?: string;
+    /** common icon */
     icon?: string;
 };
 export type UpdatePresetResponse = {

package/pushwoosh_accounts_alerts_v1.d.ts

@@ -67,6 +67,7 @@ export type SendRequest = {
     email?: AlertEmail;
     applicationId?: number;
     meta?: object;
+    /** check unique alert within the `unique_key` in the provided request */
     uniqueKey?: string;
 };
 export type UpdateStatusRequest_Alert = {
@@ -86,6 +87,7 @@ export type GetHighestSeverityResponse = {
     severity: AlertSeverity;
 };
 export type DeleteRequest = {
+    /** one of identifiers allowed */
     ids?: number[];
     uniqueKeys?: string[];
     accountId?: number;