@readyfor/api-client-pigeon 1.22.0-pr1284.dc25e7e → 1.22.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 (118) hide show
  1. package/dist/chunk-24W5FWW7.mjs +27 -0
  2. package/dist/chunk-45QYVVV2.mjs +44 -0
  3. package/dist/chunk-5XEJOYX6.mjs +0 -0
  4. package/dist/chunk-6337UNDD.mjs +27 -0
  5. package/dist/chunk-CXALAOMT.mjs +48 -0
  6. package/dist/chunk-GVEIZAMY.mjs +359 -0
  7. package/dist/chunk-JVMIOVIM.mjs +29 -0
  8. package/dist/chunk-LMM3AGZ6.mjs +36 -0
  9. package/dist/chunk-MCYE5BYS.mjs +25 -0
  10. package/dist/chunk-MKV3OPBP.mjs +42 -0
  11. package/dist/chunk-MYQ5EIA6.mjs +50 -0
  12. package/dist/chunk-NA23PDIV.mjs +28 -0
  13. package/dist/chunk-P4EIALGR.mjs +24 -0
  14. package/dist/chunk-RWX2GYF3.mjs +39 -0
  15. package/dist/chunk-SBWG7GGI.mjs +52 -0
  16. package/dist/chunk-THNPXV56.mjs +24 -0
  17. package/dist/chunk-TPXQJS55.mjs +44 -0
  18. package/dist/chunk-UHDD26HF.mjs +44 -0
  19. package/dist/chunk-VUG5S4M4.mjs +42 -0
  20. package/dist/chunk-XNOKTUME.mjs +30 -0
  21. package/dist/components.d.mts +1107 -0
  22. package/dist/components.d.ts +1107 -2
  23. package/dist/components.js +444 -284
  24. package/dist/components.mjs +130 -221
  25. package/dist/fetch/campaigns.d.mts +88 -0
  26. package/dist/fetch/campaigns.d.ts +88 -2
  27. package/dist/fetch/campaigns.js +350 -22
  28. package/dist/fetch/campaigns.mjs +12 -18
  29. package/dist/{campaignsCampaignIdImagesId-BzoZ_38r.d.ts → fetch/campaignsCampaignIdImagesId.d.mts} +8 -6
  30. package/dist/fetch/campaignsCampaignIdImagesId.d.ts +12 -2
  31. package/dist/fetch/campaignsCampaignIdImagesId.js +44 -11
  32. package/dist/fetch/campaignsCampaignIdImagesId.mjs +7 -8
  33. package/dist/fetch/campaignsId.d.mts +321 -0
  34. package/dist/fetch/campaignsId.d.ts +321 -2
  35. package/dist/fetch/campaignsId.js +360 -27
  36. package/dist/fetch/campaignsId.mjs +16 -22
  37. package/dist/{campaignsIdDeliveryJob--2Nogu0k.d.ts → fetch/campaignsIdDeliveryJob.d.mts} +12 -7
  38. package/dist/fetch/campaignsIdDeliveryJob.d.ts +19 -2
  39. package/dist/fetch/campaignsIdDeliveryJob.js +56 -17
  40. package/dist/fetch/campaignsIdDeliveryJob.mjs +11 -13
  41. package/dist/{campaignsIdImages-DMSAp5-N.d.ts → fetch/campaignsIdImages.d.mts} +17 -11
  42. package/dist/fetch/campaignsIdImages.d.ts +24 -2
  43. package/dist/fetch/campaignsIdImages.js +341 -15
  44. package/dist/fetch/campaignsIdImages.mjs +8 -12
  45. package/dist/{campaignsIdPreview-C10ENt3B.d.ts → fetch/campaignsIdPreview.d.mts} +10 -8
  46. package/dist/fetch/campaignsIdPreview.d.ts +17 -2
  47. package/dist/fetch/campaignsIdPreview.js +338 -12
  48. package/dist/fetch/campaignsIdPreview.mjs +8 -9
  49. package/dist/{campaignsIdPreviewDeliveryEmail-BxkiUV8X.d.ts → fetch/campaignsIdPreviewDeliveryEmail.d.mts} +13 -7
  50. package/dist/fetch/campaignsIdPreviewDeliveryEmail.d.ts +17 -2
  51. package/dist/fetch/campaignsIdPreviewDeliveryEmail.js +48 -15
  52. package/dist/fetch/campaignsIdPreviewDeliveryEmail.mjs +7 -12
  53. package/dist/fetch/projectsProjectIdOrKeyword.d.mts +27 -0
  54. package/dist/fetch/projectsProjectIdOrKeyword.d.ts +27 -2
  55. package/dist/fetch/projectsProjectIdOrKeyword.js +338 -12
  56. package/dist/fetch/projectsProjectIdOrKeyword.mjs +8 -9
  57. package/dist/fetch/segmentsBehaviorSegments.d.mts +24 -0
  58. package/dist/fetch/segmentsBehaviorSegments.d.ts +24 -2
  59. package/dist/fetch/segmentsBehaviorSegments.js +335 -12
  60. package/dist/fetch/segmentsBehaviorSegments.mjs +8 -9
  61. package/dist/fetch/segmentsProfileSegments.d.mts +24 -0
  62. package/dist/fetch/segmentsProfileSegments.d.ts +24 -2
  63. package/dist/fetch/segmentsProfileSegments.js +335 -12
  64. package/dist/fetch/segmentsProfileSegments.mjs +8 -9
  65. package/dist/{segmentsTargetUsersCount-CjScWKqF.d.ts → fetch/segmentsTargetUsersCount.d.mts} +10 -8
  66. package/dist/fetch/segmentsTargetUsersCount.d.ts +17 -2
  67. package/dist/fetch/segmentsTargetUsersCount.js +339 -12
  68. package/dist/fetch/segmentsTargetUsersCount.mjs +8 -9
  69. package/dist/hooks/index.d.mts +20 -0
  70. package/dist/hooks/index.d.ts +20 -8
  71. package/dist/hooks/index.js +670 -29
  72. package/dist/hooks/index.mjs +71 -8
  73. package/dist/hooks/useCampaigns.d.mts +44 -0
  74. package/dist/hooks/useCampaigns.d.ts +37 -37
  75. package/dist/hooks/useCampaigns.js +404 -33
  76. package/dist/hooks/useCampaigns.mjs +22 -27
  77. package/dist/hooks/useCampaignsId.d.mts +39 -0
  78. package/dist/hooks/useCampaignsId.d.ts +33 -33
  79. package/dist/hooks/useCampaignsId.js +404 -33
  80. package/dist/hooks/useCampaignsId.mjs +22 -27
  81. package/dist/hooks/useCampaignsIdPreview.d.mts +39 -0
  82. package/dist/hooks/useCampaignsIdPreview.d.ts +33 -32
  83. package/dist/hooks/useCampaignsIdPreview.js +404 -33
  84. package/dist/hooks/useCampaignsIdPreview.mjs +22 -27
  85. package/dist/hooks/useProjectsProjectIdOrKeyword.d.mts +39 -0
  86. package/dist/hooks/useProjectsProjectIdOrKeyword.d.ts +33 -33
  87. package/dist/hooks/useProjectsProjectIdOrKeyword.js +410 -33
  88. package/dist/hooks/useProjectsProjectIdOrKeyword.mjs +22 -27
  89. package/dist/hooks/useSegmentsBehaviorSegments.d.mts +38 -0
  90. package/dist/hooks/useSegmentsBehaviorSegments.d.ts +32 -33
  91. package/dist/hooks/useSegmentsBehaviorSegments.js +402 -33
  92. package/dist/hooks/useSegmentsBehaviorSegments.mjs +22 -27
  93. package/dist/hooks/useSegmentsProfileSegments.d.mts +38 -0
  94. package/dist/hooks/useSegmentsProfileSegments.d.ts +32 -33
  95. package/dist/hooks/useSegmentsProfileSegments.js +402 -33
  96. package/dist/hooks/useSegmentsProfileSegments.mjs +22 -27
  97. package/dist/hooks/useSegmentsTargetUsersCount.d.mts +39 -0
  98. package/dist/hooks/useSegmentsTargetUsersCount.d.ts +33 -32
  99. package/dist/hooks/useSegmentsTargetUsersCount.js +412 -33
  100. package/dist/hooks/useSegmentsTargetUsersCount.mjs +22 -27
  101. package/dist/index.d.mts +15 -0
  102. package/dist/index.d.ts +15 -14
  103. package/dist/index.js +703 -106
  104. package/dist/index.mjs +213 -13
  105. package/dist/schemaType.d.mts +887 -0
  106. package/dist/schemaType.d.ts +887 -2
  107. package/dist/schemaType.js +18 -0
  108. package/dist/schemaType.mjs +0 -1
  109. package/package.json +19 -4
  110. package/dist/campaigns-DZNsI5kN.d.ts +0 -82
  111. package/dist/campaignsId-qIqhKTZn.d.ts +0 -309
  112. package/dist/chunk-8l464Juk.js +0 -28
  113. package/dist/components-CkziYCTx.d.ts +0 -1108
  114. package/dist/index-DRYular4.d.ts +0 -1
  115. package/dist/projectsProjectIdOrKeyword-Cayu4ZMd.d.ts +0 -25
  116. package/dist/schemaType-DcWvaCEH.d.ts +0 -782
  117. package/dist/segmentsBehaviorSegments-B6cq3XGV.d.ts +0 -25
  118. package/dist/segmentsProfileSegments-CMzmpqMd.d.ts +0 -25
