@pushwoosh/rpc-v2-http-api-data 0.2.256 → 0.2.258

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/approvals.d.ts CHANGED
@@ -145,6 +145,13 @@ export type BackfillContentVersionsResponse = {
145
145
  * the items that would be rewritten.
146
146
  */
147
147
  rehashed: number;
148
+ /**
149
+ * Of the created ones, those whose body could not be read: the version carries neither
150
+ * snapshot nor hash, so the item stays sendable and the next save versions it properly.
151
+ */
152
+ createdBlind: number;
153
+ /** The items behind created_blind, with the reason their content could not be read. */
154
+ unreadable: BackfillContentVersionFailure[];
148
155
  };
149
156
  export type BackfillContentVersionFailure = {
150
157
  ownerCode: string;
package/data.js CHANGED
@@ -7852,6 +7852,13 @@ export const data = {
7852
7852
  },
7853
7853
  "rehashed": {
7854
7854
  "type": "number"
7855
+ },
7856
+ "createdBlind": {
7857
+ "type": "number"
7858
+ },
7859
+ "unreadable": {
7860
+ "type": "pushwoosh.rpc_v2.approvals.BackfillContentVersionFailure",
7861
+ "array": true
7855
7862
  }
7856
7863
  }
7857
7864
  },
@@ -10759,6 +10766,401 @@ export const data = {
10759
10766
  }
10760
10767
  }
10761
10768
  },
