@pushwoosh/rpc-v2-http-api-data 0.2.434 → 0.2.436

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
@@ -13572,6 +13572,9 @@ export const data = {
13572
13572
  },
13573
13573
  "offset": {
13574
13574
  "type": "number"
13575
+ },
13576
+ "bounceCategory": {
13577
+ "type": "pushwoosh.rpc_v2.email_suppressions.EmailBounceCategory"
13575
13578
  }
13576
13579
  }
13577
13580
  },
@@ -13610,6 +13613,12 @@ export const data = {
13610
13613
  },
13611
13614
  "application": {
13612
13615
  "type": "string"
13616
+ },
13617
+ "bounceCategory": {
13618
+ "type": "pushwoosh.rpc_v2.email_suppressions.EmailBounceCategory"
13619
+ },
13620
+ "statusCode": {
13621
+ "type": "string"
13613
13622
  }
13614
13623
  }
13615
13624
  },
@@ -13752,6 +13761,12 @@ export const data = {
13752
13761
  },
13753
13762
  "accountWide": {
13754
13763
  "type": "boolean"
13764
+ },
13765
+ "bounceCategory": {
13766
+ "type": "pushwoosh.rpc_v2.email_suppressions.EmailBounceCategory"
13767
+ },
13768
+ "statusCode": {
13769
+ "type": "string"
13755
13770
  }
13756
13771
  }
13757
13772
  },
@@ -13771,6 +13786,20 @@ export const data = {
13771
13786
  "EMAIL_SUPPRESSION_SOURCE_HARD_BOUNCE"
13772
13787
  ]
13773
13788
  },
