@pushwoosh/rpc-v2-http-api-data 0.2.52 → 0.2.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/data.js CHANGED
@@ -21165,7 +21165,9 @@ export const data = {
21165
21165
  "EXCLUDED_PAGE_INVALID",
21166
21166
  "EXCLUDED_PAGE_OPERATOR_INVALID",
21167
21167
  "EXCLUDED_PAGES_TOO_MANY",
21168
- "EXCLUDED_PAGES_NOT_ALLOWED_WITH_SPECIFIED_PAGES"
21168
+ "EXCLUDED_PAGES_NOT_ALLOWED_WITH_SPECIFIED_PAGES",
21169
+ "MATCHING_PAGE_RULE_OPERATOR_INVALID",
21170
+ "MATCHING_PAGE_RULES_TOO_MANY"
21169
21171
  ],
21170
21172
  "valuesArgs": {
21171
21173
  "NAME_TOO_LONG": [
@@ -21188,6 +21190,12 @@ export const data = {
21188
21190
  ],
21189
21191
  "EXCLUDED_PAGES_TOO_MANY": [
21190
21192
  "max"
21193
+ ],
21194
+ "MATCHING_PAGE_RULE_OPERATOR_INVALID": [
21195
+ "operator"
21196
+ ],
21197
+ "MATCHING_PAGE_RULES_TOO_MANY": [
21198
+ "max"
21191
21199
  ]
21192
21200
  }
21193
21201
  },
@@ -21239,7 +21247,7 @@ export const data = {
21239
21247
  }
21240
21248
  }
21241
21249
  },
