@readyfor/api-client-readyfor 1.112.0 → 1.114.0

package/dist/{schemaType-0Id3ajvu.d.ts → schemaType-DqoNj61o.d.ts}

@@ -4075,6 +4075,47 @@ interface paths {
      */
     get: operations["GetEngagementProjectsProjectKeywordFundraiserPermissions"];
   };
+  "/api/v1/my/engagement/settings/email_notifications": {
+    /**
+     * メール通知設定を取得する
+     * @description ログインユーザー、または subscriptionToken の持ち主のメール通知設定を返す。
+     * 配信停止メールのリンクから未ログインで到達した場合も取得できるよう、
+     * cookie セッションの代わりに subscriptionToken を資格情報として受け付ける。
+     */
+    get: operations["GetEngagementSettingsEmailNotifications"];
+    /**
+     * メール通知設定を更新する
+     * @description メール通知設定を更新する。レスポンスは更新後の設定全体を返すため、
+     * 保存後に取得し直す必要はない。
+     *
+     * 更新の単位は 2 つに分かれる。
+     * 4 つのトグルは全て必須で、送った値がそのまま反映される。
+     * 送らなかったものを現在値のまま残すことはできない。
+     * perFundraisingUserConfigs は差分で、指定した実行者の設定だけが変わる。
+     *
+     * receiveNotification が false のときは、他のフィールドの指定内容によらず
+     * 4 つのトグルと全ての perFundraisingUserConfigs が false になる。
+     */
+    patch: operations["PatchEngagementSettingsEmailNotifications"];
+  };
+  "/api/v1/my/engagement/settings/profile": {
+    /**
+     * 設定画面の初期値を取得する
+     * @description マイページの設定画面が表示するすべての値をフラットなリソースとして返す。
+     * パネルへの割り当ては FE が行うため、画面の構造は契約に持ち込まない。
+     * 全項目が本人限定のためキャッシュしない。
+     */
+    get: operations["GetEngagementSettingsProfile"];
+    /**
+     * プロフィール属性を部分更新する
+     * @description 送ったキーだけを更新する。RFC 7396 の JSON Merge Patch に従い、
+     * 値に null を送ったキーは削除として扱う。1 つもキーを送らない場合も 204 を返す。
+     * sns の各種別は保存時にサーバが種別から既存のリンクを引き当てるため、
+     * リクエストに識別子を含めない。
+     * 更新後のリソースは返さないので、FE は必要なら取得の EP を呼び直す。
+     */
+    patch: operations["PatchEngagementSettingsProfile"];
+  };
   "/api/v1/my/engagement/spot_crowdfunding_orders": {
     /**
      * ログインユーザーの支援履歴一覧を取得する
@@ -11902,6 +11943,344 @@ interface components {
        */
       fundraisingTeamId: number | null;
     };
