@readyfor/api-client-pigeon 0.258.0-pr1021.8be398d → 0.258.0

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.
@@ -3,20 +3,82 @@ import { ForceDig } from '@readyfor/api-client-base';
3
3
 
4
4
  type CampaignsGetOperation = paths["/api/campaigns"]["get"];
5
5
  type CampaignsGetResponse = CampaignsGetOperation["responses"]["200"]["content"]["application/json"];
6
- declare const buildCampaignsGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<any>;
6
+ declare const buildCampaignsGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
7
+ campaigns: ({
8
+ kind: "curationMailMagazine";
9
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
10
+ id: number;
11
+ bodyKind: "template" | "freeFormat";
12
+ deliveryAt: string | null;
13
+ lastEditorName: string;
14
+ lastEditedAt: string;
15
+ title?: string | null | undefined;
16
+ } | {
17
+ kind: "personalizedMailMagazine";
18
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
19
+ id: number;
20
+ deliveryAt: string | null;
21
+ lastEditorName: string;
22
+ lastEditedAt: string;
23
+ title?: string | null | undefined;
24
+ })[];
25
+ pagination: {
26
+ totalPages: number;
27
+ totalCount: number;
28
+ currentPerPage: number;
29
+ currentPage: number;
30
+ prevPage: number | null;
31
+ nextPage: number | null;
32
+ isFirstPage: boolean;
33
+ isLastPage: boolean;
34
+ };
35
+ }>;
7
36
  type CampaignsGetQuery = ForceDig<CampaignsGetOperation, [
8
37
  "parameters",
9
38
  "query"
10
39
  ]>;
11
- declare const getCampaigns: (query: CampaignsGetQuery, customRequestInit?: RequestInit) => Promise<any>;
40
+ declare const getCampaigns: (query: CampaignsGetQuery, customRequestInit?: RequestInit) => Promise<{
41
+ campaigns: ({
42
+ kind: "curationMailMagazine";
43
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
44
+ id: number;
45
+ bodyKind: "template" | "freeFormat";
46
+ deliveryAt: string | null;
47
+ lastEditorName: string;
48
+ lastEditedAt: string;
49
+ title?: string | null | undefined;
50
+ } | {
51
+ kind: "personalizedMailMagazine";
52
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
53
+ id: number;
54
+ deliveryAt: string | null;
55
+ lastEditorName: string;
56
+ lastEditedAt: string;
57
+ title?: string | null | undefined;
58
+ })[];
59
+ pagination: {
60
+ totalPages: number;
61
+ totalCount: number;
62
+ currentPerPage: number;
63
+ currentPage: number;
64
+ prevPage: number | null;
65
+ nextPage: number | null;
66
+ isFirstPage: boolean;
67
+ isLastPage: boolean;
68
+ };
69
+ }>;
12
70
  type CampaignsPostOperation = paths["/api/campaigns"]["post"];
13
71
  type CampaignsPostResponse = CampaignsPostOperation["responses"]["201"]["content"]["application/json"];
14
- declare const buildCampaignsPostFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<any>;
72
+ declare const buildCampaignsPostFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
73
+ id: number;
74
+ }>;
15
75
  type CampaignsPostRequestBody = ForceDig<CampaignsPostOperation, [
16
76
  "requestBody",
17
77
  "content",
18
78
  "application/json"
19
79
  ]>;
20
- declare const postCampaigns: (requestBody: CampaignsPostRequestBody, customRequestInit?: RequestInit) => Promise<any>;
80
+ declare const postCampaigns: (requestBody: CampaignsPostRequestBody, customRequestInit?: RequestInit) => Promise<{
81
+ id: number;
82
+ }>;
21
83
 
22
84
  export { type CampaignsGetQuery, type CampaignsGetResponse, type CampaignsPostRequestBody, type CampaignsPostResponse, buildCampaignsGetFetcher, buildCampaignsPostFetcher, getCampaigns, postCampaigns };
@@ -3,20 +3,82 @@ import { ForceDig } from '@readyfor/api-client-base';
3
3
 
4
4
  type CampaignsGetOperation = paths["/api/campaigns"]["get"];
5
5
  type CampaignsGetResponse = CampaignsGetOperation["responses"]["200"]["content"]["application/json"];
