Class HoujinBangouWithJsonResponse

Hierarchy

HoujinBangouWithJsonResponse
- HoujinBangouWithPlaneResponse

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HoujinBangouWithJsonResponse(applicationId: string, option?: object): HoujinBangouWithJsonResponse

- Defined in index.ts:54
Parameters
- applicationId: string
- Default value option: object = { versionNumber: 4 }
  - Optional versionNumber?: undefined | number
Returns HoujinBangouWithJsonResponse

Properties

applicationId

applicationId: string

Protected option

option: object

Type declaration

Optional JSON?: undefined | false | true
Optional versionNumber?: undefined | number

Protected self

self: HoujinBangouWithJsonResponse = this

Methods

Protected addOptionalArgs

addOptionalArgs(query_obj: object): Promise<function>

- Defined in index.ts:45
Parameters
- query_obj: object
Returns Promise<function>

diff

diff(query: diffRequestQuery): Promise<HBResponse<ResponseData>>

- Defined in index.ts:110
取得期間を指定して情報を取得するリクエスト

Parameters
- query: diffRequestQuery
Returns Promise<HBResponse<ResponseData>>

Protected getUrlObject

getUrlObject(endpoint: ENDPOINTS): Promise<UrlWithParsedQuery>

- Defined in index.ts:34
Parameters
- endpoint: ENDPOINTS
Returns Promise<UrlWithParsedQuery>

isJson

isJson(bool: boolean): HoujinBangouWithPlaneResponse | HoujinBangouWithJsonResponse

- Defined in index.ts:71
生のレスポンスデータをJSON形式に変換するかどうか選択できる。デフォルトは有効状態です。

Parameters
- bool: boolean
Returns HoujinBangouWithPlaneResponse | HoujinBangouWithJsonResponse

name

name(query: nameRequestQuery): Promise<HBResponse<ResponseData>>

- Defined in index.ts:154
法人名を指定して情報を取得するリクエスト

Parameters
- query: nameRequestQuery
Returns Promise<HBResponse<ResponseData>>

num

num(query: numRequestQuery): Promise<HBResponse<ResponseData>>

- Defined in index.ts:81
法人番号を指定して情報を取得するリクエスト

Parameters
- query: numRequestQuery
Returns Promise<HBResponse<ResponseData>>

Protected zero_pad

zero_pad(num: number): string

- Defined in index.ts:41
Parameters
- num: number
Returns string

Generated using TypeDoc