10769
+ "pushwoosh.rpc_v2.email_ads.EmailAdsService": {
10770
+ "type": "S",
10771
+ "key": "emailAds",
10772
+ "methods": {
10773
+ "ListCampaigns": {
10774
+ "request": "pushwoosh.rpc_v2.email_ads.ListAdCampaignsRequest",
10775
+ "response": "pushwoosh.rpc_v2.email_ads.ListAdCampaignsResponse",
10776
+ "method": "get",
10777
+ "path": "/api/email_ads/campaigns"
10778
+ },
10779
+ "GetCampaign": {
10780
+ "request": "pushwoosh.rpc_v2.email_ads.GetAdCampaignRequest",
10781
+ "response": "pushwoosh.rpc_v2.email_ads.GetAdCampaignResponse",
10782
+ "method": "get",
10783
+ "path": "/api/email_ads/campaigns/{id}"
10784
+ },
10785
+ "CreateCampaign": {
10786
+ "request": "pushwoosh.rpc_v2.email_ads.CreateAdCampaignRequest",
10787
+ "response": "pushwoosh.rpc_v2.email_ads.CreateAdCampaignResponse",
10788
+ "method": "post",
10789
+ "path": "/api/email_ads/campaigns"
10790
+ },
10791
+ "UpdateCampaign": {
10792
+ "request": "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignRequest",
10793
+ "response": "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignResponse",
10794
+ "method": "put",
10795
+ "path": "/api/email_ads/campaigns/{id}"
10796
+ },
10797
+ "DeleteCampaign": {
10798
+ "request": "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignRequest",
10799
+ "response": "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignResponse",
10800
+ "method": "delete",
10801
+ "path": "/api/email_ads/campaigns/{id}"
10802
+ },
10803
+ "ListCreatives": {
10804
+ "request": "pushwoosh.rpc_v2.email_ads.ListAdCreativesRequest",
10805
+ "response": "pushwoosh.rpc_v2.email_ads.ListAdCreativesResponse",
10806
+ "method": "get",
10807
+ "path": "/api/email_ads/creatives"
10808
+ },
10809
+ "CreateCreative": {
10810
+ "request": "pushwoosh.rpc_v2.email_ads.CreateAdCreativeRequest",
10811
+ "response": "pushwoosh.rpc_v2.email_ads.CreateAdCreativeResponse",
10812
+ "method": "post",
10813
+ "path": "/api/email_ads/creatives"
10814
+ },
10815
+ "UpdateCreative": {
10816
+ "request": "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeRequest",
10817
+ "response": "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeResponse",
10818
+ "method": "put",
10819
+ "path": "/api/email_ads/creatives/{id}"
10820
+ },
10821
+ "DeleteCreative": {
10822
+ "request": "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeRequest",
10823
+ "response": "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeResponse",
10824
+ "method": "delete",
10825
+ "path": "/api/email_ads/creatives/{id}"
10826
+ }
10827
+ }
10828
+ },
10829
+ "pushwoosh.rpc_v2.email_ads.AdCampaignStatus": {
10830
+ "type": "E",
10831
+ "values": [
10832
+ "AD_CAMPAIGN_STATUS_UNSPECIFIED",
10833
+ "AD_CAMPAIGN_STATUS_DRAFT",
10834
+ "AD_CAMPAIGN_STATUS_ACTIVE",
10835
+ "AD_CAMPAIGN_STATUS_PAUSED",
10836
+ "AD_CAMPAIGN_STATUS_FINISHED"
10837
+ ]
10838
+ },
10839
+ "pushwoosh.rpc_v2.email_ads.AdCampaign": {
10840
+ "type": "I",
10841
+ "fields": {
10842
+ "id": {
10843
+ "type": "number"
10844
+ },
10845
+ "name": {
10846
+ "type": "string"
10847
+ },
10848
+ "advertiser": {
10849
+ "type": "string"
10850
+ },
10851
+ "category": {
10852
+ "type": "string"
10853
+ },
10854
+ "status": {
10855
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
10856
+ },
10857
+ "startAt": {
10858
+ "type": "Date"
10859
+ },
10860
+ "endAt": {
10861
+ "type": "Date"
10862
+ },
10863
+ "sendsLimit": {
10864
+ "type": "number"
10865
+ },
10866
+ "created": {
10867
+ "type": "Date"
10868
+ },
10869
+ "updated": {
10870
+ "type": "Date"
10871
+ }
10872
+ }
10873
+ },
10874
+ "pushwoosh.rpc_v2.email_ads.AdCreative": {
10875
+ "type": "I",
10876
+ "fields": {
10877
+ "id": {
10878
+ "type": "number"
10879
+ },
10880
+ "campaignId": {
10881
+ "type": "number"
10882
+ },
10883
+ "name": {
10884
+ "type": "string"
10885
+ },
10886
+ "imageUrl": {
10887
+ "type": "string"
10888
+ },
10889
+ "headline": {
10890
+ "type": "string"
10891
+ },
10892
+ "bodyText": {
10893
+ "type": "string"
10894
+ },
10895
+ "ctaTitle": {
10896
+ "type": "string"
10897
+ },
10898
+ "targetUrl": {
10899
+ "type": "string"
10900
+ },
10901
+ "weight": {
10902
+ "type": "number"
10903
+ },
10904
+ "created": {
10905
+ "type": "Date"
10906
+ },
10907
+ "updated": {
10908
+ "type": "Date"
10909
+ }
10910
+ }
10911
+ },
10912
+ "pushwoosh.rpc_v2.email_ads.ListAdCampaignsRequest": {
10913
+ "type": "I",
10914
+ "fields": {
10915
+ "status": {
10916
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
10917
+ },
10918
+ "category": {
10919
+ "type": "string"
10920
+ },
10921
+ "page": {
10922
+ "type": "number"
10923
+ },
10924
+ "perPage": {
10925
+ "type": "number"
10926
+ }
10927
+ }
10928
+ },
10929
+ "pushwoosh.rpc_v2.email_ads.ListAdCampaignsResponse": {
10930
+ "type": "I",
10931
+ "fields": {
10932
+ "campaigns": {
10933
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign",
10934
+ "array": true
10935
+ },
10936
+ "page": {
10937
+ "type": "number"
10938
+ },
10939
+ "perPage": {
10940
+ "type": "number"
10941
+ },
10942
+ "total": {
10943
+ "type": "number"
10944
+ }
10945
+ }
10946
+ },
10947
+ "pushwoosh.rpc_v2.email_ads.GetAdCampaignRequest": {
10948
+ "type": "I",
10949
+ "fields": {
10950
+ "id": {
10951
+ "type": "number"
10952
+ }
10953
+ }
10954
+ },
10955
+ "pushwoosh.rpc_v2.email_ads.GetAdCampaignResponse": {
10956
+ "type": "I",
10957
+ "fields": {
10958
+ "campaign": {
10959
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign"
10960
+ }
10961
+ }
10962
+ },
10963
+ "pushwoosh.rpc_v2.email_ads.CreateAdCampaignRequest": {
10964
+ "type": "I",
10965
+ "fields": {
10966
+ "name": {
10967
+ "type": "string"
10968
+ },
10969
+ "advertiser": {
10970
+ "type": "string"
10971
+ },
10972
+ "category": {
10973
+ "type": "string"
10974
+ },
10975
+ "status": {
10976
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
10977
+ },
10978
+ "startAt": {
10979
+ "type": "Date"
10980
+ },
10981
+ "endAt": {
10982
+ "type": "Date"
10983
+ },
10984
+ "sendsLimit": {
10985
+ "type": "number"
10986
+ }
10987
+ }
10988
+ },
10989
+ "pushwoosh.rpc_v2.email_ads.CreateAdCampaignResponse": {
10990
+ "type": "I",
10991
+ "fields": {
10992
+ "campaign": {
10993
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign"
10994
+ }
10995
+ }
10996
+ },
10997
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignRequest": {
10998
+ "type": "I",
10999
+ "fields": {
11000
+ "id": {
11001
+ "type": "number"
11002
+ },
11003
+ "name": {
11004
+ "type": "string"
11005
+ },
11006
+ "advertiser": {
11007
+ "type": "string"
11008
+ },
11009
+ "category": {
11010
+ "type": "string"
11011
+ },
11012
+ "status": {
11013
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
11014
+ },
11015
+ "startAt": {
11016
+ "type": "Date"
11017
+ },
11018
+ "endAt": {
11019
+ "type": "Date"
11020
+ },
11021
+ "sendsLimit": {
11022
+ "type": "number"
11023
+ }
11024
+ }
11025
+ },
11026
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignResponse": {
11027
+ "type": "I",
11028
+ "fields": {
11029
+ "campaign": {
11030
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign"
11031
+ }
11032
+ }
11033
+ },
11034
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignRequest": {
11035
+ "type": "I",
11036
+ "fields": {
11037
+ "id": {
11038
+ "type": "number"
11039
+ }
11040
+ }
11041
+ },
11042
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignResponse": {
11043
+ "type": "I",
11044
+ "fields": {}
11045
+ },
11046
+ "pushwoosh.rpc_v2.email_ads.ListAdCreativesRequest": {
11047
+ "type": "I",
11048
+ "fields": {
11049
+ "campaignId": {
11050
+ "type": "number"
11051
+ },
11052
+ "page": {
11053
+ "type": "number"
11054
+ },
11055
+ "perPage": {
11056
+ "type": "number"
11057
+ }
11058
+ }
11059
+ },
11060
+ "pushwoosh.rpc_v2.email_ads.ListAdCreativesResponse": {
11061
+ "type": "I",
11062
+ "fields": {
11063
+ "creatives": {
11064
+ "type": "pushwoosh.rpc_v2.email_ads.AdCreative",
11065
+ "array": true
11066
+ },
11067
+ "page": {
11068
+ "type": "number"
11069
+ },
11070
+ "perPage": {
11071
+ "type": "number"
11072
+ },
11073
+ "total": {
11074
+ "type": "number"
11075
+ }
11076
+ }
11077
+ },
11078
+ "pushwoosh.rpc_v2.email_ads.CreateAdCreativeRequest": {
11079
+ "type": "I",
11080
+ "fields": {
11081
+ "campaignId": {
11082
+ "type": "number"
11083
+ },
11084
+ "name": {
11085
+ "type": "string"
11086
+ },
11087
+ "imageUrl": {
11088
+ "type": "string"
11089
+ },
11090
+ "headline": {
11091
+ "type": "string"
11092
+ },
11093
+ "bodyText": {
11094
+ "type": "string"
11095
+ },
11096
+ "ctaTitle": {
11097
+ "type": "string"
11098
+ },
11099
+ "targetUrl": {
11100
+ "type": "string"
11101
+ },
11102
+ "weight": {
11103
+ "type": "number"
11104
+ }
11105
+ }
11106
+ },
11107
+ "pushwoosh.rpc_v2.email_ads.CreateAdCreativeResponse": {
11108
+ "type": "I",
11109
+ "fields": {
11110
+ "creative": {
11111
+ "type": "pushwoosh.rpc_v2.email_ads.AdCreative"
11112
+ }
11113
+ }
11114
+ },
11115
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeRequest": {
11116
+ "type": "I",
11117
+ "fields": {
11118
+ "id": {
11119
+ "type": "number"
11120
+ },
11121
+ "name": {
11122
+ "type": "string"
11123
+ },
11124
+ "imageUrl": {
11125
+ "type": "string"
11126
+ },
11127
+ "headline": {
11128
+ "type": "string"
11129
+ },
11130
+ "bodyText": {
11131
+ "type": "string"
11132
+ },
11133
+ "ctaTitle": {
11134
+ "type": "string"
11135
+ },
11136
+ "targetUrl": {
11137
+ "type": "string"
11138
+ },
11139
+ "weight": {
11140
+ "type": "number"
11141
+ }
11142
+ }
11143
+ },
11144
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeResponse": {
11145
+ "type": "I",
11146
+ "fields": {
11147
+ "creative": {
11148
+ "type": "pushwoosh.rpc_v2.email_ads.AdCreative"
11149
+ }
11150
+ }
11151
+ },
11152
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeRequest": {
11153
+ "type": "I",
11154
+ "fields": {
11155
+ "id": {
11156
+ "type": "number"
11157
+ }
11158
+ }
11159
+ },
11160
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeResponse": {
11161
+ "type": "I",
11162
+ "fields": {}
11163
+ },
10762
11164
  "pushwoosh.rpc_v2.email_categories.EmailCategoriesService": {
10763
11165
  "type": "S",
10764
11166
  "key": "emailCategories",
@@ -21204,7 +21606,8 @@ export const data = {
21204
21606
  "NOT_NULL",
21205
21607
  "ILIKE",
21206
21608
  "ARRAY_CONTAINS",
21207
- "ARRAY_INCLUDES"
21609
+ "ARRAY_INCLUDES",
21610
+ "NOT_ILIKE"
21208
21611
  ]
21209
21612
  },