+    /**
+     * Engagement_Settings_EmailNotifications
+     * @description メール通知設定
+     * @example {
+     *   "receiveFavoriteTagNotification": true,
+     *   "receiveNotification": true,
+     *   "receiveProjectWatchListNotification": true,
+     *   "perFundraisingUserConfigs": [
+     *     {
+     *       "receiveMessageNotification": true,
+     *       "id": 1,
+     *       "receiveAnnouncementNotification": true,
+     *       "user": {
+     *         "imageUrl": "https://img.readyfor.jp/users/3456/thumb.jpg",
+     *         "name": "name",
+     *         "id": 1
+     *       }
+     *     },
+     *     {
+     *       "receiveMessageNotification": true,
+     *       "id": 1,
+     *       "receiveAnnouncementNotification": true,
+     *       "user": {
+     *         "imageUrl": "https://img.readyfor.jp/users/3456/thumb.jpg",
+     *         "name": "name",
+     *         "id": 1
+     *       }
+     *     }
+     *   ],
+     *   "receiveEmailMagazine": true
+     * }
+     */
+    Engagement_Settings_EmailNotifications: {
+      /** @description メール通知全体を受け取るかどうか。false のとき他の設定はすべて false になる */
+      receiveNotification: boolean;
+      /** @description メールマガジンを受け取るかどうか */
+      receiveEmailMagazine: boolean;
+      /** @description お気に入りのタグの通知を受け取るかどうか */
+      receiveFavoriteTagNotification: boolean;
+      /** @description 気になるプロジェクトの通知を受け取るかどうか */
+      receiveProjectWatchListNotification: boolean;
+      /** @description 支援先の実行者ごとの通知設定。支援先が無い場合は空配列 */
+      perFundraisingUserConfigs: components["schemas"]["Engagement_Settings_EmailNotifications_PerFundraisingUserConfig"][];
+    };
+    /**
+     * Engagement_Settings_EmailNotifications_PerFundraisingUserConfig
+     * @description 実行者 1 人ぶんの通知設定
+     * @example {
+     *   "receiveMessageNotification": true,
+     *   "id": 1,
+     *   "receiveAnnouncementNotification": true,
+     *   "user": {
+     *     "imageUrl": "https://img.readyfor.jp/users/3456/thumb.jpg",
+     *     "name": "name",
+     *     "id": 1
+     *   }
+     * }
+     */
+    Engagement_Settings_EmailNotifications_PerFundraisingUserConfig: {
+      /**
+       * Format: int64
+       * @description 設定レコードの ID。更新時のキーに使う
+       */
+      id: number;
+      /** @description 活動報告の通知を受け取るかどうか */
+      receiveAnnouncementNotification: boolean;
+      /** @description メッセージの通知を受け取るかどうか */
+      receiveMessageNotification: boolean;
+      user: components["schemas"]["Engagement_Settings_EmailNotifications_FundraisingUser"];
+    };
+    /**
+     * Engagement_Settings_EmailNotifications_FundraisingUser
+     * @description 支援先の実行者
+     * @example {
+     *   "imageUrl": "https://img.readyfor.jp/users/3456/thumb.jpg",
+     *   "name": "name",
+     *   "id": 1
+     * }
+     */
+    Engagement_Settings_EmailNotifications_FundraisingUser: {
+      /** Format: int64 */
+      id: number;
+      name: string;
+      /**
+       * @description プロフィール画像の URL。画像が未設定または削除済みの場合は
+       * /assets/ から始まる既定画像のパスを返すため、絶対 URL とパスが混在する
+       *
+       * @example https://img.readyfor.jp/users/3456/thumb.jpg
+       */
+      imageUrl: string;
+    };
+    /**
+     * Engagement_Settings_EmailNotificationsForbidden
+     * @description 403 - Forbidden
+     * @example {
+     *   "reason": "token_user_mismatch",
+     *   "error": "error"
+     * }
+     */
+    Engagement_Settings_EmailNotificationsForbidden: {
+      error: string;
+      /**
+       * @description 403 レスポンスの理由コード
+       * - token_user_mismatch: ログイン中のユーザーと subscriptionToken の持ち主が別人
+       * @enum {string}
+       */
+      reason: "token_user_mismatch";
+    };
+    /**
+     * PatchEngagementSettingsEmailNotificationsRequest
+     * @description 4 つのトグルは常に現在の値を全て送る。
+     * 送らなかったものを現在値のまま残す部分更新はできない。
+     * perFundraisingUserConfigs だけは差分で、指定した実行者の設定だけが変わる。
+     *
+     * @example {
+     *   "receiveFavoriteTagNotification": true,
+     *   "receiveNotification": true,
+     *   "subscriptionToken": "subscriptionToken",
+     *   "receiveProjectWatchListNotification": true,
+     *   "perFundraisingUserConfigs": [
+     *     {
+     *       "receiveMessageNotification": true,
+     *       "id": 1,
+     *       "receiveAnnouncementNotification": true
+     *     },
+     *     {
+     *       "receiveMessageNotification": true,
+     *       "id": 1,
+     *       "receiveAnnouncementNotification": true
+     *     }
+     *   ],
+     *   "receiveEmailMagazine": true
+     * }
+     */
+    PatchEngagementSettingsEmailNotificationsRequest: {
+      /**
+       * @description 未ログイン時の代替の資格情報。配信停止メールのリンクに含まれる。
+       * 未ログインで指定した場合は token の持ち主の設定を更新する。
+       * ログイン中に指定した場合は token の持ち主と一致するときだけ通り、
+       * 別人の token なら 403 になり更新は行われない。
+       * 持ち主が見つからない token（無効・期限切れ）は無視し、
+       * cookie セッションで認証する。セッションも無ければ 401。
+       */
+      subscriptionToken?: string;
+      /**
+       * @description メール通知全体を受け取るかどうか。
+       * false のときは他のフィールドの指定内容によらず、
+       * 4 つのトグルと全ての perFundraisingUserConfigs が false になる。
+       */
+      receiveNotification: boolean;
+      receiveEmailMagazine: boolean;
+      receiveFavoriteTagNotification: boolean;
+      receiveProjectWatchListNotification: boolean;
+      /** @description 更新する実行者ごとの設定。指定しなかった実行者の設定は変わらない */
+      perFundraisingUserConfigs?: components["schemas"]["PatchEngagementSettingsEmailNotificationsRequest_PerFundraisingUserConfig"][];
+    };
+    /**
+     * PatchEngagementSettingsEmailNotificationsRequest_PerFundraisingUserConfig
+     * @example {
+     *   "receiveMessageNotification": true,
+     *   "id": 1,
+     *   "receiveAnnouncementNotification": true
+     * }
+     */
+    PatchEngagementSettingsEmailNotificationsRequest_PerFundraisingUserConfig: {
+      /**
+       * Format: int64
+       * @description 取得時に返した設定レコードの ID
+       */
+      id: number;
+      receiveAnnouncementNotification?: boolean;
+      receiveMessageNotification?: boolean;
+    };
+    /**
+     * GetEngagementSettingsProfile
+     * @example {
+     *   "creditCards": [
+     *     {
+     *       "expMonth": 7,
+     *       "expYear": 1,
+     *       "cardSeq": 0,
+     *       "brand": "visa",
+     *       "maskedCardNumber": "maskedCardNumber"
+     *     },
+     *     {
+     *       "expMonth": 7,
+     *       "expYear": 1,
+     *       "cardSeq": 0,
+     *       "brand": "visa",
+     *       "maskedCardNumber": "maskedCardNumber"
+     *     }
+     *   ],
+     *   "profile": "profile",
+     *   "name": "name",
+     *   "twoFactorAuthentication": {
+     *     "shouldNotify": true,
+     *     "isEnabled": true,
+     *     "requiredTeamOwnerNames": [
+     *       "requiredTeamOwnerNames",
+     *       "requiredTeamOwnerNames"
+     *     ],
+     *     "isRequiredForExecutor": true
+     *   },
+     *   "hasCustomAvatar": true,
+     *   "sns": {
+     *     "website": {
+     *       "displayName": "displayName",
+     *       "url": "url"
+     *     },
+     *     "facebook": "facebook",
+     *     "x": "x",
+     *     "instagram": "instagram"
+     *   },
+     *   "unconfirmedEmail": "unconfirmedEmail",
+     *   "isPasswordUser": true,
+     *   "isDiscloseSupporting": true,
+     *   "canDeactivateSocialAccount": true,
+     *   "email": "email",
+     *   "socialAccounts": {
+     *     "line": {
+     *       "isAuthorized": true
+     *     },
+     *     "facebook": {
+     *       "isAuthorized": true
+     *     }
+     *   }
+     * }
+     */
+    GetEngagementSettingsProfile: {
+      name: string;
+      email: string;
+      /**
+       * @description 変更後のまだ確認が済んでいないメールアドレス。
+       * 変更手続き中でなければ null
+       */
+      unconfirmedEmail: string | null;
+      /**
+       * @description パスワードを設定しているかどうか。
+       * パスワードパネルの文言と、外部アカウント連携パネルの文言の出し分けに使う。
+       * 解除できるかどうかの判定には canDeactivateSocialAccount を使う
+       */
+      isPasswordUser: boolean;
+      /** @description 自己紹介 */
+      profile: string | null;
+      /**
+       * @description 既定以外のプロフィール画像を持つかどうか。「画像を削除」ボタンの出し分けに使う。
+       * 画像の URL は設定画面では表示しないため返さない
+       */
+      hasCustomAvatar: boolean;
+      sns: components["schemas"]["Engagement_Settings_Sns"];
+      /** @description 支援情報を公開するかどうか */
+      isDiscloseSupporting: boolean;
+      /** @description 登録済みのクレジットカード。1 件も無ければ空配列 */
+      creditCards: components["schemas"]["Engagement_Settings_CreditCard"][];
+      socialAccounts: components["schemas"]["Engagement_Settings_SocialAccounts"];
+      /**
+       * @description 外部アカウント連携を解除できるかどうか。解除ボタンの出し分けに使う。
+       * パスワードを設定しているか、連携が 2 件以上あれば解除できる
+       */
+      canDeactivateSocialAccount: boolean;
+      twoFactorAuthentication: components["schemas"]["Engagement_Settings_TwoFactorAuthentication"];
+    };
+    /**
+     * PatchEngagementSettingsProfileUnprocessableEntity
+     * @example {
+     *   "errors": {
+     *     "profile": [
+     *       "profile",
+     *       "profile"
+     *     ],
+     *     "name": [
+     *       "name",
+     *       "name"
+     *     ],
+     *     "sns": {
+     *       "website": {
+     *         "displayName": [
+     *           "displayName",
+     *           "displayName"
+     *         ],
+     *         "url": [
+     *           "url",
+     *           "url"
+     *         ]
+     *       },
+     *       "facebook": [
+     *         "facebook",
+     *         "facebook"
+     *       ],
+     *       "x": [
+     *         "x",
+     *         "x"
+     *       ],
+     *       "instagram": [
+     *         "instagram",
+     *         "instagram"
+     *       ]
+     *     },
+     *     "isDiscloseSupporting": [
+     *       "isDiscloseSupporting",
+     *       "isDiscloseSupporting"
+     *     ],
+     *     "base": [
+     *       "base",
+     *       "base"
+     *     ]
+     *   }
+     * }
+     */
+    PatchEngagementSettingsProfileUnprocessableEntity: {
+      errors?: components["schemas"]["PatchEngagementSettingsProfileUnprocessableEntityErrors"];
+    };
+    /**
+     * PatchEngagementSettingsProfileRequest
+     * @description 更新したいキーだけを送る。送らなかったキーは変更しない
+     *
+     * @example {
+     *   "profile": "profile",
+     *   "name": "name",
+     *   "sns": {
+     *     "website": {
+     *       "displayName": "displayName",
+     *       "url": "url"
+     *     },
+     *     "facebook": "facebook",
+     *     "x": "x",
+     *     "instagram": "instagram"
+     *   },
+     *   "isDiscloseSupporting": true
+     * }
+     */
+    PatchEngagementSettingsProfileRequest: {
+      name?: string;
+      /** @description 自己紹介。null を送ると空にする */
+      profile?: string | null;
+      isDiscloseSupporting?: boolean;
+      sns?: components["schemas"]["PatchEngagementSettingsProfileRequestSns"];
+    };
     /**
      * GetEngagementSpotCrowdfundingOrders
      * @example {
@@ -15779,6 +16158,108 @@ interface components {
       /** @enum {string} */
       __type: "sent";
     };
