@readyfor/api-client-pigeon 0.328.0 → 1.0.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.
Files changed (65) hide show
  1. package/dist/{chunk-6JHFWIAW.mjs → chunk-24W5FWW7.mjs} +1 -1
  2. package/dist/{chunk-HD6B7N5S.mjs → chunk-45QYVVV2.mjs} +1 -1
  3. package/dist/{chunk-X2WL4YZH.mjs → chunk-6337UNDD.mjs} +1 -1
  4. package/dist/{chunk-TP3CBDVX.mjs → chunk-CXALAOMT.mjs} +1 -1
  5. package/dist/{chunk-QCIAYUXK.mjs → chunk-GVEIZAMY.mjs} +26 -10
  6. package/dist/{chunk-JWVQXFDL.mjs → chunk-MKV3OPBP.mjs} +1 -1
  7. package/dist/{chunk-2FPDBPJY.mjs → chunk-MYQ5EIA6.mjs} +1 -1
  8. package/dist/{chunk-IKRY3IDS.mjs → chunk-NA23PDIV.mjs} +1 -1
  9. package/dist/{chunk-6ZETET36.mjs → chunk-P4EIALGR.mjs} +1 -1
  10. package/dist/{chunk-4GY6JZ77.mjs → chunk-RWX2GYF3.mjs} +1 -1
  11. package/dist/{chunk-OLAYQE52.mjs → chunk-SBWG7GGI.mjs} +1 -1
  12. package/dist/{chunk-2ANX7NRV.mjs → chunk-THNPXV56.mjs} +1 -1
  13. package/dist/{chunk-G6IJEAVR.mjs → chunk-TPXQJS55.mjs} +1 -1
  14. package/dist/{chunk-NIZUYZOH.mjs → chunk-UHDD26HF.mjs} +1 -1
  15. package/dist/{chunk-7JRHKS3K.mjs → chunk-VUG5S4M4.mjs} +1 -1
  16. package/dist/{chunk-OODNPRT4.mjs → chunk-XNOKTUME.mjs} +1 -1
  17. package/dist/components.d.mts +691 -4987
  18. package/dist/components.d.ts +691 -4987
  19. package/dist/components.js +26 -10
  20. package/dist/components.mjs +1 -1
  21. package/dist/fetch/campaigns.d.mts +20 -16
  22. package/dist/fetch/campaigns.d.ts +20 -16
  23. package/dist/fetch/campaigns.js +26 -10
  24. package/dist/fetch/campaigns.mjs +2 -2
  25. package/dist/fetch/campaignsId.d.mts +88 -72
  26. package/dist/fetch/campaignsId.d.ts +88 -72
  27. package/dist/fetch/campaignsId.js +26 -10
  28. package/dist/fetch/campaignsId.mjs +2 -2
  29. package/dist/fetch/campaignsIdImages.js +26 -10
  30. package/dist/fetch/campaignsIdImages.mjs +2 -2
  31. package/dist/fetch/campaignsIdPreview.js +26 -10
  32. package/dist/fetch/campaignsIdPreview.mjs +2 -2
  33. package/dist/fetch/projectsProjectIdOrKeyword.d.mts +2 -2
  34. package/dist/fetch/projectsProjectIdOrKeyword.d.ts +2 -2
  35. package/dist/fetch/projectsProjectIdOrKeyword.js +26 -10
  36. package/dist/fetch/projectsProjectIdOrKeyword.mjs +2 -2
  37. package/dist/fetch/segmentsBehaviorSegments.d.mts +2 -2
  38. package/dist/fetch/segmentsBehaviorSegments.d.ts +2 -2
  39. package/dist/fetch/segmentsBehaviorSegments.js +26 -10
  40. package/dist/fetch/segmentsBehaviorSegments.mjs +2 -2
  41. package/dist/fetch/segmentsProfileSegments.d.mts +2 -2
  42. package/dist/fetch/segmentsProfileSegments.d.ts +2 -2
  43. package/dist/fetch/segmentsProfileSegments.js +26 -10
  44. package/dist/fetch/segmentsProfileSegments.mjs +2 -2
  45. package/dist/fetch/segmentsTargetUsersCount.js +26 -10
  46. package/dist/fetch/segmentsTargetUsersCount.mjs +2 -2
  47. package/dist/hooks/index.js +26 -10
  48. package/dist/hooks/index.mjs +16 -16
  49. package/dist/hooks/useCampaigns.js +26 -10
  50. package/dist/hooks/useCampaigns.mjs +10 -10
  51. package/dist/hooks/useCampaignsId.js +26 -10
  52. package/dist/hooks/useCampaignsId.mjs +10 -10
  53. package/dist/hooks/useCampaignsIdPreview.js +26 -10
  54. package/dist/hooks/useCampaignsIdPreview.mjs +10 -10
  55. package/dist/hooks/useProjectsProjectIdOrKeyword.js +26 -10
  56. package/dist/hooks/useProjectsProjectIdOrKeyword.mjs +10 -10
  57. package/dist/hooks/useSegmentsBehaviorSegments.js +26 -10
  58. package/dist/hooks/useSegmentsBehaviorSegments.mjs +10 -10
  59. package/dist/hooks/useSegmentsProfileSegments.js +26 -10
  60. package/dist/hooks/useSegmentsProfileSegments.mjs +10 -10
  61. package/dist/hooks/useSegmentsTargetUsersCount.js +26 -10
  62. package/dist/hooks/useSegmentsTargetUsersCount.mjs +10 -10
  63. package/dist/index.js +26 -10
  64. package/dist/index.mjs +9 -9
  65. package/package.json +5 -5
