gbiz-info-api 0.2.0

//! gBizINFO REST API (v2) のレスポンス型定義。
//!
//! 各構造体は OpenAPI 定義のスキーマ名(`V2` サフィックスを除く)に対応する。

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// レスポンスの共通ラッパー。
///
/// `T` にはエンドポイントに応じて、法人基本情報 [`HojinInfo`]・
/// 法人検索結果 [`HojinInfoSearch`]・カテゴリ別情報 [`HojinInfoForChild`] のいずれかが入る。
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct HojinInfoResponse<T> {
    /// エラー情報(エラーがある場合に出力)
    pub errors: Option<Vec<ApiError>>,
    /// gBizINFOデータ
    #[serde(rename = "hojin-infos")]
    pub hojin_infos: Option<Vec<T>>,
    /// リクエストID
    pub id: Option<String>,
    /// メッセージ
    pub message: Option<String>,
}

impl<T> HojinInfoResponse<T> {
    /// `hojin-infos` を所有権ごと取り出す。未設定の場合は空の `Vec`。
    pub fn into_hojin_infos(self) -> Vec<T> {
        self.hojin_infos.unwrap_or_default()
    }
}

/// `updateInfo` 系エンドポイントのレスポンスラッパー(ページング情報付き)。
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct UpdateInfoResponse<T> {
    /// エラー情報(エラーがある場合に出力)
    pub errors: Option<Vec<ApiError>>,
    /// gBizINFOデータ
    #[serde(rename = "hojin-infos")]
    pub hojin_infos: Option<Vec<T>>,
    /// リクエストID
    pub id: Option<String>,
    /// メッセージ
    pub message: Option<String>,
    /// ページ番号
    #[serde(rename = "pageNumber")]
    pub page_number: Option<String>,
    /// 総件数
    #[serde(rename = "totalCount")]
    pub total_count: Option<String>,
    /// 総ページ数
    #[serde(rename = "totalPage")]
    pub total_page: Option<String>,
}

impl<T> UpdateInfoResponse<T> {
    /// `hojin-infos` を所有権ごと取り出す。未設定の場合は空の `Vec`。
    pub fn into_hojin_infos(self) -> Vec<T> {
        self.hojin_infos.unwrap_or_default()
    }
}

/// 法人検索(`GET /v2/hojin`)のレスポンス。
pub type SearchResponse = HojinInfoResponse<HojinInfoSearch>;
/// 法人基本情報(`GET /v2/hojin/{corporate_number}`)のレスポンス。
pub type HojinResponse = HojinInfoResponse<HojinInfo>;
/// カテゴリ別情報(`GET /v2/hojin/{corporate_number}/xxx`)のレスポンス。
pub type HojinChildResponse = HojinInfoResponse<HojinInfoForChild>;
/// 法人基本情報の更新情報(`GET /v2/hojin/updateInfo`)のレスポンス。
pub type UpdateInfoHojinResponse = UpdateInfoResponse<HojinInfo>;
/// カテゴリ別の更新情報(`GET /v2/hojin/updateInfo/xxx`)のレスポンス。
pub type UpdateInfoChildResponse = UpdateInfoResponse<HojinInfoForChild>;

/// エラー情報
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct ApiError {
    /// エラー箇所(項目)
    pub item: Option<String>,
    /// エラーメッセージ
    pub message: Option<String>,
}

/// 法人検索の結果1件分(スキーマ: `HojinInfoSearchV2`)。
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct HojinInfoSearch {
    /// 法人番号
    pub corporate_number: Option<String>,
    /// 本社所在地
    pub location: Option<String>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
    /// 法人名
    pub name: Option<String>,
    /// 法人名英語
    pub name_en: Option<String>,
    /// 法人活動情報件数
    pub number_of_activity: Option<String>,
    /// 郵便番号
    pub postal_code: Option<String>,
    /// ステータス
    pub status: Option<String>,
    /// 更新年月日
    pub update_date: Option<String>,
}

