@pushwoosh/rpc-v2-http-api-data 0.2.255 → 0.2.257

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
@@ -115,3 +115,38 @@ export type GetContentVersionRequest = {
115
115
  export type GetContentVersionResponse = {
116
116
  version: ContentVersion;
117
117
  };
118
+ export type BackfillContentVersionsRequest = {
119
+ /** Which content to sweep; required. */
120
+ ownerType: ContentOwnerType;
121
+ /** Resume point: only items with a strictly greater id are considered. */
122
+ afterId: number;
123
+ /** Items per call. 0 = 100, capped at 500. */
124
+ limit: number;
125
+ /** Report what would be written and write nothing. */
126
+ dryRun: boolean;
127
+ };
128
+ export type BackfillContentVersionsResponse = {
129
+ scanned: number;
130
+ /** Items that got a grandfathered version. A dry run writes nothing and counts into would_create. */
131
+ created: number;
132
+ /** Items that already held a version. */
133
+ skipped: number;
134
+ failed: number;
135
+ /** Last id considered; pass it as after_id to continue the sweep. */
136
+ lastId: number;
137
+ /** No items left after this page. */
138
+ done: boolean;
139
+ /** Items a dry run would have versioned — those that hold no version at all, not the whole page. */
140
+ wouldCreate: number;
141
+ /** Only the items the sweep could not read or write; the rest are counted, not listed. */
142
+ failures: BackfillContentVersionFailure[];
143
+ /**
144
+ * Items whose stored hash no longer matched the content and was rewritten; in a dry run,
145
+ * the items that would be rewritten.
146
+ */
147
+ rehashed: number;
148
+ };
149
+ export type BackfillContentVersionFailure = {
150
+ ownerCode: string;
151
+ error: string;
152
+ };
package/data.js CHANGED
@@ -7805,6 +7805,67 @@ export const data = {
7805
7805
  }
7806
7806
  }
7807
7807
  },
7808
+ "pushwoosh.rpc_v2.approvals.BackfillContentVersionsRequest": {
7809
+ "type": "I",
7810
+ "fields": {
7811
+ "ownerType": {
7812
+ "type": "pushwoosh.rpc_v2.approvals.ContentOwnerType"
7813
+ },
7814
+ "afterId": {
7815
+ "type": "number"
7816
+ },
7817
+ "limit": {
7818
+ "type": "number"
7819
+ },
7820
+ "dryRun": {
7821
+ "type": "boolean"
7822
+ }
7823
+ }
7824
+ },
7825
+ "pushwoosh.rpc_v2.approvals.BackfillContentVersionsResponse": {
7826
+ "type": "I",
7827
+ "fields": {
7828
+ "scanned": {
7829
+ "type": "number"
7830
+ },
7831
+ "created": {
7832
+ "type": "number"
7833
+ },
7834
+ "skipped": {
7835
+ "type": "number"
7836
+ },
7837
+ "failed": {
7838
+ "type": "number"
7839
+ },
7840
+ "lastId": {
7841
+ "type": "number"
7842
+ },
7843
+ "done": {
7844
+ "type": "boolean"
7845
+ },
7846
+ "wouldCreate": {
7847
+ "type": "number"
7848
+ },
7849
+ "failures": {
7850
+ "type": "pushwoosh.rpc_v2.approvals.BackfillContentVersionFailure",
7851
+ "array": true
7852
+ },
7853
+ "rehashed": {
7854
+ "type": "number"
7855
+ }
7856
+ }
7857
+ },
7858
+ "pushwoosh.rpc_v2.approvals.BackfillContentVersionFailure": {
7859
+ "type": "I",
7860
+ "fields": {
7861
+ "ownerCode": {
7862
+ "type": "string"
7863
+ },
7864
+ "error": {
7865
+ "type": "string"
7866
+ }
7867
+ }
7868
+ },
7808
7869
  "pushwoosh.rpc_v2.campaigns.CampaignsService": {
7809
7870
  "type": "S",
7810
7871
  "key": "campaigns",
@@ -10698,6 +10759,401 @@ export const data = {
10698
10759
  }
10699
10760
  }
10700
10761
  },
