@readyfor/api-client-pigeon 0.169.0 → 0.171.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.
- package/dist/chunk-6MUZHLM5.mjs +42 -0
- package/dist/chunk-7XSND6KI.mjs +100 -0
- package/dist/{chunk-2PGNAMJH.mjs → chunk-BHUMNBFZ.mjs} +1 -1
- package/dist/chunk-GBESGCUB.mjs +19 -0
- package/dist/chunk-V6EPKCC7.mjs +27 -0
- package/dist/{chunk-IOFBDHPP.mjs → chunk-ZHGMUSIW.mjs} +1 -1
- package/dist/components.d.mts +450 -2
- package/dist/components.d.ts +450 -2
- package/dist/components.js +66 -4
- package/dist/components.mjs +21 -1
- package/dist/fetch/campaigns.js +45 -4
- package/dist/fetch/campaigns.mjs +2 -2
- package/dist/fetch/campaignsId.d.mts +47 -0
- package/dist/fetch/campaignsId.d.ts +47 -0
- package/dist/fetch/campaignsId.js +119 -0
- package/dist/fetch/campaignsId.mjs +9 -0
- package/dist/fetch/personalizedMailMagazinesId.d.mts +42 -0
- package/dist/fetch/personalizedMailMagazinesId.d.ts +42 -0
- package/dist/fetch/personalizedMailMagazinesId.js +128 -0
- package/dist/fetch/personalizedMailMagazinesId.mjs +9 -0
- package/dist/hooks/index.d.mts +2 -0
- package/dist/hooks/index.d.ts +2 -0
- package/dist/hooks/index.js +95 -8
- package/dist/hooks/index.mjs +14 -4
- package/dist/hooks/useCampaigns.js +55 -8
- package/dist/hooks/useCampaigns.mjs +6 -4
- package/dist/hooks/useCampaignsId.d.mts +38 -0
- package/dist/hooks/useCampaignsId.d.ts +38 -0
- package/dist/hooks/useCampaignsId.js +166 -0
- package/dist/hooks/useCampaignsId.mjs +15 -0
- package/dist/index.d.mts +3 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.js +98 -4
- package/dist/index.mjs +35 -3
- package/dist/schemaType.d.mts +138 -0
- package/dist/schemaType.d.ts +138 -0
- package/package.json +3 -3
- package/dist/chunk-6US3CWHW.mjs +0 -48
- /package/dist/{chunk-WY7GF7TX.mjs → chunk-RD6VKGWI.mjs} +0 -0
package/dist/schemaType.d.mts
CHANGED
|
@@ -9,6 +9,14 @@ interface paths {
|
|
|
9
9
|
/** キャンペーンを作成する */
|
|
10
10
|
post: operations["PostCampaigns"];
|
|
11
11
|
};
|
|
12
|
+
"/api/campaigns/{id}": {
|
|
13
|
+
/** キャンペーン詳細を取得する */
|
|
14
|
+
get: operations["GetCampaignsCampaignId"];
|
|
15
|
+
};
|
|
16
|
+
"/api/personalized_mail_magazines/{id}": {
|
|
17
|
+
/** パーソナライズメールマガジンを更新する */
|
|
18
|
+
patch: operations["PatchPersonalizedMailMagazinesPersonalizedMailMagazineId"];
|
|
19
|
+
};
|
|
12
20
|
}
|
|
13
21
|
type webhooks = Record<string, never>;
|
|
14
22
|
interface components {
|
|
@@ -103,6 +111,93 @@ interface components {
|
|
|
103
111
|
* @enum {string}
|
|
104
112
|
*/
|
|
105
113
|
CampaignKind: "curationMailMagazine" | "personalizedMailMagazine";
|
|
114
|
+
/**
|
|
115
|
+
* @example {
|
|
116
|
+
* "campaignDetail": {
|
|
117
|
+
* "__type": "PersonalizedMailMagazineCampaignDetail",
|
|
118
|
+
* "id": 0,
|
|
119
|
+
* "title": "title",
|
|
120
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
121
|
+
* "utmCampaign": "utmCampaign",
|
|
122
|
+
* "status": "draft",
|
|
123
|
+
* "target": ""
|
|
124
|
+
* }
|
|
125
|
+
* }
|
|
126
|
+
*/
|
|
127
|
+
GetCampaignsCampaignIdResponse: {
|
|
128
|
+
campaignDetail: components["schemas"]["CampaignDetail"];
|
|
129
|
+
};
|
|
130
|
+
CampaignDetail: components["schemas"]["PersonalizedMailMagazineCampaignDetail"] | components["schemas"]["CurationMailMagazineCampaignDetail"];
|
|
131
|
+
/**
|
|
132
|
+
* PersonalizedMailMagazineCampaignDetail
|
|
133
|
+
* @example {
|
|
134
|
+
* "__type": "PersonalizedMailMagazineCampaignDetail",
|
|
135
|
+
* "id": 0,
|
|
136
|
+
* "title": "title",
|
|
137
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
138
|
+
* "utmCampaign": "utmCampaign",
|
|
139
|
+
* "status": "draft",
|
|
140
|
+
* "target": ""
|
|
141
|
+
* }
|
|
142
|
+
*/
|
|
143
|
+
PersonalizedMailMagazineCampaignDetail: {
|
|
144
|
+
/** @enum {string} */
|
|
145
|
+
__type: "PersonalizedMailMagazineCampaignDetail";
|
|
146
|
+
id: number;
|
|
147
|
+
status: components["schemas"]["CampaignStatus"];
|
|
148
|
+
title: string | null;
|
|
149
|
+
utmCampaign: string | null;
|
|
150
|
+
/** Format: date-time */
|
|
151
|
+
scheduledDeliveryAt: string | null;
|
|
152
|
+
target: components["schemas"]["PersonalizedMailMagazineCampaignDetailTarget"] | null;
|
|
153
|
+
};
|
|
154
|
+
/** CurationMailMagazineCampaignDetail */
|
|
155
|
+
CurationMailMagazineCampaignDetail: {
|
|
156
|
+
/** @enum {string} */
|
|
157
|
+
__type: "CurationMailMagazineCampaignDetail";
|
|
158
|
+
id: number;
|
|
159
|
+
};
|
|
160
|
+
PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdResponse: components["schemas"]["PersonalizedMailMagazineCampaignDetail"];
|
|
161
|
+
/**
|
|
162
|
+
* @example {
|
|
163
|
+
* "formData": {
|
|
164
|
+
* "targetCsv": "",
|
|
165
|
+
* "title": "title",
|
|
166
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
167
|
+
* "utmCampaign": "utmCampaign"
|
|
168
|
+
* }
|
|
169
|
+
* }
|
|
170
|
+
*/
|
|
171
|
+
PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdRequestBody: {
|
|
172
|
+
formData: components["schemas"]["PersonalizedMailMagazineFormData"];
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* PersonalizedMailMagazineFormData
|
|
176
|
+
* @example {
|
|
177
|
+
* "targetCsv": "",
|
|
178
|
+
* "title": "title",
|
|
179
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
180
|
+
* "utmCampaign": "utmCampaign"
|
|
181
|
+
* }
|
|
182
|
+
*/
|
|
183
|
+
PersonalizedMailMagazineFormData: {
|
|
184
|
+
title: string | null;
|
|
185
|
+
utmCampaign: string | null;
|
|
186
|
+
/** Format: date-time */
|
|
187
|
+
scheduledDeliveryAt: string | null;
|
|
188
|
+
targetCsv: components["schemas"]["PersonalizedMailMagazineTargetCsv"] | null;
|
|
189
|
+
};
|
|
190
|
+
/** PersonalizedMailMagazineTargetCsv */
|
|
191
|
+
PersonalizedMailMagazineTargetCsv: {
|
|
192
|
+
fileName: string;
|
|
193
|
+
records: components["schemas"]["PersonalizedMailMagazineTargetCsvRecord"][];
|
|
194
|
+
};
|
|
195
|
+
/** PersonalizedMailMagazineTargetCsvRecord */
|
|
196
|
+
PersonalizedMailMagazineTargetCsvRecord: {
|
|
197
|
+
userId: number;
|
|
198
|
+
projectId: number;
|
|
199
|
+
slotNumber: number;
|
|
200
|
+
};
|
|
106
201
|
/**
|
|
107
202
|
* Pagination
|
|
108
203
|
* @description ページネーション
|
|
@@ -135,6 +230,12 @@ interface components {
|
|
|
135
230
|
/** @description 最後のページかどうか */
|
|
136
231
|
isLastPage: boolean;
|
|
137
232
|
};
|
|
233
|
+
/** PersonalizedMailMagazineCampaignDetailTarget */
|
|
234
|
+
PersonalizedMailMagazineCampaignDetailTarget: {
|
|
235
|
+
csvFileName: string;
|
|
236
|
+
targetUsersCount: number;
|
|
237
|
+
excludedUsersCount: number;
|
|
238
|
+
};
|
|
138
239
|
};
|
|
139
240
|
responses: never;
|
|
140
241
|
parameters: never;
|
|
@@ -182,6 +283,43 @@ interface operations {
|
|
|
182
283
|
};
|
|
183
284
|
};
|
|
184
285
|
};
|
|
286
|
+
/** キャンペーン詳細を取得する */
|
|
287
|
+
GetCampaignsCampaignId: {
|
|
288
|
+
parameters: {
|
|
289
|
+
path: {
|
|
290
|
+
id: number;
|
|
291
|
+
};
|
|
292
|
+
};
|
|
293
|
+
responses: {
|
|
294
|
+
/** @description OK */
|
|
295
|
+
200: {
|
|
296
|
+
content: {
|
|
297
|
+
"application/json": components["schemas"]["GetCampaignsCampaignIdResponse"];
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
/** パーソナライズメールマガジンを更新する */
|
|
303
|
+
PatchPersonalizedMailMagazinesPersonalizedMailMagazineId: {
|
|
304
|
+
parameters: {
|
|
305
|
+
path: {
|
|
306
|
+
id: number;
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
requestBody: {
|
|
310
|
+
content: {
|
|
311
|
+
"application/json": components["schemas"]["PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdRequestBody"];
|
|
312
|
+
};
|
|
313
|
+
};
|
|
314
|
+
responses: {
|
|
315
|
+
/** @description OK */
|
|
316
|
+
200: {
|
|
317
|
+
content: {
|
|
318
|
+
"application/json": components["schemas"]["PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdResponse"];
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
};
|
|
322
|
+
};
|
|
185
323
|
}
|
|
186
324
|
|
|
187
325
|
export type { $defs, components, external, operations, paths, webhooks };
|
package/dist/schemaType.d.ts
CHANGED
|
@@ -9,6 +9,14 @@ interface paths {
|
|
|
9
9
|
/** キャンペーンを作成する */
|
|
10
10
|
post: operations["PostCampaigns"];
|
|
11
11
|
};
|
|
12
|
+
"/api/campaigns/{id}": {
|
|
13
|
+
/** キャンペーン詳細を取得する */
|
|
14
|
+
get: operations["GetCampaignsCampaignId"];
|
|
15
|
+
};
|
|
16
|
+
"/api/personalized_mail_magazines/{id}": {
|
|
17
|
+
/** パーソナライズメールマガジンを更新する */
|
|
18
|
+
patch: operations["PatchPersonalizedMailMagazinesPersonalizedMailMagazineId"];
|
|
19
|
+
};
|
|
12
20
|
}
|
|
13
21
|
type webhooks = Record<string, never>;
|
|
14
22
|
interface components {
|
|
@@ -103,6 +111,93 @@ interface components {
|
|
|
103
111
|
* @enum {string}
|
|
104
112
|
*/
|
|
105
113
|
CampaignKind: "curationMailMagazine" | "personalizedMailMagazine";
|
|
114
|
+
/**
|
|
115
|
+
* @example {
|
|
116
|
+
* "campaignDetail": {
|
|
117
|
+
* "__type": "PersonalizedMailMagazineCampaignDetail",
|
|
118
|
+
* "id": 0,
|
|
119
|
+
* "title": "title",
|
|
120
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
121
|
+
* "utmCampaign": "utmCampaign",
|
|
122
|
+
* "status": "draft",
|
|
123
|
+
* "target": ""
|
|
124
|
+
* }
|
|
125
|
+
* }
|
|
126
|
+
*/
|
|
127
|
+
GetCampaignsCampaignIdResponse: {
|
|
128
|
+
campaignDetail: components["schemas"]["CampaignDetail"];
|
|
129
|
+
};
|
|
130
|
+
CampaignDetail: components["schemas"]["PersonalizedMailMagazineCampaignDetail"] | components["schemas"]["CurationMailMagazineCampaignDetail"];
|
|
131
|
+
/**
|
|
132
|
+
* PersonalizedMailMagazineCampaignDetail
|
|
133
|
+
* @example {
|
|
134
|
+
* "__type": "PersonalizedMailMagazineCampaignDetail",
|
|
135
|
+
* "id": 0,
|
|
136
|
+
* "title": "title",
|
|
137
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
138
|
+
* "utmCampaign": "utmCampaign",
|
|
139
|
+
* "status": "draft",
|
|
140
|
+
* "target": ""
|
|
141
|
+
* }
|
|
142
|
+
*/
|
|
143
|
+
PersonalizedMailMagazineCampaignDetail: {
|
|
144
|
+
/** @enum {string} */
|
|
145
|
+
__type: "PersonalizedMailMagazineCampaignDetail";
|
|
146
|
+
id: number;
|
|
147
|
+
status: components["schemas"]["CampaignStatus"];
|
|
148
|
+
title: string | null;
|
|
149
|
+
utmCampaign: string | null;
|
|
150
|
+
/** Format: date-time */
|
|
151
|
+
scheduledDeliveryAt: string | null;
|
|
152
|
+
target: components["schemas"]["PersonalizedMailMagazineCampaignDetailTarget"] | null;
|
|
153
|
+
};
|
|
154
|
+
/** CurationMailMagazineCampaignDetail */
|
|
155
|
+
CurationMailMagazineCampaignDetail: {
|
|
156
|
+
/** @enum {string} */
|
|
157
|
+
__type: "CurationMailMagazineCampaignDetail";
|
|
158
|
+
id: number;
|
|
159
|
+
};
|
|
160
|
+
PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdResponse: components["schemas"]["PersonalizedMailMagazineCampaignDetail"];
|
|
161
|
+
/**
|
|
162
|
+
* @example {
|
|
163
|
+
* "formData": {
|
|
164
|
+
* "targetCsv": "",
|
|
165
|
+
* "title": "title",
|
|
166
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
167
|
+
* "utmCampaign": "utmCampaign"
|
|
168
|
+
* }
|
|
169
|
+
* }
|
|
170
|
+
*/
|
|
171
|
+
PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdRequestBody: {
|
|
172
|
+
formData: components["schemas"]["PersonalizedMailMagazineFormData"];
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* PersonalizedMailMagazineFormData
|
|
176
|
+
* @example {
|
|
177
|
+
* "targetCsv": "",
|
|
178
|
+
* "title": "title",
|
|
179
|
+
* "scheduledDeliveryAt": "2000-01-23T04:56:07.000Z",
|
|
180
|
+
* "utmCampaign": "utmCampaign"
|
|
181
|
+
* }
|
|
182
|
+
*/
|
|
183
|
+
PersonalizedMailMagazineFormData: {
|
|
184
|
+
title: string | null;
|
|
185
|
+
utmCampaign: string | null;
|
|
186
|
+
/** Format: date-time */
|
|
187
|
+
scheduledDeliveryAt: string | null;
|
|
188
|
+
targetCsv: components["schemas"]["PersonalizedMailMagazineTargetCsv"] | null;
|
|
189
|
+
};
|
|
190
|
+
/** PersonalizedMailMagazineTargetCsv */
|
|
191
|
+
PersonalizedMailMagazineTargetCsv: {
|
|
192
|
+
fileName: string;
|
|
193
|
+
records: components["schemas"]["PersonalizedMailMagazineTargetCsvRecord"][];
|
|
194
|
+
};
|
|
195
|
+
/** PersonalizedMailMagazineTargetCsvRecord */
|
|
196
|
+
PersonalizedMailMagazineTargetCsvRecord: {
|
|
197
|
+
userId: number;
|
|
198
|
+
projectId: number;
|
|
199
|
+
slotNumber: number;
|
|
200
|
+
};
|
|
106
201
|
/**
|
|
107
202
|
* Pagination
|
|
108
203
|
* @description ページネーション
|
|
@@ -135,6 +230,12 @@ interface components {
|
|
|
135
230
|
/** @description 最後のページかどうか */
|
|
136
231
|
isLastPage: boolean;
|
|
137
232
|
};
|
|
233
|
+
/** PersonalizedMailMagazineCampaignDetailTarget */
|
|
234
|
+
PersonalizedMailMagazineCampaignDetailTarget: {
|
|
235
|
+
csvFileName: string;
|
|
236
|
+
targetUsersCount: number;
|
|
237
|
+
excludedUsersCount: number;
|
|
238
|
+
};
|
|
138
239
|
};
|
|
139
240
|
responses: never;
|
|
140
241
|
parameters: never;
|
|
@@ -182,6 +283,43 @@ interface operations {
|
|
|
182
283
|
};
|
|
183
284
|
};
|
|
184
285
|
};
|
|
286
|
+
/** キャンペーン詳細を取得する */
|
|
287
|
+
GetCampaignsCampaignId: {
|
|
288
|
+
parameters: {
|
|
289
|
+
path: {
|
|
290
|
+
id: number;
|
|
291
|
+
};
|
|
292
|
+
};
|
|
293
|
+
responses: {
|
|
294
|
+
/** @description OK */
|
|
295
|
+
200: {
|
|
296
|
+
content: {
|
|
297
|
+
"application/json": components["schemas"]["GetCampaignsCampaignIdResponse"];
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
/** パーソナライズメールマガジンを更新する */
|
|
303
|
+
PatchPersonalizedMailMagazinesPersonalizedMailMagazineId: {
|
|
304
|
+
parameters: {
|
|
305
|
+
path: {
|
|
306
|
+
id: number;
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
requestBody: {
|
|
310
|
+
content: {
|
|
311
|
+
"application/json": components["schemas"]["PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdRequestBody"];
|
|
312
|
+
};
|
|
313
|
+
};
|
|
314
|
+
responses: {
|
|
315
|
+
/** @description OK */
|
|
316
|
+
200: {
|
|
317
|
+
content: {
|
|
318
|
+
"application/json": components["schemas"]["PatchPersonalizedMailMagazinesPersonalizedMailMagazineIdResponse"];
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
};
|
|
322
|
+
};
|
|
185
323
|
}
|
|
186
324
|
|
|
187
325
|
export type { $defs, components, external, operations, paths, webhooks };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@readyfor/api-client-pigeon",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.171.0",
|
|
4
4
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"build": "tsup"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
|
-
"@readyfor/api-client-base": "0.
|
|
27
|
+
"@readyfor/api-client-base": "0.171.0",
|
|
28
28
|
"@types/qs": "6.9.17",
|
|
29
29
|
"@types/react": "^18.3.12",
|
|
30
30
|
"@types/use-sync-external-store": "0.0.6",
|
|
@@ -65,5 +65,5 @@
|
|
|
65
65
|
"src"
|
|
66
66
|
]
|
|
67
67
|
},
|
|
68
|
-
"gitHead": "
|
|
68
|
+
"gitHead": "29aeedbba1da9f3c4dc255cc9963431945551fdd"
|
|
69
69
|
}
|
package/dist/chunk-6US3CWHW.mjs
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
// src/components.ts
|
|
2
|
-
import { z } from "zod";
|
|
3
|
-
var CampaignKind = z.union([
|
|
4
|
-
z.literal("curationMailMagazine"),
|
|
5
|
-
z.literal("personalizedMailMagazine")
|
|
6
|
-
]);
|
|
7
|
-
var CampaignStatus = z.union([
|
|
8
|
-
z.literal("draft"),
|
|
9
|
-
z.literal("scheduled"),
|
|
10
|
-
z.literal("delivering"),
|
|
11
|
-
z.literal("delivered"),
|
|
12
|
-
z.literal("deliveryFailed")
|
|
13
|
-
]);
|
|
14
|
-
var Pagination = z.object({
|
|
15
|
-
totalPages: z.number(),
|
|
16
|
-
totalCount: z.number(),
|
|
17
|
-
currentPerPage: z.number(),
|
|
18
|
-
currentPage: z.number(),
|
|
19
|
-
prevPage: z.union([z.number(), z.null()]),
|
|
20
|
-
nextPage: z.union([z.number(), z.null()]),
|
|
21
|
-
isFirstPage: z.boolean(),
|
|
22
|
-
isLastPage: z.boolean()
|
|
23
|
-
});
|
|
24
|
-
var Campaign = z.object({
|
|
25
|
-
id: z.number(),
|
|
26
|
-
title: z.optional(z.union([z.string(), z.null()])),
|
|
27
|
-
status: CampaignStatus,
|
|
28
|
-
kind: CampaignKind,
|
|
29
|
-
deliveryAt: z.union([z.string(), z.null()]),
|
|
30
|
-
lastEditorName: z.string(),
|
|
31
|
-
lastEditedAt: z.string()
|
|
32
|
-
});
|
|
33
|
-
var PostCampaignsRequestBody = z.object({ kind: CampaignKind });
|
|
34
|
-
var PostCampaignsResponse = z.object({ id: z.number() });
|
|
35
|
-
var GetCampaignsResponse = z.object({
|
|
36
|
-
campaigns: z.array(Campaign),
|
|
37
|
-
pagination: Pagination
|
|
38
|
-
});
|
|
39
|
-
|
|
40
|
-
export {
|
|
41
|
-
CampaignKind,
|
|
42
|
-
CampaignStatus,
|
|
43
|
-
Pagination,
|
|
44
|
-
Campaign,
|
|
45
|
-
PostCampaignsRequestBody,
|
|
46
|
-
PostCampaignsResponse,
|
|
47
|
-
GetCampaignsResponse
|
|
48
|
-
};
|
|
File without changes
|