/// 法人基本情報(スキーマ: `HojinInfoV2`)。
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct HojinInfo {
    /// 訂正区分
    pub aggregated_year: Option<String>,
    /// 全省庁統一資格の営業品目
    pub business_items: Option<Vec<String>>,
    /// 事業概要
    pub business_summary: Option<String>,
    /// 資本金
    pub capital_stock: Option<i64>,
    /// 届出・認定情報
    pub certification: Option<Vec<CertificationInfo>>,
    /// 登記記録の閉鎖等の事由
    pub close_cause: Option<String>,
    /// 登記記録の閉鎖等年月日
    pub close_date: Option<String>,
    /// 表彰情報
    pub commendation: Option<Vec<CommendationInfo>>,
    /// 企業規模詳細(女性)
    pub company_size_female: Option<i64>,
    /// 企業規模詳細(男性)
    pub company_size_male: Option<i64>,
    /// 企業ホームページ
    pub company_url: Option<String>,
    /// 法人番号
    pub corporate_number: Option<String>,
    /// 事業所情報
    #[serde(rename = "corporation-info")]
    pub corporation_info: Option<Vec<CorporationInfo>>,
    /// 設立年月日
    pub date_of_establishment: Option<String>,
    /// 従業員数
    pub employee_number: Option<i64>,
    /// 財務情報
    pub finance: Option<Finance>,
    /// 創業年
    pub founding_year: Option<i32>,
    /// 業種
    pub industry: Option<Vec<String>>,
    /// 法人名フリガナ
    pub kana: Option<String>,
    /// 法人種別
    pub kind: Option<String>,
    /// 本社所在地
    pub location: Option<String>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<Metadata>,
    /// 法人名
    pub name: Option<String>,
    /// 法人名英語
    pub name_en: Option<String>,
    /// 特許情報
    pub patent: Option<Vec<PatentInfo>>,
    /// 郵便番号
    pub postal_code: Option<String>,
    /// 処理区分
    pub process: Option<String>,
    /// 調達情報
    pub procurement: Option<Vec<ProcurementInfo>>,
    /// 全省庁統一資格の資格等級(物品の製造、物品の販売、役務の提供等、物品の買受け)
    pub qualification_grade: Option<String>,
    /// 法人代表者名
    pub representative_name: Option<String>,
    /// ステータス
    pub status: Option<String>,
    /// 補助金情報
    pub subsidy: Option<Vec<SubsidyInfo>>,
    /// 更新年月日
    pub update_date: Option<String>,
    /// 職場情報
    pub workplace_info: Option<WorkplaceInfo>,
}

/// カテゴリ別取得の結果1件分(スキーマ: `HojinInfoForChildV2`)。
///
/// 呼び出したエンドポイントに対応するカテゴリのフィールドのみ値が入る。
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct HojinInfoForChild {
    /// 届出・認定情報
    pub certification: Option<Vec<CertificationInfo>>,
    /// 表彰情報
    pub commendation: Option<Vec<CommendationInfo>>,
    /// 法人番号
    pub corporate_number: Option<String>,
    /// 事業所情報
    #[serde(rename = "corporation-info")]
    pub corporation_info: Option<Vec<CorporationInfo>>,
    /// 財務情報
    pub finance: Option<Finance>,
    /// 本社所在地
    pub location: Option<String>,
    /// 法人名
    pub name: Option<String>,
    /// 特許情報
    pub patent: Option<Vec<PatentInfo>>,
    /// 調達情報
    pub procurement: Option<Vec<ProcurementInfo>>,
    /// 補助金情報
    pub subsidy: Option<Vec<SubsidyInfo>>,
    /// 職場情報
    pub workplace_info: Option<WorkplaceInfo>,
}

