@pushwoosh/rpc-gateway-journey-data 0.27.217 → 0.27.218

package/pushwoosh_cj_journey_category.d.ts

@@ -1,40 +1,78 @@
+import { RpcMethod } from './commonTypes';
+export type Category_GetCategoriesList = RpcMethod<GetCategoriesListRequest, GetCategoriesListResponse>;
+export type Category_CreateCategory = RpcMethod<CreateCategoryRequest, CreateCategoryResponse>;
+export type Category_UpdateCategory = RpcMethod<UpdateCategoryRequest, UpdateCategoryResponse>;
+export type Category_DeleteCategory = RpcMethod<DeleteCategoryRequest, DeleteCategoryResponse>;
+/**
+ * Category service provides operations for managing journey categories
+ * Categories are used to organize and group journeys within an application
+ */
 export interface Category {
-    GetCategoriesList(request: GetCategoriesListRequest): Promise<GetCategoriesListResponse>;
-    CreateCategory(request: CreateCategoryRequest): Promise<CreateCategoryResponse>;
-    UpdateCategory(request: UpdateCategoryRequest): Promise<UpdateCategoryResponse>;
-    DeleteCategory(request: DeleteCategoryRequest): Promise<DeleteCategoryResponse>;
+    /** Returns a paginated list of journey categories for an application. Use to browse the categories that organize journeys. */
+    GetCategoriesList: Category_GetCategoriesList;
+    /** Creates a new journey category for an application and returns its generated UUID; each call creates a distinct category. */
+    CreateCategory: Category_CreateCategory;
+    /** Updates a journey category's title by its UUID. */
+    UpdateCategory: Category_UpdateCategory;
+    /** Deletes a journey category by UUID and returns the UUIDs of journeys that were in it; those journeys are detached (left uncategorized) but not deleted. Irreversible for the category. */
+    DeleteCategory: Category_DeleteCategory;
 }
+/** GetCategoriesListRequest requests a list of categories for an application */
 export type GetCategoriesListRequest = {
+    /** Application code to filter categories by */
     applicationCode?: string;
+    /** Page number (0-based) */
     page?: number;
+    /** Number of items per page */
     pageSize?: number;
 };
+/** GetCategoriesListResponse contains a list of categories */
 export type GetCategoriesListResponse = {
+    /** List of categories */
     categories: Info[];
 };
+/** CreateCategoryRequest creates a new journey category */
 export type CreateCategoryRequest = {
+    /** Application code this category belongs to */
     applicationCode?: string;
+    /** Title/name of the category */
     title?: string;
 };
+/** CreateCategoryResponse contains the newly created category */
 export type CreateCategoryResponse = {
+    /** Created category information */
     category: Info;
 };
+/** UpdateCategoryRequest updates an existing category */
 export type UpdateCategoryRequest = {
+    /** Application code */
     applicationCode?: string;
+    /** New title for the category */
     title?: string;
+    /** UUID of the category to update */
     uuid?: string;
 };
+/** UpdateCategoryResponse contains the updated category */
 export type UpdateCategoryResponse = {
+    /** Updated category information */
     category: Info;
 };
+/** DeleteCategoryRequest deletes a category */
 export type DeleteCategoryRequest = {
+    /** UUID of the category to delete */
     uuid?: string;
 };
+/** DeleteCategoryResponse contains information about the deletion impact */
 export type DeleteCategoryResponse = {
+    /** UUIDs of journeys that were in this category (now uncategorized) */
     affectedJourneyUuids: string[];
 };
+/** Info contains category metadata */
 export type Info = {
+    /** Unique identifier (UUID) of the category */
     uuid: string;
+    /** Title/name of the category */
     title: string;
+    /** Creation timestamp (ISO 8601 format) */
     createdAt: string;
 };

package/pushwoosh_objects_filters_v1.d.ts

