@readyfor/api-client-pigeon 0.237.0-pr959.ab7545f → 0.237.0

package/dist/schemaType.d.ts

@@ -27,6 +27,50 @@ interface paths {
         /** メルマガのプレビューを取得する */
         get: operations["GetCampaignsCampaignIdPreview"];
     };
+    "/api/campaigns/{id}/preview_delivery_email": {
+        /** メルマガのテスト配信 */
+        post: operations["PostCampaignsCampaignIdPreviewDeliveryEmail"];
+    };
+    "/api/campaigns/{id}/images": {
+        /** 画像をアップロードする */
+        post: {
+            parameters: {
+                path: {
+                    id: number;
+                };
+            };
+            requestBody?: {
+                content: {
+                    "multipart/form-data": components["schemas"]["PostCampaignsCampaignIdImagesReqeustBody"];
+                };
+            };
+            responses: {
+                /** @description Created */
+                201: {
+                    content: {
+                        "application/json": components["schemas"]["Image"];
+                    };
+                };
+            };
+        };
+    };
+    "/api/campaigns/{campaign_id}/images/{id}": {
+        /** アップロードされた画像を削除する */
+        delete: {
+            parameters: {
+                path: {
+                    campaign_id: number;
+                    id: number;
+                };
+            };
+            responses: {
+                /** @description No Content */
+                204: {
+                    content: never;
+                };
+            };
+        };
+    };
     "/api/projects/{project_id_or_keyword}": {
         /** プロジェクト情報を取得する */
         get: operations["GetProjectsProjectIdOrKeyword"];
@@ -63,7 +107,7 @@ interface components {
          *   "campaigns": [
          *     {
          *       "lastEditorName": "lastEditorName",
-         *       "kind": "curationMailMagazine",
+         *       "kind": "personalizedMailMagazine",
          *       "deliveryAt": "2000-01-23T04:56:07.000Z",
          *       "lastEditedAt": "2000-01-23T04:56:07.000Z",
          *       "id": 0,
@@ -72,7 +116,7 @@ interface components {
          *     },
          *     {
          *       "lastEditorName": "lastEditorName",
-         *       "kind": "curationMailMagazine",
+         *       "kind": "personalizedMailMagazine",
          *       "deliveryAt": "2000-01-23T04:56:07.000Z",
          *       "lastEditedAt": "2000-01-23T04:56:07.000Z",
          *       "id": 0,
@@ -86,11 +130,11 @@ interface components {
             campaigns: components["schemas"]["Campaign"][];
             pagination: components["schemas"]["Pagination"];
         };
+        Campaign: components["schemas"]["PersonalizedMailMagazineCampaign"] | components["schemas"]["CurationMailMagazineCampaign"];
         /**
-         * Campaign
          * @example {
          *   "lastEditorName": "lastEditorName",
-         *   "kind": "curationMailMagazine",
+         *   "kind": "personalizedMailMagazine",
          *   "deliveryAt": "2000-01-23T04:56:07.000Z",
          *   "lastEditedAt": "2000-01-23T04:56:07.000Z",
          *   "id": 0,
@@ -98,17 +142,26 @@ interface components {
          *   "status": "draft"
          * }
          */
-        Campaign: {
+        PersonalizedMailMagazineCampaign: components["schemas"]["CampaignBase"] & {
+            /** @enum {string} */
+            kind: "personalizedMailMagazine";
+        };
+        /** Campaign */
+        CampaignBase: {
             id: number;
             title?: string | null;
             status: components["schemas"]["CampaignStatus"];
-            kind: components["schemas"]["CampaignKind"];
             /** Format: date-time */
             deliveryAt: string | null;
             lastEditorName: string;
             /** Format: date-time */
             lastEditedAt: string;
         };
+        CurationMailMagazineCampaign: components["schemas"]["CampaignBase"] & {
+            /** @enum {string} */
+            kind: "curationMailMagazine";
+            bodyKind: components["schemas"]["BodyKind"];
+        };
         /**
          * PostCampaignsResponse
          * @example {
@@ -118,14 +171,24 @@ interface components {
         PostCampaignsResponse: {
             id: number;
         };
+        /** PostCampaignsRequestBody */
+        PostCampaignsRequestBody: components["schemas"]["CreateCampaignKindCurationMailMagazineFormData"] | components["schemas"]["CreateCampaignKindPersonalizedMailMagazineFormData"];
         /**
-         * PostCampaignsRequestBody
+         * CreateCampaignKindCurationMailMagazineFormData
          * @example {
-         *   "kind": "curationMailMagazine"
+         *   "kind": "curationMailMagazine",
+         *   "bodyKind": "template"
          * }
          */
-        PostCampaignsRequestBody: {
-            kind: components["schemas"]["CampaignKind"];
+        CreateCampaignKindCurationMailMagazineFormData: {
+            /** @enum {string} */
+            kind: "curationMailMagazine";
+            bodyKind: components["schemas"]["BodyKind"];
+        };
+        /** CreateCampaignKindPersonalizedMailMagazineFormData */
+        CreateCampaignKindPersonalizedMailMagazineFormData: {
+            /** @enum {string} */
+            kind: "personalizedMailMagazine";
         };
         /**
          * CampaignStatus
@@ -181,6 +244,34 @@ interface components {
         GetCampaignsCampaignIdPreviewResponse: {
             content: string;
         };
+        /**
+         * PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody
+         * @example {
+         *   "emails": [
+         *     "emails",
+         *     "emails"
+         *   ]
+         * }
+         */
+        PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody: {
+            emails: string[];
+        };
+        /** PostCampaignsCampaignIdImagesReqeustBody */
+        PostCampaignsCampaignIdImagesReqeustBody: {
+            /** Format: binary */
+            image: File | Blob;
+        };
+        /**
+         * CurationMailMagazine_Image
+         * @example {
+         *   "id": 0,
+         *   "key": "key"
+         * }
+         */
+        Image: {
+            id: number;
+            key: string;
+        };
         /**
          * GetProjectsProjectIdOrKeywordResponse
          * @example {
@@ -290,6 +381,11 @@ interface components {
             /** @description 最後のページかどうか */
             isLastPage: boolean;
         };
+        /**
+         * CurationMailMagazine_BodyKind
+         * @enum {string}
+         */
+        BodyKind: "template" | "freeFormat";
         /**
          * CampaignDetailWithPersonalizedMailMagazine
          * @example {
@@ -377,15 +473,7 @@ interface components {
             target: components["schemas"]["PersonalizedMailMagazineDetailTarget"] | null;
         };
         /** CurationMailMagazineDetail */
-        CurationMailMagazineDetail: {
-            utmCampaign: string | null;
-            subject: string | null;
-            preHeaderText: string | null;
-            deliveredUsersCount: number | null;
-            targetFilters: components["schemas"]["CurationMailMagazineTargetFilter"][];
-            projects: components["schemas"]["CurationMailMagazineTargetProject"][];
-            banners: components["schemas"]["CurationMailMagazineBanner"][];
-        };
+        CurationMailMagazineDetail: components["schemas"]["CurationMailMagazineDetailBodyKindTemplate"] | components["schemas"]["CurationMailMagazineDetailBodyKindFreeFormat"];
         /** CampaignBaseFormData */
         CampaignBaseFormData: {
             title: string | null;
@@ -410,11 +498,35 @@ interface components {
             targetUsersCount: number;
             excludedUsersCount: number;
         };
-        /** CurationMailMagazineTargetFilter */
-        CurationMailMagazineTargetFilter: {
-            id: number;
-            behaviorSegmentCodes: string[];
-            profileSegmentCodes: string[];
+        /** CurationMailMagazineDetailBodyKindTemplate */
+        CurationMailMagazineDetailBodyKindTemplate: components["schemas"]["CurationMailMagazineDetailBase"] & {
+            /** @enum {string} */
+            bodyKind: "template";
+            projects: components["schemas"]["CurationMailMagazineTargetProject"][];
+            banners: components["schemas"]["CurationMailMagazineBanner"][];
+        };
+        /** CurationMailMagazineDetailBodyKindFreeFormat */
+        CurationMailMagazineDetailBodyKindFreeFormat: components["schemas"]["CurationMailMagazineDetailBase"] & {
+            /** @enum {string} */
+            bodyKind: "freeFormat";
+            htmlBody: string | null;
+            htmlStyle: string | null;
+            images: components["schemas"]["Image"][];
+        };
+        /** PersonalizedMailMagazineFormData */
+        PersonalizedMailMagazineFormData: {
+            utmCampaign: string | null;
+            targetCsv: components["schemas"]["PersonalizedMailMagazineTargetCsvFormData"] | null;
+        };
+        /** CurationMailMagazineFormData */
+        CurationMailMagazineFormData: components["schemas"]["CurationMailMagazineFormDataBodyKindFreeFormat"] | components["schemas"]["CurationMailMagazineFormDataBodyKindTemplate"];
+        /** CurationMailMagazineDetailBase */
+        CurationMailMagazineDetailBase: {
+            utmCampaign: string | null;
+            subject: string | null;
+            preHeaderText: string | null;
+            deliveredUsersCount: number | null;
+            targetFilters: components["schemas"]["CurationMailMagazineTargetFilter"][];
         };
         /** CurationMailMagazineTargetProject */
         CurationMailMagazineTargetProject: {
@@ -435,28 +547,47 @@ interface components {
             imageUrl: string | null;
             url: string | null;
         };
-        /** PersonalizedMailMagazineFormData */
-        PersonalizedMailMagazineFormData: {
-            utmCampaign: string | null;
-            targetCsv: components["schemas"]["PersonalizedMailMagazineTargetCsvFormData"] | null;
+        /** PersonalizedMailMagazineTargetCsvFormData */
+        PersonalizedMailMagazineTargetCsvFormData: components["schemas"]["PersonalizedMailMagazineTargetDeleteCsvFormData"] | components["schemas"]["PersonalizedMailMagazineTargetUploadCsvFormData"];
+        /** CurationMailMagazineBannerFormDataBodyKindFreeFormat */
+        CurationMailMagazineFormDataBodyKindFreeFormat: components["schemas"]["CurationMailMagazineFormDataBase"] & {
+            /** @enum {string} */
+            bodyKind: "freeFormat";
+            htmlBody: string | null;
+            htmlStyle: string | null;
         };
-        /** CurationMailMagazineFormData */
-        CurationMailMagazineFormData: {
-            utmCampaign: string | null;
-            subject: string | null;
-            preHeaderText: string | null;
-            targetFilters: components["schemas"]["CurationMailMagazineTargetFilterFormData"][];
+        /** CurationMailMagazineFormDataBodyKindTemplate */
+        CurationMailMagazineFormDataBodyKindTemplate: components["schemas"]["CurationMailMagazineFormDataBase"] & {
+            /** @enum {string} */
+            bodyKind: "template";
             projects: components["schemas"]["CurationMailMagazineProjectFormData"][];
             banners: components["schemas"]["CurationMailMagazineBannerFormData"][];
         };
-        /** PersonalizedMailMagazineTargetCsvFormData */
-        PersonalizedMailMagazineTargetCsvFormData: components["schemas"]["PersonalizedMailMagazineTargetDeleteCsvFormData"] | components["schemas"]["PersonalizedMailMagazineTargetUploadCsvFormData"];
-        /** CurationMailMagazineTargetFilterFormData */
-        CurationMailMagazineTargetFilterFormData: {
-            id: number | null;
+        /** CurationMailMagazineTargetFilter */
+        CurationMailMagazineTargetFilter: {
+            id: number;
             behaviorSegmentCodes: string[];
             profileSegmentCodes: string[];
         };
+        /** PersonalizedMailMagazineTargetDeleteCsvFormData */
+        PersonalizedMailMagazineTargetDeleteCsvFormData: {
+            /** @enum {string} */
+            kind: "deleteTargetCsv";
+        };
+        /** PersonalizedMailMagazineTargetUploadCsvFormData */
+        PersonalizedMailMagazineTargetUploadCsvFormData: {
+            /** @enum {string} */
+            kind: "uploadCsv";
+            fileName: string;
+            records: components["schemas"]["PersonalizedMailMagazineTargetUploadCsvRecordFormData"][];
+        };
+        /** CurationMailMagazineFormData */
+        CurationMailMagazineFormDataBase: {
+            utmCampaign: string | null;
+            subject: string | null;
+            preHeaderText: string | null;
+            targetFilters: components["schemas"]["CurationMailMagazineTargetFilterFormData"][];
+        };
         /** CurationMailMagazineProjectFormData */
         CurationMailMagazineProjectFormData: {
             id: number | null;
@@ -476,20 +607,6 @@ interface components {
             image: components["schemas"]["ImageFormData"] | null;
             url: string | null;
         };
-        /** PersonalizedMailMagazineTargetDeleteCsvFormData */
-        PersonalizedMailMagazineTargetDeleteCsvFormData: {
-            /** @enum {string} */
-            kind: "deleteTargetCsv";
-        };
-        /** PersonalizedMailMagazineTargetUploadCsvFormData */
-        PersonalizedMailMagazineTargetUploadCsvFormData: {
-            /** @enum {string} */
-            kind: "uploadCsv";
-            fileName: string;
-            records: components["schemas"]["PersonalizedMailMagazineTargetUploadCsvRecordFormData"][];
-        };
-        /** ImageFormData */
-        ImageFormData: components["schemas"]["UploadImageFormData"] | components["schemas"]["DeleteImageFormData"];
         /**
          * PersonalizedMailMagazineTargetUploadCsvRecordFormData
          * @example [
@@ -505,6 +622,14 @@ interface components {
             userId: number;
             projectIds: string;
         };
+        /** CurationMailMagazineTargetFilterFormData */
+        CurationMailMagazineTargetFilterFormData: {
+            id: number | null;
+            behaviorSegmentCodes: string[];
+            profileSegmentCodes: string[];
+        };
+        /** ImageFormData */
+        ImageFormData: components["schemas"]["UploadImageFormData"] | components["schemas"]["DeleteImageFormData"];
         /** UploadImageFormData */
         UploadImageFormData: {
             /** @enum {string} */
@@ -677,6 +802,31 @@ interface operations {
             };
         };
     };
+    /** メルマガのテスト配信 */
+    PostCampaignsCampaignIdPreviewDeliveryEmail: {
+        parameters: {
+            path: {
+                id: number;
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PostCampaignsCampaignIdPreviewDeliveryEmailRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                content: never;
+            };
+            /** @description Bad Request */
+            400: {
+                content: {
+                    "application/json": components["schemas"]["HttpErrorBadRequest"];
+                };
+            };
+        };
+    };
     /** プロジェクト情報を取得する */
     GetProjectsProjectIdOrKeyword: {
         parameters: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readyfor/api-client-pigeon",
-  "version": "0.237.0-pr959.ab7545f",
+  "version": "0.237.0",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -20,24 +20,27 @@
       "require": "./dist/hooks/index.js"
     }
   },
+  "scripts": {
+    "build": "tsup"
+  },
   "devDependencies": {
+    "@readyfor/api-client-base": "0.237.0",
     "@types/qs": "6.9.18",
-    "@types/react": "catalog:react19",
-    "@types/use-sync-external-store": "catalog:use-sync-external-store",
+    "@types/react": "19.1.2",
+    "@types/use-sync-external-store": "1.5.0",
     "qs": "^6.13.1",
     "react": "catalog:react19",
     "swr": "catalog:",
     "use-sync-external-store": "catalog:use-sync-external-store",
-    "zod": "^3.24.1",
-    "@readyfor/api-client-base": "0.237.0-pr959.ab7545f"
+    "zod": "^3.24.1"
   },
   "peerDependencies": {
+    "@readyfor/api-client-base": "*",
     "qs": "^6",
     "react": ">=18.x <=19.x",
     "swr": "^2.3.3",
     "use-sync-external-store": "^1.2.2",
-    "zod": "^3",
-    "@readyfor/api-client-base": "0.237.0-pr959.ab7545f"
+    "zod": "^3"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -62,7 +65,5 @@
       "src"
     ]
   },
-  "scripts": {
-    "build": "tsup"
-  }
-}
+  "gitHead": "c2a9d45b4c90dc10cbd938af2e714c68a4fa707e"
+}