/// 届出・認定情報(スキーマ: `CertificationInfoV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct CertificationInfo {
    /// 部門
    pub category: Option<String>,
    /// 認定日
    pub date_of_approval: Option<String>,
    /// 府省
    pub government_departments: Option<String>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
    /// 対象
    pub target: Option<String>,
    /// 届出認定等
    pub title: Option<String>,
}

/// 表彰情報(スキーマ: `CommendationInfoV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct CommendationInfo {
    /// 部門
    pub category: Option<String>,
    /// 年月日
    pub date_of_commendation: Option<String>,
    /// 府省
    pub government_departments: Option<String>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
    /// 備考
    pub note: Option<String>,
    /// 受賞対象
    pub target: Option<String>,
    /// 表彰名
    pub title: Option<String>,
}

/// 事業所情報(スキーマ: `CorporationInfo`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct CorporationInfo {
    /// 事業所所在地
    pub corporation_location: Option<String>,
    /// 事業所所在地フリガナ
    pub corporation_location_furigana: Option<String>,
    /// 事業所名
    pub corporation_name: Option<String>,
    /// 事業所名フリガナ
    pub corporation_name_furigana: Option<String>,
    /// 被保険者数
    pub insured_number: Option<String>,
    /// 全喪年月日
    pub loss_date: Option<String>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
}

/// 財務情報(スキーマ: `FinanceV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct Finance {
    /// 会計基準
    pub accounting_standards: Option<String>,
    /// 事業年度
    pub fiscal_year_cover_page: Option<String>,
    /// 大株主
    pub major_shareholders: Option<Vec<MajorShareholder>>,
    /// 財務
    pub management_index: Option<Vec<ManagementIndex>>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
}

/// 特許情報(スキーマ: `PatentInfoV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct PatentInfo {
    /// 出願年月日
    pub application_date: Option<String>,
    /// 分類
    pub classifications: Option<Vec<HashMap<String, String>>>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
    /// 特許/意匠/商標
    pub patent_type: Option<String>,
    /// 登録番号
    pub registration_number: Option<String>,
    /// 発明の名称(等)/意匠に係る物品/表示用商標
    pub title: Option<String>,
    /// 文献固定アドレス
    pub url: Option<String>,
}

/// 調達情報(スキーマ: `ProcurementInfoV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct ProcurementInfo {
    /// 金額
    pub amount: Option<i64>,
    /// 受注日
    pub date_of_order: Option<String>,
    /// 府省
    pub government_departments: Option<String>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
    /// 備考
    pub note: Option<String>,
    /// 事業名
    pub title: Option<String>,
}

/// 補助金情報(スキーマ: `SubsidyInfoV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct SubsidyInfo {
    /// 金額
    pub amount: Option<String>,
    /// 認定日
    pub date_of_approval: Option<String>,
    /// 府省
    pub government_departments: Option<String>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
    /// 対象
    pub target: Option<String>,
    /// 補助金等
    pub title: Option<String>,
}

/// 職場情報(スキーマ: `WorkplaceInfoBeanV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct WorkplaceInfo {
    /// 勤務基本情報
    pub base_infos: Option<WorkplaceBaseInfos>,
    /// 育児・仕事の両立に関する情報
    pub compatibility_of_childcare_and_work: Option<CompatibilityOfChildcareAndWork>,
    /// メタデータ
    #[serde(rename = "meta-data")]
    pub meta_data: Option<ChildMetadata>,
    /// 女性の活躍に関する情報
    pub women_activity_infos: Option<WomenActivityInfos>,
}

/// 勤務基本情報(スキーマ: `WorkplaceBaseInfosV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct WorkplaceBaseInfos {
    /// 従業員の平均年齢
    pub average_age: Option<f64>,
    /// 正社員の平均継続勤務年数
    pub average_continuous_service_years: Option<f64>,
    /// 平均継続勤務年数-女性
    #[serde(rename = "average_continuous_service_years_Female")]
    pub average_continuous_service_years_female: Option<f64>,
    /// 平均継続勤務年数-男性
    #[serde(rename = "average_continuous_service_years_Male")]
    pub average_continuous_service_years_male: Option<f64>,
    /// 平均継続勤務年数-範囲
    pub average_continuous_service_years_type: Option<String>,
    /// 月平均所定外労働時間
    pub month_average_predetermined_overtime_hours: Option<f64>,
}