10762
+ "pushwoosh.rpc_v2.email_ads.EmailAdsService": {
10763
+ "type": "S",
10764
+ "key": "emailAds",
10765
+ "methods": {
10766
+ "ListCampaigns": {
10767
+ "request": "pushwoosh.rpc_v2.email_ads.ListAdCampaignsRequest",
10768
+ "response": "pushwoosh.rpc_v2.email_ads.ListAdCampaignsResponse",
10769
+ "method": "get",
10770
+ "path": "/api/email_ads/campaigns"
10771
+ },
10772
+ "GetCampaign": {
10773
+ "request": "pushwoosh.rpc_v2.email_ads.GetAdCampaignRequest",
10774
+ "response": "pushwoosh.rpc_v2.email_ads.GetAdCampaignResponse",
10775
+ "method": "get",
10776
+ "path": "/api/email_ads/campaigns/{id}"
10777
+ },
10778
+ "CreateCampaign": {
10779
+ "request": "pushwoosh.rpc_v2.email_ads.CreateAdCampaignRequest",
10780
+ "response": "pushwoosh.rpc_v2.email_ads.CreateAdCampaignResponse",
10781
+ "method": "post",
10782
+ "path": "/api/email_ads/campaigns"
10783
+ },
10784
+ "UpdateCampaign": {
10785
+ "request": "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignRequest",
10786
+ "response": "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignResponse",
10787
+ "method": "put",
10788
+ "path": "/api/email_ads/campaigns/{id}"
10789
+ },
10790
+ "DeleteCampaign": {
10791
+ "request": "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignRequest",
10792
+ "response": "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignResponse",
10793
+ "method": "delete",
10794
+ "path": "/api/email_ads/campaigns/{id}"
10795
+ },
10796
+ "ListCreatives": {
10797
+ "request": "pushwoosh.rpc_v2.email_ads.ListAdCreativesRequest",
10798
+ "response": "pushwoosh.rpc_v2.email_ads.ListAdCreativesResponse",
10799
+ "method": "get",
10800
+ "path": "/api/email_ads/creatives"
10801
+ },
10802
+ "CreateCreative": {
10803
+ "request": "pushwoosh.rpc_v2.email_ads.CreateAdCreativeRequest",
10804
+ "response": "pushwoosh.rpc_v2.email_ads.CreateAdCreativeResponse",
10805
+ "method": "post",
10806
+ "path": "/api/email_ads/creatives"
10807
+ },
10808
+ "UpdateCreative": {
10809
+ "request": "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeRequest",
10810
+ "response": "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeResponse",
10811
+ "method": "put",
10812
+ "path": "/api/email_ads/creatives/{id}"
10813
+ },
10814
+ "DeleteCreative": {
10815
+ "request": "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeRequest",
10816
+ "response": "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeResponse",
10817
+ "method": "delete",
10818
+ "path": "/api/email_ads/creatives/{id}"
10819
+ }
10820
+ }
10821
+ },
10822
+ "pushwoosh.rpc_v2.email_ads.AdCampaignStatus": {
10823
+ "type": "E",
10824
+ "values": [
10825
+ "AD_CAMPAIGN_STATUS_UNSPECIFIED",
10826
+ "AD_CAMPAIGN_STATUS_DRAFT",
10827
+ "AD_CAMPAIGN_STATUS_ACTIVE",
10828
+ "AD_CAMPAIGN_STATUS_PAUSED",
10829
+ "AD_CAMPAIGN_STATUS_FINISHED"
10830
+ ]
10831
+ },
10832
+ "pushwoosh.rpc_v2.email_ads.AdCampaign": {
10833
+ "type": "I",
10834
+ "fields": {
10835
+ "id": {
10836
+ "type": "number"
10837
+ },
10838
+ "name": {
10839
+ "type": "string"
10840
+ },
10841
+ "advertiser": {
10842
+ "type": "string"
10843
+ },
10844
+ "category": {
10845
+ "type": "string"
10846
+ },
10847
+ "status": {
10848
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
10849
+ },
10850
+ "startAt": {
10851
+ "type": "Date"
10852
+ },
10853
+ "endAt": {
10854
+ "type": "Date"
10855
+ },
10856
+ "sendsLimit": {
10857
+ "type": "number"
10858
+ },
10859
+ "created": {
10860
+ "type": "Date"
10861
+ },
10862
+ "updated": {
10863
+ "type": "Date"
10864
+ }
10865
+ }
10866
+ },
10867
+ "pushwoosh.rpc_v2.email_ads.AdCreative": {
10868
+ "type": "I",
10869
+ "fields": {
10870
+ "id": {
10871
+ "type": "number"
10872
+ },
10873
+ "campaignId": {
10874
+ "type": "number"
10875
+ },
10876
+ "name": {
10877
+ "type": "string"
10878
+ },
10879
+ "imageUrl": {
10880
+ "type": "string"
10881
+ },
10882
+ "headline": {
10883
+ "type": "string"
10884
+ },
10885
+ "bodyText": {
10886
+ "type": "string"
10887
+ },
10888
+ "ctaTitle": {
10889
+ "type": "string"
10890
+ },
10891
+ "targetUrl": {
10892
+ "type": "string"
10893
+ },
10894
+ "weight": {
10895
+ "type": "number"
10896
+ },
10897
+ "created": {
10898
+ "type": "Date"
10899
+ },
10900
+ "updated": {
10901
+ "type": "Date"
10902
+ }
10903
+ }
10904
+ },
10905
+ "pushwoosh.rpc_v2.email_ads.ListAdCampaignsRequest": {
10906
+ "type": "I",
10907
+ "fields": {
10908
+ "status": {
10909
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
10910
+ },
10911
+ "category": {
10912
+ "type": "string"
10913
+ },
10914
+ "page": {
10915
+ "type": "number"
10916
+ },
10917
+ "perPage": {
10918
+ "type": "number"
10919
+ }
10920
+ }
10921
+ },
10922
+ "pushwoosh.rpc_v2.email_ads.ListAdCampaignsResponse": {
10923
+ "type": "I",
10924
+ "fields": {
10925
+ "campaigns": {
10926
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign",
10927
+ "array": true
10928
+ },
10929
+ "page": {
10930
+ "type": "number"
10931
+ },
10932
+ "perPage": {
10933
+ "type": "number"
10934
+ },
10935
+ "total": {
10936
+ "type": "number"
10937
+ }
10938
+ }
10939
+ },
10940
+ "pushwoosh.rpc_v2.email_ads.GetAdCampaignRequest": {
10941
+ "type": "I",
10942
+ "fields": {
10943
+ "id": {
10944
+ "type": "number"
10945
+ }
10946
+ }
10947
+ },
10948
+ "pushwoosh.rpc_v2.email_ads.GetAdCampaignResponse": {
10949
+ "type": "I",
10950
+ "fields": {
10951
+ "campaign": {
10952
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign"
10953
+ }
10954
+ }
10955
+ },
10956
+ "pushwoosh.rpc_v2.email_ads.CreateAdCampaignRequest": {
10957
+ "type": "I",
10958
+ "fields": {
10959
+ "name": {
10960
+ "type": "string"
10961
+ },
10962
+ "advertiser": {
10963
+ "type": "string"
10964
+ },
10965
+ "category": {
10966
+ "type": "string"
10967
+ },
10968
+ "status": {
10969
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
10970
+ },
10971
+ "startAt": {
10972
+ "type": "Date"
10973
+ },
10974
+ "endAt": {
10975
+ "type": "Date"
10976
+ },
10977
+ "sendsLimit": {
10978
+ "type": "number"
10979
+ }
10980
+ }
10981
+ },
10982
+ "pushwoosh.rpc_v2.email_ads.CreateAdCampaignResponse": {
10983
+ "type": "I",
10984
+ "fields": {
10985
+ "campaign": {
10986
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign"
10987
+ }
10988
+ }
10989
+ },
10990
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignRequest": {
10991
+ "type": "I",
10992
+ "fields": {
10993
+ "id": {
10994
+ "type": "number"
10995
+ },
10996
+ "name": {
10997
+ "type": "string"
10998
+ },
10999
+ "advertiser": {
11000
+ "type": "string"
11001
+ },
11002
+ "category": {
11003
+ "type": "string"
11004
+ },
11005
+ "status": {
11006
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaignStatus"
11007
+ },
11008
+ "startAt": {
11009
+ "type": "Date"
11010
+ },
11011
+ "endAt": {
11012
+ "type": "Date"
11013
+ },
11014
+ "sendsLimit": {
11015
+ "type": "number"
11016
+ }
11017
+ }
11018
+ },
11019
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCampaignResponse": {
11020
+ "type": "I",
11021
+ "fields": {
11022
+ "campaign": {
11023
+ "type": "pushwoosh.rpc_v2.email_ads.AdCampaign"
11024
+ }
11025
+ }
11026
+ },
11027
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignRequest": {
11028
+ "type": "I",
11029
+ "fields": {
11030
+ "id": {
11031
+ "type": "number"
11032
+ }
11033
+ }
11034
+ },
11035
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCampaignResponse": {
11036
+ "type": "I",
11037
+ "fields": {}
11038
+ },
11039
+ "pushwoosh.rpc_v2.email_ads.ListAdCreativesRequest": {
11040
+ "type": "I",
11041
+ "fields": {
11042
+ "campaignId": {
11043
+ "type": "number"
11044
+ },
11045
+ "page": {
11046
+ "type": "number"
11047
+ },
11048
+ "perPage": {
11049
+ "type": "number"
11050
+ }
11051
+ }
11052
+ },
11053
+ "pushwoosh.rpc_v2.email_ads.ListAdCreativesResponse": {
11054
+ "type": "I",
11055
+ "fields": {
11056
+ "creatives": {
11057
+ "type": "pushwoosh.rpc_v2.email_ads.AdCreative",
11058
+ "array": true
11059
+ },
11060
+ "page": {
11061
+ "type": "number"
11062
+ },
11063
+ "perPage": {
11064
+ "type": "number"
11065
+ },
11066
+ "total": {
11067
+ "type": "number"
11068
+ }
11069
+ }
11070
+ },
11071
+ "pushwoosh.rpc_v2.email_ads.CreateAdCreativeRequest": {
11072
+ "type": "I",
11073
+ "fields": {
11074
+ "campaignId": {
11075
+ "type": "number"
11076
+ },
11077
+ "name": {
11078
+ "type": "string"
11079
+ },
11080
+ "imageUrl": {
11081
+ "type": "string"
11082
+ },
11083
+ "headline": {
11084
+ "type": "string"
11085
+ },
11086
+ "bodyText": {
11087
+ "type": "string"
11088
+ },
11089
+ "ctaTitle": {
11090
+ "type": "string"
11091
+ },
11092
+ "targetUrl": {
11093
+ "type": "string"
11094
+ },
11095
+ "weight": {
11096
+ "type": "number"
11097
+ }
11098
+ }
11099
+ },
11100
+ "pushwoosh.rpc_v2.email_ads.CreateAdCreativeResponse": {
11101
+ "type": "I",
11102
+ "fields": {
11103
+ "creative": {
11104
+ "type": "pushwoosh.rpc_v2.email_ads.AdCreative"
11105
+ }
11106
+ }
11107
+ },
11108
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeRequest": {
11109
+ "type": "I",
11110
+ "fields": {
11111
+ "id": {
11112
+ "type": "number"
11113
+ },
11114
+ "name": {
11115
+ "type": "string"
11116
+ },
11117
+ "imageUrl": {
11118
+ "type": "string"
11119
+ },
11120
+ "headline": {
11121
+ "type": "string"
11122
+ },
11123
+ "bodyText": {
11124
+ "type": "string"
11125
+ },
11126
+ "ctaTitle": {
11127
+ "type": "string"
11128
+ },
11129
+ "targetUrl": {
11130
+ "type": "string"
11131
+ },
11132
+ "weight": {
11133
+ "type": "number"
11134
+ }
11135
+ }
11136
+ },
11137
+ "pushwoosh.rpc_v2.email_ads.UpdateAdCreativeResponse": {
11138
+ "type": "I",
11139
+ "fields": {
11140
+ "creative": {
11141
+ "type": "pushwoosh.rpc_v2.email_ads.AdCreative"
11142
+ }
11143
+ }
11144
+ },
11145
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeRequest": {
11146
+ "type": "I",
11147
+ "fields": {
11148
+ "id": {
11149
+ "type": "number"
11150
+ }
11151
+ }
11152
+ },
11153
+ "pushwoosh.rpc_v2.email_ads.DeleteAdCreativeResponse": {
11154
+ "type": "I",
11155
+ "fields": {}
11156
+ },
10701
11157
  "pushwoosh.rpc_v2.email_categories.EmailCategoriesService": {
10702
11158
  "type": "S",
10703
11159
  "key": "emailCategories",
@@ -21143,7 +21599,8 @@ export const data = {
21143
21599
  "NOT_NULL",
21144
21600
  "ILIKE",
21145
21601
  "ARRAY_CONTAINS",
21146
- "ARRAY_INCLUDES"
21602
+ "ARRAY_INCLUDES",
21603
+ "NOT_ILIKE"
21147
21604
  ]
21148
21605
  },