21210
21613
  "pushwoosh.objects.filters.v1.LogicExpression.Field.ID": {
@@ -23911,7 +24314,8 @@ export const data = {
23911
24314
  "NOT_NULL",
23912
24315
  "ILIKE",
23913
24316
  "ARRAY_CONTAINS",
23914
- "ARRAY_INCLUDES"
24317
+ "ARRAY_INCLUDES",
24318
+ "NOT_ILIKE"
23915
24319
  ]
23916
24320
  },
23917
24321
  "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.ID": {
@@ -24784,6 +25188,21 @@ export const data = {
24784
25188
  }
24785
25189
  }
24786
25190
  },
25191
+ "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.AllowEmailAds": {
25192
+ "type": "I",
25193
+ "fields": {
25194
+ "operator": {
25195
+ "type": "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.Operator"
25196
+ },
25197
+ "value": {
25198
+ "type": "boolean"
25199
+ },
25200
+ "values": {
25201
+ "type": "boolean",
25202
+ "array": true
25203
+ }
25204
+ }
25205
+ },
24787
25206
  "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field": {
24788
25207
  "type": "I",
24789
25208
  "fields": {
@@ -24960,6 +25379,9 @@ export const data = {
24960
25379
  },
24961
25380
  "CondRequireContentApproval": {
24962
25381
  "type": "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.RequireContentApproval"
25382
+ },
25383
+ "CondAllowEmailAds": {
25384
+ "type": "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.AllowEmailAds"
24963
25385
  }
24964
25386
  },
24965
25387
  "oneofs": {
@@ -25022,7 +25444,8 @@ export const data = {
25022
25444
  "CondAllowLaoDeletePolicy",
25023
25445
  "CondAllowJourneyVersioning",
25024
25446
  "CondAllowJourneyPointTemplates",
25025
- "CondRequireContentApproval"
25447
+ "CondRequireContentApproval",
25448
+ "CondAllowEmailAds"
25026
25449
  ]
25027
25450
  }
25028
25451
  }
