@readyfor/api-client-readyfor-api 0.258.0 → 0.259.0-pr1009.6de08a7

package/dist/schemaType.d.mts

@@ -327,6 +327,18 @@ interface paths {
         /** 支援者一覧CSVの生成をキャンセル */
         delete: operations["FundraisingContributorsCsv_DeleteGenerations"];
     };
+    "/api/v2/fundraising/contributors/{id}": {
+        /** 支援者詳細を取得 */
+        get: operations["Fundraising_Contributors_Id"];
+    };
+    "/api/v2/fundraising/contributors/{id}/orders": {
+        /** 支援者の支援一覧を取得 */
+        get: operations["Fundraising_Contributors_Id_Orders"];
+    };
+    "/api/v2/fundraising/contributors/{id}/memo": {
+        /** 支援者のメモを更新 */
+        put: operations["Fundraising_Contributors_Id_Memo"];
+    };
     "/api/v2/fundraising/spot_crowdfunding_projects/owned_public_projects": {
         /** 所有している公開済みクラウドファンディングプロジェクトの一覧 */
         get: operations["Fundraising_OwnedPublicSpotCrowdfundingProjects"];
@@ -335,6 +347,10 @@ interface paths {
         /** 所有している公開済み継続寄付プロジェクトの一覧 */
         get: operations["Fundraising_OwnedPublicSteadyCrowdfundingProjects"];
     };
+    "/api/v2/fundraising/contributors/owned_public_projects": {
+        /** 実行者のプロジェクト一覧を取得 */
+        get: operations["Fundraising_Contributors_OwnedPublicProjects"];
+    };
     "/api/v2/fundraising/spot_crowdfunding_project_orders": {
         /** CFプロジェクトに対する支援申し込み一覧 */
         get: operations["FundraisingSpotCrowdfundingProjectOrders"];
@@ -383,6 +399,14 @@ interface paths {
         /** 支援申込一覧CSVの生成をキャンセル */
         delete: operations["FundraisingOrdersCsv_DeleteGenerations"];
     };
+    "/api/v2/fundraising/steady_crowdfunding/orders_csv": {
+        /** 継続寄付支援申込一覧CSVを取得 */
+        get: operations["Fundraising_SteadyCrowdfunding_OrdersCsv"];
+    };
+    "/api/v2/fundraising/steady_crowdfunding/order_transactions_csv": {
+        /** 継続寄付取引一覧CSVを取得 */
+        get: operations["Fundraising_SteadyCrowdfunding_OrderTransactionsCsv"];
+    };
     "/api/v2/fundraising/projects/{project_id}/payment_summary": {
         /** 支援の支払い状況を返す */
         get: operations["FundraisingProjectsProjectIdPaymentSummary"];
@@ -2491,6 +2515,200 @@ interface components {
         };
         /** Fundraising_DownloadFileGenerationStatus */
         Fundraising_DownloadFileGenerationStatus: components["schemas"]["Fundraising_DownloadFileGenerationStatus_None"] | components["schemas"]["Fundraising_DownloadFileGenerationStatus_Processing"] | components["schemas"]["Fundraising_DownloadFileGenerationStatus_Generated"] | components["schemas"]["Fundraising_DownloadFileGenerationStatus_Failed"];
+        /**
+         * @example {
+         *   "pagination": {
+         *     "nextPage": 2,
+         *     "isLastPage": true,
+         *     "totalPages": 5,
+         *     "prevPage": 3,
+         *     "totalCount": 2,
+         *     "currentPage": 9,
+         *     "isFirstPage": true,
+         *     "currentPerPage": 7
+         *   },
+         *   "orders": [
+         *     {
+         *       "orderedAt": "orderedAt",
+         *       "delivery": {
+         *         "address": "address",
+         *         "phoneNumber": "phoneNumber",
+         *         "receiverName": "receiverName"
+         *       },
+         *       "orderRewards": [
+         *         {
+         *           "quantity": 5,
+         *           "deliveryState": "unnecessary",
+         *           "options": [
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             },
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             }
+         *           ],
+         *           "id": 1,
+         *           "title": "title"
+         *         },
+         *         {
+         *           "quantity": 5,
+         *           "deliveryState": "unnecessary",
+         *           "options": [
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             },
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             }
+         *           ],
+         *           "id": 1,
+         *           "title": "title"
+         *         }
+         *       ],
+         *       "amount": 6,
+         *       "settlementStatus": "settlementStatus",
+         *       "project": {
+         *         "imageUrl": "imageUrl",
+         *         "fundingModel": 6,
+         *         "id": 0,
+         *         "title": "title"
+         *       },
+         *       "id": 0
+         *     },
+         *     {
+         *       "orderedAt": "orderedAt",
+         *       "delivery": {
+         *         "address": "address",
+         *         "phoneNumber": "phoneNumber",
+         *         "receiverName": "receiverName"
+         *       },
+         *       "orderRewards": [
+         *         {
+         *           "quantity": 5,
+         *           "deliveryState": "unnecessary",
+         *           "options": [
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             },
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             }
+         *           ],
+         *           "id": 1,
+         *           "title": "title"
+         *         },
+         *         {
+         *           "quantity": 5,
+         *           "deliveryState": "unnecessary",
+         *           "options": [
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             },
+         *             {
+         *               "name": "name",
+         *               "value": "value"
+         *             }
+         *           ],
+         *           "id": 1,
+         *           "title": "title"
+         *         }
+         *       ],
+         *       "amount": 6,
+         *       "settlementStatus": "settlementStatus",
+         *       "project": {
+         *         "imageUrl": "imageUrl",
+         *         "fundingModel": 6,
+         *         "id": 0,
+         *         "title": "title"
+         *       },
+         *       "id": 0
+         *     }
+         *   ]
+         * }
+         */
+        Fundraising_Contributors_Id_Orders_OrderWithOrderRewardsList: {
+            /** @description 支援一覧 */
+            orders: components["schemas"]["Fundraising_Contributors_Id_Orders_OrderWithOrderRewards"][];
+            pagination: components["schemas"]["OwnerCrm_Pagination"];
+        };
+        /**
+         * @example {
+         *   "orderedAt": "orderedAt",
+         *   "delivery": {
+         *     "address": "address",
+         *     "phoneNumber": "phoneNumber",
+         *     "receiverName": "receiverName"
+         *   },
+         *   "orderRewards": [
+         *     {
+         *       "quantity": 5,
+         *       "deliveryState": "unnecessary",
+         *       "options": [
+         *         {
+         *           "name": "name",
+         *           "value": "value"
+         *         },
+         *         {
+         *           "name": "name",
+         *           "value": "value"
+         *         }
+         *       ],
+         *       "id": 1,
+         *       "title": "title"
+         *     },
+         *     {
+         *       "quantity": 5,
+         *       "deliveryState": "unnecessary",
+         *       "options": [
+         *         {
+         *           "name": "name",
+         *           "value": "value"
+         *         },
+         *         {
+         *           "name": "name",
+         *           "value": "value"
+         *         }
+         *       ],
+         *       "id": 1,
+         *       "title": "title"
+         *     }
+         *   ],
+         *   "amount": 6,
+         *   "settlementStatus": "settlementStatus",
+         *   "project": {
+         *     "imageUrl": "imageUrl",
+         *     "fundingModel": 6,
+         *     "id": 0,
+         *     "title": "title"
+         *   },
+         *   "id": 0
+         * }
+         */
+        Fundraising_Contributors_Id_Orders_OrderWithOrderRewards: {
+            /** @description ID */
+            id: number;
+            /** @description 支援申込日 */
+            orderedAt: string;
+            project: components["schemas"]["OwnerCrm_Project"];
+            /** @description 支援金額 */
+            amount: number;
+            /** @description 決済状況の状態名 */
+            settlementStatus: string;
+            delivery?: components["schemas"]["OwnerCrm_Delivery"];
+            /** @description リターンごとの注文情報 */
+            orderRewards: components["schemas"]["OwnerCrm_OrderReward"][];
+        };
+        Fundraising_Contributors_Id_Memo_Params: {
+            /** @description 支援者のメモ */
+            memo: string;
+        };
         /**
          * GetFundraising_OwnedPublicProjects
          * @example {
@@ -2509,6 +2727,28 @@ interface components {
         GetFundraising_OwnedPublicProjects: {
             projects: components["schemas"]["Fundraising_OwnedProject"][];
         };
+        /**
+         * @example {
+         *   "projects": [
+         *     {
+         *       "imageUrl": "imageUrl",
+         *       "fundingModel": 6,
+         *       "id": 0,
+         *       "title": "title"
+         *     },
+         *     {
+         *       "imageUrl": "imageUrl",
+         *       "fundingModel": 6,
+         *       "id": 0,
+         *       "title": "title"
+         *     }
+         *   ]
+         * }
+         */
+        Fundraising_Contributors_OwnedPublicProjects_Projects: {
+            /** @description 実行者に紐づくプロジェクト一覧 */
+            projects: components["schemas"]["OwnerCrm_Project"][];
+        };
         /**
          * @example {
          *   "ordersCount": {
@@ -5507,6 +5747,81 @@ interface operations {
             };
         };
     };
+    /** 支援者詳細を取得 */
+    Fundraising_Contributors_Id: {
+        parameters: {
+            query?: {
+                /** @description 実行者ID(管理者ユーザのみ使用可) */
+                ownerId?: number;
+            };
+            path: {
+                /** @description 支援者のユーザーID */
+                id: number;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["OwnerCrm_Contributor"];
+                };
+            };
+        };
+    };
+    /** 支援者の支援一覧を取得 */
+    Fundraising_Contributors_Id_Orders: {
+        parameters: {
+            query?: {
+                /** @description ソートする項目（orderedAt, project, amount, settlementStatus） */
+                sortBy?: string;
+                /** @description ソート順（0=昇順, 1=降順） */
+                sortOrder?: number;
+                /** @description ページ */
+                page?: number;
+                /** @description １ページあたりの件数 */
+                perPage?: number;
+                /** @description 実行者ID(管理者ユーザのみ使用可) */
+                ownerId?: number;
+            };
+            path: {
+                /** @description 支援者のユーザーID */
+                id: number;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["Fundraising_Contributors_Id_Orders_OrderWithOrderRewardsList"];
+                };
+            };
+        };
+    };
+    /** 支援者のメモを更新 */
+    Fundraising_Contributors_Id_Memo: {
+        parameters: {
+            header: {
+                "X-CSRF-Token": string;
+            };
+            path: {
+                /** @description 支援者のユーザーID */
+                id: number;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["Fundraising_Contributors_Id_Memo_Params"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["OwnerCrm_UpdateResult"];
+                };
+            };
+        };
+    };
     /** 所有している公開済みクラウドファンディングプロジェクトの一覧 */
     Fundraising_OwnedPublicSpotCrowdfundingProjects: {
         responses: {
@@ -5529,6 +5844,23 @@ interface operations {
             };
         };
     };
+    /** 実行者のプロジェクト一覧を取得 */
+    Fundraising_Contributors_OwnedPublicProjects: {
+        parameters: {
+            query?: {
+                /** @description 実行者ID(管理者ユーザのみ使用可) */
+                ownerId?: number;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["Fundraising_Contributors_OwnedPublicProjects_Projects"];
+                };
+            };
+        };
+    };
     /** CFプロジェクトに対する支援申し込み一覧 */
     FundraisingSpotCrowdfundingProjectOrders: {
         parameters: {
@@ -5812,6 +6144,52 @@ interface operations {
             };
         };
     };
+    /** 継続寄付支援申込一覧CSVを取得 */
+    Fundraising_SteadyCrowdfunding_OrdersCsv: {
+        parameters: {
+            query: {
+                /** @description プロジェクトID */
+                projectId: number;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "text/csv": string;
+                };
+            };
+            /** @description Not Found */
+            404: {
+                content: {
+                    "application/json": components["schemas"]["Common_Error"];
+                };
+            };
+        };
+    };
+    /** 継続寄付取引一覧CSVを取得 */
+    Fundraising_SteadyCrowdfunding_OrderTransactionsCsv: {
+        parameters: {
+            query: {
+                /** @description プロジェクトID */
+                projectId: number;
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                content: {
+                    "text/csv": string;
+                };
+            };
+            /** @description Not Found */
+            404: {
+                content: {
+                    "application/json": components["schemas"]["Common_Error"];
+                };
+            };
+        };
+    };
     /** 支援の支払い状況を返す */
     FundraisingProjectsProjectIdPaymentSummary: {
         parameters: {