+    /**
+     * Engagement_Settings_Sns
+     * @description プロフィールページに表示する SNS とその他リンク。
+     * ログイン連携の状態（socialAccounts）とは別の概念で、
+     * どちらにも facebook キーがあるため取り違えに注意する。
+     * リンクが 1 件も無い種別もキー自体は返し、値を null にする
+     *
+     * @example {
+     *   "website": {
+     *     "displayName": "displayName",
+     *     "url": "url"
+     *   },
+     *   "facebook": "facebook",
+     *   "x": "x",
+     *   "instagram": "instagram"
+     * }
+     */
+    Engagement_Settings_Sns: {
+      /**
+       * @description X のアカウント名。プレフィックスを除いた保存値が入る（例 READYFOR_cf）。
+       * 完全な URL は FE がプレフィックスを付けて組み立てる
+       */
+      x: string | null;
+      /** @description Facebook のアカウント名。プレフィックスを除いた保存値 */
+      facebook: string | null;
+      /** @description Instagram のアカウント名。プレフィックスを除いた保存値 */
+      instagram: string | null;
+      website: components["schemas"]["Engagement_Settings_Sns_Website"];
+    };
+    /**
+     * Engagement_Settings_CreditCard
+     * @description 登録済みのクレジットカード 1 件
+     * @example {
+     *   "expMonth": 7,
+     *   "expYear": 1,
+     *   "cardSeq": 0,
+     *   "brand": "visa",
+     *   "maskedCardNumber": "maskedCardNumber"
+     * }
+     */
+    Engagement_Settings_CreditCard: {
+      /** @description 決済代行側でカードを指すための連番 */
+      cardSeq: number;
+      /**
+       * @description カードブランド。ブランドの画像は FE が持つ。
+       * 移植元はブランド画像の URL も返すが、値が Rails のアセットの相対パスで
+       * engagement から解決できないため契約には含めない
+       *
+       * @enum {string}
+       */
+      brand: "visa" | "master_card" | "jcb" | "american_express" | "diners_club";
+      /** @description マスク済みのカード番号。桁区切りはブランドによって変わる */
+      maskedCardNumber: string;
+      /** @description 有効期限の月 */
+      expMonth: number;
+      /** @description 有効期限の年（西暦 4 桁） */
+      expYear: number;
+    };
+    /**
+     * Engagement_Settings_SocialAccounts
+     * @description 外部アカウント連携の状態。この事業者でログインできるかどうかを表す。
+     * プロフィールに表示する SNS リンク（sns）とは別の概念
+     *
+     * @example {
+     *   "line": {
+     *     "isAuthorized": true
+     *   },
+     *   "facebook": {
+     *     "isAuthorized": true
+     *   }
+     * }
+     */
+    Engagement_Settings_SocialAccounts: {
+      line: components["schemas"]["Engagement_Settings_SocialAccount"];
+      facebook: components["schemas"]["Engagement_Settings_SocialAccount"];
+    };
+    /**
+     * Engagement_Settings_TwoFactorAuthentication
+     * @description 2 要素認証パネルの表示状態。
+     * 2 要素認証の EP は作成・更新・削除しか持たず取得の口が無いため、
+     * 設定画面の初期値を返す EP がこの状態も合わせて返す
+     *
+     * @example {
+     *   "shouldNotify": true,
+     *   "isEnabled": true,
+     *   "requiredTeamOwnerNames": [
+     *     "requiredTeamOwnerNames",
+     *     "requiredTeamOwnerNames"
+     *   ],
+     *   "isRequiredForExecutor": true
+     * }
+     */
+    Engagement_Settings_TwoFactorAuthentication: {
+      /** @description 2 要素認証が有効かどうか */
+      isEnabled: boolean;
+      /** @description 設定を促す通知を出すかどうか */
+      shouldNotify: boolean;
+      /** @description 実行者として 2 要素認証が必須になるプロジェクトを持っているかどうか */
+      isRequiredForExecutor: boolean;
+      /** @description 2 要素認証を必須にしている参加チームのオーナー名。該当が無ければ空配列 */
+      requiredTeamOwnerNames: string[];
+    };
     /**
      * ProjectState
      * @example {
@@ -16450,6 +16931,17 @@ interface components {
        */
       sentAt: string;
     };
