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