/// 育児・仕事の両立に関する情報(スキーマ: `CompatibilityOfChildcareAndWorkV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct CompatibilityOfChildcareAndWork {
    /// 育児休業取得者数(女性)
    pub maternity_leave_acquisition_num: Option<i64>,
    /// 育児休業対象者数(女性)
    pub number_of_maternity_leave: Option<i64>,
    /// 育児休業対象者数(男性)
    pub number_of_paternity_leave: Option<i64>,
    /// 育児休業取得者数(男性)
    pub paternity_leave_acquisition_num: Option<i64>,
}

/// 女性の活躍に関する情報(スキーマ: `WomenActivityInfosV2`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct WomenActivityInfos {
    /// 女性管理職人数
    pub female_share_of_manager: Option<i64>,
    /// 女性役員人数
    pub female_share_of_officers: Option<i64>,
    /// 労働者に占める女性労働者の割合
    pub female_workers_proportion: Option<f64>,
    /// 労働者に占める女性労働者の割合-範囲
    pub female_workers_proportion_type: Option<String>,
    /// 管理職全体人数(男女計)
    pub gender_total_of_manager: Option<i64>,
    /// 役員全体人数(男女計)
    pub gender_total_of_officers: Option<i64>,
}

/// 大株主(スキーマ: `MajorShareholders`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct MajorShareholder {
    /// 氏名又は名称
    pub name_major_shareholders: Option<String>,
    /// 発行済株式総数に対する所有株式数の割合
    pub shareholding_ratio: Option<f64>,
}

/// 財務(スキーマ: `ManagementIndex`)
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct ManagementIndex {
    /// 資本金
    pub capital_stock_summary_of_business_results: Option<i64>,
    /// 資本金(単位)
    pub capital_stock_summary_of_business_results_unit_ref: Option<String>,
    /// 営業総収入
    pub gross_operating_revenue_summary_of_business_results: Option<i64>,
    /// 営業総収入(単位)
    pub gross_operating_revenue_summary_of_business_results_unit_ref: Option<String>,
    /// 純資産額
    pub net_assets_summary_of_business_results: Option<i64>,
    /// 純資産額(単位)
    pub net_assets_summary_of_business_results_unit_ref: Option<String>,
    /// 当期純利益又は当期純損失(△)
    pub net_income_loss_summary_of_business_results: Option<i64>,
    /// 当期純利益又は当期純損失(△)(単位)
    pub net_income_loss_summary_of_business_results_unit_ref: Option<String>,
    /// 正味収入保険料
    pub net_premiums_written_summary_of_business_results_ins: Option<i64>,
    /// 正味収入保険料(単位)
    pub net_premiums_written_summary_of_business_results_ins_unit_ref: Option<String>,
    /// 売上高
    pub net_sales_summary_of_business_results: Option<i64>,
    /// 売上高(単位)
    pub net_sales_summary_of_business_results_unit_ref: Option<String>,
    /// 従業員数
    pub number_of_employees: Option<i64>,
    /// 従業員数(単位)
    pub number_of_employees_unit_ref: Option<String>,
    /// 営業収益
    pub operating_revenue1_summary_of_business_results: Option<i64>,
    /// 営業収益(単位)
    pub operating_revenue1_summary_of_business_results_unit_ref: Option<String>,
    /// 営業収入
    pub operating_revenue2_summary_of_business_results: Option<i64>,
    /// 営業収入(単位)
    pub operating_revenue2_summary_of_business_results_unit_ref: Option<String>,
    /// 経常利益又は経常損失(△)
    pub ordinary_income_loss_summary_of_business_results: Option<i64>,
    /// 経常利益又は経常損失(△)(単位)
    pub ordinary_income_loss_summary_of_business_results_unit_ref: Option<String>,
    /// 経常収益
    pub ordinary_income_summary_of_business_results: Option<i64>,
    /// 経常収益(単位)
    pub ordinary_income_summary_of_business_results_unit_ref: Option<String>,
    /// 回次
    pub period: Option<String>,
    /// 総資産額
    pub total_assets_summary_of_business_results: Option<i64>,
    /// 総資産額(単位)
    pub total_assets_summary_of_business_results_unit_ref: Option<String>,
}