+    /**
+     * Engagement_Settings_SocialAccount
+     * @description 外部アカウント 1 事業者ぶんの連携状態
+     * @example {
+     *   "isAuthorized": true
+     * }
+     */
+    Engagement_Settings_SocialAccount: {
+      /** @description 連携済みかどうか */
+      isAuthorized: boolean;
+    };
     /**
      * RewardExSelection
      * @description 選択型リターンオプションの選択肢項目
@@ -17824,6 +18316,153 @@ interface components {
        */
       id: number;
     } | null;
+    /**
+     * PatchEngagementSettingsProfileUnprocessableEntityErrorsSnsWebsite
+     * @example {
+     *   "displayName": [
+     *     "displayName",
+     *     "displayName"
+     *   ],
+     *   "url": [
+     *     "url",
+     *     "url"
+     *   ]
+     * }
+     */
+    PatchEngagementSettingsProfileUnprocessableEntityErrorsSnsWebsite: {
+      url?: string[];
+      displayName?: string[];
+    };
+    /**
+     * PatchEngagementSettingsProfileUnprocessableEntityErrorsSns
+     * @example {
+     *   "website": {
+     *     "displayName": [
+     *       "displayName",
+     *       "displayName"
+     *     ],
+     *     "url": [
+     *       "url",
+     *       "url"
+     *     ]
+     *   },
+     *   "facebook": [
+     *     "facebook",
+     *     "facebook"
+     *   ],
+     *   "x": [
+     *     "x",
+     *     "x"
+     *   ],
+     *   "instagram": [
+     *     "instagram",
+     *     "instagram"
+     *   ]
+     * }
+     */
+    PatchEngagementSettingsProfileUnprocessableEntityErrorsSns: {
+      x?: string[];
+      facebook?: string[];
+      instagram?: string[];
+      website?: components["schemas"]["PatchEngagementSettingsProfileUnprocessableEntityErrorsSnsWebsite"];
+    };
+    /**
+     * PatchEngagementSettingsProfileUnprocessableEntityErrors
+     * @description フィールドごとの検証エラー。キーはリクエストのキーに揃える。
+     * base は特定のフィールドに紐づかないエラー
+     *
+     * @example {
+     *   "profile": [
+     *     "profile",
+     *     "profile"
+     *   ],
+     *   "name": [
+     *     "name",
+     *     "name"
+     *   ],
+     *   "sns": {
+     *     "website": {
+     *       "displayName": [
+     *         "displayName",
+     *         "displayName"
+     *       ],
+     *       "url": [
+     *         "url",
+     *         "url"
+     *       ]
+     *     },
+     *     "facebook": [
+     *       "facebook",
+     *       "facebook"
+     *     ],
+     *     "x": [
+     *       "x",
+     *       "x"
+     *     ],
+     *     "instagram": [
+     *       "instagram",
+     *       "instagram"
+     *     ]
+     *   },
+     *   "isDiscloseSupporting": [
+     *     "isDiscloseSupporting",
+     *     "isDiscloseSupporting"
+     *   ],
+     *   "base": [
+     *     "base",
+     *     "base"
+     *   ]
+     * }
+     */
+    PatchEngagementSettingsProfileUnprocessableEntityErrors: {
+      name?: string[];
+      profile?: string[];
+      isDiscloseSupporting?: string[];
+      sns?: components["schemas"]["PatchEngagementSettingsProfileUnprocessableEntityErrorsSns"];
+      /**
+       * @description 同じ種別のリンクの並行編集が解消できなかった場合など、
+       * 特定のフィールドに紐づかないエラー
+       */
+      base?: string[];
+    };
+    /**
+     * PatchEngagementSettingsProfileRequestSnsWebsite
+     * @description その他リンク。4 つの種別のうちこれだけが表示名を持つ
+     * @example {
+     *   "displayName": "displayName",
+     *   "url": "url"
+     * }
+     */
+    PatchEngagementSettingsProfileRequestSnsWebsite: {
+      /** @description プレフィックスを除いた値を送る */
+      url?: string;
+      displayName?: string;
+    } | null;
+    /**
+     * PatchEngagementSettingsProfileRequestSns
+     * @description プロフィールページに表示する SNS とその他リンク。
+     * 種別ごとに null を送るとそのリンクを削除する
+     *
+     * @example {
+     *   "website": {
+     *     "displayName": "displayName",
+     *     "url": "url"
+     *   },
+     *   "facebook": "facebook",
+     *   "x": "x",
+     *   "instagram": "instagram"
+     * }
+     */
+    PatchEngagementSettingsProfileRequestSns: {
+      /**
+       * @description X のアカウント名。プレフィックスを除いた値を送る。
+       * 完全な URL を送った場合もサーバ側で除去される
+       */
+      x?: string | null;
+      facebook?: string | null;
+      instagram?: string | null;
+      website?: components["schemas"]["PatchEngagementSettingsProfileRequestSnsWebsite"];
+    };
     /**
      * Engagement_SpotCrowdfundingOrder_UserDelivery
      * @description お届け先。登録されていない場合は null
@@ -18553,6 +19192,22 @@ interface components {
        */
       repliedAt: string | null;
     } | null;