6
- declare const buildCampaignsGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<any>;
6
+ declare const buildCampaignsGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
7
+ campaigns: ({
8
+ kind: "curationMailMagazine";
9
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
10
+ id: number;
11
+ bodyKind: "template" | "freeFormat";
12
+ deliveryAt: string | null;
13
+ lastEditorName: string;
14
+ lastEditedAt: string;
15
+ title?: string | null | undefined;
16
+ } | {
17
+ kind: "personalizedMailMagazine";
18
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
19
+ id: number;
20
+ deliveryAt: string | null;
21
+ lastEditorName: string;
22
+ lastEditedAt: string;
23
+ title?: string | null | undefined;
24
+ })[];
25
+ pagination: {
26
+ totalPages: number;
27
+ totalCount: number;
28
+ currentPerPage: number;
29
+ currentPage: number;
30
+ prevPage: number | null;
31
+ nextPage: number | null;
32
+ isFirstPage: boolean;
33
+ isLastPage: boolean;
34
+ };
35
+ }>;
7
36
  type CampaignsGetQuery = ForceDig<CampaignsGetOperation, [
8
37
  "parameters",
9
38
  "query"
10
39
  ]>;
11
- declare const getCampaigns: (query: CampaignsGetQuery, customRequestInit?: RequestInit) => Promise<any>;
40
+ declare const getCampaigns: (query: CampaignsGetQuery, customRequestInit?: RequestInit) => Promise<{
41
+ campaigns: ({
42
+ kind: "curationMailMagazine";
43
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
44
+ id: number;
45
+ bodyKind: "template" | "freeFormat";
46
+ deliveryAt: string | null;
47
+ lastEditorName: string;
48
+ lastEditedAt: string;
49
+ title?: string | null | undefined;
50
+ } | {
51
+ kind: "personalizedMailMagazine";
52
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
53
+ id: number;
54
+ deliveryAt: string | null;
55
+ lastEditorName: string;
56
+ lastEditedAt: string;
57
+ title?: string | null | undefined;
58
+ })[];
59
+ pagination: {
60
+ totalPages: number;
61
+ totalCount: number;
62
+ currentPerPage: number;
63
+ currentPage: number;
64
+ prevPage: number | null;
65
+ nextPage: number | null;
66
+ isFirstPage: boolean;
67
+ isLastPage: boolean;
68
+ };
69
+ }>;
12
70
  type CampaignsPostOperation = paths["/api/campaigns"]["post"];
13
71
  type CampaignsPostResponse = CampaignsPostOperation["responses"]["201"]["content"]["application/json"];
14
- declare const buildCampaignsPostFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<any>;
72
+ declare const buildCampaignsPostFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
73
+ id: number;
74
+ }>;
15
75
  type CampaignsPostRequestBody = ForceDig<CampaignsPostOperation, [
16
76
  "requestBody",
17
77
  "content",
18
78
  "application/json"
19
79
  ]>;
20
- declare const postCampaigns: (requestBody: CampaignsPostRequestBody, customRequestInit?: RequestInit) => Promise<any>;
80
+ declare const postCampaigns: (requestBody: CampaignsPostRequestBody, customRequestInit?: RequestInit) => Promise<{
81
+ id: number;
82
+ }>;
21
83
 
22
84
  export { type CampaignsGetQuery, type CampaignsGetResponse, type CampaignsPostRequestBody, type CampaignsPostResponse, buildCampaignsGetFetcher, buildCampaignsPostFetcher, getCampaigns, postCampaigns };
@@ -3,12 +3,148 @@ import { ForceDig } from '@readyfor/api-client-base';
3
3
 
4
4
  type CampaignsIdGetOperation = paths["/api/campaigns/{id}"]["get"];
5
5
  type CampaignsIdGetResponse = CampaignsIdGetOperation["responses"]["200"]["content"]["application/json"];
6
- declare const buildCampaignsIdGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<any>;
6
+ declare const buildCampaignsIdGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
7
+ campaignDetail: {
8
+ curationMailMagazine: {
9
+ utmCampaign: string | null;
10
+ subject: string | null;
11
+ preHeaderText: string | null;
12
+ targetFilters: {
13
+ id: number;
14
+ behaviorSegmentCodes: string[];
15
+ profileSegmentCodes: string[];
16
+ }[];
17
+ deliveredUsersCount: number | null;
18
+ bodyKind: "freeFormat";
19
+ htmlBody: string | null;
20
+ htmlStyle: string | null;
21
+ images: {
22
+ id: number;
23
+ key: string;
24
+ }[];
25
+ } | {
26
+ utmCampaign: string | null;
27
+ subject: string | null;
28
+ preHeaderText: string | null;
29
+ targetFilters: {
30
+ id: number;
31
+ behaviorSegmentCodes: string[];
32
+ profileSegmentCodes: string[];
33
+ }[];
34
+ deliveredUsersCount: number | null;
35
+ bodyKind: "template";
36
+ projects: {
37
+ id: number;
38
+ slotNumber: number;
39
+ readyforProjectId: number;
40
+ isPaidSlot: boolean;
41
+ title: string | null;
42
+ description: string | null;
43
+ tag: string | null;
44
+ tagUrl: string | null;
45
+ thumbnailUrl: string | null;
46
+ }[];
47
+ banners: {
48
+ id: number;
49
+ slotNumber: number;
50
+ url: string | null;
51
+ imageUrl: string | null;
52
+ }[];
53
+ };
54
+ kind: "curationMailMagazine";
55
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
56
+ id: number;
57
+ title: string | null;
58
+ deliveryScheduledAt: string | null;
59
+ } | {
60
+ personalizedMailMagazine: {
61
+ utmCampaign: string | null;
62
+ target: {
63
+ csvFileName: string;
64
+ targetUsersCount: number;
65
+ excludedUsersCount: number;
66
+ } | null;
67
+ };
68
+ kind: "personalizedMailMagazine";
69
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
70
+ id: number;
71
+ title: string | null;
72
+ deliveryScheduledAt: string | null;
73
+ };
74
+ }>;
7
75
  type CampaignsIdGetPath = ForceDig<CampaignsIdGetOperation, [
8
76
  "parameters",
9
77
  "path"
10
78
  ]>;