21149
21606
  "pushwoosh.objects.filters.v1.LogicExpression.Field.ID": {
@@ -23850,7 +24307,8 @@ export const data = {
23850
24307
  "NOT_NULL",
23851
24308
  "ILIKE",
23852
24309
  "ARRAY_CONTAINS",
23853
- "ARRAY_INCLUDES"
24310
+ "ARRAY_INCLUDES",
24311
+ "NOT_ILIKE"
23854
24312
  ]
23855
24313
  },
23856
24314
  "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.ID": {
@@ -24723,6 +25181,21 @@ export const data = {
24723
25181
  }
24724
25182
  }
24725
25183
  },
25184
+ "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.AllowEmailAds": {
25185
+ "type": "I",
25186
+ "fields": {
25187
+ "operator": {
25188
+ "type": "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.Operator"
25189
+ },
25190
+ "value": {
25191
+ "type": "boolean"
25192
+ },
25193
+ "values": {
25194
+ "type": "boolean",
25195
+ "array": true
25196
+ }
25197
+ }
25198
+ },
24726
25199
  "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field": {
24727
25200
  "type": "I",
24728
25201
  "fields": {
@@ -24899,6 +25372,9 @@ export const data = {
24899
25372
  },
24900
25373
  "CondRequireContentApproval": {
24901
25374
  "type": "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.RequireContentApproval"
25375
+ },
25376
+ "CondAllowEmailAds": {
25377
+ "type": "pushwoosh.objects.restrictionValues.v1.LogicExpression.Field.AllowEmailAds"
24902
25378
  }
24903
25379
  },
24904
25380
  "oneofs": {
@@ -24961,7 +25437,8 @@ export const data = {
24961
25437
  "CondAllowLaoDeletePolicy",
24962
25438
  "CondAllowJourneyVersioning",
24963
25439
  "CondAllowJourneyPointTemplates",
24964
- "CondRequireContentApproval"
25440
+ "CondRequireContentApproval",
25441
+ "CondAllowEmailAds"
24965
25442
  ]
24966
25443
  }
24967
25444
  }
