/**
 * シルギア 電話番号・市外局番API v1 の型定義
 * https://api.shirugear.com/tel/
 *
 * 互換の方針: v1 の中では項目を「足す」ことはあっても、名前や意味は変えません。
 * 知らない項目が増えていても無視してください。
 */

/**
 * 番号の種類（値が増えることがあります）。
 * fixed=固定電話 / mobile=携帯電話（070・080・090）/ ip=IP電話（050）/
 * freedial=フリーダイヤル（0120・0800）/ navidial=ナビダイヤル（0570）/ teledome=テレドーム（0180）/
 * premium=情報料代理徴収（0990）/ m2m=M2M等専用番号（020）/ fmc=FMC（060）
 */
export type TelType = "fixed" | "mobile" | "ip" | "freedial" | "navidial" | "teledome" | "premium" | "m2m" | "fmc";

/** 固定電話の地域（番号区画） */
export interface TelArea {
  /** 番号区画コード（例: "2"・"219"） */
  section_code: string;
  /** 番号区画の名前。総務省「市外局番の一覧」の書き方そのまま（「（…を除く。）」などを含む） */
  name: string;
  /** その番号区画にかかる都道府県（2つ以上のことがある） */
  prefectures: string[];
}

/** GET /tel/v1/{電話番号}.json */
export interface TelResponse {
  /** ハイフンを取り除いた電話番号 */
  number: string;
  /** ハイフン付きの電話番号（例: "0123-45-6789"・"090-1234-5678"） */
  formatted: string;
  type: TelType;
  /** 種類の日本語（「固定電話」など。言い回しが変わることがある） */
  type_name: string;
  /** 市外局番（頭の 0 を含む）。固定電話以外は null */
  area_code: string | null;
  /** 市内局番。固定電話以外は null */
  local_code: string | null;
  /** 加入者番号（最後の4桁）。固定電話以外は null */
  subscriber: string | null;
  /** 地域（番号区画）。固定電話以外は null */
  area: TelArea | null;
  /**
   * 総務省がその番号の範囲（先頭6桁）を割り当てた電話会社（総務省の書き方そのまま）。
   * 番号ポータビリティで今の会社と違うことがある。未使用の範囲と固定電話以外は null
   */
  carrier: string | null;
  /**
   * 総務省の指定状況でその範囲が「使用中」なら true、「未使用」なら false。固定電話以外は null。
   * その番号を実際にだれかが使っているかは表さない
   */
  in_use: boolean | null;
  /** データの版 "YYYY-MM-DD"（その日現在） */
  data_version: string;
}

/** areas の番号区画1つ */
export interface TelSection {
  /** 番号区画コード（TelArea.section_code と同じ） */
  code: string;
  name: string;
  prefectures: string[];
}

/** areas の1件（市外局番1つ） */
export interface TelAreaCode {
  /** 市外局番（頭の 0 を含む。例: "03"・"0154"） */
  area_code: string;
  /** 市内局番の桁数（市外局番と合わせて6桁になる数） */
  local_code_digits: number;
  /** その市外局番の番号区画にかかる都道府県 */
  prefectures: string[];
  /** その市外局番を使う番号区画（1つ以上） */
  sections: TelSection[];
}

/** GET /tel/v1/areas.json */
export interface TelAreasResponse {
  data_version: string;
  count: number;
  /** 市外局番の順 */
  areas: TelAreaCode[];
}

/** GET /tel/v1/prefixes.json */
export interface TelPrefixesResponse {
  data_version: string;
  count: number;
  /** prefixes の値の並び */
  fields: ["area_code", "section", "in_use"];
  /** 先頭6桁 → [市外局番, 番号区画コード, 使用中なら1・未使用なら0] */
  prefixes: Record<string, [string, string, 0 | 1]>;
}

/** GET /tel/v1/meta.json */
export interface TelMetaResponse {
  /** 使った総務省の公表のうち、いちばん新しい版 "YYYY-MM-DD" */
  data_version: string;
  /** データを作った日時（ISO 8601・UTC） */
  built_at: string;
  source: string;
  /** 利用規約の名前と URL */
  license: string;
  /** 出典ごとの URL と版（as_of: その日現在） */
  sources: Array<{ name: string; url: string; as_of: string; page: string }>;
  /** 出典を取ってきた日時（ISO 8601・UTC） */
  fetched_at: string;
  counts: {
    /** 固定電話の先頭6桁の数 */
    prefixes: number;
    /** そのうち使用中の数 */
    in_use: number;
    /** 市外局番の数 */
    area_codes: number;
    /** 番号区画の数 */
    sections: number;
  };
}

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