@pushwoosh/rpc-v2-http-api-data 0.2.403 → 0.2.405

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
@@ -31670,6 +31670,19 @@ export const data = {
31670
31670
  "POPUP_FORM_CONTENT_IN_USE"
31671
31671
  ]
31672
31672
  },
31673
+ "pushwoosh.rpc.popup_forms_contents.v3.PopupFormsContentsService_Batch_FieldViolations": {
31674
+ "type": "E",
31675
+ "values": [
31676
+ "FV_BATCH_UNSPECIFIED",
31677
+ "CODES_EMPTY",
31678
+ "CODES_TOO_MANY"
31679
+ ],
31680
+ "valuesArgs": {
31681
+ "CODES_TOO_MANY": [
31682
+ "max"
31683
+ ]
31684
+ }
31685
+ },
31673
31686
  "pushwoosh.rpc.popup_forms_contents.v3.PopupFormsContentsService": {
31674
31687
  "type": "S",
31675
31688
  "key": "popupFormsContents",
@@ -31719,6 +31732,24 @@ export const data = {
31719
31732
  "errors": {
31720
31733
  "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
31721
31734
  }
31735
+ },
31736
+ "DeletePopupFormsContents": {
31737
+ "request": "pushwoosh.rpc.popup_forms_contents.v3.DeletePopupFormsContentsRequest",
31738
+ "response": "pushwoosh.rpc.popup_forms_contents.v3.DeletePopupFormsContentsResponse",
31739
+ "method": "post",
31740
+ "path": "/api/v3/popup_forms_contents/delete",
31741
+ "errors": {
31742
+ "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
31743
+ }
31744
+ },
31745
+ "GetPopupFormsContentsUsage": {
31746
+ "request": "pushwoosh.rpc.popup_forms_contents.v3.GetPopupFormsContentsUsageRequest",
31747
+ "response": "pushwoosh.rpc.popup_forms_contents.v3.GetPopupFormsContentsUsageResponse",
31748
+ "method": "post",
31749
+ "path": "/api/v3/popup_forms_contents/usage",
31750
+ "errors": {
31751
+ "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
31752
+ }
31722
31753
  }
31723
31754
  }
31724
31755
  },
@@ -31910,6 +31941,81 @@ export const data = {
31910
31941
  "type": "I",
31911
31942
  "fields": {}
31912
31943
  },