@@ -25520,6 +25943,12 @@ export const data = {
25520
25943
  "response": "{}",
25521
25944
  "method": "patch",
25522
25945
  "path": "/v1/objects/restrictionValues/ID/{ID}/update/RequireContentApproval"
25946
+ },
25947
+ "UpdateAllowEmailAds": {
25948
+ "request": "pushwoosh.objects.restrictionValues.v1.UpdateAllowEmailAdsRequest",
25949
+ "response": "{}",
25950
+ "method": "patch",
25951
+ "path": "/v1/objects/restrictionValues/ID/{ID}/update/AllowEmailAds"
25523
25952
  }
25524
25953
  }
25525
25954
  },
@@ -25696,6 +26125,9 @@ export const data = {
25696
26125
  },
25697
26126
  "RequireContentApproval": {
25698
26127
  "type": "boolean"
26128
+ },
26129
+ "AllowEmailAds": {
26130
+ "type": "boolean"
25699
26131
  }
25700
26132
  }
25701
26133
  },
@@ -26469,6 +26901,17 @@ export const data = {
26469
26901
  }
26470
26902
  }
26471
26903
  },
26904
+ "pushwoosh.objects.restrictionValues.v1.UpdateAllowEmailAdsRequest": {
26905
+ "type": "I",
26906
+ "fields": {
26907
+ "ID": {
26908
+ "type": "number"
26909
+ },
26910
+ "value": {
26911
+ "type": "boolean"
26912
+ }
26913
+ }
26914
+ },
26472
26915
  "pushwoosh.objects.restrictionValues.v1.GetRequest": {
26473
26916
  "type": "I",
26474
26917
  "fields": {
@@ -26681,6 +27124,9 @@ export const data = {
26681
27124
  },
26682
27125
  "RequireContentApproval": {
26683
27126
  "type": "boolean"
27127
+ },
27128
+ "AllowEmailAds": {
27129
+ "type": "boolean"
26684
27130
  }
26685
27131
  }
26686
27132
  },
