/**
 * シルギア 住所の表記をそろえるAPI v1 の型定義
 * https://api.shirugear.com/address/
 *
 * 住所の書き方の違いを、日本郵便の郵便番号データの正式な書き方にそろえ、
 * 都道府県・市区町村・町域・丁目・番地・建物名に分けて返します。
 * 番地・建物名が実在するかは確かめません（郵便番号データに番地は無いため）。
 * 住所が見つからなくても 404 にはせず、200 で level = 0 を返します。
 *
 * 互換の方針: v1 の中では項目を「足す」ことはあっても、名前や意味は変えません。
 * 知らない項目が増えていても無視してください。
 */

/** どこまで見つかったか。0＝見つからない（または決まらない）、1＝都道府県まで、2＝市区町村まで、3＝町域まで */
export type AddressLevel = 0 | 1 | 2 | 3;

/** 町域の郵便番号の1件 */
export interface AddressZipcode {
  /** 7桁 */
  zipcode: string;
  /** 郵便番号データの但し書き（例: "１〜１９丁目"）。無ければ null */
  note: string | null;
}

/** 市区町村が1つに決まらないときの候補 */
export interface AddressCandidate {
  prefecture: string | null;
  city: string;
  /** 市区町村コード（5桁） */
  jiscode: string;
}

/** GET /address/v1/normalize.json?q={住所} */
export interface AddressResponse {
  /** 受け取った住所（全角の英数字・記号を半角にし、前後の空白と先頭の郵便番号を外したもの） */
  input: string;
  level: AddressLevel;
  /** そろえた住所。level 0 のときは null */
  normalized: string | null;
  prefecture: string | null;
  /** 都道府県の読み（カタカナ） */
  prefecture_kana: string | null;
  /** 都道府県コード（2桁） */
  prefcode: string | null;
  /** 市区町村名（郡・政令指定都市の区を含む。例: "西多摩郡奥多摩町"・"横浜市中区"） */
  city: string | null;
  city_kana: string | null;
  /** 市区町村コード（5桁） */
  jiscode: string | null;
  /** 検査数字付きの6桁の地方公共団体コード */
  lgcode: string | null;
  /** 町域名（郵便番号データの書き方） */
  town: string | null;
  /** 町域の読み（全角カタカナ。数字が全角のこともあります） */
  town_kana: string | null;
  /** 京都市の通り名（例: "河原町通二条下る"）。ほかは null */
  street: string | null;
  /** 丁目の数。「◯丁目」と書いてあるときだけ */
  chome: number | null;
  /** 番地・号を "-" でつないだもの（例: "1-2-3"） */
  banchi: string | null;
  /** 番地のあとに残った部分（建物名・部屋番号など） */
  building: string | null;
  /** 町域が見つからなかったときの残りの部分 */
  rest: string | null;
  /** 郵便番号（7桁）。1つに決まったときだけ */
  zipcode: string | null;
  /** 町域の郵便番号すべて（町域が見つからなければ空） */
  zipcodes: AddressZipcode[];
  /** 市区町村が1つに決まらないときの候補（無ければ空） */
  candidates: AddressCandidate[];
  /** 郵便番号データの版（年月 "YYYY-MM"） */
  data_version: string | null;
}

/** エラー（400・403・405） */
export interface AddressError {
  error: {
    status: number;
    code: "invalid_query" | "region_not_allowed" | "method_not_allowed";
    message: string;
  };
}