11
- declare const getCampaignsId: (path: CampaignsIdGetPath, customRequestInit?: RequestInit) => Promise<any>;
79
+ declare const getCampaignsId: (path: CampaignsIdGetPath, customRequestInit?: RequestInit) => Promise<{
80
+ campaignDetail: {
81
+ curationMailMagazine: {
82
+ utmCampaign: string | null;
83
+ subject: string | null;
84
+ preHeaderText: string | null;
85
+ targetFilters: {
86
+ id: number;
87
+ behaviorSegmentCodes: string[];
88
+ profileSegmentCodes: string[];
89
+ }[];
90
+ deliveredUsersCount: number | null;
91
+ bodyKind: "freeFormat";
92
+ htmlBody: string | null;
93
+ htmlStyle: string | null;
94
+ images: {
95
+ id: number;
96
+ key: string;
97
+ }[];
98
+ } | {
99
+ utmCampaign: string | null;
100
+ subject: string | null;
101
+ preHeaderText: string | null;
102
+ targetFilters: {
103
+ id: number;
104
+ behaviorSegmentCodes: string[];
105
+ profileSegmentCodes: string[];
106
+ }[];
107
+ deliveredUsersCount: number | null;
108
+ bodyKind: "template";
109
+ projects: {
110
+ id: number;
111
+ slotNumber: number;
112
+ readyforProjectId: number;
113
+ isPaidSlot: boolean;
114
+ title: string | null;
115
+ description: string | null;
116
+ tag: string | null;
117
+ tagUrl: string | null;
118
+ thumbnailUrl: string | null;
119
+ }[];
120
+ banners: {
121
+ id: number;
122
+ slotNumber: number;
123
+ url: string | null;
124
+ imageUrl: string | null;
125
+ }[];
126
+ };
127
+ kind: "curationMailMagazine";
128
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
129
+ id: number;
130
+ title: string | null;
131
+ deliveryScheduledAt: string | null;
132
+ } | {
133
+ personalizedMailMagazine: {
134
+ utmCampaign: string | null;
135
+ target: {
136
+ csvFileName: string;
137
+ targetUsersCount: number;
138
+ excludedUsersCount: number;
139
+ } | null;
140
+ };
141
+ kind: "personalizedMailMagazine";
142
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
143
+ id: number;
144
+ title: string | null;
145
+ deliveryScheduledAt: string | null;
146
+ };
147
+ }>;
12
148
  type CampaignsIdDeleteOperation = paths["/api/campaigns/{id}"]["delete"];
13
149
  declare const buildCampaignsIdDeleteFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<void>;
