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

package/pushwoosh_rpc_errors_v3.d.ts

@@ -2,16 +2,36 @@ export type I18NOptions = {
     args: Record<string, string>;
 };
 export type BadRequest_FieldViolation = {
+    /**
+     * A path that leads to a field in the request body. The value will be a
+     * sequence of dot-separated identifiers that identify a protocol buffer
+     * field.
+     */
     field: string;
+    /** A description of the violation. This will be a concise human-readable summary */
     description: string;
+    /**
+     * A machine-readable code that identifies the error. This will be a constant value.
+     * Each service defined its own set of error codes.
+     */
     reason: string;
+    /**
+     * Optional arguments for error localization.
+     * For each reason, the set of args is fixed and cannot be changed after release.
+     */
     args: Record<string, string>;
 };
 export type BadRequest = {
+    /** The list of field violations that caused the error. */
     fieldViolations: BadRequest_FieldViolation[];
 };
 export type FailedPrecondition = {
+    /**
+     * A machine-readable code that identifies the error. This will be a constant value.
+     * Each service defined its own set of error codes.
+     */
     Type: string;
+    /** A human-readable description of the error. This will be a concise summary of the error. */
     Description: string;
 };
 export type Common_FailedPreconditions = {

package/pushwoosh_rpc_popup_forms_contents_v3.d.ts

@@ -91,10 +91,15 @@ export type PopupFormsContentsService_Delete = RpcMethodV3<DeleteRequest, Delete
     failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
 }>;
 export interface PopupFormsContentsService {
+    /** List Popup Forms Contents for given application and filters. */
     List: PopupFormsContentsService_List;
+    /** Get Popup Form Content by code. */
     Get: PopupFormsContentsService_Get;
+    /** Create new Popup Form Content. Popup Form Content code will be generated by server and returned in response. */
     Create: PopupFormsContentsService_Create;
+    /** Update Popup Form Content. */
     Update: PopupFormsContentsService_Update;
+    /** Delete Popup Form Content. */
     Delete: PopupFormsContentsService_Delete;
 }
 export type PopupFormsContentsService_Errors = {
@@ -116,60 +121,103 @@ export type PopupFormsContentsService_Errors = {
     };
 };
 export type PopupFormContent = {
+    /** Popup Form Content code. */
     code: string;
+    /**
+     * Name of Popup Form Content.
+     * Must be unique within the application.
+     */
     name: string;
+    /**
+     * Json of Popup Form Content.
+     * This string is generated and used only on the frontend side.
+     */
     json: string;
+    /**
+     * Html of Popup Form Content.
+     * This string is generated and used only on the frontend side.
+     */
     html?: string;
+    /** Popup Form Content created timestamp. */
     created: Date;
+    /** Popup Form Content updated timestamp. */
     updated: Date;
 };
 export type ListRequest_OrderBy = 'UPDATED' | 'NAME';
 export type ListRequest_OrderDirection = 'DESC' | 'ASC';
 export type ListRequest = {
+    /** Application code to filter by. */
     application?: string;
+    /** Search query to filter by name or code. */
     search?: string;
+    /** Field to order results by. */
     orderBy?: ListRequest_OrderBy;
+    /** Order direction. */
     orderDirection?: ListRequest_OrderDirection;
+    /** Page number. Pagination start from 0 */
     page?: number;
+    /** Number of items per page. */
     perPage?: number;
 };
 export type ListResponse_ListItem = {
+    /** Similar to the PopupFormContent. */
     code: string;
+    /** Similar to the PopupFormContent. */
     name: string;
+    /** Similar to the PopupFormContent. */
     json: string;
+    /** Similar to the PopupFormContent. */
     html?: string;
+    /** Similar to the PopupFormContent. */
     updated: Date;
 };
 export type ListResponse = {
+    /** List of Popup Form Contents for the current page. */
     items: ListResponse_ListItem[];
+    /** Current page number. Pagination start from 0 */
     page: number;
+    /** Number of items per page. */
     perPage: number;
+    /** Total number of pages. */
     totalPages: number;
+    /** Total number of items across all pages. */
     total: number;
 };
 export type GetRequest = {
+    /** Similar to the PopupFormContent. */
     code?: string;
 };
 export type GetResponse = {
+    /** Popup Form Content. */
     item: PopupFormContent;
 };
 export type CreateRequest = {
+    /** Application code to which Popup Form Content belongs. */
     application?: string;
+    /** Similar to the PopupFormContent. */
     name?: string;
+    /** Similar to the PopupFormContent. */
     json?: string;
+    /** Similar to the PopupFormContent. */
     html?: string;
 };
 export type CreateResponse = {
+    /** Similar to the PopupFormContent. */
     code: string;
 };
 export type UpdateRequest = {
+    /** Similar to the PopupFormContent. */
     code?: string;
+    /** Similar to the PopupFormContent. */
     name?: string;
+    /** Similar to the PopupFormContent. */
     json?: string;
+    /** Similar to the PopupFormContent. */
     html?: string;
 };
 export type UpdateResponse = {};
 export type DeleteRequest = {
+    /** Similar to the PopupFormContent. */
     code?: string;
 };
 export type DeleteResponse = {};

