@pushwoosh/rpc-v2-http-api-data 0.2.435 → 0.2.437
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 +99 -0
- package/feature_flags.d.ts +5 -1
- package/package.json +1 -1
- package/tags.d.ts +36 -2
package/data.js
CHANGED
|
@@ -18907,6 +18907,12 @@ export const data = {
|
|
|
18907
18907
|
"changes": {
|
|
18908
18908
|
"type": "pushwoosh.rpc_v2.feature_flags.FeatureFlagChange",
|
|
18909
18909
|
"array": true
|
|
18910
|
+
},
|
|
18911
|
+
"apiTokenName": {
|
|
18912
|
+
"type": "string"
|
|
18913
|
+
},
|
|
18914
|
+
"byApiToken": {
|
|
18915
|
+
"type": "boolean"
|
|
18910
18916
|
}
|
|
18911
18917
|
}
|
|
18912
18918
|
},
|
|
@@ -37148,6 +37154,18 @@ export const data = {
|
|
|
37148
37154
|
"method": "delete",
|
|
37149
37155
|
"path": "/api/tags/{name}"
|
|
37150
37156
|
},
|
|
37157
|
+
"DeleteTags": {
|
|
37158
|
+
"request": "pushwoosh.rpc_v2.tags.DeleteTagsRequest",
|
|
37159
|
+
"response": "pushwoosh.rpc_v2.tags.DeleteTagsResponse",
|
|
37160
|
+
"method": "post",
|
|
37161
|
+
"path": "/api/tags:delete"
|
|
37162
|
+
},
|
|
37163
|
+
"GetTagsUsage": {
|
|
37164
|
+
"request": "pushwoosh.rpc_v2.tags.GetTagsUsageRequest",
|
|
37165
|
+
"response": "pushwoosh.rpc_v2.tags.GetTagsUsageResponse",
|
|
37166
|
+
"method": "post",
|
|
37167
|
+
"path": "/api/tags:usage"
|
|
37168
|
+
},
|
|
37151
37169
|
"List": {
|
|
37152
37170
|
"request": "pushwoosh.rpc_v2.tags.ListTagsRequest",
|
|
37153
37171
|
"response": "pushwoosh.rpc_v2.tags.ListTagsResponse",
|
|
@@ -37244,6 +37262,87 @@ export const data = {
|
|
|
37244
37262
|
"type": "I",
|
|
37245
37263
|
"fields": {}
|
|
37246
37264
|
},
|
|
37265
|
+
"pushwoosh.rpc_v2.tags.DeleteTagsRequest": {
|
|
37266
|
+
"type": "I",
|
|
37267
|
+
"fields": {
|
|
37268
|
+
"names": {
|
|
37269
|
+
"type": "string",
|
|
37270
|
+
"array": true
|
|
37271
|
+
}
|
|
37272
|
+
}
|
|
37273
|
+
},
|
|
37274
|
+
"pushwoosh.rpc_v2.tags.DeleteTagsResponse": {
|
|
37275
|
+
"type": "I",
|
|
37276
|
+
"fields": {}
|
|
37277
|
+
},
|
|
37278
|
+
"pushwoosh.rpc_v2.tags.GetTagsUsageRequest": {
|
|
37279
|
+
"type": "I",
|
|
37280
|
+
"fields": {
|
|
37281
|
+
"names": {
|
|
37282
|
+
"type": "string",
|
|
37283
|
+
"array": true
|
|
37284
|
+
}
|
|
37285
|
+
}
|
|
37286
|
+
},
|
|
37287
|
+
"pushwoosh.rpc_v2.tags.TagUser.Kind": {
|
|
37288
|
+
"type": "E",
|
|
37289
|
+
"values": [
|
|
37290
|
+
"KIND_UNSPECIFIED",
|
|
37291
|
+
"KIND_SEGMENT",
|
|
37292
|
+
"KIND_IN_APP",
|
|
37293
|
+
"KIND_POPUP_FORM",
|
|
37294
|
+
"KIND_JOURNEY",
|
|
37295
|
+
"KIND_MESSAGE",
|
|
37296
|
+
"KIND_INBOUND_WEBHOOK",
|
|
37297
|
+
"KIND_CONTROL_GROUP",
|
|
37298
|
+
"KIND_PUSH_PRESET",
|
|
37299
|
+
"KIND_SMS_PRESET",
|
|
37300
|
+
"KIND_INBOX_PRESET",
|
|
37301
|
+
"KIND_EMAIL_TEMPLATE",
|
|
37302
|
+
"KIND_RICH_MEDIA"
|
|
37303
|
+
]
|
|
37304
|
+
},
|
|
37305
|
+
"pushwoosh.rpc_v2.tags.TagUser": {
|
|
37306
|
+
"type": "I",
|
|
37307
|
+
"fields": {
|
|
37308
|
+
"kind": {
|
|
37309
|
+
"type": "pushwoosh.rpc_v2.tags.TagUser.Kind"
|
|
37310
|
+
},
|
|
37311
|
+
"code": {
|
|
37312
|
+
"type": "string"
|
|
37313
|
+
},
|
|
37314
|
+
"name": {
|
|
37315
|
+
"type": "string"
|
|
37316
|
+
},
|
|
37317
|
+
"warning": {
|
|
37318
|
+
"type": "boolean"
|
|
37319
|
+
}
|
|
37320
|
+
}
|
|
37321
|
+
},
|
|
37322
|
+
"pushwoosh.rpc_v2.tags.TagUsage": {
|
|
37323
|
+
"type": "I",
|
|
37324
|
+
"fields": {
|
|
37325
|
+
"name": {
|
|
37326
|
+
"type": "string"
|
|
37327
|
+
},
|
|
37328
|
+
"users": {
|
|
37329
|
+
"type": "pushwoosh.rpc_v2.tags.TagUser",
|
|
37330
|
+
"array": true
|
|
37331
|
+
},
|
|
37332
|
+
"protected": {
|
|
37333
|
+
"type": "boolean"
|
|
37334
|
+
}
|
|
37335
|
+
}
|
|
37336
|
+
},
|
|
37337
|
+
"pushwoosh.rpc_v2.tags.GetTagsUsageResponse": {
|
|
37338
|
+
"type": "I",
|
|
37339
|
+
"fields": {
|
|
37340
|
+
"usages": {
|
|
37341
|
+
"type": "pushwoosh.rpc_v2.tags.TagUsage",
|
|
37342
|
+
"array": true
|
|
37343
|
+
}
|
|
37344
|
+
}
|
|
37345
|
+
},
|
|
37247
37346
|
"pushwoosh.rpc_v2.tags.ListTagsRequest.OrderBy": {
|
|
37248
37347
|
"type": "E",
|
|
37249
37348
|
"values": [
|
package/feature_flags.d.ts
CHANGED
|
@@ -337,14 +337,18 @@ export type FeatureFlagHistoryEntry = {
|
|
|
337
337
|
version: number;
|
|
338
338
|
/** create, update, set_percent, kill, unkill, archive, restore or reshuffle */
|
|
339
339
|
action: string;
|
|
340
|
+
/** 0 when the change came through an API token or a service */
|
|
340
341
|
userId: number;
|
|
341
|
-
/** empty when the user is gone or
|
|
342
|
+
/** empty when the user is gone or there is no user */
|
|
342
343
|
userEmail: string;
|
|
343
344
|
created: Date;
|
|
344
345
|
/** the flag right after the change */
|
|
345
346
|
flag: FeatureFlag;
|
|
346
347
|
/** against the previous version; empty for create and for the oldest entry kept */
|
|
347
348
|
changes: FeatureFlagChange[];
|
|
349
|
+
/** the name of the API token the change came through; empty for a change by a user */
|
|
350
|
+
apiTokenName: string;
|
|
351
|
+
byApiToken: boolean;
|
|
348
352
|
};
|
|
349
353
|
export type ListFeatureFlagHistoryResponse = {
|
|
350
354
|
entries: FeatureFlagHistoryEntry[];
|
package/package.json
CHANGED
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
|
|
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
|
|
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 = {
|