@@ -0,0 +1,887 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ interface paths {
6
+ "/api/campaigns": {
7
+ /** キャンペーン一覧を取得する */
8
+ get: operations["GetCampaigns"];
9
+ /** キャンペーンを作成する */
10
+ post: operations["PostCampaigns"];
11
+ };
12
+ "/api/campaigns/{id}": {
13
+ /** キャンペーン詳細を取得する */
14
+ get: operations["GetCampaignsCampaignId"];
15
+ /** キャンペーンを削除する */
16
+ delete: operations["DeleteCampaignsCampaignId"];
17
+ /** キャンペーンを更新する */
18
+ patch: operations["PatchCampaignsCampaignId"];
19
+ };
20
+ "/api/campaigns/{id}/delivery_job": {
21
+ /** キャンペーンの配信予約をする */
22
+ post: operations["PostCampaignsCampaignIdDeliveryJob"];
23
+ /** キャンペーンの配信予約を取り消す */
24
+ delete: operations["DeleteCampaignsCampaignIdDeliveryJob"];
25
+ };
26
+ "/api/campaigns/{id}/preview": {
27
+ /** メルマガのプレビューを取得する */
28
+ get: operations["GetCampaignsCampaignIdPreview"];
29
+ };
30
+ "/api/campaigns/{id}/preview_delivery_email": {
31
+ /** メルマガのテスト配信 */
32
+ post: operations["PostCampaignsCampaignIdPreviewDeliveryEmail"];
33
+ };
34
+ "/api/campaigns/{id}/images": {
35
+ /** 画像をアップロードする */
36
+ post: {
37
+ parameters: {
38
+ path: {
39
+ id: number;
40
+ };
41
+ };
42
+ requestBody?: {
43
+ content: {
44
+ "multipart/form-data": components["schemas"]["PostCampaignsCampaignIdImagesReqeustBody"];
45
+ };
46
+ };
47
+ responses: {
48
+ /** @description Created */
49
+ 201: {
50
+ content: {
51
+ "application/json": components["schemas"]["Image"];
52
+ };
53
+ };
54
+ };
55
+ };
56
+ };
57
+ "/api/campaigns/{campaign_id}/images/{id}": {
58
+ /** アップロードされた画像を削除する */
59
+ delete: {
60
+ parameters: {
61
+ path: {
62
+ campaign_id: number;
63
+ id: number;
64
+ };
65
+ };
66
+ responses: {
67
+ /** @description No Content */
68
+ 204: {
69
+ content: never;
70
+ };
71
+ };
72
+ };
73
+ };
74
+ "/api/projects/{project_id_or_keyword}": {
75
+ /** プロジェクト情報を取得する */
76
+ get: operations["GetProjectsProjectIdOrKeyword"];
77
+ };
78
+ "/api/segments/behavior_segments": {
79
+ /** 配信先の行動セグメントの一覧を返す */
80
+ get: operations["GetBehaviorSegments"];
81
+ };
82
+ "/api/segments/profile_segments": {
83
+ /** 配信先の属性セグメントの一覧を返す */
84
+ get: operations["GetProfileSegments"];
85
+ };
86
+ "/api/segments/target_users_count": {
87
+ /** 配信先設定時の配信対象人数を取得する */
88
+ get: operations["GetTargetUsersCount"];
89
+ };
90
+ }
91
+ type webhooks = Record<string, never>;
92
+ interface components {
93
+ schemas: {
94
+ /**
95
+ * GetCampaignsResponse
96
+ * @example {
97
+ * "pagination": {
98
+ * "nextPage": 7,
99
+ * "isLastPage": true,
100
+ * "totalPages": 6,
101
+ * "prevPage": 2,
102
+ * "totalCount": 1,
103
+ * "currentPage": 5,
104
+ * "isFirstPage": true,
105
+ * "currentPerPage": 5
106
+ * },
107
+ * "campaigns": [
108
+ * {
109
+ * "lastEditorName": "lastEditorName",
110
+ * "kind": "personalizedMailMagazine",
111
+ * "deliveryAt": "2000-01-23T04:56:07.000Z",
112
+ * "lastEditedAt": "2000-01-23T04:56:07.000Z",
113
+ * "id": 0,
114
+ * "title": "title",
115
+ * "status": "draft"
116
+ * },
117
+ * {
118
+ * "lastEditorName": "lastEditorName",
119
+ * "kind": "personalizedMailMagazine",
120
+ * "deliveryAt": "2000-01-23T04:56:07.000Z",
121
+ * "lastEditedAt": "2000-01-23T04:56:07.000Z",
122
+ * "id": 0,
123
+ * "title": "title",
124
+ * "status": "draft"
125
+ * }
126
+ * ]
127
+ * }
128
+ */
129
+ GetCampaignsResponse: {
130
+ campaigns: components["schemas"]["Campaign"][];
131
+ pagination: components["schemas"]["Pagination"];
132
+ };
133
+ Campaign: components["schemas"]["PersonalizedMailMagazineCampaign"] | components["schemas"]["CurationMailMagazineCampaign"];
134
+ /**
135
+ * @example {
136
+ * "lastEditorName": "lastEditorName",
137
+ * "kind": "personalizedMailMagazine",
138
+ * "deliveryAt": "2000-01-23T04:56:07.000Z",
139
+ * "lastEditedAt": "2000-01-23T04:56:07.000Z",
140
+ * "id": 0,
141
+ * "title": "title",
142
+ * "status": "draft"
143
+ * }
144
+ */
145
+ PersonalizedMailMagazineCampaign: components["schemas"]["CampaignBase"] & {
146
+ /** @enum {string} */
147
+ kind: "personalizedMailMagazine";
148
+ };
149
+ /** Campaign */
150
+ CampaignBase: {
151
+ id: number;
152
+ title?: string | null;
153
+ status: components["schemas"]["CampaignStatus"];
154
+ /** Format: date-time */
155
+ deliveryAt: string | null;
156
+ lastEditorName: string;
157
+ /** Format: date-time */
158
+ lastEditedAt: string;
159
+ };
160
+ CurationMailMagazineCampaign: components["schemas"]["CampaignBase"] & {
161
+ /** @enum {string} */
162
+ kind: "curationMailMagazine";
163
+ bodyKind: components["schemas"]["BodyKind"];
164
+ };
165
+ /**
166
+ * PostCampaignsResponse
167
+ * @example {
168
+ * "id": 0
169
+ * }
170
+ */
171
+ PostCampaignsResponse: {
172
+ id: number;
173
+ };
174
+ /** PostCampaignsRequestBody */
175
+ PostCampaignsRequestBody: components["schemas"]["CreateCampaignKindCurationMailMagazineFormData"] | components["schemas"]["CreateCampaignKindPersonalizedMailMagazineFormData"];
176
+ /**
177
+ * CreateCampaignKindCurationMailMagazineFormData
178
+ * @example {
179
+ * "kind": "curationMailMagazine",
180
+ * "bodyKind": "template"
181
+ * }
182
+ */
183
+ CreateCampaignKindCurationMailMagazineFormData: {
184
+ /** @enum {string} */
185
+ kind: "curationMailMagazine";
186
+ bodyKind: components["schemas"]["BodyKind"];
187
+ };
188
+ /** CreateCampaignKindPersonalizedMailMagazineFormData */
189
+ CreateCampaignKindPersonalizedMailMagazineFormData: {
190
+ /** @enum {string} */
191
+ kind: "personalizedMailMagazine";
192
+ };
193
+ /**
194
+ * CampaignStatus
195
+ * @enum {string}
196
+ */
197
+ CampaignStatus: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
198
+ /**
199
+ * CampaignKind
200
+ * @enum {string}
201
+ */
202
+ CampaignKind: "curationMailMagazine" | "personalizedMailMagazine";
203
+ /**
204
+ * @example {
205
+ * "campaignDetail": {
206
+ * "personalizedMailMagazine": {
207
+ * "utmCampaign": "utmCampaign",
208
+ * "target": ""
209
+ * },
210
+ * "kind": "personalizedMailMagazine",
211
+ * "deliveryScheduledAt": "2000-01-23T04:56:07.000Z",
212
+ * "id": 0,
213
+ * "title": "title",
214
+ * "status": "draft"
215
+ * }
216
+ * }
217
+ */
218
+ CampaignsCampaignIdResponse: {
219
+ campaignDetail: components["schemas"]["CampaignDetail"];
220
+ };
221
+ /** CampaignDetail */
222
+ CampaignDetail: components["schemas"]["CampaignDetailWithPersonalizedMailMagazine"] | components["schemas"]["CampaignDetailWithCurationMailMagazine"];
223
+ PatchCampaignsCampaignIdRequestBody: {
224
+ formData: components["schemas"]["CampaignFormData"];
225
+ };
226
+ /**
227
+ * HttpErrorBadRequest
228
+ * @example {
229
+ * "errors": [
230
+ * "errors",
231
+ * "errors"
232
+ * ]
233
+ * }
234
+ */
235
+ HttpErrorBadRequest: {
236
+ errors: string[];
237
+ };
238
+ /**
239
+ * GetCampaignsCampaignIdPreviewResponse
240
+ * @example {
241
+ * "content": "content"
242
+ * }
243
+ */
244
+ GetCampaignsCampaignIdPreviewResponse: {
245
+ content: string;
246
+ };
247
+ /**
248
+ * PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody
249
+ * @example {
250
+ * "emails": [
251
+ * "emails",
252
+ * "emails"
253
+ * ]
254
+ * }
255
+ */
256
+ PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody: {
257
+ emails: string[];
258
+ };
259
+ /** PostCampaignsCampaignIdImagesReqeustBody */
260
+ PostCampaignsCampaignIdImagesReqeustBody: {
261
+ /** Format: binary */
262
+ image: File | Blob;
263
+ };
264
+ /**
265
+ * CurationMailMagazine_Image
266
+ * @example {
267
+ * "id": 0,
268
+ * "key": "key"
269
+ * }
270
+ */
271
+ Image: {
272
+ id: number;
273
+ key: string;
274
+ };
275
+ /**
276
+ * GetProjectsProjectIdOrKeywordResponse
277
+ * @example {
278
+ * "project": {
279
+ * "abstract": "abstract",
280
+ * "keyword": "keyword",
281
+ * "title": "title",
282
+ * "projectId": 0
283
+ * }
284
+ * }
285
+ */
286
+ GetProjectsProjectIdOrKeywordResponse: {
287
+ project: components["schemas"]["ReadyforProject"];
288
+ };
289
+ /**
290
+ * @example {
291
+ * "behaviorSegments": [
292
+ * {
293
+ * "code": "code",
294
+ * "displayOrder": 0,
295
+ * "description": "description",
296
+ * "label": "label",
297
+ * "isActive": true
298
+ * },
299
+ * {
300
+ * "code": "code",
301
+ * "displayOrder": 0,
302
+ * "description": "description",
303
+ * "label": "label",
304
+ * "isActive": true
305
+ * }
306
+ * ]
307
+ * }
308
+ */
309
+ GetBehaviorSegmentsResponse: {
310
+ behaviorSegments: components["schemas"]["Segment"][];
311
+ };
312
+ /**
313
+ * @example {
314
+ * "profileSegments": [
315
+ * {
316
+ * "code": "code",
317
+ * "displayOrder": 0,
318
+ * "description": "description",
319
+ * "label": "label",
320
+ * "isActive": true
321
+ * },
322
+ * {
323
+ * "code": "code",
324
+ * "displayOrder": 0,
325
+ * "description": "description",
326
+ * "label": "label",
327
+ * "isActive": true
328
+ * }
329
+ * ]
330
+ * }
331
+ */
332
+ GetProfileSegmentsResponse: {
333
+ profileSegments: components["schemas"]["Segment"][];
334
+ };
335
+ /**
336
+ * GetTargetUsersCountResponse
337
+ * @example {
338
+ * "count": 0
339
+ * }
340
+ */
341
+ GetTargetUsersCountResponse: {
342
+ /** @description 配信対象人数 */
343
+ count: number;
344
+ };
345
+ /** TargetFilterSegments */
346
+ TargetFilterSegments: {
347
+ /** @description 行動セグメントコードの配列 */
348
+ behaviorSegmentCodes: string[];
349
+ /** @description 属性セグメントコードの配列 */
350
+ profileSegmentCodes: string[];
351
+ };
352
+ /**
353
+ * Pagination
354
+ * @description ページネーション
355
+ * @example {
356
+ * "nextPage": 7,
357
+ * "isLastPage": true,
358
+ * "totalPages": 6,
359
+ * "prevPage": 2,
360
+ * "totalCount": 1,
361
+ * "currentPage": 5,
362
+ * "isFirstPage": true,
363
+ * "currentPerPage": 5
364
+ * }
365
+ */
366
+ Pagination: {
367
+ /** @description 合計ページ */
368
+ totalPages: number;
369
+ /** @description 合計件数 */
370
+ totalCount: number;
371
+ /** @description 1ページあたりのレコード数 */
372
+ currentPerPage: number;
373
+ /** @description 現在のページ */
374
+ currentPage: number;
375
+ /** @description 前のページ */
376
+ prevPage: number | null;
377
+ /** @description 次のページ */
378
+ nextPage: number | null;
379
+ /** @description 最初のページかどうか */
380
+ isFirstPage: boolean;
381
+ /** @description 最後のページかどうか */
382
+ isLastPage: boolean;
383
+ };
384
+ /**
385
+ * CurationMailMagazine_BodyKind
386
+ * @enum {string}
387
+ */
388
+ BodyKind: "template" | "freeFormat";
389
+ /**
390
+ * CampaignDetailWithPersonalizedMailMagazine
391
+ * @example {
392
+ * "personalizedMailMagazine": {
393
+ * "utmCampaign": "utmCampaign",
394
+ * "target": ""
395
+ * },
396
+ * "kind": "personalizedMailMagazine",
397
+ * "deliveryScheduledAt": "2000-01-23T04:56:07.000Z",
398
+ * "id": 0,
399
+ * "title": "title",
400
+ * "status": "draft"
401
+ * }
402
+ */
403
+ CampaignDetailWithPersonalizedMailMagazine: components["schemas"]["CampaignDetailBase"] & components["schemas"]["CampaignDetailKindDataPersonalizedMailMagazine"];
404
+ /** CampaignDetailWithCurationMailMagazine */
405
+ CampaignDetailWithCurationMailMagazine: components["schemas"]["CampaignDetailBase"] & components["schemas"]["CampaignDetailKindDataCurationMailMagazine"];
406
+ /** CampaignFormData */
407
+ CampaignFormData: components["schemas"]["CampaignWithPersonalizedMailMagazineFormData"] | components["schemas"]["CampaignWithCurationMailMagazineFormData"];
408
+ /**
409
+ * ReadyforProject
410
+ * @example {
411
+ * "abstract": "abstract",
412
+ * "keyword": "keyword",
413
+ * "title": "title",
414
+ * "projectId": 0
415
+ * }
416
+ */
417
+ ReadyforProject: {
418
+ projectId: number;
419
+ keyword: string;
420
+ title: string;
421
+ abstract: string;
422
+ };
423
+ /**
424
+ * Segment
425
+ * @example {
426
+ * "code": "code",
427
+ * "displayOrder": 0,
428
+ * "description": "description",
429
+ * "label": "label",
430
+ * "isActive": true
431
+ * }
432
+ */
433
+ Segment: {
434
+ code: string;
435
+ label: string;
436
+ isActive: boolean;
437
+ displayOrder: number | null;
438
+ description: string | null;
439
+ };
440
+ /** CampaignDetailBase */
441
+ CampaignDetailBase: {
442
+ id: number;
443
+ status: components["schemas"]["CampaignStatus"];
444
+ title: string | null;
445
+ /** Format: date-time */
446
+ deliveryScheduledAt: string | null;
447
+ };
448
+ /** CampaignDetailKindDataPersonalizedMailMagazine */
449
+ CampaignDetailKindDataPersonalizedMailMagazine: {
450
+ /** @enum {string} */
451
+ kind: "personalizedMailMagazine";
452
+ personalizedMailMagazine: components["schemas"]["PersonalizedMailMagazineDetail"];
453
+ };
454
+ /** CampaignDetailKindDataCurationMailMagazine */
455
+ CampaignDetailKindDataCurationMailMagazine: {
456
+ /** @enum {string} */
457
+ kind: "curationMailMagazine";
458
+ curationMailMagazine: components["schemas"]["CurationMailMagazineDetail"];
459
+ };
460
+ /** CampaignWithPersonalizedMailMagazineFormData */
461
+ CampaignWithPersonalizedMailMagazineFormData: components["schemas"]["CampaignBaseFormData"] & components["schemas"]["CampaignKindDataPersonalizedMailMagazineFormData"];
462
+ /** CampaignWithCurationMailMagazineFormData */
463
+ CampaignWithCurationMailMagazineFormData: components["schemas"]["CampaignBaseFormData"] & components["schemas"]["CampaignKindDataCurationMailMagazineFormData"];
464
+ /**
465
+ * PersonalizedMailMagazineDetail
466
+ * @example {
467
+ * "utmCampaign": "utmCampaign",
468
+ * "target": ""
469
+ * }
470
+ */
471
+ PersonalizedMailMagazineDetail: {
472
+ utmCampaign: string | null;
473
+ target: components["schemas"]["PersonalizedMailMagazineDetailTarget"] | null;
474
+ };
475
+ /** CurationMailMagazineDetail */
476
+ CurationMailMagazineDetail: components["schemas"]["CurationMailMagazineDetailBodyKindTemplate"] | components["schemas"]["CurationMailMagazineDetailBodyKindFreeFormat"];
477
+ /** CampaignBaseFormData */
478
+ CampaignBaseFormData: {
479
+ title: string | null;
480
+ /** Format: date-time */
481
+ deliveryScheduledAt: string | null;
482
+ };
483
+ /** CampaignKindDataPersonalizedMailMagazineFormData */
484
+ CampaignKindDataPersonalizedMailMagazineFormData: {
485
+ /** @enum {string} */
486
+ kind: "personalizedMailMagazine";
487
+ personalizedMailMagazine: components["schemas"]["PersonalizedMailMagazineFormData"];
488
+ };
489
+ /** CampaignKindDataCurationMailMagazineFormData */
490
+ CampaignKindDataCurationMailMagazineFormData: {
491
+ /** @enum {string} */
492
+ kind: "curationMailMagazine";
493
+ curationMailMagazine: components["schemas"]["CurationMailMagazineFormData"];
494
+ };
495
+ /** PersonalizedMailMagazineDetailTarget */
496
+ PersonalizedMailMagazineDetailTarget: {
497
+ csvFileName: string;
498
+ targetUsersCount: number;
499
+ excludedUsersCount: number;
500
+ };
501
+ /** CurationMailMagazineDetailBodyKindTemplate */
502
+ CurationMailMagazineDetailBodyKindTemplate: components["schemas"]["CurationMailMagazineDetailBase"] & {
503
+ /** @enum {string} */
504
+ bodyKind: "template";
505
+ projects: components["schemas"]["CurationMailMagazineTargetProject"][];
506
+ banners: components["schemas"]["CurationMailMagazineBanner"][];
507
+ };
508
+ /** CurationMailMagazineDetailBodyKindFreeFormat */
509
+ CurationMailMagazineDetailBodyKindFreeFormat: components["schemas"]["CurationMailMagazineDetailBase"] & {
510
+ /** @enum {string} */
511
+ bodyKind: "freeFormat";
512
+ htmlBody: string | null;
513
+ htmlStyle: string | null;
514
+ images: components["schemas"]["Image"][];
515
+ };
516
+ /** PersonalizedMailMagazineFormData */
517
+ PersonalizedMailMagazineFormData: {
518
+ utmCampaign: string | null;
519
+ targetCsv: components["schemas"]["PersonalizedMailMagazineTargetCsvFormData"] | null;
520
+ };
521
+ /** CurationMailMagazineFormData */
522
+ CurationMailMagazineFormData: components["schemas"]["CurationMailMagazineFormDataBodyKindFreeFormat"] | components["schemas"]["CurationMailMagazineFormDataBodyKindTemplate"];
523
+ /** CurationMailMagazineDetailBase */
524
+ CurationMailMagazineDetailBase: {
525
+ utmCampaign: string | null;
526
+ subject: string | null;
527
+ preHeaderText: string | null;
528
+ deliveredUsersCount: number | null;
529
+ targetFilters: components["schemas"]["CurationMailMagazineTargetFilter"][];
530
+ };
531
+ /** CurationMailMagazineTargetProject */
532
+ CurationMailMagazineTargetProject: {
533
+ id: number;
534
+ readyforProjectId: number;
535
+ slotNumber: number;
536
+ isPaidSlot: boolean;
537
+ title: string | null;
538
+ description: string | null;
539
+ thumbnailUrl: string | null;
540
+ tag: string | null;
541
+ tagUrl: string | null;
542
+ };
543
+ /** CurationMailMagazineBanner */
544
+ CurationMailMagazineBanner: {
545
+ id: number;
546
+ slotNumber: number;
547
+ imageUrl: string | null;
548
+ url: string | null;
549
+ };
550
+ /** PersonalizedMailMagazineTargetCsvFormData */
551
+ PersonalizedMailMagazineTargetCsvFormData: components["schemas"]["PersonalizedMailMagazineTargetDeleteCsvFormData"] | components["schemas"]["PersonalizedMailMagazineTargetUploadCsvFormData"];
552
+ /** CurationMailMagazineBannerFormDataBodyKindFreeFormat */
553
+ CurationMailMagazineFormDataBodyKindFreeFormat: components["schemas"]["CurationMailMagazineFormDataBase"] & {
554
+ /** @enum {string} */
555
+ bodyKind: "freeFormat";
556
+ htmlBody: string | null;
557
+ htmlStyle: string | null;
558
+ };
559
+ /** CurationMailMagazineFormDataBodyKindTemplate */
560
+ CurationMailMagazineFormDataBodyKindTemplate: components["schemas"]["CurationMailMagazineFormDataBase"] & {
561
+ /** @enum {string} */
562
+ bodyKind: "template";
563
+ projects: components["schemas"]["CurationMailMagazineProjectFormData"][];
564
+ banners: components["schemas"]["CurationMailMagazineBannerFormData"][];
565
+ };
566
+ /** CurationMailMagazineTargetFilter */
567
+ CurationMailMagazineTargetFilter: {
568
+ id: number;
569
+ behaviorSegmentCodes: string[];
570
+ profileSegmentCodes: string[];
571
+ };
572
+ /** PersonalizedMailMagazineTargetDeleteCsvFormData */
573
+ PersonalizedMailMagazineTargetDeleteCsvFormData: {
574
+ /** @enum {string} */
575
+ kind: "deleteTargetCsv";
576
+ };
577
+ /** PersonalizedMailMagazineTargetUploadCsvFormData */
578
+ PersonalizedMailMagazineTargetUploadCsvFormData: {
579
+ /** @enum {string} */
580
+ kind: "uploadCsv";
581
+ fileName: string;
582
+ records: components["schemas"]["PersonalizedMailMagazineTargetUploadCsvRecordFormData"][];
583
+ };
584
+ /** CurationMailMagazineFormData */
585
+ CurationMailMagazineFormDataBase: {
586
+ utmCampaign: string | null;
587
+ subject: string | null;
588
+ preHeaderText: string | null;
589
+ targetFilters: components["schemas"]["CurationMailMagazineTargetFilterFormData"][];
590
+ };
591
+ /** CurationMailMagazineProjectFormData */
592
+ CurationMailMagazineProjectFormData: {
593
+ id: number | null;
594
+ slotNumber: number;
595
+ readyforProjectId: number;
596
+ isPaidSlot: boolean;
597
+ title: string | null;
598
+ description: string | null;
599
+ thumbnail: components["schemas"]["ImageFormData"] | null;
600
+ tag: string | null;
601
+ tagUrl: string | null;
602
+ };
603
+ /** CurationMailMagazineBannerFormData */
604
+ CurationMailMagazineBannerFormData: {
605
+ id: number | null;
606
+ slotNumber: number;
607
+ image: components["schemas"]["ImageFormData"] | null;
608
+ url: string | null;
609
+ };
610
+ /**
611
+ * PersonalizedMailMagazineTargetUploadCsvRecordFormData
612
+ * @example [
613
+ * {
614
+ * "userId": 12345678
615
+ * },
616
+ * {
617
+ * "projectIds": "111111;2222222;33333333"
618
+ * }
619
+ * ]
620
+ */
621
+ PersonalizedMailMagazineTargetUploadCsvRecordFormData: {
622
+ userId: number;
623
+ projectIds: string;
624
+ };
625
+ /** CurationMailMagazineTargetFilterFormData */
626
+ CurationMailMagazineTargetFilterFormData: {
627
+ id: number | null;
628
+ behaviorSegmentCodes: string[];
629
+ profileSegmentCodes: string[];
630
+ };
631
+ /** ImageFormData */
632
+ ImageFormData: components["schemas"]["UploadImageFormData"] | components["schemas"]["DeleteImageFormData"];
633
+ /** UploadImageFormData */
634
+ UploadImageFormData: {
635
+ /** @enum {string} */
636
+ kind: "upload";
637
+ /** Format: binary */
638
+ data: File | Blob;
639
+ };
640
+ /** DeleteImageFormData */
641
+ DeleteImageFormData: {
642
+ /** @enum {string} */
643
+ kind: "delete";
644
+ };
645
+ };
646
+ responses: never;
647
+ parameters: never;
648
+ requestBodies: never;
649
+ headers: never;
650
+ pathItems: never;
651
+ }
652
+ type $defs = Record<string, never>;
653
+ type external = Record<string, never>;
654
+ interface operations {
655
+ /** キャンペーン一覧を取得する */
656
+ GetCampaigns: {
657
+ parameters: {
658
+ query?: {
659
+ title?: string;
660
+ status?: components["schemas"]["CampaignStatus"];
661
+ kind?: components["schemas"]["CampaignKind"];
662
+ deliveryAtFrom?: string;
663
+ deliveryAtTo?: string;
664
+ page?: number;
665
+ };
666
+ };
667
+ responses: {
668
+ /** @description OK */
669
+ 200: {
670
+ content: {
671
+ "application/json": components["schemas"]["GetCampaignsResponse"];
672
+ };
673
+ };
674
+ };
675
+ };
676
+ /** キャンペーンを作成する */
677
+ PostCampaigns: {
678
+ requestBody: {
679
+ content: {
680
+ "application/json": components["schemas"]["PostCampaignsRequestBody"];
681
+ };
682
+ };
683
+ responses: {
684
+ /** @description Created */
685
+ 201: {
686
+ content: {
687
+ "application/json": components["schemas"]["PostCampaignsResponse"];
688
+ };
689
+ };
690
+ };
691
+ };
692
+ /** キャンペーン詳細を取得する */
693
+ GetCampaignsCampaignId: {
694
+ parameters: {
695
+ path: {
696
+ id: number;
697
+ };
698
+ };
699
+ responses: {
700
+ /** @description OK */
701
+ 200: {
702
+ content: {
703
+ "application/json": components["schemas"]["CampaignsCampaignIdResponse"];
704
+ };
705
+ };
706
+ };
707
+ };
708
+ /** キャンペーンを削除する */
709
+ DeleteCampaignsCampaignId: {
710
+ parameters: {
711
+ path: {
712
+ id: number;
713
+ };
714
+ };
715
+ responses: {
716
+ /** @description No Content */
717
+ 204: {
718
+ content: never;
719
+ };
720
+ };
721
+ };
722
+ /** キャンペーンを更新する */
723
+ PatchCampaignsCampaignId: {
724
+ parameters: {
725
+ path: {
726
+ id: number;
727
+ };
728
+ };
729
+ requestBody: {
730
+ content: {
731
+ "multipart/form-data": components["schemas"]["PatchCampaignsCampaignIdRequestBody"];
732
+ };
733
+ };
734
+ responses: {
735
+ /** @description OK */
736
+ 200: {
737
+ content: {
738
+ "application/json": components["schemas"]["CampaignsCampaignIdResponse"];
739
+ };
740
+ };
741
+ /** @description Bad Request */
742
+ 400: {
743
+ content: {
744
+ "application/json": components["schemas"]["HttpErrorBadRequest"];
745
+ };
746
+ };
747
+ };
748
+ };
749
+ /** キャンペーンの配信予約をする */
750
+ PostCampaignsCampaignIdDeliveryJob: {
751
+ parameters: {
752
+ path: {
753
+ id: number;
754
+ };
755
+ };
756
+ responses: {
757
+ /** @description Created */
758
+ 201: {
759
+ content: never;
760
+ };
761
+ /** @description Bad Request */
762
+ 400: {
763
+ content: {
764
+ "application/json": components["schemas"]["HttpErrorBadRequest"];
765
+ };
766
+ };
767
+ };
768
+ };
769
+ /** キャンペーンの配信予約を取り消す */
770
+ DeleteCampaignsCampaignIdDeliveryJob: {
771
+ parameters: {
772
+ path: {
773
+ id: number;
774
+ };
775
+ };
776
+ responses: {
777
+ /** @description No Content */
778
+ 204: {
779
+ content: never;
780
+ };
781
+ /** @description Bad Request */
782
+ 400: {
783
+ content: {
784
+ "application/json": components["schemas"]["HttpErrorBadRequest"];
785
+ };
786
+ };
787
+ };
788
+ };
789
+ /** メルマガのプレビューを取得する */
790
+ GetCampaignsCampaignIdPreview: {
791
+ parameters: {
792
+ path: {
793
+ id: number;
794
+ };
795
+ };
796
+ responses: {
797
+ /** @description OK */
798
+ 200: {
799
+ content: {
800
+ "application/json": components["schemas"]["GetCampaignsCampaignIdPreviewResponse"];
801
+ };
802
+ };
803
+ };
804
+ };
805
+ /** メルマガのテスト配信 */
806
+ PostCampaignsCampaignIdPreviewDeliveryEmail: {
807
+ parameters: {
808
+ path: {
809
+ id: number;
810
+ };
811
+ };
812
+ requestBody: {
813
+ content: {
814
+ "application/json": components["schemas"]["PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody"];
815
+ };
816
+ };
817
+ responses: {
818
+ /** @description Created */
819
+ 201: {
820
+ content: never;
821
+ };
822
+ /** @description Bad Request */
823
+ 400: {
824
+ content: {
825
+ "application/json": components["schemas"]["HttpErrorBadRequest"];
826
+ };
827
+ };
828
+ };
829
+ };
830
+ /** プロジェクト情報を取得する */
831
+ GetProjectsProjectIdOrKeyword: {
832
+ parameters: {
833
+ path: {
834
+ project_id_or_keyword: string;
835
+ };
836
+ };
837
+ responses: {
838
+ /** @description OK */
839
+ 200: {
840
+ content: {
841
+ "application/json": components["schemas"]["GetProjectsProjectIdOrKeywordResponse"];
842
+ };
843
+ };
844
+ };
845
+ };
846
+ /** 配信先の行動セグメントの一覧を返す */
847
+ GetBehaviorSegments: {
848
+ responses: {
849
+ /** @description OK */
850
+ 200: {
851
+ content: {
852
+ "application/json": components["schemas"]["GetBehaviorSegmentsResponse"];
853
+ };
854
+ };
855
+ };
856
+ };
857
+ /** 配信先の属性セグメントの一覧を返す */
858
+ GetProfileSegments: {
859
+ responses: {
860
+ /** @description OK */
861
+ 200: {
862
+ content: {
863
+ "application/json": components["schemas"]["GetProfileSegmentsResponse"];
864
+ };
865
+ };
866
+ };
867
+ };
868
+ /** 配信先設定時の配信対象人数を取得する */
869
+ GetTargetUsersCount: {
870
+ parameters: {
871
+ query?: {
872
+ /** @description 配信対象セグメントの配列 */
873
+ targetFilters?: components["schemas"]["TargetFilterSegments"][];
874
+ };
875
+ };
876
+ responses: {
877
+ /** @description OK */
878
+ 200: {
879
+ content: {
880
+ "application/json": components["schemas"]["GetTargetUsersCountResponse"];
881
+ };
882
+ };
883
+ };
884
+ };
885
+ }
886
+
887
+ export type { $defs, components, external, operations, paths, webhooks };