@@ -4,17 +4,24 @@ import { ForceDig } from '@readyfor/api-client-base';
4
4
  type CampaignsIdGetOperation = paths["/api/campaigns/{id}"]["get"];
5
5
  type CampaignsIdGetResponse = CampaignsIdGetOperation["responses"]["200"]["content"]["application/json"];
6
6
  declare const buildCampaignsIdGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
7
- campaignDetail: {
8
- curationMailMagazine: {
7
+ campaignDetail: ({
8
+ id: number;
9
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
10
+ title: string | null;
11
+ deliveryScheduledAt: string | null;
12
+ } & {
13
+ kind: "curationMailMagazine";
14
+ curationMailMagazine: ({
9
15
  utmCampaign: string | null;
10
16
  subject: string | null;
11
17
  preHeaderText: string | null;
18
+ deliveredUsersCount: number | null;
12
19
  targetFilters: {
13
20
  id: number;
14
21
  behaviorSegmentCodes: string[];
15
22
  profileSegmentCodes: string[];
16
23
  }[];
17
- deliveredUsersCount: number | null;
24
+ } & {
18
25
  bodyKind: "freeFormat";
19
26
  htmlBody: string | null;
20
27
  htmlStyle: string | null;
@@ -22,41 +29,43 @@ declare const buildCampaignsIdGetFetcher: (requestInit?: RequestInit) => (input:
22
29
  id: number;
23
30
  key: string;
24
31
  }[];
25
- } | {
32
+ }) | ({
26
33
  utmCampaign: string | null;
27
34
  subject: string | null;
28
35
  preHeaderText: string | null;
36
+ deliveredUsersCount: number | null;
29
37
  targetFilters: {
30
38
  id: number;
31
39
  behaviorSegmentCodes: string[];
32
40
  profileSegmentCodes: string[];
33
41
  }[];
34
- deliveredUsersCount: number | null;
42
+ } & {
35
43
  bodyKind: "template";
36
44
  projects: {
37
45
  id: number;
38
- slotNumber: number;
39
46
  readyforProjectId: number;
47
+ slotNumber: number;
40
48
  isPaidSlot: boolean;
41
49
  title: string | null;
42
50
  description: string | null;
51
+ thumbnailUrl: string | null;
43
52
  tag: string | null;
44
53
  tagUrl: string | null;
45
- thumbnailUrl: string | null;
46
54
  }[];
47
55
  banners: {
48
56
  id: number;
49
57
  slotNumber: number;
50
- url: string | null;
51
58
  imageUrl: string | null;
59
+ url: string | null;
52
60
  }[];
53
- };
54
- kind: "curationMailMagazine";
55
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
61
+ });
62
+ }) | ({
56
63
  id: number;
64
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
57
65
  title: string | null;
58
66
  deliveryScheduledAt: string | null;
59
- } | {
67
+ } & {
68
+ kind: "personalizedMailMagazine";
60
69
  personalizedMailMagazine: {
61
70
  utmCampaign: string | null;
62
71
  target: {
@@ -65,29 +74,31 @@ declare const buildCampaignsIdGetFetcher: (requestInit?: RequestInit) => (input:
65
74
  excludedUsersCount: number;
66
75
  } | null;
67
76
  };
68
- kind: "personalizedMailMagazine";
69
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
70
- id: number;
71
- title: string | null;
72
- deliveryScheduledAt: string | null;
73
- };
77
+ });
74
78
  }>;
