/**
 * シルギア 金融機関コード・支店コードAPI v1 の型定義
 * https://api.shirugear.com/bank/
 *
 * 出典: zengin-code/source-data（https://github.com/zengin-code/source-data・MIT License。
 * 元は「銀行コード検索」http://ykaku.net/ginkokensaku/）を加工して作成。
 * 有志が更新しているデータで、金融機関の公式の一覧ではありません。合併や店舗の統廃合で最新と違うことがあります。
 *
 * 名前は略称（"みずほ"・"三菱ＵＦＪ"・"北海道信金"・"ゆうちょ" など。「銀行」は付かない）。
 * カナは振込で使う形の全角カタカナで、小さい字は大きく書きます（"ネツト"）。
 *
 * 互換の方針: v1 の中では項目を「足す」ことはあっても、名前や意味は変えません。
 * 知らない項目が増えていても無視してください。
 */

/** 金融機関コード4桁（"0001" など。頭の 0 を省かない文字列） */
export type BankCode = string;

/** 支店コード3桁（"001" など） */
export type BranchCode = string;

/** 名前と読み（金融機関・支店で共通） */
export interface BankNames {
  /** 名前。金融機関は略称。ゆうちょ銀行（9900）の支店は振込用の漢数字の店名（"〇一八" など） */
  name: string;
  /** 振込で使う形の全角カタカナ（小さい字は大きく書く。全角の "－" や英字が入ることがある） */
  kana: string;
  /** kana をひらがなにしたもの（検索用） */
  hira: string;
  /** kana をローマ字にしたもの（検索用・小文字。ヘボン式とは限らない） */
  roma: string;
}

/** 金融機関 */
export interface Bank extends BankNames {
  code: BankCode;
}

/** 金融機関（支店の数つき） */
export interface BankWithCount extends Bank {
  /** データにある支店の数 */
  branch_count: number;
}

/** 支店 */
export interface Branch extends BankNames {
  code: BranchCode;
}

/** GET /bank/v1/banks.json */
export interface BanksResponse {
  /** データの版（元のデータが更新された日 "YYYY-MM-DD"） */
  data_version: string;
  /** 金融機関の数 */
  count: number;
  /** 金融機関コードの順 */
  banks: BankWithCount[];
}

/** GET /bank/v1/{金融機関コード4桁}.json */
export interface BankResponse extends BankWithCount {
  /** 支店コードの順 */
  branches: Branch[];
  data_version: string;
}

/** GET /bank/v1/{金融機関コード4桁}/{支店コード3桁}.json */
export interface BranchResponse {
  /** 金融機関（branch_count は入らない） */
  bank: Bank;
  branch: Branch;
  data_version: string;
}

/** GET /bank/v1/meta.json */
export interface BankMetaResponse {
  data_version: string;
  /** データを作った日時（ISO 8601・UTC） */
  built_at: string;
  /** 出典の書き方 */
  source: string;
  sources: {
    name: string;
    /** 元にしたリポジトリの URL */
    url: string;
    /** "MIT" */
    license: string;
    /** 使ったコミット */
    commit: string;
    /** 取得した日時（ISO 8601・UTC） */
    fetched_at: string;
  }[];
  counts: {
    /** 金融機関の数 */
    banks: number;
    /** 支店の数の合計 */
    branches: number;
  };
}

/** エラーのときの本文 */
export interface ErrorResponse {
  error: {
    status: 400 | 403 | 404 | 405;
    code: "invalid_code" | "code_not_found" | "region_not_allowed" | "method_not_allowed";
    message: string;
  };
}