14
150
  type CampaignsIdDeletePath = ForceDig<CampaignsIdDeleteOperation, [
@@ -18,7 +154,75 @@ type CampaignsIdDeletePath = ForceDig<CampaignsIdDeleteOperation, [
18
154
  declare const deleteCampaignsId: (path: CampaignsIdDeletePath, customRequestInit?: RequestInit) => Promise<void>;
19
155
  type CampaignsIdPatchOperation = paths["/api/campaigns/{id}"]["patch"];
20
156
  type CampaignsIdPatchResponse = CampaignsIdPatchOperation["responses"]["200"]["content"]["application/json"];
21
- declare const buildCampaignsIdPatchFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<any>;
157
+ declare const buildCampaignsIdPatchFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
158
+ campaignDetail: {
159
+ curationMailMagazine: {
160
+ utmCampaign: string | null;
161
+ subject: string | null;
162
+ preHeaderText: string | null;
163
+ targetFilters: {
164
+ id: number;
165
+ behaviorSegmentCodes: string[];
166
+ profileSegmentCodes: string[];
167
+ }[];
168
+ deliveredUsersCount: number | null;
169
+ bodyKind: "freeFormat";
170
+ htmlBody: string | null;
171
+ htmlStyle: string | null;
172
+ images: {
173
+ id: number;
174
+ key: string;
175
+ }[];
176
+ } | {
177
+ utmCampaign: string | null;
178
+ subject: string | null;
179
+ preHeaderText: string | null;
180
+ targetFilters: {
181
+ id: number;
182
+ behaviorSegmentCodes: string[];
183
+ profileSegmentCodes: string[];
184
+ }[];
185
+ deliveredUsersCount: number | null;
186
+ bodyKind: "template";
187
+ projects: {
188
+ id: number;
189
+ slotNumber: number;
190
+ readyforProjectId: number;
191
+ isPaidSlot: boolean;
192
+ title: string | null;
193
+ description: string | null;
194
+ tag: string | null;
195
+ tagUrl: string | null;
196
+ thumbnailUrl: string | null;
197
+ }[];
198
+ banners: {
199
+ id: number;
200
+ slotNumber: number;
201
+ url: string | null;
202
+ imageUrl: string | null;
203
+ }[];
204
+ };
205
+ kind: "curationMailMagazine";
206
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
207
+ id: number;
208
+ title: string | null;
209
+ deliveryScheduledAt: string | null;
210
+ } | {
211
+ personalizedMailMagazine: {
212
+ utmCampaign: string | null;
213
+ target: {
214
+ csvFileName: string;
215
+ targetUsersCount: number;
216
+ excludedUsersCount: number;
217
+ } | null;
218
+ };
219
+ kind: "personalizedMailMagazine";
220
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
221
+ id: number;
222
+ title: string | null;
223
+ deliveryScheduledAt: string | null;
224
+ };
225
+ }>;
22
226
  type CampaignsIdPatchPath = ForceDig<CampaignsIdPatchOperation, [
23
227
  "parameters",
24
228
  "path"
@@ -28,6 +232,74 @@ type CampaignsIdPatchRequestBody = ForceDig<CampaignsIdPatchOperation, [
28
232
  "content",
29
233
  "multipart/form-data"
30
234
  ]>;
31
- declare const patchCampaignsId: (path: CampaignsIdPatchPath, requestBody: FormData, customRequestInit?: RequestInit) => Promise<any>;
235
+ declare const patchCampaignsId: (path: CampaignsIdPatchPath, requestBody: FormData, customRequestInit?: RequestInit) => Promise<{
236
+ campaignDetail: {
237
+ curationMailMagazine: {
238
+ utmCampaign: string | null;
239
+ subject: string | null;
240
+ preHeaderText: string | null;
241
+ targetFilters: {
242
+ id: number;
243
+ behaviorSegmentCodes: string[];
244
+ profileSegmentCodes: string[];
245
+ }[];
246
+ deliveredUsersCount: number | null;
247
+ bodyKind: "freeFormat";
248
+ htmlBody: string | null;
249
+ htmlStyle: string | null;
250
+ images: {
251
+ id: number;
252
+ key: string;
253
+ }[];
254
+ } | {
255
+ utmCampaign: string | null;
256
+ subject: string | null;
257
+ preHeaderText: string | null;
258
+ targetFilters: {
259
+ id: number;
260
+ behaviorSegmentCodes: string[];
261
+ profileSegmentCodes: string[];
262
+ }[];
263
+ deliveredUsersCount: number | null;
264
+ bodyKind: "template";
265
+ projects: {
266
+ id: number;
267
+ slotNumber: number;
268
+ readyforProjectId: number;
269
+ isPaidSlot: boolean;
270
+ title: string | null;
271
+ description: string | null;
272
+ tag: string | null;
273
+ tagUrl: string | null;
274
+ thumbnailUrl: string | null;
275
+ }[];
276
+ banners: {
277
+ id: number;
278
+ slotNumber: number;
279
+ url: string | null;
280
+ imageUrl: string | null;
281
+ }[];
282
+ };
283
+ kind: "curationMailMagazine";
284
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
285
+ id: number;
286
+ title: string | null;
287
+ deliveryScheduledAt: string | null;
288
+ } | {
289
+ personalizedMailMagazine: {
290
+ utmCampaign: string | null;
291
+ target: {
292
+ csvFileName: string;
293
+ targetUsersCount: number;
294
+ excludedUsersCount: number;
295
+ } | null;
296
+ };
297
+ kind: "personalizedMailMagazine";
298
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
299
+ id: number;
300
+ title: string | null;
301
+ deliveryScheduledAt: string | null;
302
+ };
303
+ }>;
32
304
 
33
305
  export { type CampaignsIdDeletePath, type CampaignsIdGetPath, type CampaignsIdGetResponse, type CampaignsIdPatchPath, type CampaignsIdPatchRequestBody, type CampaignsIdPatchResponse, buildCampaignsIdDeleteFetcher, buildCampaignsIdGetFetcher, buildCampaignsIdPatchFetcher, deleteCampaignsId, getCampaignsId, patchCampaignsId };