@readyfor/api-client-pigeon 1.25.3-pr1309.03db1a2 → 1.25.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{campaigns-yDw8-cXZ.d.ts → campaigns-DZNsI5kN.d.ts} +1 -1
- package/dist/{campaignsCampaignIdImagesId-C6QRcxjf.d.ts → campaignsCampaignIdImagesId-BzoZ_38r.d.ts} +1 -1
- package/dist/{campaignsId-BO1uXISL.d.ts → campaignsId-qIqhKTZn.d.ts} +1 -1
- package/dist/{campaignsIdDeliveryJob-CFxX58Qs.d.ts → campaignsIdDeliveryJob--2Nogu0k.d.ts} +1 -1
- package/dist/{campaignsIdImages-CzsDK-F5.d.ts → campaignsIdImages-DMSAp5-N.d.ts} +1 -1
- package/dist/{campaignsIdPreview-BNTeNQZi.d.ts → campaignsIdPreview-C10ENt3B.d.ts} +1 -1
- package/dist/{campaignsIdPreviewDeliveryEmail-DDXg4wNV.d.ts → campaignsIdPreviewDeliveryEmail-BxkiUV8X.d.ts} +1 -1
- package/dist/fetch/campaigns.d.ts +1 -1
- package/dist/fetch/campaignsCampaignIdImagesId.d.ts +1 -1
- package/dist/fetch/campaignsId.d.ts +1 -1
- package/dist/fetch/campaignsIdDeliveryJob.d.ts +1 -1
- package/dist/fetch/campaignsIdImages.d.ts +1 -1
- package/dist/fetch/campaignsIdPreview.d.ts +1 -1
- package/dist/fetch/campaignsIdPreviewDeliveryEmail.d.ts +1 -1
- package/dist/fetch/projectsProjectIdOrKeyword.d.ts +1 -1
- package/dist/fetch/segmentsBehaviorSegments.d.ts +1 -1
- package/dist/fetch/segmentsProfileSegments.d.ts +1 -1
- package/dist/fetch/segmentsTargetUsersCount.d.ts +1 -1
- package/dist/hooks/useCampaigns.d.ts +2 -2
- package/dist/hooks/useCampaignsId.d.ts +2 -2
- package/dist/hooks/useCampaignsIdPreview.d.ts +1 -1
- package/dist/hooks/useProjectsProjectIdOrKeyword.d.ts +2 -2
- package/dist/hooks/useSegmentsBehaviorSegments.d.ts +2 -2
- package/dist/hooks/useSegmentsProfileSegments.d.ts +2 -2
- package/dist/hooks/useSegmentsTargetUsersCount.d.ts +1 -1
- package/dist/index.d.ts +13 -13
- package/dist/{projectsProjectIdOrKeyword-C84JJgJX.d.ts → projectsProjectIdOrKeyword-Cayu4ZMd.d.ts} +1 -1
- package/dist/{schemaType-BW_7DtM1.d.ts → schemaType-DcWvaCEH.d.ts} +187 -430
- package/dist/schemaType.d.ts +2 -2
- package/dist/{segmentsBehaviorSegments-DqY-PPyZ.d.ts → segmentsBehaviorSegments-B6cq3XGV.d.ts} +1 -1
- package/dist/{segmentsProfileSegments-Xl2rqUr2.d.ts → segmentsProfileSegments-CMzmpqMd.d.ts} +1 -1
- package/dist/{segmentsTargetUsersCount-CzLau-Nh.d.ts → segmentsTargetUsersCount-CjScWKqF.d.ts} +1 -1
- package/package.json +3 -3
|
@@ -1,102 +1,34 @@
|
|
|
1
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
|
+
*/
|
|
2
6
|
interface paths {
|
|
3
7
|
"/api/campaigns": {
|
|
4
|
-
|
|
5
|
-
query?: never;
|
|
6
|
-
header?: never;
|
|
7
|
-
path?: never;
|
|
8
|
-
cookie?: never;
|
|
9
|
-
}; /** キャンペーン一覧を取得する */
|
|
10
|
-
get: operations["GetCampaigns"];
|
|
11
|
-
put?: never; /** キャンペーンを作成する */
|
|
8
|
+
/** キャンペーン一覧を取得する */get: operations["GetCampaigns"]; /** キャンペーンを作成する */
|
|
12
9
|
post: operations["PostCampaigns"];
|
|
13
|
-
delete?: never;
|
|
14
|
-
options?: never;
|
|
15
|
-
head?: never;
|
|
16
|
-
patch?: never;
|
|
17
|
-
trace?: never;
|
|
18
10
|
};
|
|
19
11
|
"/api/campaigns/{id}": {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
header?: never;
|
|
23
|
-
path?: never;
|
|
24
|
-
cookie?: never;
|
|
25
|
-
}; /** キャンペーン詳細を取得する */
|
|
26
|
-
get: operations["GetCampaignsCampaignId"];
|
|
27
|
-
put?: never;
|
|
28
|
-
post?: never; /** キャンペーンを削除する */
|
|
29
|
-
delete: operations["DeleteCampaignsCampaignId"];
|
|
30
|
-
options?: never;
|
|
31
|
-
head?: never; /** キャンペーンを更新する */
|
|
12
|
+
/** キャンペーン詳細を取得する */get: operations["GetCampaignsCampaignId"]; /** キャンペーンを削除する */
|
|
13
|
+
delete: operations["DeleteCampaignsCampaignId"]; /** キャンペーンを更新する */
|
|
32
14
|
patch: operations["PatchCampaignsCampaignId"];
|
|
33
|
-
trace?: never;
|
|
34
15
|
};
|
|
35
16
|
"/api/campaigns/{id}/delivery_job": {
|
|
36
|
-
|
|
37
|
-
query?: never;
|
|
38
|
-
header?: never;
|
|
39
|
-
path?: never;
|
|
40
|
-
cookie?: never;
|
|
41
|
-
};
|
|
42
|
-
get?: never;
|
|
43
|
-
put?: never; /** キャンペーンの配信予約をする */
|
|
44
|
-
post: operations["PostCampaignsCampaignIdDeliveryJob"]; /** キャンペーンの配信予約を取り消す */
|
|
17
|
+
/** キャンペーンの配信予約をする */post: operations["PostCampaignsCampaignIdDeliveryJob"]; /** キャンペーンの配信予約を取り消す */
|
|
45
18
|
delete: operations["DeleteCampaignsCampaignIdDeliveryJob"];
|
|
46
|
-
options?: never;
|
|
47
|
-
head?: never;
|
|
48
|
-
patch?: never;
|
|
49
|
-
trace?: never;
|
|
50
19
|
};
|
|
51
20
|
"/api/campaigns/{id}/preview": {
|
|
52
|
-
|
|
53
|
-
query?: never;
|
|
54
|
-
header?: never;
|
|
55
|
-
path?: never;
|
|
56
|
-
cookie?: never;
|
|
57
|
-
}; /** メルマガのプレビューを取得する */
|
|
58
|
-
get: operations["GetCampaignsCampaignIdPreview"];
|
|
59
|
-
put?: never;
|
|
60
|
-
post?: never;
|
|
61
|
-
delete?: never;
|
|
62
|
-
options?: never;
|
|
63
|
-
head?: never;
|
|
64
|
-
patch?: never;
|
|
65
|
-
trace?: never;
|
|
21
|
+
/** メルマガのプレビューを取得する */get: operations["GetCampaignsCampaignIdPreview"];
|
|
66
22
|
};
|
|
67
23
|
"/api/campaigns/{id}/preview_delivery_email": {
|
|
68
|
-
|
|
69
|
-
query?: never;
|
|
70
|
-
header?: never;
|
|
71
|
-
path?: never;
|
|
72
|
-
cookie?: never;
|
|
73
|
-
};
|
|
74
|
-
get?: never;
|
|
75
|
-
put?: never; /** メルマガのテスト配信 */
|
|
76
|
-
post: operations["PostCampaignsCampaignIdPreviewDeliveryEmail"];
|
|
77
|
-
delete?: never;
|
|
78
|
-
options?: never;
|
|
79
|
-
head?: never;
|
|
80
|
-
patch?: never;
|
|
81
|
-
trace?: never;
|
|
24
|
+
/** メルマガのテスト配信 */post: operations["PostCampaignsCampaignIdPreviewDeliveryEmail"];
|
|
82
25
|
};
|
|
83
26
|
"/api/campaigns/{id}/images": {
|
|
84
|
-
|
|
85
|
-
query?: never;
|
|
86
|
-
header?: never;
|
|
87
|
-
path?: never;
|
|
88
|
-
cookie?: never;
|
|
89
|
-
};
|
|
90
|
-
get?: never;
|
|
91
|
-
put?: never; /** 画像をアップロードする */
|
|
92
|
-
post: {
|
|
27
|
+
/** 画像をアップロードする */post: {
|
|
93
28
|
parameters: {
|
|
94
|
-
query?: never;
|
|
95
|
-
header?: never;
|
|
96
29
|
path: {
|
|
97
30
|
id: number;
|
|
98
31
|
};
|
|
99
|
-
cookie?: never;
|
|
100
32
|
};
|
|
101
33
|
requestBody?: {
|
|
102
34
|
content: {
|
|
@@ -105,119 +37,39 @@ interface paths {
|
|
|
105
37
|
};
|
|
106
38
|
responses: {
|
|
107
39
|
/** @description Created */201: {
|
|
108
|
-
headers: {
|
|
109
|
-
[name: string]: unknown;
|
|
110
|
-
};
|
|
111
40
|
content: {
|
|
112
41
|
"application/json": components["schemas"]["Image"];
|
|
113
42
|
};
|
|
114
43
|
};
|
|
115
44
|
};
|
|
116
45
|
};
|
|
117
|
-
delete?: never;
|
|
118
|
-
options?: never;
|
|
119
|
-
head?: never;
|
|
120
|
-
patch?: never;
|
|
121
|
-
trace?: never;
|
|
122
46
|
};
|
|
123
47
|
"/api/campaigns/{campaign_id}/images/{id}": {
|
|
124
|
-
|
|
125
|
-
query?: never;
|
|
126
|
-
header?: never;
|
|
127
|
-
path?: never;
|
|
128
|
-
cookie?: never;
|
|
129
|
-
};
|
|
130
|
-
get?: never;
|
|
131
|
-
put?: never;
|
|
132
|
-
post?: never; /** アップロードされた画像を削除する */
|
|
133
|
-
delete: {
|
|
48
|
+
/** アップロードされた画像を削除する */delete: {
|
|
134
49
|
parameters: {
|
|
135
|
-
query?: never;
|
|
136
|
-
header?: never;
|
|
137
50
|
path: {
|
|
138
51
|
campaign_id: number;
|
|
139
52
|
id: number;
|
|
140
53
|
};
|
|
141
|
-
cookie?: never;
|
|
142
54
|
};
|
|
143
|
-
requestBody?: never;
|
|
144
55
|
responses: {
|
|
145
56
|
/** @description No Content */204: {
|
|
146
|
-
|
|
147
|
-
[name: string]: unknown;
|
|
148
|
-
};
|
|
149
|
-
content?: never;
|
|
57
|
+
content: never;
|
|
150
58
|
};
|
|
151
59
|
};
|
|
152
60
|
};
|
|
153
|
-
options?: never;
|
|
154
|
-
head?: never;
|
|
155
|
-
patch?: never;
|
|
156
|
-
trace?: never;
|
|
157
61
|
};
|
|
158
62
|
"/api/projects/{project_id_or_keyword}": {
|
|
159
|
-
|
|
160
|
-
query?: never;
|
|
161
|
-
header?: never;
|
|
162
|
-
path?: never;
|
|
163
|
-
cookie?: never;
|
|
164
|
-
}; /** プロジェクト情報を取得する */
|
|
165
|
-
get: operations["GetProjectsProjectIdOrKeyword"];
|
|
166
|
-
put?: never;
|
|
167
|
-
post?: never;
|
|
168
|
-
delete?: never;
|
|
169
|
-
options?: never;
|
|
170
|
-
head?: never;
|
|
171
|
-
patch?: never;
|
|
172
|
-
trace?: never;
|
|
63
|
+
/** プロジェクト情報を取得する */get: operations["GetProjectsProjectIdOrKeyword"];
|
|
173
64
|
};
|
|
174
65
|
"/api/segments/behavior_segments": {
|
|
175
|
-
|
|
176
|
-
query?: never;
|
|
177
|
-
header?: never;
|
|
178
|
-
path?: never;
|
|
179
|
-
cookie?: never;
|
|
180
|
-
}; /** 配信先の行動セグメントの一覧を返す */
|
|
181
|
-
get: operations["GetBehaviorSegments"];
|
|
182
|
-
put?: never;
|
|
183
|
-
post?: never;
|
|
184
|
-
delete?: never;
|
|
185
|
-
options?: never;
|
|
186
|
-
head?: never;
|
|
187
|
-
patch?: never;
|
|
188
|
-
trace?: never;
|
|
66
|
+
/** 配信先の行動セグメントの一覧を返す */get: operations["GetBehaviorSegments"];
|
|
189
67
|
};
|
|
190
68
|
"/api/segments/profile_segments": {
|
|
191
|
-
|
|
192
|
-
query?: never;
|
|
193
|
-
header?: never;
|
|
194
|
-
path?: never;
|
|
195
|
-
cookie?: never;
|
|
196
|
-
}; /** 配信先の属性セグメントの一覧を返す */
|
|
197
|
-
get: operations["GetProfileSegments"];
|
|
198
|
-
put?: never;
|
|
199
|
-
post?: never;
|
|
200
|
-
delete?: never;
|
|
201
|
-
options?: never;
|
|
202
|
-
head?: never;
|
|
203
|
-
patch?: never;
|
|
204
|
-
trace?: never;
|
|
69
|
+
/** 配信先の属性セグメントの一覧を返す */get: operations["GetProfileSegments"];
|
|
205
70
|
};
|
|
206
71
|
"/api/segments/target_users_count": {
|
|
207
|
-
|
|
208
|
-
query?: never;
|
|
209
|
-
header?: never;
|
|
210
|
-
path?: never;
|
|
211
|
-
cookie?: never;
|
|
212
|
-
}; /** 配信先設定時の配信対象人数を取得する */
|
|
213
|
-
get: operations["GetTargetUsersCount"];
|
|
214
|
-
put?: never;
|
|
215
|
-
post?: never;
|
|
216
|
-
delete?: never;
|
|
217
|
-
options?: never;
|
|
218
|
-
head?: never;
|
|
219
|
-
patch?: never;
|
|
220
|
-
trace?: never;
|
|
72
|
+
/** 配信先設定時の配信対象人数を取得する */get: operations["GetTargetUsersCount"];
|
|
221
73
|
};
|
|
222
74
|
}
|
|
223
75
|
type webhooks = Record<string, never>;
|
|
@@ -226,37 +78,37 @@ interface components {
|
|
|
226
78
|
/**
|
|
227
79
|
* GetCampaignsResponse
|
|
228
80
|
* @example {
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
*
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
* }
|
|
258
|
-
* ]
|
|
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"
|
|
259
109
|
* }
|
|
110
|
+
* ]
|
|
111
|
+
* }
|
|
260
112
|
*/
|
|
261
113
|
GetCampaignsResponse: {
|
|
262
114
|
campaigns: components["schemas"]["Campaign"][];
|
|
@@ -265,14 +117,14 @@ interface components {
|
|
|
265
117
|
Campaign: components["schemas"]["PersonalizedMailMagazineCampaign"] | components["schemas"]["CurationMailMagazineCampaign"];
|
|
266
118
|
/**
|
|
267
119
|
* @example {
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
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
|
+
* }
|
|
276
128
|
*/
|
|
277
129
|
PersonalizedMailMagazineCampaign: components["schemas"]["CampaignBase"] & {
|
|
278
130
|
/** @enum {string} */kind: "personalizedMailMagazine";
|
|
@@ -292,8 +144,8 @@ interface components {
|
|
|
292
144
|
/**
|
|
293
145
|
* PostCampaignsResponse
|
|
294
146
|
* @example {
|
|
295
|
-
*
|
|
296
|
-
*
|
|
147
|
+
* "id": 0
|
|
148
|
+
* }
|
|
297
149
|
*/
|
|
298
150
|
PostCampaignsResponse: {
|
|
299
151
|
id: number;
|
|
@@ -302,9 +154,9 @@ interface components {
|
|
|
302
154
|
/**
|
|
303
155
|
* CreateCampaignKindCurationMailMagazineFormData
|
|
304
156
|
* @example {
|
|
305
|
-
*
|
|
306
|
-
*
|
|
307
|
-
*
|
|
157
|
+
* "kind": "curationMailMagazine",
|
|
158
|
+
* "bodyKind": "template"
|
|
159
|
+
* }
|
|
308
160
|
*/
|
|
309
161
|
CreateCampaignKindCurationMailMagazineFormData: {
|
|
310
162
|
/** @enum {string} */kind: "curationMailMagazine";
|
|
@@ -325,18 +177,18 @@ interface components {
|
|
|
325
177
|
CampaignKind: "curationMailMagazine" | "personalizedMailMagazine";
|
|
326
178
|
/**
|
|
327
179
|
* @example {
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
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
|
+
* }
|
|
340
192
|
*/
|
|
341
193
|
CampaignsCampaignIdResponse: {
|
|
342
194
|
campaignDetail: components["schemas"]["CampaignDetail"];
|
|
@@ -348,11 +200,11 @@ interface components {
|
|
|
348
200
|
/**
|
|
349
201
|
* HttpErrorBadRequest
|
|
350
202
|
* @example {
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
-
*
|
|
203
|
+
* "errors": [
|
|
204
|
+
* "errors",
|
|
205
|
+
* "errors"
|
|
206
|
+
* ]
|
|
207
|
+
* }
|
|
356
208
|
*/
|
|
357
209
|
HttpErrorBadRequest: {
|
|
358
210
|
errors: string[];
|
|
@@ -360,8 +212,8 @@ interface components {
|
|
|
360
212
|
/**
|
|
361
213
|
* GetCampaignsCampaignIdPreviewResponse
|
|
362
214
|
* @example {
|
|
363
|
-
*
|
|
364
|
-
*
|
|
215
|
+
* "content": "content"
|
|
216
|
+
* }
|
|
365
217
|
*/
|
|
366
218
|
GetCampaignsCampaignIdPreviewResponse: {
|
|
367
219
|
content: string;
|
|
@@ -369,11 +221,11 @@ interface components {
|
|
|
369
221
|
/**
|
|
370
222
|
* PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody
|
|
371
223
|
* @example {
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
224
|
+
* "emails": [
|
|
225
|
+
* "emails",
|
|
226
|
+
* "emails"
|
|
227
|
+
* ]
|
|
228
|
+
* }
|
|
377
229
|
*/
|
|
378
230
|
PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody: {
|
|
379
231
|
emails: string[];
|
|
@@ -384,9 +236,9 @@ interface components {
|
|
|
384
236
|
/**
|
|
385
237
|
* CurationMailMagazine_Image
|
|
386
238
|
* @example {
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
*
|
|
239
|
+
* "id": 0,
|
|
240
|
+
* "key": "key"
|
|
241
|
+
* }
|
|
390
242
|
*/
|
|
391
243
|
Image: {
|
|
392
244
|
id: number;
|
|
@@ -395,59 +247,59 @@ interface components {
|
|
|
395
247
|
/**
|
|
396
248
|
* GetProjectsProjectIdOrKeywordResponse
|
|
397
249
|
* @example {
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
250
|
+
* "project": {
|
|
251
|
+
* "abstract": "abstract",
|
|
252
|
+
* "keyword": "keyword",
|
|
253
|
+
* "title": "title",
|
|
254
|
+
* "projectId": 0
|
|
255
|
+
* }
|
|
256
|
+
* }
|
|
405
257
|
*/
|
|
406
258
|
GetProjectsProjectIdOrKeywordResponse: {
|
|
407
259
|
project: components["schemas"]["ReadyforProject"];
|
|
408
260
|
};
|
|
409
261
|
/**
|
|
410
262
|
* @example {
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
* }
|
|
426
|
-
* ]
|
|
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
|
|
427
277
|
* }
|
|
278
|
+
* ]
|
|
279
|
+
* }
|
|
428
280
|
*/
|
|
429
281
|
GetBehaviorSegmentsResponse: {
|
|
430
282
|
behaviorSegments: components["schemas"]["Segment"][];
|
|
431
283
|
};
|
|
432
284
|
/**
|
|
433
285
|
* @example {
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
* }
|
|
449
|
-
* ]
|
|
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
|
|
450
300
|
* }
|
|
301
|
+
* ]
|
|
302
|
+
* }
|
|
451
303
|
*/
|
|
452
304
|
GetProfileSegmentsResponse: {
|
|
453
305
|
profileSegments: components["schemas"]["Segment"][];
|
|
@@ -455,8 +307,8 @@ interface components {
|
|
|
455
307
|
/**
|
|
456
308
|
* GetTargetUsersCountResponse
|
|
457
309
|
* @example {
|
|
458
|
-
*
|
|
459
|
-
*
|
|
310
|
+
* "count": 0
|
|
311
|
+
* }
|
|
460
312
|
*/
|
|
461
313
|
GetTargetUsersCountResponse: {
|
|
462
314
|
/** @description 配信対象人数 */count: number;
|
|
@@ -469,15 +321,15 @@ interface components {
|
|
|
469
321
|
* Pagination
|
|
470
322
|
* @description ページネーション
|
|
471
323
|
* @example {
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
477
|
-
*
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
*
|
|
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
|
+
* }
|
|
481
333
|
*/
|
|
482
334
|
Pagination: {
|
|
483
335
|
/** @description 合計ページ */totalPages: number; /** @description 合計件数 */
|
|
@@ -497,16 +349,16 @@ interface components {
|
|
|
497
349
|
/**
|
|
498
350
|
* CampaignDetailWithPersonalizedMailMagazine
|
|
499
351
|
* @example {
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
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
|
+
* }
|
|
510
362
|
*/
|
|
511
363
|
CampaignDetailWithPersonalizedMailMagazine: components["schemas"]["CampaignDetailBase"] & components["schemas"]["CampaignDetailKindDataPersonalizedMailMagazine"]; /** CampaignDetailWithCurationMailMagazine */
|
|
512
364
|
CampaignDetailWithCurationMailMagazine: components["schemas"]["CampaignDetailBase"] & components["schemas"]["CampaignDetailKindDataCurationMailMagazine"]; /** CampaignFormData */
|
|
@@ -514,11 +366,11 @@ interface components {
|
|
|
514
366
|
/**
|
|
515
367
|
* ReadyforProject
|
|
516
368
|
* @example {
|
|
517
|
-
*
|
|
518
|
-
*
|
|
519
|
-
*
|
|
520
|
-
*
|
|
521
|
-
*
|
|
369
|
+
* "abstract": "abstract",
|
|
370
|
+
* "keyword": "keyword",
|
|
371
|
+
* "title": "title",
|
|
372
|
+
* "projectId": 0
|
|
373
|
+
* }
|
|
522
374
|
*/
|
|
523
375
|
ReadyforProject: {
|
|
524
376
|
projectId: number;
|
|
@@ -529,12 +381,12 @@ interface components {
|
|
|
529
381
|
/**
|
|
530
382
|
* Segment
|
|
531
383
|
* @example {
|
|
532
|
-
*
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
384
|
+
* "code": "code",
|
|
385
|
+
* "displayOrder": 0,
|
|
386
|
+
* "description": "description",
|
|
387
|
+
* "label": "label",
|
|
388
|
+
* "isActive": true
|
|
389
|
+
* }
|
|
538
390
|
*/
|
|
539
391
|
Segment: {
|
|
540
392
|
code: string;
|
|
@@ -562,9 +414,9 @@ interface components {
|
|
|
562
414
|
/**
|
|
563
415
|
* PersonalizedMailMagazineDetail
|
|
564
416
|
* @example {
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
*
|
|
417
|
+
* "utmCampaign": "utmCampaign",
|
|
418
|
+
* "target": ""
|
|
419
|
+
* }
|
|
568
420
|
*/
|
|
569
421
|
PersonalizedMailMagazineDetail: {
|
|
570
422
|
utmCampaign: string | null;
|
|
@@ -678,13 +530,13 @@ interface components {
|
|
|
678
530
|
/**
|
|
679
531
|
* PersonalizedMailMagazineTargetUploadCsvRecordFormData
|
|
680
532
|
* @example [
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
*
|
|
533
|
+
* {
|
|
534
|
+
* "userId": 12345678
|
|
535
|
+
* },
|
|
536
|
+
* {
|
|
537
|
+
* "projectIds": "111111;2222222;33333333"
|
|
538
|
+
* }
|
|
539
|
+
* ]
|
|
688
540
|
*/
|
|
689
541
|
PersonalizedMailMagazineTargetUploadCsvRecordFormData: {
|
|
690
542
|
userId: number;
|
|
@@ -711,7 +563,9 @@ interface components {
|
|
|
711
563
|
pathItems: never;
|
|
712
564
|
}
|
|
713
565
|
type $defs = Record<string, never>;
|
|
566
|
+
type external = Record<string, never>;
|
|
714
567
|
interface operations {
|
|
568
|
+
/** キャンペーン一覧を取得する */
|
|
715
569
|
GetCampaigns: {
|
|
716
570
|
parameters: {
|
|
717
571
|
query?: {
|
|
@@ -722,29 +576,17 @@ interface operations {
|
|
|
722
576
|
deliveryAtTo?: string;
|
|
723
577
|
page?: number;
|
|
724
578
|
};
|
|
725
|
-
header?: never;
|
|
726
|
-
path?: never;
|
|
727
|
-
cookie?: never;
|
|
728
579
|
};
|
|
729
|
-
requestBody?: never;
|
|
730
580
|
responses: {
|
|
731
581
|
/** @description OK */200: {
|
|
732
|
-
headers: {
|
|
733
|
-
[name: string]: unknown;
|
|
734
|
-
};
|
|
735
582
|
content: {
|
|
736
583
|
"application/json": components["schemas"]["GetCampaignsResponse"];
|
|
737
584
|
};
|
|
738
585
|
};
|
|
739
586
|
};
|
|
740
587
|
};
|
|
588
|
+
/** キャンペーンを作成する */
|
|
741
589
|
PostCampaigns: {
|
|
742
|
-
parameters: {
|
|
743
|
-
query?: never;
|
|
744
|
-
header?: never;
|
|
745
|
-
path?: never;
|
|
746
|
-
cookie?: never;
|
|
747
|
-
};
|
|
748
590
|
requestBody: {
|
|
749
591
|
content: {
|
|
750
592
|
"application/json": components["schemas"]["PostCampaignsRequestBody"];
|
|
@@ -752,63 +594,46 @@ interface operations {
|
|
|
752
594
|
};
|
|
753
595
|
responses: {
|
|
754
596
|
/** @description Created */201: {
|
|
755
|
-
headers: {
|
|
756
|
-
[name: string]: unknown;
|
|
757
|
-
};
|
|
758
597
|
content: {
|
|
759
598
|
"application/json": components["schemas"]["PostCampaignsResponse"];
|
|
760
599
|
};
|
|
761
600
|
};
|
|
762
601
|
};
|
|
763
602
|
};
|
|
603
|
+
/** キャンペーン詳細を取得する */
|
|
764
604
|
GetCampaignsCampaignId: {
|
|
765
605
|
parameters: {
|
|
766
|
-
query?: never;
|
|
767
|
-
header?: never;
|
|
768
606
|
path: {
|
|
769
607
|
id: number;
|
|
770
608
|
};
|
|
771
|
-
cookie?: never;
|
|
772
609
|
};
|
|
773
|
-
requestBody?: never;
|
|
774
610
|
responses: {
|
|
775
611
|
/** @description OK */200: {
|
|
776
|
-
headers: {
|
|
777
|
-
[name: string]: unknown;
|
|
778
|
-
};
|
|
779
612
|
content: {
|
|
780
613
|
"application/json": components["schemas"]["CampaignsCampaignIdResponse"];
|
|
781
614
|
};
|
|
782
615
|
};
|
|
783
616
|
};
|
|
784
617
|
};
|
|
618
|
+
/** キャンペーンを削除する */
|
|
785
619
|
DeleteCampaignsCampaignId: {
|
|
786
620
|
parameters: {
|
|
787
|
-
query?: never;
|
|
788
|
-
header?: never;
|
|
789
621
|
path: {
|
|
790
622
|
id: number;
|
|
791
623
|
};
|
|
792
|
-
cookie?: never;
|
|
793
624
|
};
|
|
794
|
-
requestBody?: never;
|
|
795
625
|
responses: {
|
|
796
626
|
/** @description No Content */204: {
|
|
797
|
-
|
|
798
|
-
[name: string]: unknown;
|
|
799
|
-
};
|
|
800
|
-
content?: never;
|
|
627
|
+
content: never;
|
|
801
628
|
};
|
|
802
629
|
};
|
|
803
630
|
};
|
|
631
|
+
/** キャンペーンを更新する */
|
|
804
632
|
PatchCampaignsCampaignId: {
|
|
805
633
|
parameters: {
|
|
806
|
-
query?: never;
|
|
807
|
-
header?: never;
|
|
808
634
|
path: {
|
|
809
635
|
id: number;
|
|
810
636
|
};
|
|
811
|
-
cookie?: never;
|
|
812
637
|
};
|
|
813
638
|
requestBody: {
|
|
814
639
|
content: {
|
|
@@ -817,106 +642,74 @@ interface operations {
|
|
|
817
642
|
};
|
|
818
643
|
responses: {
|
|
819
644
|
/** @description OK */200: {
|
|
820
|
-
headers: {
|
|
821
|
-
[name: string]: unknown;
|
|
822
|
-
};
|
|
823
645
|
content: {
|
|
824
646
|
"application/json": components["schemas"]["CampaignsCampaignIdResponse"];
|
|
825
647
|
};
|
|
826
648
|
}; /** @description Bad Request */
|
|
827
649
|
400: {
|
|
828
|
-
headers: {
|
|
829
|
-
[name: string]: unknown;
|
|
830
|
-
};
|
|
831
650
|
content: {
|
|
832
651
|
"application/json": components["schemas"]["HttpErrorBadRequest"];
|
|
833
652
|
};
|
|
834
653
|
};
|
|
835
654
|
};
|
|
836
655
|
};
|
|
656
|
+
/** キャンペーンの配信予約をする */
|
|
837
657
|
PostCampaignsCampaignIdDeliveryJob: {
|
|
838
658
|
parameters: {
|
|
839
|
-
query?: never;
|
|
840
|
-
header?: never;
|
|
841
659
|
path: {
|
|
842
660
|
id: number;
|
|
843
661
|
};
|
|
844
|
-
cookie?: never;
|
|
845
662
|
};
|
|
846
|
-
requestBody?: never;
|
|
847
663
|
responses: {
|
|
848
664
|
/** @description Created */201: {
|
|
849
|
-
|
|
850
|
-
[name: string]: unknown;
|
|
851
|
-
};
|
|
852
|
-
content?: never;
|
|
665
|
+
content: never;
|
|
853
666
|
}; /** @description Bad Request */
|
|
854
667
|
400: {
|
|
855
|
-
headers: {
|
|
856
|
-
[name: string]: unknown;
|
|
857
|
-
};
|
|
858
668
|
content: {
|
|
859
669
|
"application/json": components["schemas"]["HttpErrorBadRequest"];
|
|
860
670
|
};
|
|
861
671
|
};
|
|
862
672
|
};
|
|
863
673
|
};
|
|
674
|
+
/** キャンペーンの配信予約を取り消す */
|
|
864
675
|
DeleteCampaignsCampaignIdDeliveryJob: {
|
|
865
676
|
parameters: {
|
|
866
|
-
query?: never;
|
|
867
|
-
header?: never;
|
|
868
677
|
path: {
|
|
869
678
|
id: number;
|
|
870
679
|
};
|
|
871
|
-
cookie?: never;
|
|
872
680
|
};
|
|
873
|
-
requestBody?: never;
|
|
874
681
|
responses: {
|
|
875
682
|
/** @description No Content */204: {
|
|
876
|
-
|
|
877
|
-
[name: string]: unknown;
|
|
878
|
-
};
|
|
879
|
-
content?: never;
|
|
683
|
+
content: never;
|
|
880
684
|
}; /** @description Bad Request */
|
|
881
685
|
400: {
|
|
882
|
-
headers: {
|
|
883
|
-
[name: string]: unknown;
|
|
884
|
-
};
|
|
885
686
|
content: {
|
|
886
687
|
"application/json": components["schemas"]["HttpErrorBadRequest"];
|
|
887
688
|
};
|
|
888
689
|
};
|
|
889
690
|
};
|
|
890
691
|
};
|
|
692
|
+
/** メルマガのプレビューを取得する */
|
|
891
693
|
GetCampaignsCampaignIdPreview: {
|
|
892
694
|
parameters: {
|
|
893
|
-
query?: never;
|
|
894
|
-
header?: never;
|
|
895
695
|
path: {
|
|
896
696
|
id: number;
|
|
897
697
|
};
|
|
898
|
-
cookie?: never;
|
|
899
698
|
};
|
|
900
|
-
requestBody?: never;
|
|
901
699
|
responses: {
|
|
902
700
|
/** @description OK */200: {
|
|
903
|
-
headers: {
|
|
904
|
-
[name: string]: unknown;
|
|
905
|
-
};
|
|
906
701
|
content: {
|
|
907
702
|
"application/json": components["schemas"]["GetCampaignsCampaignIdPreviewResponse"];
|
|
908
703
|
};
|
|
909
704
|
};
|
|
910
705
|
};
|
|
911
706
|
};
|
|
707
|
+
/** メルマガのテスト配信 */
|
|
912
708
|
PostCampaignsCampaignIdPreviewDeliveryEmail: {
|
|
913
709
|
parameters: {
|
|
914
|
-
query?: never;
|
|
915
|
-
header?: never;
|
|
916
710
|
path: {
|
|
917
711
|
id: number;
|
|
918
712
|
};
|
|
919
|
-
cookie?: never;
|
|
920
713
|
};
|
|
921
714
|
requestBody: {
|
|
922
715
|
content: {
|
|
@@ -925,95 +718,59 @@ interface operations {
|
|
|
925
718
|
};
|
|
926
719
|
responses: {
|
|
927
720
|
/** @description Created */201: {
|
|
928
|
-
|
|
929
|
-
[name: string]: unknown;
|
|
930
|
-
};
|
|
931
|
-
content?: never;
|
|
721
|
+
content: never;
|
|
932
722
|
}; /** @description Bad Request */
|
|
933
723
|
400: {
|
|
934
|
-
headers: {
|
|
935
|
-
[name: string]: unknown;
|
|
936
|
-
};
|
|
937
724
|
content: {
|
|
938
725
|
"application/json": components["schemas"]["HttpErrorBadRequest"];
|
|
939
726
|
};
|
|
940
727
|
};
|
|
941
728
|
};
|
|
942
729
|
};
|
|
730
|
+
/** プロジェクト情報を取得する */
|
|
943
731
|
GetProjectsProjectIdOrKeyword: {
|
|
944
732
|
parameters: {
|
|
945
|
-
query?: never;
|
|
946
|
-
header?: never;
|
|
947
733
|
path: {
|
|
948
734
|
project_id_or_keyword: string;
|
|
949
735
|
};
|
|
950
|
-
cookie?: never;
|
|
951
736
|
};
|
|
952
|
-
requestBody?: never;
|
|
953
737
|
responses: {
|
|
954
738
|
/** @description OK */200: {
|
|
955
|
-
headers: {
|
|
956
|
-
[name: string]: unknown;
|
|
957
|
-
};
|
|
958
739
|
content: {
|
|
959
740
|
"application/json": components["schemas"]["GetProjectsProjectIdOrKeywordResponse"];
|
|
960
741
|
};
|
|
961
742
|
};
|
|
962
743
|
};
|
|
963
744
|
};
|
|
745
|
+
/** 配信先の行動セグメントの一覧を返す */
|
|
964
746
|
GetBehaviorSegments: {
|
|
965
|
-
parameters: {
|
|
966
|
-
query?: never;
|
|
967
|
-
header?: never;
|
|
968
|
-
path?: never;
|
|
969
|
-
cookie?: never;
|
|
970
|
-
};
|
|
971
|
-
requestBody?: never;
|
|
972
747
|
responses: {
|
|
973
748
|
/** @description OK */200: {
|
|
974
|
-
headers: {
|
|
975
|
-
[name: string]: unknown;
|
|
976
|
-
};
|
|
977
749
|
content: {
|
|
978
750
|
"application/json": components["schemas"]["GetBehaviorSegmentsResponse"];
|
|
979
751
|
};
|
|
980
752
|
};
|
|
981
753
|
};
|
|
982
754
|
};
|
|
755
|
+
/** 配信先の属性セグメントの一覧を返す */
|
|
983
756
|
GetProfileSegments: {
|
|
984
|
-
parameters: {
|
|
985
|
-
query?: never;
|
|
986
|
-
header?: never;
|
|
987
|
-
path?: never;
|
|
988
|
-
cookie?: never;
|
|
989
|
-
};
|
|
990
|
-
requestBody?: never;
|
|
991
757
|
responses: {
|
|
992
758
|
/** @description OK */200: {
|
|
993
|
-
headers: {
|
|
994
|
-
[name: string]: unknown;
|
|
995
|
-
};
|
|
996
759
|
content: {
|
|
997
760
|
"application/json": components["schemas"]["GetProfileSegmentsResponse"];
|
|
998
761
|
};
|
|
999
762
|
};
|
|
1000
763
|
};
|
|
1001
764
|
};
|
|
765
|
+
/** 配信先設定時の配信対象人数を取得する */
|
|
1002
766
|
GetTargetUsersCount: {
|
|
1003
767
|
parameters: {
|
|
1004
768
|
query?: {
|
|
1005
769
|
/** @description 配信対象セグメントの配列 */targetFilters?: components["schemas"]["TargetFilterSegments"][];
|
|
1006
770
|
};
|
|
1007
|
-
header?: never;
|
|
1008
|
-
path?: never;
|
|
1009
|
-
cookie?: never;
|
|
1010
771
|
};
|
|
1011
|
-
requestBody?: never;
|
|
1012
772
|
responses: {
|
|
1013
773
|
/** @description OK */200: {
|
|
1014
|
-
headers: {
|
|
1015
|
-
[name: string]: unknown;
|
|
1016
|
-
};
|
|
1017
774
|
content: {
|
|
1018
775
|
"application/json": components["schemas"]["GetTargetUsersCountResponse"];
|
|
1019
776
|
};
|
|
@@ -1022,4 +779,4 @@ interface operations {
|
|
|
1022
779
|
};
|
|
1023
780
|
}
|
|
1024
781
|
//#endregion
|
|
1025
|
-
export {
|
|
782
|
+
export { paths as a, operations as i, components as n, webhooks as o, external as r, $defs as t };
|