Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KENALL

Hierarchy

  • KENALL

Index

Constructors

Properties

Methods

Constructors

constructor

  • The constructor.

    Parameters

    • apikey: string

      The key string that you want to call the API with. The key is shown in the dashboard you will be navigated to right after signing in to the service.

    • config: Config = {}

      Specfies the configuration given by Config.

    Returns KENALL

Properties

Readonly apibase

apibase: string

Readonly apikey

apikey: string

Readonly timeout

timeout: number

Methods

getAddress

  • getAddress<T>(postalCode: string, version?: string, apiVersion?: T): Promise<AddressResolverResponseForVersion<T>>

  • "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。

    Type Parameters

    • T extends undefined | APIVersion = undefined

    Parameters

    • postalCode: string

      The postal code to query with.

      問い合わせ対象の郵便番号。

    • Optional version: string

      The version of the database that the query has to be performed against. Will default to the latest available version if not specified.

      問い合わせが実行される対象となるデータベースのバージョン。指定がない場合は最新のものに対する問い合わせとなります。

    • Optional apiVersion: T

      The API version. The return type is determined based on this argument, and thus it cannot be a variable.

      APIバージョン。戻り値の方はこの引数によって決定されるため、この引数は変数であってはなりません。

    Returns Promise<AddressResolverResponseForVersion<T>>

getCities

  • getCities<T>(prefectureCode: string, version?: string, apiVersion?: T): Promise<CityResolverResponseForVersion<T>>

  • "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。

    Type Parameters

    • T extends undefined | APIVersion = undefined

    Parameters

    • prefectureCode: string

      The prefecture code to query with.

      問い合わせ対象の都道府県コード。

    • Optional version: string

      The version of the database that the query has to be performed against. Will default to the latest available version if not specified.

      問い合わせが実行される対象となるデータベースのバージョン。指定がない場合は最新のものに対する問い合わせとなります。

    • Optional apiVersion: T

      The API version. The return type is determined based on this argument, and thus it cannot be a variable.

      APIバージョン。戻り値の方はこの引数によって決定されるため、この引数は変数であってはなりません。

    Returns Promise<CityResolverResponseForVersion<T>>

getNTACorporateInfo

  • getNTACorporateInfo<T>(corporateNumber: string, apiVersion?: T): Promise<NTACorporateInfoResolverResponseForVersion<T>>

  • "getNTACorporateInfo" API (エンドポイント: /houjinbangou/{corporateNumber}) を呼び出します。

    Type Parameters

    • T extends undefined | APIVersion = undefined

    Parameters

    • corporateNumber: string

      The corporate number to query with.

      問い合わせ対象の法人番号。

    • Optional apiVersion: T

      The API version. The return type is determined based on this argument, and thus it cannot be a variable.

      APIバージョン。戻り値の方はこの引数によって決定されるため、この引数は変数であってはなりません。

    Returns Promise<NTACorporateInfoResolverResponseForVersion<T>>

getNTAQualifiedInvoiceIssuerInfo

  • "getNTAQualifiedInvoiceIssuerInfo" API (エンドポイント: /invoice/{issuerNumber}) を呼び出します。

    Type Parameters

    • T extends undefined | APIVersion = undefined

    Parameters

    • issuerNumber: string

      The qualified invoice issuer number to query with.

      問い合わせ対象の適格請求書発行事業者登録番号。

    • Optional apiVersion: T

      The API version. The return type is determined based on this argument, and thus it cannot be a variable.

      APIバージョン。戻り値の方はこの引数によって決定されるため、この引数は変数であってはなりません。

    Returns Promise<NTAQualifiedInvoiceIssuerInfoResolverResponse>

    {@link NTAQualifiedInvoiceIssuerResolverResponse}.

Protected request

  • request(endpoint: string, params?: {}, apiVersion?: string): Promise<unknown>

  • Parameters

    • endpoint: string
    • params: {} = {}
      • Optional apiVersion: string

      Returns Promise<unknown>

    searchAddresses

    • searchAddresses<T>(options: AddressSearcherOptions, apiVersion?: T): Promise<AddressSearcherResponseForVersion<T>>

    • "searchAddresses" API (エンドポイント: /postalcode/?...) を呼び出します。

      Type Parameters

      • T extends undefined | APIVersion = undefined

      Parameters

      • options: AddressSearcherOptions

        The query.

        問い合わせ内容。

      • Optional apiVersion: T

        The API version. The return type is determined based on this argument, and thus it cannot be a variable.

        APIバージョン。戻り値の方はこの引数によって決定されるため、この引数は変数であってはなりません。

      Returns Promise<AddressSearcherResponseForVersion<T>>

    searchNTACorporateInfo

    • searchNTACorporateInfo<T>(options: NTACorporateInfoSearcherOptions, apiVersion?: T): Promise<NTACorporateInfoSearcherResponseForVersion<T>>

    • "searchNTACorporateInfo" API (エンドポイント: /houjinbangou?...) を呼び出します。

      Type Parameters

      • T extends undefined | APIVersion = undefined

      Parameters

      • options: NTACorporateInfoSearcherOptions

        The query.

        問い合わせ内容。

      • Optional apiVersion: T

        The API version. The return type is determined based on this argument, and thus it cannot be a variable.

        APIバージョン。戻り値の方はこの引数によって決定されるため、この引数は変数であってはなりません。

      Returns Promise<NTACorporateInfoSearcherResponseForVersion<T>>

    Generated using TypeDoc