21242
- "pushwoosh.rpc.popup_forms.v3.ExcludedPage": {
21250
+ "pushwoosh.rpc.popup_forms.v3.PageRule": {
21243
21251
  "type": "I",
21244
21252
  "fields": {
21245
21253
  "path": {
@@ -21310,7 +21318,11 @@ export const data = {
21310
21318
  "type": "string"
21311
21319
  },
21312
21320
  "excludedPages": {
21313
- "type": "pushwoosh.rpc.popup_forms.v3.ExcludedPage",
21321
+ "type": "pushwoosh.rpc.popup_forms.v3.PageRule",
21322
+ "array": true
21323
+ },
21324
+ "matchingPageRules": {
21325
+ "type": "pushwoosh.rpc.popup_forms.v3.PageRule",
21314
21326
  "array": true
21315
21327
  }
21316
21328
  }
@@ -21465,7 +21477,11 @@ export const data = {
21465
21477
  "type": "string"
21466
21478
  },
21467
21479
  "excludedPages": {
21468
- "type": "pushwoosh.rpc.popup_forms.v3.ExcludedPage",
21480
+ "type": "pushwoosh.rpc.popup_forms.v3.PageRule",
21481
+ "array": true
21482
+ },
21483
+ "matchingPageRules": {
21484
+ "type": "pushwoosh.rpc.popup_forms.v3.PageRule",
21469
21485
  "array": true
21470
21486
  }
21471
21487
  }
@@ -21540,7 +21556,14 @@ export const data = {
21540
21556
  "type": "boolean"
21541
21557
  },
21542
21558
  "excludedPages": {
21543
- "type": "pushwoosh.rpc.popup_forms.v3.ExcludedPage",
21559
+ "type": "pushwoosh.rpc.popup_forms.v3.PageRule",
21560
+ "array": true
21561
+ },
21562
+ "updateMatchingPageRules": {
21563
+ "type": "boolean"
21564
+ },
21565
+ "matchingPageRules": {
21566
+ "type": "pushwoosh.rpc.popup_forms.v3.PageRule",
21544
21567
  "array": true
21545
21568
  }
21546
21569
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.52",
3
+ "version": "0.2.54",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -93,7 +93,17 @@ export type PopupFormsServiceErrors =
93
93
  */
94
94
  | 'EXCLUDED_PAGES_TOO_MANY'
95
95
  /** excluded_pages cannot be combined with a non-empty matching_pages list. */
96
- | 'EXCLUDED_PAGES_NOT_ALLOWED_WITH_SPECIFIED_PAGES';
96
+ | 'EXCLUDED_PAGES_NOT_ALLOWED_WITH_SPECIFIED_PAGES'
97
+ /**
98
+ * Matching page rule operator is invalid (allowed: EQUALS, STARTS_WITH).
99
+ * args: operator - the invalid operator value.
100
+ */
101
+ | 'MATCHING_PAGE_RULE_OPERATOR_INVALID'
102
+ /**
103
+ * Too many matching page rules.
104
+ * args: max - the maximum allowed number of matching page rules.
105
+ */
106
+ | 'MATCHING_PAGE_RULES_TOO_MANY';
97
107
  export type PopupFormsService_List = RpcMethod<ListRequest, ListResponse>;
98
108
  export type PopupFormsService_Get = RpcMethod<GetRequest, GetResponse>;
99
109
  export type PopupFormsService_Create = RpcMethod<CreateRequest, CreateResponse>;
@@ -118,10 +128,10 @@ export interface PopupFormsService {
118
128
  Activate: PopupFormsService_Activate;
119
129
  }
120
130
  /**
121
- * ExcludedPage is a single "do not show on this page" rule. operator is a
131
+ * PageRule is a single "do not show on this page" rule. operator is a
122
132
  * string ("EQUALS" | "STARTS_WITH") to match the other categorical fields.
123
133
  */
124
- export type ExcludedPage = {
134
+ export type PageRule = {
125
135
  /** Page path, e.g. "/checkout" or "/account". */
126
136
  path: string;
127
137
  /** Match operator: "EQUALS" (exact path) or "STARTS_WITH" (path prefix). */
@@ -180,7 +190,13 @@ export type PopupForm = {
180
190
  * Pages to suppress the popup on. Only meaningful when matching_pages is empty
181
191
  * (i.e. the popup targets all pages). Empty list means no exclusions.
182
192
  */
183
- excludedPages: ExcludedPage[];
193
+ excludedPages: PageRule[];
194
+ /**
195
+ * Operator-aware "Specified pages" include list ({path, operator}, reuses the
196
+ * PageRule shape). Superset of the legacy matching_pages, which is kept in
197
+ * sync (= rule paths) for older SDKs. Empty means no page restrictions.
198
+ */
199
+ matchingPageRules: PageRule[];
184
200
  };
185
201
  export type ListRequest_OrderBy = 'PUBLISHED' | 'NAME';
186
202
  export type ListRequest_OrderDirection = 'DESC' | 'ASC';
@@ -264,7 +280,12 @@ export type CreateRequest = {
264
280
  /** Similar to the PopupForm. Mutually exclusive with filter_expression. */
265
281
  filterCode?: string;
266
282
  /** Similar to the PopupForm. Only allowed when matching_pages is empty. */
267
- excludedPages?: ExcludedPage[];
283
+ excludedPages?: PageRule[];
284
+ /**
285
+ * Similar to the PopupForm. Operator-aware include list; when set it supersedes
286
+ * matching_pages (which is kept in sync = rule paths).
287
+ */
288
+ matchingPageRules?: PageRule[];
268
289
  };
269
290
  export type CreateResponse = {
270
291
  /** Similar to the PopupForm. */
@@ -330,7 +351,15 @@ export type UpdateRequest = {
330
351
  */
331
352
  updateExcludedPages?: boolean;
332
353
  /** Similar to the PopupForm. Only applied when update_excluded_pages is true. */
333
- excludedPages?: ExcludedPage[];
354
+ excludedPages?: PageRule[];
355
+ /**
356
+ * Controls how matching_page_rules is applied (PATCH semantics):
357
+ * - true → replace matching_page_rules (and the synced legacy matching_pages).
358
+ * - false → do not touch them.
359
+ */
360
+ updateMatchingPageRules?: boolean;
361
+ /** Similar to the PopupForm. Only applied when update_matching_page_rules is true. */
362
+ matchingPageRules?: PageRule[];
334
363
  };
335
364
  export type UpdateResponse = {};
336
365
  export type DeleteRequest = {