package/email_ads.d.ts ADDED
@@ -0,0 +1,159 @@
1
+ import { RpcMethod } from './commonTypes';
2
+ export type EmailAdsService_ListCampaigns = RpcMethod<ListAdCampaignsRequest, ListAdCampaignsResponse>;
3
+ export type EmailAdsService_GetCampaign = RpcMethod<GetAdCampaignRequest, GetAdCampaignResponse>;
4
+ export type EmailAdsService_CreateCampaign = RpcMethod<CreateAdCampaignRequest, CreateAdCampaignResponse>;
5
+ export type EmailAdsService_UpdateCampaign = RpcMethod<UpdateAdCampaignRequest, UpdateAdCampaignResponse>;
6
+ export type EmailAdsService_DeleteCampaign = RpcMethod<DeleteAdCampaignRequest, DeleteAdCampaignResponse>;
7
+ export type EmailAdsService_ListCreatives = RpcMethod<ListAdCreativesRequest, ListAdCreativesResponse>;
8
+ export type EmailAdsService_CreateCreative = RpcMethod<CreateAdCreativeRequest, CreateAdCreativeResponse>;
9
+ export type EmailAdsService_UpdateCreative = RpcMethod<UpdateAdCreativeRequest, UpdateAdCreativeResponse>;
10
+ export type EmailAdsService_DeleteCreative = RpcMethod<DeleteAdCreativeRequest, DeleteAdCreativeResponse>;
11
+ export interface EmailAdsService {
12
+ /** Lists the account's ad campaigns — the inventory a client sells in its own newsletters — newest first, optionally narrowed to one status or category. Use to browse campaigns or find a campaign id before get/update/delete. */
13
+ ListCampaigns: EmailAdsService_ListCampaigns;
14
+ /** Returns a single ad campaign by id, with its advertiser, period, status, category and sends limit. Use after list_ad_campaigns to inspect one campaign. */
15
+ GetCampaign: EmailAdsService_GetCampaign;
16
+ /** Creates an ad campaign under the account and returns it with its generated id. A campaign holds the period and status; the banner itself is an ad creative created separately. */
17
+ CreateCampaign: EmailAdsService_CreateCampaign;
18
+ /** Overwrites an ad campaign's name, advertiser, category, status, period and sends limit. Use to edit a campaign or to activate/pause it. */
19
+ UpdateCampaign: EmailAdsService_UpdateCampaign;
20
+ /** Permanently deletes an ad campaign together with its creatives. Cannot be undone; letters already sent keep the creative they were rendered with. */
21
+ DeleteCampaign: EmailAdsService_DeleteCampaign;
22
+ /** Lists the creatives of one ad campaign — the banners themselves: image, headline, call to action and target link. Use to show what a campaign can render. */
23
+ ListCreatives: EmailAdsService_ListCreatives;
24
+ /** Adds a creative to an ad campaign and returns it with its generated id. Weight decides how often it is picked among the campaign's creatives. */
25
+ CreateCreative: EmailAdsService_CreateCreative;
26
+ /** Overwrites an ad creative's image, headline, body, call to action, target link and weight. Use to edit a banner; the campaign it belongs to cannot be changed. */
27
+ UpdateCreative: EmailAdsService_UpdateCreative;
28
+ /** Permanently deletes one ad creative from its campaign. Cannot be undone. */
29
+ DeleteCreative: EmailAdsService_DeleteCreative;
30
+ }
31
+ export type AdCampaignStatus = 'AD_CAMPAIGN_STATUS_UNSPECIFIED' | 'AD_CAMPAIGN_STATUS_DRAFT' | 'AD_CAMPAIGN_STATUS_ACTIVE' | 'AD_CAMPAIGN_STATUS_PAUSED' | 'AD_CAMPAIGN_STATUS_FINISHED';
32
+ export type AdCampaign = {
33
+ id: number;
34
+ name: string;
35
+ /** Who bought the slot; free text shown to the client only. */
36
+ advertiser: string;
37
+ /** Matches the category of the ad slot in a template, so a sports issue gets a sports banner. */
38
+ category: string;
39
+ status: AdCampaignStatus;
40
+ /** Campaign runs from this moment; unset means "since always". */
41
+ startAt: Date;
42
+ /** Campaign stops after this moment; unset means "until stopped". */
43
+ endAt: Date;
44
+ /** Cap on the number of sends the campaign may be attached to; 0 means no cap. */
45
+ sendsLimit: number;
46
+ created: Date;
47
+ updated: Date;
48
+ };
49
+ export type AdCreative = {
50
+ id: number;
51
+ campaignId: number;
52
+ /** Internal label of the banner, not shown to recipients. */
53
+ name: string;
54
+ imageUrl: string;
55
+ headline: string;
56
+ bodyText: string;
57
+ /** Text of the call-to-action button. */
58
+ ctaTitle: string;
59
+ /** Where the call to action leads; wrapped into a tracked short link on send. */
60
+ targetUrl: string;
61
+ /** Relative share among the campaign's creatives; 0 is treated as 1. */
62
+ weight: number;
63
+ created: Date;
64
+ updated: Date;
65
+ };
66
+ export type ListAdCampaignsRequest = {
67
+ /** Keeps only campaigns in this status; omit for all statuses. */
68
+ status?: AdCampaignStatus;
69
+ /** Keeps only campaigns of this category; omit for all categories. */
70
+ category?: string;
71
+ page?: number;
72
+ perPage?: number;
73
+ };
74
+ export type ListAdCampaignsResponse = {
75
+ campaigns: AdCampaign[];
76
+ page: number;
77
+ perPage: number;
78
+ total: number;
79
+ };
80
+ export type GetAdCampaignRequest = {
81
+ id?: number;
82
+ };
83
+ export type GetAdCampaignResponse = {
84
+ campaign: AdCampaign;
85
+ };
86
+ export type CreateAdCampaignRequest = {
87
+ name?: string;
88
+ advertiser?: string;
89
+ category?: string;
90
+ /** Unspecified creates the campaign as a draft. */
91
+ status?: AdCampaignStatus;
92
+ startAt?: Date;
93
+ endAt?: Date;
94
+ sendsLimit?: number;
95
+ };
96
+ export type CreateAdCampaignResponse = {
97
+ campaign: AdCampaign;
98
+ };
99
+ export type UpdateAdCampaignRequest = {
100
+ id?: number;
101
+ name?: string;
102
+ advertiser?: string;
103
+ category?: string;
104
+ /** Unspecified leaves the current status untouched. */
105
+ status?: AdCampaignStatus;
106
+ startAt?: Date;
107
+ endAt?: Date;
108
+ sendsLimit?: number;
109
+ };
110
+ export type UpdateAdCampaignResponse = {
111
+ campaign: AdCampaign;
112
+ };
113
+ export type DeleteAdCampaignRequest = {
114
+ id?: number;
115
+ };
116
+ export type DeleteAdCampaignResponse = {};
117
+ export type ListAdCreativesRequest = {
118
+ /** Campaign whose creatives to list; required. */
119
+ campaignId?: number;
120
+ page?: number;
121
+ perPage?: number;
122
+ };
123
+ export type ListAdCreativesResponse = {
124
+ creatives: AdCreative[];
125
+ page: number;
126
+ perPage: number;
127
+ total: number;
128
+ };
129
+ export type CreateAdCreativeRequest = {
130
+ campaignId?: number;
131
+ name?: string;
132
+ imageUrl?: string;
133
+ headline?: string;
134
+ bodyText?: string;
135
+ ctaTitle?: string;
136
+ targetUrl?: string;
137
+ /** 0 is stored as "unset" and treated as 1 when a creative is picked. */
138
+ weight?: number;
139
+ };
140
+ export type CreateAdCreativeResponse = {
141
+ creative: AdCreative;
142
+ };
143
+ export type UpdateAdCreativeRequest = {
144
+ id?: number;
145
+ name?: string;
146
+ imageUrl?: string;
147
+ headline?: string;
148
+ bodyText?: string;
149
+ ctaTitle?: string;
150
+ targetUrl?: string;
151
+ weight?: number;
152
+ };
153
+ export type UpdateAdCreativeResponse = {
154
+ creative: AdCreative;
155
+ };
156
+ export type DeleteAdCreativeRequest = {
157
+ id?: number;
158
+ };
159
+ export type DeleteAdCreativeResponse = {};
package/email_ads.js ADDED
@@ -0,0 +1,3 @@
1
+ /* eslint-disable */
2
+ /* Autogenerated code */
3
+ export {};
package/index.d.ts CHANGED
@@ -26,6 +26,7 @@ import { CustomerJourneyService as pushwoosh_rpc_v2_customer_journey_CustomerJou
26
26
  import { DeeplinksService as pushwoosh_rpc_v2_deeplinks_DeeplinksService } from './deeplinks';
27
27
  import { DeliverabilityCheckerService as pushwoosh_rpc_v2_deliverability_checker_DeliverabilityCheckerService } from './deliverability_checker';
28
28
  import { DevicesService as pushwoosh_rpc_v2_devices_DevicesService } from './devices';
29
+ import { EmailAdsService as pushwoosh_rpc_v2_email_ads_EmailAdsService } from './email_ads';
29
30
  import { EmailCategoriesService as pushwoosh_rpc_v2_email_categories_EmailCategoriesService } from './email_categories';
30
31
  import { EmailSuppressionsService as pushwoosh_rpc_v2_email_suppressions_EmailSuppressionsService } from './email_suppressions';
31
32
  import { EmailTemplatesService as pushwoosh_rpc_v2_accounts_EmailTemplatesService } from './accounts';
@@ -98,6 +99,7 @@ export type API = {
98
99
  deeplinks: pushwoosh_rpc_v2_deeplinks_DeeplinksService;
99
100
  deliverabilityChecker: pushwoosh_rpc_v2_deliverability_checker_DeliverabilityCheckerService;
100
101
  devices: pushwoosh_rpc_v2_devices_DevicesService;
102
+ emailAds: pushwoosh_rpc_v2_email_ads_EmailAdsService;
101
103
  emailCategories: pushwoosh_rpc_v2_email_categories_EmailCategoriesService;
102
104
  emailSuppressions: pushwoosh_rpc_v2_email_suppressions_EmailSuppressionsService;
103
105
  emailTemplates: pushwoosh_rpc_v2_accounts_EmailTemplatesService;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.256",
3
+ "version": "0.2.258",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -38,7 +38,9 @@ export type LogicExpression_Field_Operator = 'INVALID'
38
38
  /** field '@>' array */
39
39
  | 'ARRAY_CONTAINS'
40
40
  /** field '<@' array */
41
- | 'ARRAY_INCLUDES';
41
+ | 'ARRAY_INCLUDES'
42
+ /** field not ilike '%value%' */
43
+ | 'NOT_ILIKE';
42
44
  export type LogicExpression_Field_ID = {
43
45
  operator: LogicExpression_Field_Operator;
44
46
  value: number;
@@ -49,7 +49,9 @@ export type LogicExpression_Field_Operator = 'INVALID'
49
49
  /** field '@>' array */
50
50
  | 'ARRAY_CONTAINS'
51
51
  /** field '<@' array */
52
- | 'ARRAY_INCLUDES';
52
+ | 'ARRAY_INCLUDES'
53
+ /** field not ilike '%value%' */
54
+ | 'NOT_ILIKE';
53
55
  export type LogicExpression_Field_ID = {
54
56
  operator: LogicExpression_Field_Operator;
55
57
  value: number;
@@ -340,6 +342,11 @@ export type LogicExpression_Field_RequireContentApproval = {
340
342
  value: boolean;
341
343
  values: boolean[];
342
344
  };
345
+ export type LogicExpression_Field_AllowEmailAds = {
346
+ operator: LogicExpression_Field_Operator;
347
+ value: boolean;
348
+ values: boolean[];
349
+ };
343
350
  export type LogicExpression_Field_kind_CondID = {
344
351
  type: 'CondID';
345
352
  data: LogicExpression_Field_ID;
@@ -572,7 +579,11 @@ export type LogicExpression_Field_kind_CondRequireContentApproval = {
572
579
  type: 'CondRequireContentApproval';
573
580
  data: LogicExpression_Field_RequireContentApproval;
574
581
  };
575
- export type LogicExpression_Field_kind = LogicExpression_Field_kind_CondID | LogicExpression_Field_kind_CondIsLocked | LogicExpression_Field_kind_CondMaxDevices | LogicExpression_Field_kind_CondMaxUsers | LogicExpression_Field_kind_CondMaxPreparedFilters | LogicExpression_Field_kind_CondDevicesInactivityLimit | LogicExpression_Field_kind_CondAllowApi | LogicExpression_Field_kind_CondMinSendRate | LogicExpression_Field_kind_CondMaxSendRate | LogicExpression_Field_kind_CondAllowIePlatformUsage | LogicExpression_Field_kind_CondMaxVerifyingEmails | LogicExpression_Field_kind_CondMaxVerifyingDomains | LogicExpression_Field_kind_CondAllowMetadata | LogicExpression_Field_kind_CondMaxPushOnEventDelayInDays | LogicExpression_Field_kind_CondAllowEventStatisticsApi | LogicExpression_Field_kind_CondAllowTagNotSetFilter | LogicExpression_Field_kind_CondAllowDebugMode | LogicExpression_Field_kind_CondAllowTrackUninstalls | LogicExpression_Field_kind_CondEmailRateCounterAggregatePeriod | LogicExpression_Field_kind_CondEmailBounceRateLimit | LogicExpression_Field_kind_CondEmailComplaintRateLimit | LogicExpression_Field_kind_CondAllowFrequencyCapping | LogicExpression_Field_kind_CondEmailsFreeLimit | LogicExpression_Field_kind_CondEmailsLimited | LogicExpression_Field_kind_CondAllowContentTemplates | LogicExpression_Field_kind_CondAllowBaiduAndroidPlatformUsage | LogicExpression_Field_kind_CondMaxInboxTtlDays | LogicExpression_Field_kind_CondMessageHistoryStorePeriod | LogicExpression_Field_kind_CondAllowApiGetMessageLog | LogicExpression_Field_kind_CondDetailActionHistoryStorePeriod | LogicExpression_Field_kind_CondAllowShowDeliveryStatistics | LogicExpression_Field_kind_CondAllowRFMSegments | LogicExpression_Field_kind_CondAllowBestTimeToSend | LogicExpression_Field_kind_CondAllowEventSegmentation | LogicExpression_Field_kind_CondAllowSegmentsGroups | LogicExpression_Field_kind_CondAllowCjSMS | LogicExpression_Field_kind_CondAllowCjDynamicSetTagsInUpdateProfile | LogicExpression_Field_kind_CondAllowCjAddBranchesInWaitForTrigger | LogicExpression_Field_kind_CondAllowEventsFunnel | LogicExpression_Field_kind_CondAllowChannelsSection | LogicExpression_Field_kind_CondAllowCjEmailBcc | LogicExpression_Field_kind_CondEmailFileStorePeriod | LogicExpression_Field_kind_CondAllowWhatsApp | LogicExpression_Field_kind_CondAllowCjAlternativeGoalsStats | LogicExpression_Field_kind_CondAllowCjListenUserIdChanged | LogicExpression_Field_kind_CondAllowLine | LogicExpression_Field_kind_CondAllowPostEventInApp | LogicExpression_Field_kind_CondAllowAIAssistant | LogicExpression_Field_kind_CondAllowKeepUserWithoutDevice | LogicExpression_Field_kind_CondAllowCJSplitterDeviceCheck | LogicExpression_Field_kind_CondAllowTagsAutoCreation | LogicExpression_Field_kind_CondAllowAIWalletBilling | LogicExpression_Field_kind_CondApplicationSpecificFilters | LogicExpression_Field_kind_CondAllowCloudPages | LogicExpression_Field_kind_CondAllowLaoDeletePolicy | LogicExpression_Field_kind_CondAllowJourneyVersioning | LogicExpression_Field_kind_CondAllowJourneyPointTemplates | LogicExpression_Field_kind_CondRequireContentApproval;
582
+ export type LogicExpression_Field_kind_CondAllowEmailAds = {
583
+ type: 'CondAllowEmailAds';
584
+ data: LogicExpression_Field_AllowEmailAds;
585
+ };
586
+ export type LogicExpression_Field_kind = LogicExpression_Field_kind_CondID | LogicExpression_Field_kind_CondIsLocked | LogicExpression_Field_kind_CondMaxDevices | LogicExpression_Field_kind_CondMaxUsers | LogicExpression_Field_kind_CondMaxPreparedFilters | LogicExpression_Field_kind_CondDevicesInactivityLimit | LogicExpression_Field_kind_CondAllowApi | LogicExpression_Field_kind_CondMinSendRate | LogicExpression_Field_kind_CondMaxSendRate | LogicExpression_Field_kind_CondAllowIePlatformUsage | LogicExpression_Field_kind_CondMaxVerifyingEmails | LogicExpression_Field_kind_CondMaxVerifyingDomains | LogicExpression_Field_kind_CondAllowMetadata | LogicExpression_Field_kind_CondMaxPushOnEventDelayInDays | LogicExpression_Field_kind_CondAllowEventStatisticsApi | LogicExpression_Field_kind_CondAllowTagNotSetFilter | LogicExpression_Field_kind_CondAllowDebugMode | LogicExpression_Field_kind_CondAllowTrackUninstalls | LogicExpression_Field_kind_CondEmailRateCounterAggregatePeriod | LogicExpression_Field_kind_CondEmailBounceRateLimit | LogicExpression_Field_kind_CondEmailComplaintRateLimit | LogicExpression_Field_kind_CondAllowFrequencyCapping | LogicExpression_Field_kind_CondEmailsFreeLimit | LogicExpression_Field_kind_CondEmailsLimited | LogicExpression_Field_kind_CondAllowContentTemplates | LogicExpression_Field_kind_CondAllowBaiduAndroidPlatformUsage | LogicExpression_Field_kind_CondMaxInboxTtlDays | LogicExpression_Field_kind_CondMessageHistoryStorePeriod | LogicExpression_Field_kind_CondAllowApiGetMessageLog | LogicExpression_Field_kind_CondDetailActionHistoryStorePeriod | LogicExpression_Field_kind_CondAllowShowDeliveryStatistics | LogicExpression_Field_kind_CondAllowRFMSegments | LogicExpression_Field_kind_CondAllowBestTimeToSend | LogicExpression_Field_kind_CondAllowEventSegmentation | LogicExpression_Field_kind_CondAllowSegmentsGroups | LogicExpression_Field_kind_CondAllowCjSMS | LogicExpression_Field_kind_CondAllowCjDynamicSetTagsInUpdateProfile | LogicExpression_Field_kind_CondAllowCjAddBranchesInWaitForTrigger | LogicExpression_Field_kind_CondAllowEventsFunnel | LogicExpression_Field_kind_CondAllowChannelsSection | LogicExpression_Field_kind_CondAllowCjEmailBcc | LogicExpression_Field_kind_CondEmailFileStorePeriod | LogicExpression_Field_kind_CondAllowWhatsApp | LogicExpression_Field_kind_CondAllowCjAlternativeGoalsStats | LogicExpression_Field_kind_CondAllowCjListenUserIdChanged | LogicExpression_Field_kind_CondAllowLine | LogicExpression_Field_kind_CondAllowPostEventInApp | LogicExpression_Field_kind_CondAllowAIAssistant | LogicExpression_Field_kind_CondAllowKeepUserWithoutDevice | LogicExpression_Field_kind_CondAllowCJSplitterDeviceCheck | LogicExpression_Field_kind_CondAllowTagsAutoCreation | LogicExpression_Field_kind_CondAllowAIWalletBilling | LogicExpression_Field_kind_CondApplicationSpecificFilters | LogicExpression_Field_kind_CondAllowCloudPages | LogicExpression_Field_kind_CondAllowLaoDeletePolicy | LogicExpression_Field_kind_CondAllowJourneyVersioning | LogicExpression_Field_kind_CondAllowJourneyPointTemplates | LogicExpression_Field_kind_CondRequireContentApproval | LogicExpression_Field_kind_CondAllowEmailAds;
576
587
  export type LogicExpression_Field = {
577
588
  kind: LogicExpression_Field_kind;
578
589
  };
@@ -679,6 +690,7 @@ export type RestrictionValuesCrudService_UpdateAllowLaoDeletePolicy = RpcMethod<
679
690
  export type RestrictionValuesCrudService_UpdateAllowJourneyVersioning = RpcMethod<UpdateAllowJourneyVersioningRequest, {}>;
680
691
  export type RestrictionValuesCrudService_UpdateAllowJourneyPointTemplates = RpcMethod<UpdateAllowJourneyPointTemplatesRequest, {}>;
681
692
  export type RestrictionValuesCrudService_UpdateRequireContentApproval = RpcMethod<UpdateRequireContentApprovalRequest, {}>;
693
+ export type RestrictionValuesCrudService_UpdateAllowEmailAds = RpcMethod<UpdateAllowEmailAdsRequest, {}>;
682
694
  export interface RestrictionValuesCrudService {
683
695
  Create: RestrictionValuesCrudService_Create;
684
696
  CreateMany: RestrictionValuesCrudService_CreateMany;
@@ -746,6 +758,7 @@ export interface RestrictionValuesCrudService {
746
758
  UpdateAllowJourneyVersioning: RestrictionValuesCrudService_UpdateAllowJourneyVersioning;
747
759
  UpdateAllowJourneyPointTemplates: RestrictionValuesCrudService_UpdateAllowJourneyPointTemplates;
748
760
  UpdateRequireContentApproval: RestrictionValuesCrudService_UpdateRequireContentApproval;
761
+ UpdateAllowEmailAds: RestrictionValuesCrudService_UpdateAllowEmailAds;
749
762
  }
750
763
  export type CreateRequest = {
751
764
  IsLocked?: boolean;
@@ -805,6 +818,7 @@ export type CreateRequest = {
805
818
  AllowJourneyVersioning?: boolean;
806
819
  AllowJourneyPointTemplates?: boolean;
807
820
  RequireContentApproval?: boolean;
821
+ AllowEmailAds?: boolean;
808
822
  };
809
823
  export type CreateResponse = {
810
824
  restrictionValue: RestrictionValue;
@@ -1085,6 +1099,10 @@ export type UpdateRequireContentApprovalRequest = {
1085
1099
  ID?: number;
1086
1100
  value?: boolean;
1087
1101
  };
1102
+ export type UpdateAllowEmailAdsRequest = {
1103
+ ID?: number;
1104
+ value?: boolean;
1105
+ };
1088
1106
  export type GetRequest = {
1089
1107
  ID?: number;
1090
1108
  };
@@ -1160,4 +1178,5 @@ export type RestrictionValue = {
1160
1178
  AllowJourneyVersioning: boolean;
1161
1179
  AllowJourneyPointTemplates: boolean;
1162
1180
  RequireContentApproval: boolean;
1181
+ AllowEmailAds: boolean;
1163
1182
  };