@readyfor/api-client-readyfor 0.178.1 → 0.179.0-pr898.587f717

package/dist/schemaType.d.ts

@@ -117,6 +117,13 @@ interface paths {
             };
         };
     };
+    "/api/v1/projects/{project_id}/announcements": {
+        /**
+         * 活動報告一覧
+         * @description project_idを指定して活動報告をページネーションで取得する
+         */
+        get: operations["Project_Announcements_Get"];
+    };
     "/api/v1/tags": {
         /** タグ一覧を取得 */
         get: {
@@ -2933,6 +2940,21 @@ interface components {
         /** @description リワード一覧 */
         GetProjectRewardsForPreview: components["schemas"]["Project_RewardOrNonApprovedReward"][];
         Project_RewardOrNonApprovedReward: components["schemas"]["Project_Reward"] | components["schemas"]["Project_NonApprovedReward"];
+        /**
+         * GetProjectAnnouncements
+         * @description 活動報告一覧。一覧向けのAnnouncementSummaryの配列
+         */
+        GetProjectAnnouncements: components["schemas"]["Project_AnnouncementSummary"][];
+        /**
+         * HttpErrorBadRequest
+         * @description 400 - BadRequest
+         * @example {
+         *   "error": "error"
+         * }
+         */
+        HttpErrorBadRequest: {
+            error?: string;
+        };
         /** GetTags */
         GetTags: components["schemas"]["Tag"][];
         /**
@@ -3176,16 +3198,6 @@ interface components {
             error?: string;
             message?: string;
         };
-        /**
-         * HttpErrorBadRequest
-         * @description 400 - BadRequest
-         * @example {
-         *   "error": "error"
-         * }
-         */
-        HttpErrorBadRequest: {
-            error?: string;
-        };
         /**
          * HttpErrorRecordInvalid
          * @description 422 - RecordInvalid
@@ -8204,6 +8216,38 @@ interface components {
             likeCharity: boolean | null;
             isSystemUsageFeeCase: boolean | null;
         };
+        /**
+         * ProjectAnnouncementSummary
+         * @description 活動報告のサマリー。活動報告のデータを全て含んでいるわけではなく、活動報告一覧の中の一要素としてのスキーマを表している
+         * @example {
+         *   "date": "date",
+         *   "audience": "public",
+         *   "restricted": true,
+         *   "imageUrl": "imageUrl",
+         *   "id": 1,
+         *   "href": "href",
+         *   "title": "title",
+         *   "body": "body"
+         * }
+         */
+        Project_AnnouncementSummary: {
+            /** Format: int64 */
+            id: number;
+            /** @description 活動報告のタイトル */
+            title: string;
+            /** @description 活動報告のURL */
+            href: string;
+            /** @description ISO8601ではなく、ユーザに直接見せる形式の日付文字列 */
+            date: string;
+            /** @description 文字を切り詰められた活動報告の本文 */
+            body: string;
+            /** @description 制限されているコンテンツかどうかをbooleanで表す。ログイン中のユーザの情報を用いて決まる */
+            restricted: boolean;
+            /** @enum {string} */
+            audience: "public" | "activeRecurringContributors";
+            /** @description 活動報告のサムネイル画像のURL */
+            imageUrl: string | null;
+        };
         /**
          * @example {
          *   "name": "name",
@@ -12935,6 +12979,35 @@ interface operations {
             };
         };
     };
+    /**
+     * 活動報告一覧
+     * @description project_idを指定して活動報告をページネーションで取得する
+     */
+    Project_Announcements_Get: {
+        parameters: {
+            query: {
+                /** @description 活動報告のページネーション番号。1から始まる */
+                page: number;
+            };
+            path: {
+                project_id: string;
+            };
+        };
+        responses: {
+            /** @description Successful response. */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GetProjectAnnouncements"];
+                };
+            };
+            /** @description 検索クエリのパラメータが不正な場合に返す */
+            400: {
+                content: {
+                    "application/json": components["schemas"]["HttpErrorBadRequest"];
+                };
+            };
+        };
+    };
     /** メッセージをやりとりしているユーザの一覧 */
     Message_ExchangedUsers: {
         parameters: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readyfor/api-client-readyfor",
-  "version": "0.178.1",
+  "version": "0.179.0-pr898.587f717",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -20,11 +20,7 @@
       "require": "./dist/hooks/index.js"
     }
   },
-  "scripts": {
-    "build": "tsup"
-  },
   "devDependencies": {
-    "@readyfor/api-client-base": "0.178.1",
     "@types/qs": "6.9.18",
     "@types/react": "^18.3.12",
     "@types/use-sync-external-store": "0.0.6",
@@ -32,15 +28,16 @@
     "react": "^18.3.1",
     "swr": "^2.3.3",
     "use-sync-external-store": "^1.2.2",
-    "zod": "^3.24.1"
+    "zod": "^3.24.1",
+    "@readyfor/api-client-base": "0.179.0-pr898.587f717"
   },
   "peerDependencies": {
-    "@readyfor/api-client-base": "*",
     "qs": "^6",
     "react": "^18",
     "swr": "^2.3.3",
     "use-sync-external-store": "1.2.2",
-    "zod": "^3"
+    "zod": "^3",
+    "@readyfor/api-client-base": "0.179.0-pr898.587f717"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -65,5 +62,7 @@
       "src"
     ]
   },
-  "gitHead": "87312f69aff4b6592dec7ed397c24d1c45213678"
-}
+  "scripts": {
+    "build": "tsup"
+  }
+}