+    /**
+     * Engagement_Settings_Sns_Website
+     * @description その他リンク。4 つの種別のうちこれだけが表示名を持つためオブジェクトになる。
+     * 未設定でもキーは返り、url と displayName が null になる
+     *
+     * @example {
+     *   "displayName": "displayName",
+     *   "url": "url"
+     * }
+     */
+    Engagement_Settings_Sns_Website: {
+      /** @description プレフィックス（https://）を除いた保存値 */
+      url: string | null;
+      /** @description リンクの表示名 */
+      displayName: string | null;
+    };
     /**
      * @description プロジェクト実行責任者の表示情報
      * @example {
@@ -22043,6 +22698,210 @@ interface operations {
       };
     };
   };
+  /**
+   * メール通知設定を取得する
+   * @description ログインユーザー、または subscriptionToken の持ち主のメール通知設定を返す。
+   * 配信停止メールのリンクから未ログインで到達した場合も取得できるよう、
+   * cookie セッションの代わりに subscriptionToken を資格情報として受け付ける。
+   */
+  GetEngagementSettingsEmailNotifications: {
+    parameters: {
+      query?: {
+        /**
+         * @description 未ログイン時の代替の資格情報。配信停止メールのリンクに含まれる。
+         * 未ログインで指定した場合は token の持ち主の設定を返す。
+         * ログイン中に指定した場合は token の持ち主と一致するときだけ通り、
+         * 別人の token なら 403 になる。
+         * 持ち主が見つからない token（無効・期限切れ）は無視し、
+         * cookie セッションで認証する。セッションも無ければ 401。
+         */
+        subscriptionToken?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Engagement_Settings_EmailNotifications"];
+        };
+      };
+      /**
+       * @description cookie セッションが無く、かつ subscriptionToken でも持ち主を特定できない場合に返す。
+       * 無効・期限切れの token を指定した場合を含む。
+       */
+      401: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorUnauthenticated"];
+        };
+      };
+      /**
+       * @description ログイン中のユーザーと subscriptionToken の持ち主が別人の場合に返す。
+       * reason は token_user_mismatch。
+       */
+      403: {
+        content: {
+          "application/json": components["schemas"]["Engagement_Settings_EmailNotificationsForbidden"];
+        };
+      };
+      /** @description 対象ユーザーのメール通知設定のレコードが存在しない場合に返す */
+      404: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorNotFound"];
+        };
+      };
+      /** @description サーバー内部で何らかのエラーが発生した場合に返す */
+      500: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorInternalServerError"];
+        };
+      };
+    };
+  };
+  /**
+   * メール通知設定を更新する
+   * @description メール通知設定を更新する。レスポンスは更新後の設定全体を返すため、
+   * 保存後に取得し直す必要はない。
+   *
+   * 更新の単位は 2 つに分かれる。
+   * 4 つのトグルは全て必須で、送った値がそのまま反映される。
+   * 送らなかったものを現在値のまま残すことはできない。
+   * perFundraisingUserConfigs は差分で、指定した実行者の設定だけが変わる。
+   *
+   * receiveNotification が false のときは、他のフィールドの指定内容によらず
+   * 4 つのトグルと全ての perFundraisingUserConfigs が false になる。
+   */
+  PatchEngagementSettingsEmailNotifications: {
+    requestBody: {
+      content: {
+        /**
+         * @example {
+         *   "receiveNotification": true,
+         *   "receiveEmailMagazine": false,
+         *   "receiveFavoriteTagNotification": true,
+         *   "receiveProjectWatchListNotification": true,
+         *   "perFundraisingUserConfigs": [
+         *     {
+         *       "id": 12,
+         *       "receiveAnnouncementNotification": false
+         *     }
+         *   ]
+         * }
+         */
+        "application/json": components["schemas"]["PatchEngagementSettingsEmailNotificationsRequest"];
+      };
+    };
+    responses: {
+      /** @description 更新後のメール通知設定 */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Engagement_Settings_EmailNotifications"];
+        };
+      };
+      /**
+       * @description cookie セッションが無く、かつ subscriptionToken でも持ち主を特定できない場合に返す。
+       * 無効・期限切れの token を指定した場合を含む。
+       */
+      401: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorUnauthenticated"];
+        };
+      };
+      /**
+       * @description ログイン中のユーザーと subscriptionToken の持ち主が別人の場合に返す。
+       * reason は token_user_mismatch。更新は行わない。
+       */
+      403: {
+        content: {
+          "application/json": components["schemas"]["Engagement_Settings_EmailNotificationsForbidden"];
+        };
+      };
+      /** @description 対象ユーザーのメール通知設定のレコードが存在しない場合に返す */
+      404: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorNotFound"];
+        };
+      };
+      /** @description サーバー内部で何らかのエラーが発生した場合に返す */
+      500: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorInternalServerError"];
+        };
+      };
+    };
+  };
+  /**
+   * 設定画面の初期値を取得する
+   * @description マイページの設定画面が表示するすべての値をフラットなリソースとして返す。
+   * パネルへの割り当ては FE が行うため、画面の構造は契約に持ち込まない。
+   * 全項目が本人限定のためキャッシュしない。
+   */
+  GetEngagementSettingsProfile: {
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["GetEngagementSettingsProfile"];
+        };
+      };
+      /** @description ログイン状態が確認できなかった場合に返す */
+      401: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorUnauthenticated"];
+        };
+      };
+    };
+  };
+  /**
+   * プロフィール属性を部分更新する
+   * @description 送ったキーだけを更新する。RFC 7396 の JSON Merge Patch に従い、
+   * 値に null を送ったキーは削除として扱う。1 つもキーを送らない場合も 204 を返す。
+   * sns の各種別は保存時にサーバが種別から既存のリンクを引き当てるため、
+   * リクエストに識別子を含めない。
+   * 更新後のリソースは返さないので、FE は必要なら取得の EP を呼び直す。
+   */
+  PatchEngagementSettingsProfile: {
+    requestBody: {
+      content: {
+        /**
+         * @example {
+         *   "name": "新しい名前",
+         *   "profile": "新しい自己紹介",
+         *   "isDiscloseSupporting": false,
+         *   "sns": {
+         *     "x": null,
+         *     "website": {
+         *       "url": "example.com/blog",
+         *       "displayName": "個人サイト"
+         *     }
+         *   }
+         * }
+         */
+        "application/json": components["schemas"]["PatchEngagementSettingsProfileRequest"];
+      };
+    };
+    responses: {
+      /** @description 更新に成功した場合に返す */
+      204: {
+        content: never;
+      };
+      /** @description ログイン状態が確認できなかった場合に返す */
+      401: {
+        content: {
+          "application/json": components["schemas"]["HttpErrorUnauthenticated"];
+        };
+      };
+      /**
+       * @description 入力の検証に失敗した場合に返す。
+       * エラーが無いフィールドのキーは含まない。
+       * メッセージは素のまま返し、表示上の装飾は FE が付ける
+       */
+      422: {
+        content: {
+          "application/json": components["schemas"]["PatchEngagementSettingsProfileUnprocessableEntity"];
+        };
+      };
+    };
+  };
   /**
    * ログインユーザーの支援履歴一覧を取得する
    * @description ログインユーザー自身の支援を 1 ページ 10 件で返す。