/// 法人基本情報のメタデータ(スキーマ: `Metadata`)。
///
/// `metadata_flg=true` を指定した場合のみ出力される。
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct Metadata {
    /// データ品質
    pub data_quality: Option<MetadataFields>,
    /// データ取込頻度
    pub import_frequency: Option<MetadataFields>,
    /// キー情報
    pub key_field: Option<String>,
    /// 最終取得日
    pub last_acquisition_date: Option<MetadataFields>,
    /// 最終更新日
    pub last_update_date: Option<MetadataFields>,
    /// 出典元
    pub source: Option<MetadataFields>,
}

/// [`Metadata`] の項目別の値。
///
/// OpenAPI 定義では `MetadataDataQuality` / `MetadataImportFrequency` /
/// `MetadataLastAcquisitionDate` / `MetadataLastUpdateDate` / `MetadataSource`
/// に分かれているが、全て同一の構造のため1つの型で表現する。
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct MetadataFields {
    /// 訂正区分
    pub aggregated_year: Option<String>,
    /// 全省庁統一資格の営業品目
    pub business_items: Option<String>,
    /// 事業概要
    pub business_summary: Option<String>,
    /// 資本金
    pub capital_stock: Option<String>,
    /// 登記記録の閉鎖等の事由
    pub close_cause: Option<String>,
    /// 登記記録の閉鎖等年月日
    pub close_date: Option<String>,
    /// 企業規模詳細(女性)
    pub company_size_female: Option<String>,
    /// 企業規模詳細(男性)
    pub company_size_male: Option<String>,
    /// 企業ホームページ
    pub company_url: Option<String>,
    /// 法人番号
    pub corporate_number: Option<String>,
    /// 設立年月日
    pub date_of_establishment: Option<String>,
    /// 従業員数
    pub employee_number: Option<String>,
    /// 創業年
    pub founding_year: Option<String>,
    /// 業種
    pub industry: Option<String>,
    /// 法人名フリガナ
    pub kana: Option<String>,
    /// 法人種別
    pub kind: Option<String>,
    /// 本社所在地
    pub location: Option<String>,
    /// 法人名
    pub name: Option<String>,
    /// 法人名英語
    pub name_en: Option<String>,
    /// 郵便番号
    pub postal_code: Option<String>,
    /// 処理区分
    pub process: Option<String>,
    /// 全省庁統一資格の資格等級
    pub qualification_grade: Option<String>,
    /// 法人代表者名
    pub representative_name: Option<String>,
    /// ステータス
    pub status: Option<String>,
    /// 更新年月日
    pub update_date: Option<String>,
}

/// カテゴリ別情報・検索結果のメタデータ(スキーマ: `ChildMetadata`)。
///
/// `metadata_flg=true` を指定した場合のみ出力される。
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct ChildMetadata {
    /// データ品質
    pub data_quality: Option<String>,
    /// データ取込頻度
    pub import_frequency: Option<String>,
    /// キー情報
    pub key_field: Option<String>,
    /// 最終取得日
    pub last_acquisition_date: Option<String>,
    /// 最終更新日
    pub last_update_date: Option<String>,
    /// 出典元
    pub source: Option<String>,
}