# phishing_hunter_api

> JS API client generated by OpenAPI Generator

Latest version **1.0.0** (published 2022-12-17) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install phishing_hunter_api
pnpm add phishing_hunter_api
yarn add phishing_hunter_api
bun add phishing_hunter_api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-12-17 |
| First published | 2022-12-17 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 179.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | tatsui |

## Links

- npm: https://www.npmjs.com/package/phishing_hunter_api
- npm.io page: https://npm.io/package/phishing_hunter_api

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) ^5.3.0

## Recent versions

- 1.0.0 (latest) — 2022-12-17

## README

# phishing_hunter_api

PhishingHunterApi - JavaScript client for phishing_hunter_api
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install phishing_hunter_api --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your phishing_hunter_api from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var PhishingHunterApi = require('phishing_hunter_api');

var defaultClient = PhishingHunterApi.ApiClient.instance;
// Configure API key authorization: custom_authorizer
var custom_authorizer = defaultClient.authentications['custom_authorizer'];
custom_authorizer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//custom_authorizer.apiKeyPrefix['Authorization'] = "Token"

var api = new PhishingHunterApi.HuntingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHunting(callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://api.phishing-hunter.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PhishingHunterApi.HuntingApi* | [**getHunting**](docs/HuntingApi.md#getHunting) | **GET** /hunting | ハンティング設定の取得
*PhishingHunterApi.HuntingApi* | [**postHunting**](docs/HuntingApi.md#postHunting) | **POST** /hunting | ハンティング設定の更新
*PhishingHunterApi.ObservationApi* | [**getObservations**](docs/ObservationApi.md#getObservations) | **GET** /observation | 監視対象ドメイン一覧の取得
*PhishingHunterApi.ObservationApi* | [**postObservationAdd**](docs/ObservationApi.md#postObservationAdd) | **POST** /observation/add | 監視対象ドメインの追加
*PhishingHunterApi.ObservationApi* | [**postObservationRemove**](docs/ObservationApi.md#postObservationRemove) | **POST** /observation/remove | 監視対象ドメインの削除
*PhishingHunterApi.ScannerApi* | [**getScanner**](docs/ScannerApi.md#getScanner) | **GET** /scanner | スキャン対象のドメイン一覧の取得
*PhishingHunterApi.ScannerApi* | [**postScannerAdd**](docs/ScannerApi.md#postScannerAdd) | **POST** /scanner/add | スキャン対象のドメインの追加
*PhishingHunterApi.ScannerApi* | [**postScannerRemove**](docs/ScannerApi.md#postScannerRemove) | **POST** /scanner/remove | スキャン対象のドメイン一覧の削除
*PhishingHunterApi.SettingsApi* | [**getApikeys**](docs/SettingsApi.md#getApikeys) | **GET** /apikeys | 外部サービス設定の取得
*PhishingHunterApi.SettingsApi* | [**getNotifySlack**](docs/SettingsApi.md#getNotifySlack) | **GET** /notify | 通知設定の一覧を取得
*PhishingHunterApi.SettingsApi* | [**postApikeys**](docs/SettingsApi.md#postApikeys) | **POST** /apikeys | 外部サービス設定の更新
*PhishingHunterApi.SettingsApi* | [**postNotifySlack**](docs/SettingsApi.md#postNotifySlack) | **POST** /notify | 通知設定の更新
*PhishingHunterApi.UserApi* | [**getApikey**](docs/UserApi.md#getApikey) | **GET** /apikey | APIキーの一覧を取得
*PhishingHunterApi.UserApi* | [**getUsersInfo**](docs/UserApi.md#getUsersInfo) | **GET** /users/info | ユーザ情報の取得
*PhishingHunterApi.UserApi* | [**postApikeyCreate**](docs/UserApi.md#postApikeyCreate) | **POST** /apikey/create | APIキーの作成
*PhishingHunterApi.UserApi* | [**postApikeyDelete**](docs/UserApi.md#postApikeyDelete) | **POST** /apikey/delete | APIキーの削除


## Documentation for Models

 - [PhishingHunterApi.GetApikey200Response](docs/GetApikey200Response.md)
 - [PhishingHunterApi.GetApikeys200Response](docs/GetApikeys200Response.md)
 - [PhishingHunterApi.GetApikeys200ResponseApiKeys](docs/GetApikeys200ResponseApiKeys.md)
 - [PhishingHunterApi.GetHunting200Response](docs/GetHunting200Response.md)
 - [PhishingHunterApi.GetHunting200ResponseKeywords](docs/GetHunting200ResponseKeywords.md)
 - [PhishingHunterApi.GetNotifySlack200Response](docs/GetNotifySlack200Response.md)
 - [PhishingHunterApi.GetNotifySlack200ResponseHunting](docs/GetNotifySlack200ResponseHunting.md)
 - [PhishingHunterApi.GetObservations200Response](docs/GetObservations200Response.md)
 - [PhishingHunterApi.GetScanner200Response](docs/GetScanner200Response.md)
 - [PhishingHunterApi.GetScanner500Response](docs/GetScanner500Response.md)
 - [PhishingHunterApi.GetUsersInfo200Response](docs/GetUsersInfo200Response.md)
 - [PhishingHunterApi.GetUsersInfo200ResponseQuota](docs/GetUsersInfo200ResponseQuota.md)
 - [PhishingHunterApi.PostApikeyCreate200Response](docs/PostApikeyCreate200Response.md)
 - [PhishingHunterApi.PostApikeyCreateRequest](docs/PostApikeyCreateRequest.md)
 - [PhishingHunterApi.PostApikeyDelete200Response](docs/PostApikeyDelete200Response.md)
 - [PhishingHunterApi.PostNotifySlackRequest](docs/PostNotifySlackRequest.md)
 - [PhishingHunterApi.PostObservationAddRequest](docs/PostObservationAddRequest.md)
 - [PhishingHunterApi.PostObservationAddRequestApiConfig](docs/PostObservationAddRequestApiConfig.md)
 - [PhishingHunterApi.PostObservationAddRequestApiConfigUrlscan](docs/PostObservationAddRequestApiConfigUrlscan.md)
 - [PhishingHunterApi.PostObservationRemoveRequest](docs/PostObservationRemoveRequest.md)
 - [PhishingHunterApi.PostScannerAdd200Response](docs/PostScannerAdd200Response.md)
 - [PhishingHunterApi.PostScannerAddRequest](docs/PostScannerAddRequest.md)


## Documentation for Authorization



### custom_authorizer


- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

---
_Source: https://npm.io/package/phishing_hunter_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