75
79
  type CampaignsIdGetPath = ForceDig<CampaignsIdGetOperation, [
76
80
  "parameters",
77
81
  "path"
78
82
  ]>;
79
83
  declare const getCampaignsId: (path: CampaignsIdGetPath, customRequestInit?: RequestInit) => Promise<{
80
- campaignDetail: {
81
- curationMailMagazine: {
84
+ campaignDetail: ({
85
+ id: number;
86
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
87
+ title: string | null;
88
+ deliveryScheduledAt: string | null;
89
+ } & {
90
+ kind: "curationMailMagazine";
91
+ curationMailMagazine: ({
82
92
  utmCampaign: string | null;
83
93
  subject: string | null;
84
94
  preHeaderText: string | null;
95
+ deliveredUsersCount: number | null;
85
96
  targetFilters: {
86
97
  id: number;
87
98
  behaviorSegmentCodes: string[];
88
99
  profileSegmentCodes: string[];
89
100
  }[];
90
- deliveredUsersCount: number | null;
101
+ } & {
91
102
  bodyKind: "freeFormat";
92
103
  htmlBody: string | null;
93
104
  htmlStyle: string | null;
@@ -95,41 +106,43 @@ declare const getCampaignsId: (path: CampaignsIdGetPath, customRequestInit?: Req
95
106
  id: number;
96
107
  key: string;
97
108
  }[];
98
- } | {
109
+ }) | ({
99
110
  utmCampaign: string | null;
100
111
  subject: string | null;
101
112
  preHeaderText: string | null;
113
+ deliveredUsersCount: number | null;
102
114
  targetFilters: {
103
115
  id: number;
104
116
  behaviorSegmentCodes: string[];
105
117
  profileSegmentCodes: string[];
106
118
  }[];
107
- deliveredUsersCount: number | null;
119
+ } & {
108
120
  bodyKind: "template";
109
121
  projects: {
110
122
  id: number;
111
- slotNumber: number;
112
123
  readyforProjectId: number;
124
+ slotNumber: number;
113
125
  isPaidSlot: boolean;
114
126
  title: string | null;
115
127
  description: string | null;
128
+ thumbnailUrl: string | null;
116
129
  tag: string | null;
117
130
  tagUrl: string | null;
118
- thumbnailUrl: string | null;
119
131
  }[];
120
132
  banners: {
121
133
  id: number;
122
134
  slotNumber: number;
123
- url: string | null;
124
135
  imageUrl: string | null;
136
+ url: string | null;
125
137
  }[];
126
- };
127
- kind: "curationMailMagazine";
128
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
138
+ });
139
+ }) | ({
129
140
  id: number;
141
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
130
142
  title: string | null;
131
143
  deliveryScheduledAt: string | null;
132
- } | {
144
+ } & {
145
+ kind: "personalizedMailMagazine";
133
146
  personalizedMailMagazine: {
134
147
  utmCampaign: string | null;
135
148
  target: {
@@ -138,12 +151,7 @@ declare const getCampaignsId: (path: CampaignsIdGetPath, customRequestInit?: Req
138
151
  excludedUsersCount: number;
139
152
  } | null;
140
153
  };
141
- kind: "personalizedMailMagazine";
142
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
143
- id: number;
144
- title: string | null;
145
- deliveryScheduledAt: string | null;
146
- };
154
+ });
147
155
  }>;
148
156
  type CampaignsIdDeleteOperation = paths["/api/campaigns/{id}"]["delete"];
149
157
  declare const buildCampaignsIdDeleteFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<void>;
@@ -155,17 +163,24 @@ declare const deleteCampaignsId: (path: CampaignsIdDeletePath, customRequestInit
155
163
  type CampaignsIdPatchOperation = paths["/api/campaigns/{id}"]["patch"];
156
164
  type CampaignsIdPatchResponse = CampaignsIdPatchOperation["responses"]["200"]["content"]["application/json"];
157
165
  declare const buildCampaignsIdPatchFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
158
- campaignDetail: {
159
- curationMailMagazine: {
166
+ campaignDetail: ({
167
+ id: number;
168
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
169
+ title: string | null;
170
+ deliveryScheduledAt: string | null;
171
+ } & {
172
+ kind: "curationMailMagazine";
173
+ curationMailMagazine: ({
160
174
  utmCampaign: string | null;
161
175
  subject: string | null;
162
176
  preHeaderText: string | null;
177
+ deliveredUsersCount: number | null;
163
178
  targetFilters: {
164
179
  id: number;
165
180
  behaviorSegmentCodes: string[];
166
181
  profileSegmentCodes: string[];
167
182
  }[];
168
- deliveredUsersCount: number | null;
183
+ } & {
169
184
  bodyKind: "freeFormat";
170
185
  htmlBody: string | null;
171
186
  htmlStyle: string | null;
@@ -173,41 +188,43 @@ declare const buildCampaignsIdPatchFetcher: (requestInit?: RequestInit) => (inpu
173
188
  id: number;
174
189
  key: string;
175
190
  }[];
176
- } | {
191
+ }) | ({
177
192
  utmCampaign: string | null;
178
193
  subject: string | null;
179
194
  preHeaderText: string | null;
195
+ deliveredUsersCount: number | null;
180
196
  targetFilters: {
181
197
  id: number;
182
198
  behaviorSegmentCodes: string[];
183
199
  profileSegmentCodes: string[];
184
200
  }[];
185
- deliveredUsersCount: number | null;
201
+ } & {
186
202
  bodyKind: "template";
187
203
  projects: {
188
204
  id: number;
189
- slotNumber: number;
190
205
  readyforProjectId: number;
206
+ slotNumber: number;
191
207
  isPaidSlot: boolean;
192
208
  title: string | null;
193
209
  description: string | null;
210
+ thumbnailUrl: string | null;
194
211
  tag: string | null;
195
212
  tagUrl: string | null;
196
- thumbnailUrl: string | null;
197
213
  }[];
198
214
  banners: {
199
215
  id: number;
200
216
  slotNumber: number;
201
- url: string | null;
202
217
  imageUrl: string | null;
218
+ url: string | null;
203
219
  }[];
204
- };
205
- kind: "curationMailMagazine";
206
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
220
+ });
221
+ }) | ({
207
222
  id: number;
223
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
208
224
  title: string | null;
209
225
  deliveryScheduledAt: string | null;
210
- } | {
226
+ } & {
227
+ kind: "personalizedMailMagazine";
211
228
  personalizedMailMagazine: {
212
229
  utmCampaign: string | null;
213
230
  target: {
@@ -216,12 +233,7 @@ declare const buildCampaignsIdPatchFetcher: (requestInit?: RequestInit) => (inpu
216
233
  excludedUsersCount: number;
217
234
  } | null;
218
235
  };
219
- kind: "personalizedMailMagazine";
220
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
221
- id: number;
222
- title: string | null;
223
- deliveryScheduledAt: string | null;
224
- };
236
+ });
225
237
  }>;
226
238
  type CampaignsIdPatchPath = ForceDig<CampaignsIdPatchOperation, [
227
239
  "parameters",
@@ -233,17 +245,24 @@ type CampaignsIdPatchRequestBody = ForceDig<CampaignsIdPatchOperation, [
233
245
  "multipart/form-data"
234
246
  ]>;
235
247
  declare const patchCampaignsId: (path: CampaignsIdPatchPath, requestBody: FormData, customRequestInit?: RequestInit) => Promise<{
236
- campaignDetail: {
237
- curationMailMagazine: {
248
+ campaignDetail: ({
249
+ id: number;
250
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
251
+ title: string | null;
252
+ deliveryScheduledAt: string | null;
253
+ } & {
254
+ kind: "curationMailMagazine";
255
+ curationMailMagazine: ({
238
256
  utmCampaign: string | null;
239
257
  subject: string | null;
240
258
  preHeaderText: string | null;
259
+ deliveredUsersCount: number | null;
241
260
  targetFilters: {
242
261
  id: number;
243
262
  behaviorSegmentCodes: string[];
244
263
  profileSegmentCodes: string[];
245
264
  }[];
246
- deliveredUsersCount: number | null;
265
+ } & {
247
266
  bodyKind: "freeFormat";
248
267
  htmlBody: string | null;
249
268
  htmlStyle: string | null;
@@ -251,41 +270,43 @@ declare const patchCampaignsId: (path: CampaignsIdPatchPath, requestBody: FormDa
251
270
  id: number;
252
271
  key: string;
253
272
  }[];
254
- } | {
273
+ }) | ({
255
274
  utmCampaign: string | null;
256
275
  subject: string | null;
257
276
  preHeaderText: string | null;
277
+ deliveredUsersCount: number | null;
258
278
  targetFilters: {
259
279
  id: number;
260
280
  behaviorSegmentCodes: string[];
261
281
  profileSegmentCodes: string[];
262
282
  }[];
263
- deliveredUsersCount: number | null;
283
+ } & {
264
284
  bodyKind: "template";
265
285
  projects: {
266
286
  id: number;
267
- slotNumber: number;
268
287
  readyforProjectId: number;
288
+ slotNumber: number;
269
289
  isPaidSlot: boolean;
270
290
  title: string | null;
271
291
  description: string | null;
292
+ thumbnailUrl: string | null;
272
293
  tag: string | null;
273
294
  tagUrl: string | null;
274
- thumbnailUrl: string | null;
275
295
  }[];
276
296
  banners: {
277
297
  id: number;
278
298
  slotNumber: number;
279
- url: string | null;
280
299
  imageUrl: string | null;
300
+ url: string | null;
281
301
  }[];
282
- };
283
- kind: "curationMailMagazine";
284
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
302
+ });
303
+ }) | ({
285
304
  id: number;
305
+ status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
286
306
  title: string | null;
287
307
  deliveryScheduledAt: string | null;
288
- } | {
308
+ } & {
309
+ kind: "personalizedMailMagazine";
289
310
  personalizedMailMagazine: {
290
311
  utmCampaign: string | null;
291
312
  target: {
@@ -294,12 +315,7 @@ declare const patchCampaignsId: (path: CampaignsIdPatchPath, requestBody: FormDa
294
315
  excludedUsersCount: number;
295
316
  } | null;
296
317
  };
297
- kind: "personalizedMailMagazine";
298
- status: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
299
- id: number;
300
- title: string | null;
301
- deliveryScheduledAt: string | null;
302
- };
318
+ });
303
319
  }>;
304
320
 
305
321
  export { type CampaignsIdDeletePath, type CampaignsIdGetPath, type CampaignsIdGetResponse, type CampaignsIdPatchPath, type CampaignsIdPatchRequestBody, type CampaignsIdPatchResponse, buildCampaignsIdDeleteFetcher, buildCampaignsIdGetFetcher, buildCampaignsIdPatchFetcher, deleteCampaignsId, getCampaignsId, patchCampaignsId };