@@ -1,15 +1,57 @@
+import { RpcMethod } from './commonTypes';
+/**
+ * This struct is used to avoid protoc compiler warnings about unused includes in case when
+ * there are no usage for timestamp.* and wrappers.*
+ * This can be removed if you figure out how to remove unused includes.
+ */
 export type __filter_collection_internal = {
     f1: string;
     f2: Date;
     f3: Filter;
 };
 export type LogicExpression_Binary_Operator = 'INVALID' | 'AND' | 'OR';
+/**
+ * BinaryExpression is a kind of expression that allows to combine
+ * two other expressions with application of some binary logic operator.
+ */
 export type LogicExpression_Binary = {
     operator: LogicExpression_Binary_Operator;
     left: LogicExpression;
     right: LogicExpression;
 };
-export type LogicExpression_Field_Operator = 'INVALID' | 'EQ' | 'NEQ' | 'IN' | 'GT' | 'GTE' | 'LT' | 'LTE' | 'STARTS_WITH' | 'ENDS_WITH' | 'LIKE' | 'IS_NULL' | 'NOT_NULL' | 'ILIKE' | 'ARRAY_CONTAINS' | 'ARRAY_INCLUDES' | 'NOT_ILIKE';
+export type LogicExpression_Field_Operator = 'INVALID'
+/** field = value */
+ | 'EQ'
+/** field != value */
+ | 'NEQ'
+/** field in value */
+ | 'IN'
+/** field > value */
+ | 'GT'
+/** field >= value */
+ | 'GTE'
+/** field < value */
+ | 'LT'
+/** field <= value */
+ | 'LTE'
+/** field like 'value%' */
+ | 'STARTS_WITH'
+/** field like '%value' */
+ | 'ENDS_WITH'
+/** field like '%value%' */
+ | 'LIKE'
+/** field is null */
+ | 'IS_NULL'
+/** field is not null */
+ | 'NOT_NULL'
+/** field is ilike '%value%' */
+ | 'ILIKE'
+/** field '@>' array */
+ | 'ARRAY_CONTAINS'
+/** field '<@' array */
+ | 'ARRAY_INCLUDES'
+/** field not ilike '%value%' */
+ | 'NOT_ILIKE';
 export type LogicExpression_Field_ID = {
     operator: LogicExpression_Field_Operator;
     value: number;
@@ -203,6 +245,7 @@ export type LogicExpression_kind_field = {
     data: LogicExpression_Field;
 };
 export type LogicExpression_kind = LogicExpression_kind_binary | LogicExpression_kind_field;
+/** Abstract expression structure. That's an expressions container */
 export type LogicExpression = {
     kind: LogicExpression_kind;
 };
@@ -220,43 +263,83 @@ export type ForExpression = {
     level: LockLevel;
     waiting: LockWaitingOption;
 };
+/**
+ * This struct is used to avoid protoc compiler warnings about unused includes in case when
+ * there are no usage for timestamp.* and wrappers.*
+ * This can be removed if you figure out how to remove unused includes.
+ */
 export type __filter_crud_service_internal = {
     f1: string;
     f2: Date;
     f3: {};
 };
+export type FiltersCrudService_Create = RpcMethod<CreateRequest, CreateResponse>;
+export type FiltersCrudService_CreateMany = RpcMethod<CreateManyRequest, CreateManyResponse>;
+export type FiltersCrudService_Get = RpcMethod<GetRequest, GetResponse>;
+export type FiltersCrudService_LoadByCode = RpcMethod<LoadByCodeRequest, LoadByCodeResponse>;
+export type FiltersCrudService_LoadByAccountIDName = RpcMethod<LoadByAccountIDNameRequest, LoadByAccountIDNameResponse>;
+export type FiltersCrudService_Delete = RpcMethod<DeleteRequest, {}>;
+export type FiltersCrudService_DeleteMany = RpcMethod<DeleteManyRequest, DeleteManyResponse>;
+export type FiltersCrudService_Count = RpcMethod<CountRequest, CountResponse>;
+export type FiltersCrudService_GetPage = RpcMethod<GetPageRequest, GetPageResponse>;
+export type FiltersCrudService_List = RpcMethod<ListRequest, ListResponse>;
+export type FiltersCrudService_Paginate = RpcMethod<PaginateRequest, PaginateResponse>;
+export type FiltersCrudService_List2 = RpcMethod<List2Request, List2Response>;
+export type FiltersCrudService_UpdateCode = RpcMethod<UpdateCodeRequest, {}>;
+export type FiltersCrudService_UpdateAccountID = RpcMethod<UpdateAccountIDRequest, {}>;
+export type FiltersCrudService_UpdateName = RpcMethod<UpdateNameRequest, {}>;
+export type FiltersCrudService_UpdateApplicationID = RpcMethod<UpdateApplicationIDRequest, {}>;
+export type FiltersCrudService_UpdateIsFiltrationInProgress = RpcMethod<UpdateIsFiltrationInProgressRequest, {}>;
+export type FiltersCrudService_UpdateFiltrationStartedAt = RpcMethod<UpdateFiltrationStartedAtRequest, {}>;
+export type FiltersCrudService_UpdateFiltrationLastFilteredAt = RpcMethod<UpdateFiltrationLastFilteredAtRequest, {}>;
+export type FiltersCrudService_UpdateFiltrationLastCheckedAt = RpcMethod<UpdateFiltrationLastCheckedAtRequest, {}>;
+export type FiltersCrudService_UpdateFiltrationScheduledAt = RpcMethod<UpdateFiltrationScheduledAtRequest, {}>;
+export type FiltersCrudService_UpdateCheckerScheduledAt = RpcMethod<UpdateCheckerScheduledAtRequest, {}>;
+export type FiltersCrudService_UpdateIsSystem = RpcMethod<UpdateIsSystemRequest, {}>;
+export type FiltersCrudService_UpdateExpirationDate = RpcMethod<UpdateExpirationDateRequest, {}>;
+export type FiltersCrudService_UpdateCreated = RpcMethod<UpdateCreatedRequest, {}>;
+export type FiltersCrudService_UpdateFilterExpressionRaw = RpcMethod<UpdateFilterExpressionRawRequest, {}>;
+export type FiltersCrudService_UpdateFiltrationID = RpcMethod<UpdateFiltrationIDRequest, {}>;
+export type FiltersCrudService_UpdateUpdated = RpcMethod<UpdateUpdatedRequest, {}>;
+export type FiltersCrudService_UpdateDescription = RpcMethod<UpdateDescriptionRequest, {}>;
+export type FiltersCrudService_UpdateDeviceLoadPolicy = RpcMethod<UpdateDeviceLoadPolicyRequest, {}>;
+export type FiltersCrudService_UpdateHighSpeed = RpcMethod<UpdateHighSpeedRequest, {}>;
 export interface FiltersCrudService {
-    Create(request: CreateRequest): Promise<CreateResponse>;
-    CreateMany(request: CreateManyRequest): Promise<CreateManyResponse>;
-    Get(request: GetRequest): Promise<GetResponse>;
-    LoadByCode(request: LoadByCodeRequest): Promise<LoadByCodeResponse>;
-    LoadByAccountIDName(request: LoadByAccountIDNameRequest): Promise<LoadByAccountIDNameResponse>;
-    Delete(request: DeleteRequest): Promise<{}>;
-    DeleteMany(request: DeleteManyRequest): Promise<DeleteManyResponse>;
-    Count(request: CountRequest): Promise<CountResponse>;
-    GetPage(request: GetPageRequest): Promise<GetPageResponse>;
-    List(request: ListRequest): Promise<ListResponse>;
-    Paginate(request: PaginateRequest): Promise<PaginateResponse>;
-    List2(request: List2Request): Promise<List2Response>;
-    UpdateCode(request: UpdateCodeRequest): Promise<{}>;
-    UpdateAccountID(request: UpdateAccountIDRequest): Promise<{}>;
-    UpdateName(request: UpdateNameRequest): Promise<{}>;
-    UpdateApplicationID(request: UpdateApplicationIDRequest): Promise<{}>;
-    UpdateIsFiltrationInProgress(request: UpdateIsFiltrationInProgressRequest): Promise<{}>;
-    UpdateFiltrationStartedAt(request: UpdateFiltrationStartedAtRequest): Promise<{}>;
-    UpdateFiltrationLastFilteredAt(request: UpdateFiltrationLastFilteredAtRequest): Promise<{}>;
-    UpdateFiltrationLastCheckedAt(request: UpdateFiltrationLastCheckedAtRequest): Promise<{}>;
-    UpdateFiltrationScheduledAt(request: UpdateFiltrationScheduledAtRequest): Promise<{}>;
-    UpdateCheckerScheduledAt(request: UpdateCheckerScheduledAtRequest): Promise<{}>;
-    UpdateIsSystem(request: UpdateIsSystemRequest): Promise<{}>;
-    UpdateExpirationDate(request: UpdateExpirationDateRequest): Promise<{}>;
-    UpdateCreated(request: UpdateCreatedRequest): Promise<{}>;
-    UpdateFilterExpressionRaw(request: UpdateFilterExpressionRawRequest): Promise<{}>;
-    UpdateFiltrationID(request: UpdateFiltrationIDRequest): Promise<{}>;
-    UpdateUpdated(request: UpdateUpdatedRequest): Promise<{}>;
-    UpdateDescription(request: UpdateDescriptionRequest): Promise<{}>;
-    UpdateDeviceLoadPolicy(request: UpdateDeviceLoadPolicyRequest): Promise<{}>;
-    UpdateHighSpeed(request: UpdateHighSpeedRequest): Promise<{}>;
+    Create: FiltersCrudService_Create;
+    CreateMany: FiltersCrudService_CreateMany;
+    Get: FiltersCrudService_Get;
+    LoadByCode: FiltersCrudService_LoadByCode;
+    LoadByAccountIDName: FiltersCrudService_LoadByAccountIDName;
+    Delete: FiltersCrudService_Delete;
+    DeleteMany: FiltersCrudService_DeleteMany;
+    Count: FiltersCrudService_Count;
+    GetPage: FiltersCrudService_GetPage;
+    List: FiltersCrudService_List;
+    Paginate: FiltersCrudService_Paginate;
+    /**
+     * List2 reads the whole collection within a single query, so the result is always a
+     * consistent snapshot, unlike the List + Paginate pair which reads each page separately.
+     */
+    List2: FiltersCrudService_List2;
+    UpdateCode: FiltersCrudService_UpdateCode;
+    UpdateAccountID: FiltersCrudService_UpdateAccountID;
+    UpdateName: FiltersCrudService_UpdateName;
+    UpdateApplicationID: FiltersCrudService_UpdateApplicationID;
+    UpdateIsFiltrationInProgress: FiltersCrudService_UpdateIsFiltrationInProgress;
+    UpdateFiltrationStartedAt: FiltersCrudService_UpdateFiltrationStartedAt;
+    UpdateFiltrationLastFilteredAt: FiltersCrudService_UpdateFiltrationLastFilteredAt;
+    UpdateFiltrationLastCheckedAt: FiltersCrudService_UpdateFiltrationLastCheckedAt;
+    UpdateFiltrationScheduledAt: FiltersCrudService_UpdateFiltrationScheduledAt;
+    UpdateCheckerScheduledAt: FiltersCrudService_UpdateCheckerScheduledAt;
+    UpdateIsSystem: FiltersCrudService_UpdateIsSystem;
+    UpdateExpirationDate: FiltersCrudService_UpdateExpirationDate;
+    UpdateCreated: FiltersCrudService_UpdateCreated;
+    UpdateFilterExpressionRaw: FiltersCrudService_UpdateFilterExpressionRaw;
+    UpdateFiltrationID: FiltersCrudService_UpdateFiltrationID;
+    UpdateUpdated: FiltersCrudService_UpdateUpdated;
+    UpdateDescription: FiltersCrudService_UpdateDescription;
+    UpdateDeviceLoadPolicy: FiltersCrudService_UpdateDeviceLoadPolicy;
+    UpdateHighSpeed: FiltersCrudService_UpdateHighSpeed;
 }
 export type CreateRequest = {
     Code?: string;
@@ -433,6 +516,11 @@ export type LoadByAccountIDNameRequest = {
 export type LoadByAccountIDNameResponse = {
     filter: Filter;
 };
+/**
+ * This struct is used to avoid protoc compiler warnings about unused includes in case when
+ * there are no usage for timestamp.* and wrappers.*
+ * This can be removed if you figure out how to remove unused includes.
+ */
 export type __filter_model_internal = {
     f1: string;
     f2: Date;
@@ -466,12 +554,14 @@ export type FilterExpression_Operation = {
 };
 export type FilterExpression_Application_TokenPresence = 'TOKEN_PRESENCE_UNSPECIFIED' | 'TOKEN_PRESENCE_WITH_TOKENS' | 'TOKEN_PRESENCE_WITHOUT_TOKENS' | 'TOKEN_PRESENCE_ALL';
 export type FilterExpression_Application_DevicePresence = 'DEVICE_PRESENCE_UNSPECIFIED' | 'DEVICE_PRESENCE_WITH_DEVICES' | 'DEVICE_PRESENCE_WITHOUT_DEVICES' | 'DEVICE_PRESENCE_ALL';
+/** Application specifies set of devices that subscribed to given applications */
 export type FilterExpression_Application = {
     codes: string[];
     platforms: number[];
     tokenPresence: FilterExpression_Application_TokenPresence;
     devicePresence: FilterExpression_Application_DevicePresence;
 };
+/** Geo specifies set of devices located within given coordinate range */
 export type FilterExpression_Geo = {
     application: string;
     lat: number;
@@ -515,6 +605,7 @@ export type FilterExpression_BestTimeToSend_Value_kind = FilterExpression_BestTi
 export type FilterExpression_BestTimeToSend_Value = {
     kind: FilterExpression_BestTimeToSend_Value_kind;
 };
+/** BestTimeToSend specifies set of devices associated with given best time to send value */
 export type FilterExpression_BestTimeToSend = {
     applications: string[];
     value: FilterExpression_BestTimeToSend_Value;
@@ -523,9 +614,14 @@ export type FilterExpression_Segment = {
     application: string;
     segment: string;
 };
+/**
+ * OPERATOR_UNSPECIFIED is read as OPERATOR_IN: filters saved before the
+ * operator existed carry no value here.
+ */
 export type FilterExpression_List_Operator = 'OPERATOR_UNSPECIFIED' | 'OPERATOR_IN' | 'OPERATOR_NOT_IN' | 'OPERATOR_STARTS_WITH' | 'OPERATOR_ENDS_WITH' | 'OPERATOR_CONTAINS';
 export type FilterExpression_List = {
     application: string;
+    /** kind: users | devices | tokens */
     kind: string;
     users: string[];
     devices: string[];
@@ -536,6 +632,7 @@ export type FilterExpression_ExternalSegment = {
     application: string;
     segment: string;
 };
+/** UserID/HWID set stored in database */
 export type FilterExpression_Static = {
     application: string;
     segment: string;
@@ -1047,6 +1144,7 @@ export type FilterExpression_Event_Attribute = {
     name: string;
     kind: FilterExpression_Event_Attribute_kind;
 };
+/** Event specifies set of devices associated with given event parameters */
 export type FilterExpression_Event = {
     application: string;
     event: string;
@@ -1055,6 +1153,10 @@ export type FilterExpression_Event = {
     attributes: FilterExpression_Event_Attribute[];
     platforms: string[];
     hwids: string[];
+    /**
+     * sums restricts the sum of numeric attributes over the matched events of a device or user.
+     * Only integer and price attributes with eq/neq/lte/gte/between are accepted.
+     */
     sums: FilterExpression_Event_Attribute[];
 };
 export type FilterExpression_Updated_Condition_Lte = {
@@ -1084,6 +1186,7 @@ export type FilterExpression_Updated_Condition_kind = FilterExpression_Updated_C
 export type FilterExpression_Updated_Condition = {
     kind: FilterExpression_Updated_Condition_kind;
 };
+/** Updated specifies set of devices that match restrictions for device updated at field */
 export type FilterExpression_Updated = {
     application: string;
     condition: FilterExpression_Updated_Condition;
@@ -1563,11 +1666,13 @@ export type FilterExpression_Tag_kind_timezone = {
     data: FilterExpression_Tag_Timezone;
 };
 export type FilterExpression_Tag_kind = FilterExpression_Tag_kind_integer | FilterExpression_Tag_kind_string | FilterExpression_Tag_kind_list | FilterExpression_Tag_kind_date | FilterExpression_Tag_kind_boolean | FilterExpression_Tag_kind_price | FilterExpression_Tag_kind_version | FilterExpression_Tag_kind_timezone;
+/** Tag specifies set of devices that match given tag conditions */
 export type FilterExpression_Tag = {
     name: string;
     application: string;
     kind: FilterExpression_Tag_kind;
 };
+/** Tag specifies set of devices that match given tag conditions */
 export type FilterExpression_TagDateMatch = {
     name: string;
     application: string;
@@ -1576,6 +1681,7 @@ export type FilterExpression_TagDateMatch = {
     addDays: number;
 };
 export type FilterExpression_FeatureFlag_State = 'STATE_UNSPECIFIED' | 'STATE_ENABLED' | 'STATE_DISABLED' | 'STATE_IN_RULE';
+/** FeatureFlag specifies devices by their last feature flag assignment */
 export type FilterExpression_FeatureFlag = {
     application: string;
     key: string;
@@ -1635,6 +1741,7 @@ export type FilterExpression_kind_featureFlag = {
     data: FilterExpression_FeatureFlag;
 };
 export type FilterExpression_kind = FilterExpression_kind_operation | FilterExpression_kind_application | FilterExpression_kind_tag | FilterExpression_kind_geo | FilterExpression_kind_static | FilterExpression_kind_event | FilterExpression_kind_updated | FilterExpression_kind_bestTimeToSend | FilterExpression_kind_tagDateMatch | FilterExpression_kind_segment | FilterExpression_kind_list | FilterExpression_kind_externalSegment | FilterExpression_kind_featureFlag;
+/** FilterExpression describes structures for querying devices from the database */
 export type FilterExpression = {
     kind: FilterExpression_kind;
 };

package/types.d.ts

@@ -7,12 +7,14 @@ export type InterfaceDefinition = {
     oneofs?: {
         [oneofName: string]: OneofGroup;
     };
+    comment?: string;
 };
 export type FieldDefinition = {
     type: string;
     mapKeyType?: string;
     array?: boolean;
     optional?: boolean;
+    comment?: string;
 };
 export type OneofGroup = {
     oneof: string[];
@@ -20,6 +22,9 @@ export type OneofGroup = {
 export type EnumDefinition = {
     type: 'E';
     values: string[];
+    valuesArgs?: Record<string, string[]>;
+    comment?: string;
+    valueComments?: Record<string, string>;
 };
 export type ServiceDefinition = {
     type: 'S';
@@ -27,12 +32,20 @@ export type ServiceDefinition = {
     methods: {
         [methodName: string]: ServiceMethod;
     };
+    comment?: string;
 };
 export type ServiceMethod = {
     request: string;
     response: string;
     method: string;
     path: string;
+    serverStreaming?: boolean;
+    errors?: {
+        fieldViolations?: string;
+        failedPreconditions?: string;
+        commonFailedPreconditions?: string;
+    };
+    comment?: string;
 };
 export type InterfaceDefinitionRaw = InterfaceDefinition & {
     package: string;

package/types.js

@@ -1 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
 export {};