13789
+ "pushwoosh.rpc_v2.email_suppressions.EmailBounceCategory": {
13790
+ "type": "E",
13791
+ "values": [
13792
+ "EMAIL_BOUNCE_CATEGORY_UNSPECIFIED",
13793
+ "EMAIL_BOUNCE_CATEGORY_ADDRESS_NOT_EXIST",
13794
+ "EMAIL_BOUNCE_CATEGORY_MAILBOX_INACTIVE",
13795
+ "EMAIL_BOUNCE_CATEGORY_MAILBOX_FULL",
13796
+ "EMAIL_BOUNCE_CATEGORY_SENDER_REPUTATION",
13797
+ "EMAIL_BOUNCE_CATEGORY_SPAM",
13798
+ "EMAIL_BOUNCE_CATEGORY_DELIVERY_FAILED",
13799
+ "EMAIL_BOUNCE_CATEGORY_MESSAGE_TOO_LARGE",
13800
+ "EMAIL_BOUNCE_CATEGORY_OTHER"
13801
+ ]
13802
+ },
13774
13803
  "pushwoosh.rpc_v2.accounts.EmailTemplatesService": {
13775
13804
  "type": "S",
13776
13805
  "key": "emailTemplates",
@@ -37119,6 +37148,18 @@ export const data = {
37119
37148
  "method": "delete",
37120
37149
  "path": "/api/tags/{name}"
37121
37150
  },
37151
+ "DeleteTags": {
37152
+ "request": "pushwoosh.rpc_v2.tags.DeleteTagsRequest",
37153
+ "response": "pushwoosh.rpc_v2.tags.DeleteTagsResponse",
37154
+ "method": "post",
37155
+ "path": "/api/tags:delete"
37156
+ },
37157
+ "GetTagsUsage": {
37158
+ "request": "pushwoosh.rpc_v2.tags.GetTagsUsageRequest",
37159
+ "response": "pushwoosh.rpc_v2.tags.GetTagsUsageResponse",
37160
+ "method": "post",
37161
+ "path": "/api/tags:usage"
37162
+ },
37122
37163
  "List": {
37123
37164
  "request": "pushwoosh.rpc_v2.tags.ListTagsRequest",
37124
37165
  "response": "pushwoosh.rpc_v2.tags.ListTagsResponse",
@@ -37215,6 +37256,87 @@ export const data = {
37215
37256
  "type": "I",
37216
37257
  "fields": {}
37217
37258
  },
37259
+ "pushwoosh.rpc_v2.tags.DeleteTagsRequest": {
37260
+ "type": "I",
37261
+ "fields": {
37262
+ "names": {
37263
+ "type": "string",
37264
+ "array": true
37265
+ }
37266
+ }
37267
+ },
37268
+ "pushwoosh.rpc_v2.tags.DeleteTagsResponse": {
37269
+ "type": "I",
37270
+ "fields": {}
37271
+ },
37272
+ "pushwoosh.rpc_v2.tags.GetTagsUsageRequest": {
37273
+ "type": "I",
37274
+ "fields": {
37275
+ "names": {
37276
+ "type": "string",
37277
+ "array": true
37278
+ }
37279
+ }
37280
+ },
37281
+ "pushwoosh.rpc_v2.tags.TagUser.Kind": {
37282
+ "type": "E",
37283
+ "values": [
37284
+ "KIND_UNSPECIFIED",
37285
+ "KIND_SEGMENT",
37286
+ "KIND_IN_APP",
37287
+ "KIND_POPUP_FORM",
37288
+ "KIND_JOURNEY",
37289
+ "KIND_MESSAGE",
37290
+ "KIND_INBOUND_WEBHOOK",
37291
+ "KIND_CONTROL_GROUP",
37292
+ "KIND_PUSH_PRESET",
37293
+ "KIND_SMS_PRESET",
37294
+ "KIND_INBOX_PRESET",
37295
+ "KIND_EMAIL_TEMPLATE",
37296
+ "KIND_RICH_MEDIA"
37297
+ ]
37298
+ },
37299
+ "pushwoosh.rpc_v2.tags.TagUser": {
37300
+ "type": "I",
37301
+ "fields": {
37302
+ "kind": {
37303
+ "type": "pushwoosh.rpc_v2.tags.TagUser.Kind"
37304
+ },
37305
+ "code": {
37306
+ "type": "string"
37307
+ },
37308
+ "name": {
37309
+ "type": "string"
37310
+ },
37311
+ "warning": {
37312
+ "type": "boolean"
37313
+ }
37314
+ }
37315
+ },
37316
+ "pushwoosh.rpc_v2.tags.TagUsage": {
37317
+ "type": "I",
37318
+ "fields": {
37319
+ "name": {
37320
+ "type": "string"
37321
+ },
37322
+ "users": {
37323
+ "type": "pushwoosh.rpc_v2.tags.TagUser",
37324
+ "array": true
37325
+ },
37326
+ "protected": {
37327
+ "type": "boolean"
37328
+ }
37329
+ }
37330
+ },
37331
+ "pushwoosh.rpc_v2.tags.GetTagsUsageResponse": {
37332
+ "type": "I",
37333
+ "fields": {
37334
+ "usages": {
37335
+ "type": "pushwoosh.rpc_v2.tags.TagUsage",
37336
+ "array": true
37337
+ }
37338
+ }
37339
+ },
37218
37340
  "pushwoosh.rpc_v2.tags.ListTagsRequest.OrderBy": {
37219
37341
  "type": "E",
37220
37342
  "values": [
@@ -27,6 +27,8 @@ export type ListEmailSuppressionsRequest = {
27
27
  /** Page size, 50 by default, 500 at most. */
28
28
  limit?: number;
29
29
  offset?: number;
30
+ /** Bounce category filter; any value but unspecified leaves spam complaints out. */
31
+ bounceCategory?: EmailBounceCategory;
30
32
  };
31
33
  export type ListEmailSuppressionsResponse = {
32
34
  suppressions: EmailSuppressionEntry[];
@@ -42,6 +44,10 @@ export type EmailSuppressionEntry = {
42
44
  diagnosticCode: string;
43
45
  /** Application the suppression was recorded in; empty when that application is gone. */
44
46
  application: string;
47
+ /** Why the provider rejected the address; unspecified for spam complaints and unclassified rows. */
48
+ bounceCategory: EmailBounceCategory;
49
+ /** Enhanced status code the provider returned, e.g. 5.1.1; empty when it sent none. */
50
+ statusCode: string;
45
51
  };
46
52
  export type ReactivateEmailRequest = {
47
53
  /** Pushwoosh application code (XXXXX-XXXXX) the reactivation is performed from. */
@@ -109,6 +115,12 @@ export type EmailSuppression = {
109
115
  application: string;
110
116
  /** Suppression is enforced for the whole account, not only for the recorded application. */
111
117
  accountWide: boolean;
118
+ /** Why the provider rejected the address; unspecified for spam complaints and unclassified rows. */
119
+ bounceCategory: EmailBounceCategory;
120
+ /** Enhanced status code the provider returned, e.g. 5.1.1; empty when it sent none. */
121
+ statusCode: string;
112
122
  };
113
123
  export type EmailSuppressionState = 'EMAIL_SUPPRESSION_STATE_UNSPECIFIED' | 'EMAIL_SUPPRESSION_STATE_DELIVERABLE' | 'EMAIL_SUPPRESSION_STATE_SUPPRESSED';
114
124
  export type EmailSuppressionSource = 'EMAIL_SUPPRESSION_SOURCE_UNSPECIFIED' | 'EMAIL_SUPPRESSION_SOURCE_SPAM_COMPLAINT' | 'EMAIL_SUPPRESSION_SOURCE_HARD_BOUNCE';
125
+ /** Bounce category as classified by feedback-smtp, the same taxonomy as the email message statistics. */
126
+ export type EmailBounceCategory = 'EMAIL_BOUNCE_CATEGORY_UNSPECIFIED' | 'EMAIL_BOUNCE_CATEGORY_ADDRESS_NOT_EXIST' | 'EMAIL_BOUNCE_CATEGORY_MAILBOX_INACTIVE' | 'EMAIL_BOUNCE_CATEGORY_MAILBOX_FULL' | 'EMAIL_BOUNCE_CATEGORY_SENDER_REPUTATION' | 'EMAIL_BOUNCE_CATEGORY_SPAM' | 'EMAIL_BOUNCE_CATEGORY_DELIVERY_FAILED' | 'EMAIL_BOUNCE_CATEGORY_MESSAGE_TOO_LARGE' | 'EMAIL_BOUNCE_CATEGORY_OTHER';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.434",
3
+ "version": "0.2.436",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
package/tags.d.ts CHANGED
@@ -2,6 +2,8 @@ import { RpcMethod } from './commonTypes';
2
2
  export type TagsService_Get = RpcMethod<GetTagRequest, Tag>;
3
3
  export type TagsService_Create = RpcMethod<CreateTagRequest, CreateTagResponse>;
4
4
  export type TagsService_Delete = RpcMethod<DeleteTagRequest, DeleteTagResponse>;
5
+ export type TagsService_DeleteTags = RpcMethod<DeleteTagsRequest, DeleteTagsResponse>;
6
+ export type TagsService_GetTagsUsage = RpcMethod<GetTagsUsageRequest, GetTagsUsageResponse>;
5
7
  export type TagsService_List = RpcMethod<ListTagsRequest, ListTagsResponse>;
6
8
  export type TagsService_GetTagValues = RpcMethod<GetTagValuesRequest, GetTagValuesResponse>;
7
9
  export type TagsService_GetTagUsage = RpcMethod<GetTagUsageRequest, GetTagUsageResponse>;
@@ -10,13 +12,17 @@ export interface TagsService {
10
12
  Get: TagsService_Get;
11
13
  /** Creates a new account tag with the given name and value type. Fails if a tag of that name already exists; timezone-typed tags cannot be created here. */
12
14
  Create: TagsService_Create;
13
- /** Permanently deletes an account tag by name. Refuses to delete system or reserved tags, or tags still referenced by any segment, in-app or journey; check get_tag_usage first. */
15
+ /** Permanently deletes an account tag by name. Refuses to delete system, reserved, consent or RFM tags, and tags still used (see get_tags_usage); the error names every user. */
14
16
  Delete: TagsService_Delete;
17
+ /** Permanently deletes up to 1000 account tags by name, all or nothing: if any tag is missing, protected or still used, nothing is deleted and the error names the users. Check get_tags_usage first. */
18
+ DeleteTags: TagsService_DeleteTags;
19
+ /** Lists which of up to 1000 account tags are used, and by what: segments, in-apps, popup forms, running or paused journeys, pending messages, inbound webhooks, control groups and content placeholders. A user marked warning does not stop the delete. Tags missing from the answer are not used or not found. */
20
+ GetTagsUsage: TagsService_GetTagsUsage;
15
21
  /** Lists the account's tags, newest or name-ordered, with paging, name substring search and an optional type filter. Use to browse tags or find a tag name before fetching values or usage. */
16
22
  List: TagsService_List;
17
23
  /** Returns the distinct stored values of a tag in an application with per-value subscriber counts, filtered by substring and paged. Use to see which values a string/list tag actually holds; integer and price tags return no values. */
18
24
  GetTagValues: TagsService_GetTagValues;
19
- /** Returns the segments, in-apps and journeys that reference a tag by name. Use to find what would break before deleting or editing a tag. */
25
+ /** Returns only the segments, in-apps and running or paused journeys that use a tag. For every user of a tag (messages, webhooks, control groups, content) use get_tags_usage. */
20
26
  GetTagUsage: TagsService_GetTagUsage;
21
27
  }
22
28
  export type GetTagRequest = {
@@ -47,6 +53,34 @@ export type DeleteTagRequest = {
47
53
  name?: string;
48
54
  };
49
55
  export type DeleteTagResponse = {};
56
+ export type DeleteTagsRequest = {
57
+ /** Names of the tags to delete. */
58
+ names?: string[];
59
+ };
60
+ export type DeleteTagsResponse = {};
61
+ export type GetTagsUsageRequest = {
62
+ /** Names of the tags to check. */
63
+ names?: string[];
64
+ };
65
+ export type TagUser_Kind = 'KIND_UNSPECIFIED' | 'KIND_SEGMENT' | 'KIND_IN_APP' | 'KIND_POPUP_FORM' | 'KIND_JOURNEY' | 'KIND_MESSAGE' | 'KIND_INBOUND_WEBHOOK' | 'KIND_CONTROL_GROUP' | 'KIND_PUSH_PRESET' | 'KIND_SMS_PRESET' | 'KIND_INBOX_PRESET' | 'KIND_EMAIL_TEMPLATE' | 'KIND_RICH_MEDIA';
66
+ export type TagUser = {
67
+ kind: TagUser_Kind;
68
+ /** The user's own identifier: uuid for a journey and an inbound webhook, code for every other kind. */
69
+ code: string;
70
+ name: string;
71
+ /** Set for a placeholder with a default value, or one the device fills in: the tag can still be deleted. */
72
+ warning: boolean;
73
+ };
74
+ export type TagUsage = {
75
+ name: string;
76
+ users: TagUser[];
77
+ /** The platform itself writes or reads this tag (system, reserved, consent, RFM): it is never deleted. */
78
+ protected: boolean;
79
+ };
80
+ export type GetTagsUsageResponse = {
81
+ /** Only the tags that are used or protected, sorted by name. */
82
+ usages: TagUsage[];
83
+ };
50
84
  export type ListTagsRequest_OrderBy = 'NAME' | 'CREATED';
51
85
  export type ListTagsRequest_OrderDirection = 'ASC' | 'DESC';
52
86
  export type ListTagsRequest = {