@pushwoosh/rpc-v2-http-api-data 0.2.51 → 0.2.53
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 +63 -1
- package/package.json +1 -1
- package/pushwoosh_rpc_popup_forms_v3.d.ts +73 -1
package/data.js
CHANGED
|
@@ -21161,7 +21161,13 @@ export const data = {
|
|
|
21161
21161
|
"CONTENT_OR_SUBSCRIPTION_REQUIRED",
|
|
21162
21162
|
"SUBSCRIPTION_FORM_CODE_INVALID",
|
|
21163
21163
|
"SUBSCRIPTION_FORM_CODE_EMPTY",
|
|
21164
|
-
"POPUP_FORM_SOURCE_TYPE_IMMUTABLE"
|
|
21164
|
+
"POPUP_FORM_SOURCE_TYPE_IMMUTABLE",
|
|
21165
|
+
"EXCLUDED_PAGE_INVALID",
|
|
21166
|
+
"EXCLUDED_PAGE_OPERATOR_INVALID",
|
|
21167
|
+
"EXCLUDED_PAGES_TOO_MANY",
|
|
21168
|
+
"EXCLUDED_PAGES_NOT_ALLOWED_WITH_SPECIFIED_PAGES",
|
|
21169
|
+
"MATCHING_PAGE_RULE_OPERATOR_INVALID",
|
|
21170
|
+
"MATCHING_PAGE_RULES_TOO_MANY"
|
|
21165
21171
|
],
|
|
21166
21172
|
"valuesArgs": {
|
|
21167
21173
|
"NAME_TOO_LONG": [
|
|
@@ -21175,6 +21181,21 @@ export const data = {
|
|
|
21175
21181
|
],
|
|
21176
21182
|
"PER_PAGE_TOO_LARGE": [
|
|
21177
21183
|
"max_per_page"
|
|
21184
|
+
],
|
|
21185
|
+
"EXCLUDED_PAGE_INVALID": [
|
|
21186
|
+
"page"
|
|
21187
|
+
],
|
|
21188
|
+
"EXCLUDED_PAGE_OPERATOR_INVALID": [
|
|
21189
|
+
"operator"
|
|
21190
|
+
],
|
|
21191
|
+
"EXCLUDED_PAGES_TOO_MANY": [
|
|
21192
|
+
"max"
|
|
21193
|
+
],
|
|
21194
|
+
"MATCHING_PAGE_RULE_OPERATOR_INVALID": [
|
|
21195
|
+
"operator"
|
|
21196
|
+
],
|
|
21197
|
+
"MATCHING_PAGE_RULES_TOO_MANY": [
|
|
21198
|
+
"max"
|
|
21178
21199
|
]
|
|
21179
21200
|
}
|
|
21180
21201
|
},
|
|
@@ -21226,6 +21247,17 @@ export const data = {
|
|
|
21226
21247
|
}
|
|
21227
21248
|
}
|
|
21228
21249
|
},
|
|
21250
|
+
"pushwoosh.rpc.popup_forms.v3.PageRule": {
|
|
21251
|
+
"type": "I",
|
|
21252
|
+
"fields": {
|
|
21253
|
+
"path": {
|
|
21254
|
+
"type": "string"
|
|
21255
|
+
},
|
|
21256
|
+
"operator": {
|
|
21257
|
+
"type": "string"
|
|
21258
|
+
}
|
|
21259
|
+
}
|
|
21260
|
+
},
|
|
21229
21261
|
"pushwoosh.rpc.popup_forms.v3.PopupForm": {
|
|
21230
21262
|
"type": "I",
|
|
21231
21263
|
"fields": {
|
|
@@ -21284,6 +21316,14 @@ export const data = {
|
|
|
21284
21316
|
},
|
|
21285
21317
|
"filterCode": {
|
|
21286
21318
|
"type": "string"
|
|
21319
|
+
},
|
|
21320
|
+
"excludedPages": {
|
|
21321
|
+
"type": "pushwoosh.rpc.popup_forms.v3.PageRule",
|
|
21322
|
+
"array": true
|
|
21323
|
+
},
|
|
21324
|
+
"matchingPageRules": {
|
|
21325
|
+
"type": "pushwoosh.rpc.popup_forms.v3.PageRule",
|
|
21326
|
+
"array": true
|
|
21287
21327
|
}
|
|
21288
21328
|
}
|
|
21289
21329
|
},
|
|
@@ -21435,6 +21475,14 @@ export const data = {
|
|
|
21435
21475
|
},
|
|
21436
21476
|
"filterCode": {
|
|
21437
21477
|
"type": "string"
|
|
21478
|
+
},
|
|
21479
|
+
"excludedPages": {
|
|
21480
|
+
"type": "pushwoosh.rpc.popup_forms.v3.PageRule",
|
|
21481
|
+
"array": true
|
|
21482
|
+
},
|
|
21483
|
+
"matchingPageRules": {
|
|
21484
|
+
"type": "pushwoosh.rpc.popup_forms.v3.PageRule",
|
|
21485
|
+
"array": true
|
|
21438
21486
|
}
|
|
21439
21487
|
}
|
|
21440
21488
|
},
|
|
@@ -21503,6 +21551,20 @@ export const data = {
|
|
|
21503
21551
|
},
|
|
21504
21552
|
"filterCode": {
|
|
21505
21553
|
"type": "string"
|
|
21554
|
+
},
|
|
21555
|
+
"updateExcludedPages": {
|
|
21556
|
+
"type": "boolean"
|
|
21557
|
+
},
|
|
21558
|
+
"excludedPages": {
|
|
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",
|
|
21567
|
+
"array": true
|
|
21506
21568
|
}
|
|
21507
21569
|
}
|
|
21508
21570
|
},
|
package/package.json
CHANGED
|
@@ -76,7 +76,34 @@ export type PopupFormsServiceErrors =
|
|
|
76
76
|
/** Subscription form code is required. */
|
|
77
77
|
| 'SUBSCRIPTION_FORM_CODE_EMPTY'
|
|
78
78
|
/** Cannot switch a popup form between a content and a subscription form via update. */
|
|
79
|
-
| 'POPUP_FORM_SOURCE_TYPE_IMMUTABLE'
|
|
79
|
+
| 'POPUP_FORM_SOURCE_TYPE_IMMUTABLE'
|
|
80
|
+
/**
|
|
81
|
+
* Excluded page path has invalid format.
|
|
82
|
+
* args: page - the invalid excluded page path value.
|
|
83
|
+
*/
|
|
84
|
+
| 'EXCLUDED_PAGE_INVALID'
|
|
85
|
+
/**
|
|
86
|
+
* Excluded page operator is invalid (allowed: EQUALS, STARTS_WITH).
|
|
87
|
+
* args: operator - the invalid operator value.
|
|
88
|
+
*/
|
|
89
|
+
| 'EXCLUDED_PAGE_OPERATOR_INVALID'
|
|
90
|
+
/**
|
|
91
|
+
* Too many excluded pages.
|
|
92
|
+
* args: max - the maximum allowed number of excluded pages.
|
|
93
|
+
*/
|
|
94
|
+
| 'EXCLUDED_PAGES_TOO_MANY'
|
|
95
|
+
/** excluded_pages cannot be combined with a non-empty matching_pages list. */
|
|
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';
|
|
80
107
|
export type PopupFormsService_List = RpcMethod<ListRequest, ListResponse>;
|
|
81
108
|
export type PopupFormsService_Get = RpcMethod<GetRequest, GetResponse>;
|
|
82
109
|
export type PopupFormsService_Create = RpcMethod<CreateRequest, CreateResponse>;
|
|
@@ -100,6 +127,16 @@ export interface PopupFormsService {
|
|
|
100
127
|
/** Activate Popup Form (set status to active). */
|
|
101
128
|
Activate: PopupFormsService_Activate;
|
|
102
129
|
}
|
|
130
|
+
/**
|
|
131
|
+
* PageRule is a single "do not show on this page" rule. operator is a
|
|
132
|
+
* string ("EQUALS" | "STARTS_WITH") to match the other categorical fields.
|
|
133
|
+
*/
|
|
134
|
+
export type PageRule = {
|
|
135
|
+
/** Page path, e.g. "/checkout" or "/account". */
|
|
136
|
+
path: string;
|
|
137
|
+
/** Match operator: "EQUALS" (exact path) or "STARTS_WITH" (path prefix). */
|
|
138
|
+
operator: string;
|
|
139
|
+
};
|
|
103
140
|
export type PopupForm = {
|
|
104
141
|
/** Popup Form code. */
|
|
105
142
|
code: string;
|
|
@@ -149,6 +186,17 @@ export type PopupForm = {
|
|
|
149
186
|
* Mutually exclusive with filter_expression.
|
|
150
187
|
*/
|
|
151
188
|
filterCode: string;
|
|
189
|
+
/**
|
|
190
|
+
* Pages to suppress the popup on. Only meaningful when matching_pages is empty
|
|
191
|
+
* (i.e. the popup targets all pages). Empty list means no exclusions.
|
|
192
|
+
*/
|
|
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[];
|
|
152
200
|
};
|
|
153
201
|
export type ListRequest_OrderBy = 'PUBLISHED' | 'NAME';
|
|
154
202
|
export type ListRequest_OrderDirection = 'DESC' | 'ASC';
|
|
@@ -231,6 +279,13 @@ export type CreateRequest = {
|
|
|
231
279
|
filterExpression?: pushwoosh_objects_filters_v1_FilterExpression;
|
|
232
280
|
/** Similar to the PopupForm. Mutually exclusive with filter_expression. */
|
|
233
281
|
filterCode?: string;
|
|
282
|
+
/** Similar to the PopupForm. Only allowed when matching_pages is empty. */
|
|
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[];
|
|
234
289
|
};
|
|
235
290
|
export type CreateResponse = {
|
|
236
291
|
/** Similar to the PopupForm. */
|
|
@@ -288,6 +343,23 @@ export type UpdateRequest = {
|
|
|
288
343
|
filterExpression?: pushwoosh_objects_filters_v1_FilterExpression;
|
|
289
344
|
/** Similar to the PopupForm. Only applied when update_audience is true. */
|
|
290
345
|
filterCode?: string;
|
|
346
|
+
/**
|
|
347
|
+
* Controls how excluded_pages is applied (PATCH semantics):
|
|
348
|
+
* - true → replace excluded_pages with the provided list.
|
|
349
|
+
* - false → do not touch excluded_pages.
|
|
350
|
+
* Required because proto3 cannot distinguish an unset repeated field from one explicitly set to an empty list.
|
|
351
|
+
*/
|
|
352
|
+
updateExcludedPages?: boolean;
|
|
353
|
+
/** Similar to the PopupForm. Only applied when update_excluded_pages is true. */
|
|
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[];
|
|
291
363
|
};
|
|
292
364
|
export type UpdateResponse = {};
|
|
293
365
|
export type DeleteRequest = {
|