package/pushwoosh_rpc_segments_v3.d.ts

@@ -134,10 +134,15 @@ export type SegmentsService_Delete = RpcMethodV3<DeleteRequest, DeleteResponse,
     failedPreconditions?: SegmentsService_Delete_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
 }>;
 export interface SegmentsService {
+    /** List segments for given application. */
     List: SegmentsService_List;
+    /** Get segment by code. */
     Get: SegmentsService_Get;
+    /** Create new segment. Segment code will be generated by server and returned in response. */
     Create: SegmentsService_Create;
+    /** Update segment. */
     Update: SegmentsService_Update;
+    /** Delete segment. */
     Delete: SegmentsService_Delete;
 }
 export type SegmentsService_Errors = {
@@ -158,6 +163,11 @@ export type SegmentsService_Errors = {
         failedPreconditions: SegmentsService_Delete_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
     };
 };
+/**
+ * DeviceLoadPolicy defines which devices will be loaded into segment during segmentation process.
+ * FILTER - only devices matching the filter. This is the default.
+ * ALL -  all user's devices.
+ */
 export type DeviceLoadPolicy = 'FILTER' | 'ALL';
 export type ListRequest = {
     application?: string;
@@ -166,14 +176,23 @@ export type ListResponse = {};
 export type GetRequest = {
     segment?: string;
 };
+/** Get segment response. Segment conditions are returned in both seglang and filter expression formats. */
 export type GetResponse = {
+    /** Owning application code. */
     application: string;
+    /** Segment code. */
     code: string;
+    /** Segment name. */
     name: string;
+    /** Segment conditions in seglang format. */
     seglang: string;
+    /** Segment conditions in filter expression format. */
     filterExpression: pushwoosh_objects_filters_v1_FilterExpression;
+    /** Device load policy. See DeviceLoadPolicy description for details. */
     deviceLoadPolicy: DeviceLoadPolicy;
+    /** Whether segment is high-speed. See CreateRequest for details. */
     highSpeed: boolean;
+    /** Whether high-speed segment is ready to use. See CreateRequest for details. */
     highSpeedReady: boolean;
     highSpeedPreparedAt: Date;
     createdAt: Date;
@@ -189,24 +208,57 @@ export type CreateRequest_conditions_filterExpression = {
 };
 export type CreateRequest_conditions = CreateRequest_conditions_seglang | CreateRequest_conditions_filterExpression;
 export type CreateRequest = {
+    /** Application code to which segment belongs to. */
     application?: string;
+    /**
+     * Segment name. Must be unique within account.
+     * todo: make uniqueness per application, not account when all filters are migrated to applications.
+     */
     name?: string;
+    /** See DeviceLoadPolicy description for details. If not set, it defaults to FILTER. */
     deviceLoadPolicy?: DeviceLoadPolicy;
+    /**
+     * Whether segment will use high-speed infrastructure. High-speed segment will not return real-time data, but
+     * they allow to omit segmentation process during sending and thus significantly increase sending speed.
+     * High-speed segments are updated in background periodically. Typically every 15 minutes.
+     * If high-speed segment is not updated in 3 hours, it becomes invalid until next successful update.
+     * After creation high-speed segment will be unusable until the initial segmentation process is completed,
+     * so it's recommended to create high-speed segments in advance before they are actually needed.
+     * You can check whether the segment is ready by calling GetSegment and checking high_speed_ready flag.
+     * Once segment is created with high-speed option, it cannot be changed.
+     */
     highSpeed?: boolean;
+    /**
+     * Segment expiration date.
+     * If set, segment will be automatically deleted after given date.
+     * Deletion process is performed in background and may take up to 1 hour after expiration date.
+     * Expiration time is in UTC timezone and cannot be changed after creation.
+     */
     expireAt?: Date;
     conditions: CreateRequest_conditions;
 };
 export type CreateResponse = {
+    /** Owning application code. */
     application: string;
+    /** Segment code. */
     code: string;
+    /** Segment name. */
     name: string;
+    /** Segment conditions in seglang format. */
     seglang: string;
+    /** Segment conditions in filter expression format. */
     filterExpression: pushwoosh_objects_filters_v1_FilterExpression;
+    /** Device load policy. See DeviceLoadPolicy description for details. */
     deviceLoadPolicy: DeviceLoadPolicy;
+    /** Whether segment is high-speed. See CreateRequest for details. */
     highSpeed: boolean;
+    /** Whether high-speed segment is ready to use. See CreateRequest for details. */
     highSpeedReady: boolean;
+    /** Last time when high-speed segment was successfully updated and is ready to use. */
     highSpeedPreparedAt: Date;
+    /** Segment creation time. */
     createdAt: Date;
+    /** Segment expiration time. */
     expireAt: Date;
 };
 export type UpdateRequest_conditions_seglang = {
@@ -219,7 +271,9 @@ export type UpdateRequest_conditions_filterExpression = {
 };
 export type UpdateRequest_conditions = UpdateRequest_conditions_seglang | UpdateRequest_conditions_filterExpression;
 export type UpdateRequest = {
+    /** Segment code. */
     segment?: string;
+    /** New segment name. If set, it must not be empty string and must be unique within account. */
     name?: string;
     conditions: UpdateRequest_conditions;
 };

package/referral_partners.d.ts

@@ -31,6 +31,7 @@ export type GetWithdrawalsHistoryResponse_Status = 'UNKNOWN' | 'CREATED' | 'IN_P
 export type GetWithdrawalsHistoryResponse_Withdrawal = {
     date: Date;
     status: GetWithdrawalsHistoryResponse_Status;
+    /** create withdrawal structure */
     withdrawalInfo: string;
     amount: number;
 };

package/rich_medias.d.ts

@@ -72,6 +72,7 @@ export type ListRequest = {
     viewType?: ListRequest_ListView;
     withMetrics?: boolean;
     withContent?: boolean;
+    /** in ['category'] */
     searchByCategory?: string[];
     codes?: string[];
     orderBy?: ListRequest_OrderBy;
@@ -89,6 +90,7 @@ export type ListResponse = {
     total: number;
 };
 export type GetDetailedStatisticsRequest = {
+    /** rich media code */
     code?: string;
     application?: string;
     dateFrom?: Date;
@@ -110,6 +112,7 @@ export type GetDetailedStatisticsResponse = {
     totals: GetDetailedStatisticsResponse_MetricsWithTimestamp[];
 };
 export type GetDetailedActionStatisticsRequest = {
+    /** rich media code */
     code?: string;
     application?: string;
     dateFrom?: Date;
@@ -138,6 +141,7 @@ export type GetDetailedActionStatisticsResponse = {
     totals: Action[];
 };
 export type GetSendChannelsRequest = {
+    /** rich media code */
     code?: string;
     application?: string;
     dateFrom?: Date;
@@ -164,6 +168,7 @@ export type GetSendChannelsResponse = {
     items: GetSendChannelsResponse_SendChannel[];
 };
 export type GetDevicesRequest = {
+    /** rich media code */
     code?: string;
     application?: string;
     dateFrom?: Date;
@@ -186,6 +191,7 @@ export type GetDevicesResponse = {
     items: GetDevicesResponse_Device[];
 };
 export type GetEventsRequest = {
+    /** rich media code */
     code?: string;
     application?: string;
     dateFrom?: Date;

package/sms_presets.d.ts

@@ -19,13 +19,16 @@ export type ListSmsPresetsRequest = {
     orderDirection?: ListSmsPresetsRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** like %name% */
     searchByName?: string;
+    /** in ['category'] */
     searchByCategory?: string[];
 };
 export type SmsPreset = {
     name: string;
     code: string;
     categories: string[];
+    /** content map {"en": "content"...} */
     localizedContent: Record<string, string>;
     created: Date;
     updated: Date;
@@ -46,6 +49,7 @@ export type CreateSmsPresetRequest = {
     application?: string;
     name?: string;
     categories?: string[];
+    /** content map {"en": "content"...} */
     localizedContent?: Record<string, string>;
 };
 export type CreateSmsPresetResponse = {
@@ -55,6 +59,7 @@ export type UpdateSmsPresetRequest = {
     code?: string;
     name?: string;
     categories?: string[];
+    /** content map {"en": "content"...} */
     localizedContent?: Record<string, string>;
 };
 export type UpdateSmsPresetResponse = {