31944
+ "pushwoosh.rpc.popup_forms_contents.v3.DeletePopupFormsContentsRequest": {
31945
+ "type": "I",
31946
+ "fields": {
31947
+ "application": {
31948
+ "type": "string"
31949
+ },
31950
+ "codes": {
31951
+ "type": "string",
31952
+ "array": true
31953
+ }
31954
+ }
31955
+ },
31956
+ "pushwoosh.rpc.popup_forms_contents.v3.DeletePopupFormsContentsResponse": {
31957
+ "type": "I",
31958
+ "fields": {}
31959
+ },
31960
+ "pushwoosh.rpc.popup_forms_contents.v3.GetPopupFormsContentsUsageRequest": {
31961
+ "type": "I",
31962
+ "fields": {
31963
+ "application": {
31964
+ "type": "string"
31965
+ },
31966
+ "codes": {
31967
+ "type": "string",
31968
+ "array": true
31969
+ }
31970
+ }
31971
+ },
31972
+ "pushwoosh.rpc.popup_forms_contents.v3.PopupFormContentUsage.UsingPopupForm": {
31973
+ "type": "I",
31974
+ "fields": {
31975
+ "code": {
31976
+ "type": "string"
31977
+ },
31978
+ "name": {
31979
+ "type": "string"
31980
+ }
31981
+ }
31982
+ },
31983
+ "pushwoosh.rpc.popup_forms_contents.v3.PopupFormContentUsage.UsingJourney": {
31984
+ "type": "I",
31985
+ "fields": {
31986
+ "uuid": {
31987
+ "type": "string"
31988
+ },
31989
+ "title": {
31990
+ "type": "string"
31991
+ }
31992
+ }
31993
+ },
31994
+ "pushwoosh.rpc.popup_forms_contents.v3.PopupFormContentUsage": {
31995
+ "type": "I",
31996
+ "fields": {
31997
+ "code": {
31998
+ "type": "string"
31999
+ },
32000
+ "popupForms": {
32001
+ "type": "pushwoosh.rpc.popup_forms_contents.v3.PopupFormContentUsage.UsingPopupForm",
32002
+ "array": true
32003
+ },
32004
+ "journeys": {
32005
+ "type": "pushwoosh.rpc.popup_forms_contents.v3.PopupFormContentUsage.UsingJourney",
32006
+ "array": true
32007
+ }
32008
+ }
32009
+ },
32010
+ "pushwoosh.rpc.popup_forms_contents.v3.GetPopupFormsContentsUsageResponse": {
32011
+ "type": "I",
32012
+ "fields": {
32013
+ "usages": {
32014
+ "type": "pushwoosh.rpc.popup_forms_contents.v3.PopupFormContentUsage",
32015
+ "array": true
32016
+ }
32017
+ }
32018
+ },
31913
32019
  "pushwoosh.rpc_v2.presets.presetsService": {
31914
32020
  "type": "S",
31915
32021
  "key": "presets",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.403",
3
+ "version": "0.2.405",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -61,6 +61,22 @@ export type PopupFormsContentsService_Common_FailedPreconditions = {
61
61
  type: 'POPUP_FORM_CONTENT_IN_USE';
62
62
  description: string;
63
63
  };
64
+ export type PopupFormsContentsService_Batch_FieldViolations = {
65
+ reason: 'FV_BATCH_UNSPECIFIED';
66
+ field: string;
67
+ description: string;
68
+ } | {
69
+ reason: 'CODES_EMPTY';
70
+ field: string;
71
+ description: string;
72
+ } | {
73
+ reason: 'CODES_TOO_MANY';
74
+ field: string;
75
+ description: string;
76
+ args: {
77
+ max: string;
78
+ };
79
+ };
64
80
  export type PopupFormsContentsService_List = RpcMethodV3<ListRequest, ListResponse, {
65
81
  error: unknown;
66
82
  fieldViolations?: undefined;
@@ -98,6 +114,20 @@ export type PopupFormsContentsService_Delete = RpcMethodV3<DeleteRequest, Delete
98
114
  error?: undefined;
99
115
  failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
100
116
  }>;
117
+ export type PopupFormsContentsService_DeletePopupFormsContents = RpcMethodV3<DeletePopupFormsContentsRequest, DeletePopupFormsContentsResponse, {
118
+ error: unknown;
119
+ failedPreconditions?: undefined;
120
+ } | {
121
+ error?: undefined;
122
+ failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
123
+ }>;
124
+ export type PopupFormsContentsService_GetPopupFormsContentsUsage = RpcMethodV3<GetPopupFormsContentsUsageRequest, GetPopupFormsContentsUsageResponse, {
125
+ error: unknown;
126
+ failedPreconditions?: undefined;
127
+ } | {
128
+ error?: undefined;
129
+ failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
130
+ }>;
101
131
  export interface PopupFormsContentsService {
102
132
  /** Lists popup form contents (web subscription-popup designs) for an application code XXXXX-XXXXX, ordered by updated or name, with paging and free-text search over name and code. Use to browse designs or find a content code before get/update/delete. */
103
133
  List: PopupFormsContentsService_List;
@@ -107,8 +137,12 @@ export interface PopupFormsContentsService {
107
137
  Create: PopupFormsContentsService_Create;
108
138
  /** Overwrites a popup form content's name, json and html by content code. Use to save edits to an existing design; delete_popup_form_content removes it instead. */
109
139
  Update: PopupFormsContentsService_Update;
110
- /** Deletes a popup form content by content code. Fails if any popup form still references it; a repeat call after deletion returns not-found. */
140
+ /** Deletes a popup form content by content code. Fails if any popup form still references it or a running or paused journey opens it from an inbox message; a repeat call after deletion returns not-found. */
111
141
  Delete: PopupFormsContentsService_Delete;
142
+ /** Permanently deletes several popup form contents of an application (code XXXXX-XXXXX) in one request, up to 1000 codes, like delete_popup_form_content. All-or-nothing: if any code is not found, is used by a popup form or is opened from an inbox message of a running or paused journey, nothing is deleted; check get_popup_form_contents_usage first. */
143
+ DeletePopupFormsContents: PopupFormsContentsService_DeletePopupFormsContents;
144
+ /** Lists which of the given popup form contents of an application (code XXXXX-XXXXX), up to 1000 codes, are used by popup forms or opened from inbox messages of running or paused journeys, with those popup forms and journeys. Contents missing from the answer are not in use or not found. Use before delete_popup_form_contents. */
145
+ GetPopupFormsContentsUsage: PopupFormsContentsService_GetPopupFormsContentsUsage;
112
146
  }
113
147
  export type PopupFormsContentsService_Errors = {
114
148
  List: {
@@ -127,6 +161,12 @@ export type PopupFormsContentsService_Errors = {
127
161
  Delete: {
128
162
  failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
129
163
  };
164
+ DeletePopupFormsContents: {
165
+ failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
166
+ };
167
+ GetPopupFormsContentsUsage: {
168
+ failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
169
+ };
130
170
  };
131
171
  export type PopupFormContent = {
132
172
  /** Popup Form Content code. */
@@ -238,3 +278,36 @@ export type DeleteRequest = {
238
278
  code?: string;
239
279
  };
240
280
  export type DeleteResponse = {};
281
+ export type DeletePopupFormsContentsRequest = {
282
+ /** Application code (XXXXX-XXXXX) the contents belong to. */
283
+ application?: string;
284
+ /** Popup Form Content codes to delete. */
285
+ codes?: string[];
286
+ };
287
+ export type DeletePopupFormsContentsResponse = {};
288
+ export type GetPopupFormsContentsUsageRequest = {
289
+ /** Application code (XXXXX-XXXXX) the contents belong to. */
290
+ application?: string;
291
+ /** Popup Form Content codes to check. */
292
+ codes?: string[];
293
+ };
294
+ export type PopupFormContentUsage_UsingPopupForm = {
295
+ code: string;
296
+ name: string;
297
+ };
298
+ export type PopupFormContentUsage_UsingJourney = {
299
+ uuid: string;
300
+ title: string;
301
+ };
302
+ export type PopupFormContentUsage = {
303
+ /** Popup Form Content code. */
304
+ code: string;
305
+ /** Popup forms (web popups) showing the content, in any status. */
306
+ popupForms: PopupFormContentUsage_UsingPopupForm[];
307
+ /** Running or paused journeys whose inbox messages open the content. */
308
+ journeys: PopupFormContentUsage_UsingJourney[];
309
+ };
310
+ export type GetPopupFormsContentsUsageResponse = {
311
+ /** Only the contents that are in use, sorted by content code. */
312
+ usages: PopupFormContentUsage[];
313
+ };