@@ -25459,6 +25936,12 @@ export const data = {
25459
25936
  "response": "{}",
25460
25937
  "method": "patch",
25461
25938
  "path": "/v1/objects/restrictionValues/ID/{ID}/update/RequireContentApproval"
25939
+ },
25940
+ "UpdateAllowEmailAds": {
25941
+ "request": "pushwoosh.objects.restrictionValues.v1.UpdateAllowEmailAdsRequest",
25942
+ "response": "{}",
25943
+ "method": "patch",
25944
+ "path": "/v1/objects/restrictionValues/ID/{ID}/update/AllowEmailAds"
25462
25945
  }
25463
25946
  }
25464
25947
  },
@@ -25635,6 +26118,9 @@ export const data = {
25635
26118
  },
25636
26119
  "RequireContentApproval": {
25637
26120
  "type": "boolean"
26121
+ },
26122
+ "AllowEmailAds": {
26123
+ "type": "boolean"
25638
26124
  }
25639
26125
  }
25640
26126
  },
@@ -26408,6 +26894,17 @@ export const data = {
26408
26894
  }
26409
26895
  }
26410
26896
  },
26897
+ "pushwoosh.objects.restrictionValues.v1.UpdateAllowEmailAdsRequest": {
26898
+ "type": "I",
26899
+ "fields": {
26900
+ "ID": {
26901
+ "type": "number"
26902
+ },
26903
+ "value": {
26904
+ "type": "boolean"
26905
+ }
26906
+ }
26907
+ },
26411
26908
  "pushwoosh.objects.restrictionValues.v1.GetRequest": {
26412
26909
  "type": "I",
26413
26910
  "fields": {
@@ -26620,6 +27117,9 @@ export const data = {
26620
27117
  },
26621
27118
  "RequireContentApproval": {
26622
27119
  "type": "boolean"
27120
+ },
27121
+ "AllowEmailAds": {
27122
+ "type": "boolean"
26623
27123
  }
26624
27124
  }
26625
27125
  },
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.255",
3
+ "version": "0.2.257",
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
  };