# athena_core_apis

> _APIs

Latest version **1.4.1-0** (published 2022-03-17) · Unlicense license · 0 weekly downloads

## Install

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

## 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.4.1-0 |
| Published | 2022-03-17 |
| First published | 2021-12-21 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 169.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | yanglg, yex-g, xjwfk, liuyaping |

## Links

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

## 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.4.1-0 (latest) — 2022-03-17
- 1.3.1-0 — 2022-03-03
- 1.2.1-0 — 2022-03-01
- 1.1.1-0 — 2022-02-15
- 1.1.0-0 — 2022-02-11
- 1.0.8 — 2022-02-09
- 1.0.7-0 — 2022-01-25
- 1.0.6 — 2021-12-29
- 0.0.1-SNAPSHOT — 2021-12-29
- 1.0.1 — 2021-12-24
- 1.0.3 — 2021-12-22
- 1.0.0 — 2021-12-21

## README

# athena_core_apis

AthenaCoreApis - JavaScript client for athena_core_apis
内容云基础功能 APIs
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1-SNAPSHOT
- Package version: 0.0.1-SNAPSHOT
- 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 athena_core_apis --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 athena_core_apis 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 AthenaCoreApis = require('athena_core_apis');


var api = new AthenaCoreApis.AccountApi()
var opts = {
  'generateVerificationRequest': new AthenaCoreApis.GenerateVerificationRequest() // {GenerateVerificationRequest} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateVerification(opts, callback);

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8080/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AthenaCoreApis.AccountApi* | [**generateVerification**](docs/AccountApi.md#generateVerification) | **POST** /account/verification | 生成验证码
*AthenaCoreApis.AccountApi* | [**getAccount**](docs/AccountApi.md#getAccount) | **GET** /account | 查询账户信息
*AthenaCoreApis.AccountApi* | [**login**](docs/AccountApi.md#login) | **POST** /account/session | 用户登录
*AthenaCoreApis.AccountApi* | [**loginOptions**](docs/AccountApi.md#loginOptions) | **OPTIONS** /account/session | 用户登录说明
*AthenaCoreApis.AccountApi* | [**logout**](docs/AccountApi.md#logout) | **DELETE** /account/session | 用户退出
*AthenaCoreApis.AccountApi* | [**signup**](docs/AccountApi.md#signup) | **POST** /account | 用户注册
*AthenaCoreApis.AccountApi* | [**updateAccount**](docs/AccountApi.md#updateAccount) | **PUT** /account | 更改账户信息
*AthenaCoreApis.AccountApi* | [**updatePassword**](docs/AccountApi.md#updatePassword) | **PUT** /account/password | 更新账号密码
*AthenaCoreApis.AccountApi* | [**updatePhone**](docs/AccountApi.md#updatePhone) | **PUT** /account/phone | 更新绑定手机号
*AthenaCoreApis.BuyPayApi* | [**cancelOrder**](docs/BuyPayApi.md#cancelOrder) | **DELETE** /orders/{id} | 取消订单
*AthenaCoreApis.BuyPayApi* | [**createOrder**](docs/BuyPayApi.md#createOrder) | **POST** /orders | 创建订单
*AthenaCoreApis.BuyPayApi* | [**createPayment**](docs/BuyPayApi.md#createPayment) | **POST** /orders/{id}/payment | 支付订单
*AthenaCoreApis.BuyPayApi* | [**getOrder**](docs/BuyPayApi.md#getOrder) | **GET** /orders/{id} | 查询订单
*AthenaCoreApis.BuyPayApi* | [**listOrders**](docs/BuyPayApi.md#listOrders) | **GET** /orders | 枚举订单
*AthenaCoreApis.BuyPayApi* | [**listTiers**](docs/BuyPayApi.md#listTiers) | **GET** /tiers | 查询产品可购套餐
*AthenaCoreApis.WeChatApi* | [**createWechatSession**](docs/WeChatApi.md#createWechatSession) | **POST** /wechat/session | 创建微信认证会话
*AthenaCoreApis.WeChatApi* | [**getWechatSession**](docs/WeChatApi.md#getWechatSession) | **GET** /wechat/session/{id} | 查询微信认证会话详情和状态


## Documentation for Models

 - [AthenaCoreApis.AccessToken](docs/AccessToken.md)
 - [AthenaCoreApis.Account](docs/Account.md)
 - [AthenaCoreApis.Application](docs/Application.md)
 - [AthenaCoreApis.CreateOrderRequest](docs/CreateOrderRequest.md)
 - [AthenaCoreApis.CreatePaymentRequest](docs/CreatePaymentRequest.md)
 - [AthenaCoreApis.CreatorQuota](docs/CreatorQuota.md)
 - [AthenaCoreApis.ErrorBody](docs/ErrorBody.md)
 - [AthenaCoreApis.FaultBody](docs/FaultBody.md)
 - [AthenaCoreApis.GenerateVerificationRequest](docs/GenerateVerificationRequest.md)
 - [AthenaCoreApis.InlineResponseDefault](docs/InlineResponseDefault.md)
 - [AthenaCoreApis.LoginRequest](docs/LoginRequest.md)
 - [AthenaCoreApis.Order](docs/Order.md)
 - [AthenaCoreApis.OrderList](docs/OrderList.md)
 - [AthenaCoreApis.OrderState](docs/OrderState.md)
 - [AthenaCoreApis.Ordering](docs/Ordering.md)
 - [AthenaCoreApis.Pagination](docs/Pagination.md)
 - [AthenaCoreApis.PayMethod](docs/PayMethod.md)
 - [AthenaCoreApis.Payment](docs/Payment.md)
 - [AthenaCoreApis.PaymentState](docs/PaymentState.md)
 - [AthenaCoreApis.Plan](docs/Plan.md)
 - [AthenaCoreApis.Platform](docs/Platform.md)
 - [AthenaCoreApis.SignupRequest](docs/SignupRequest.md)
 - [AthenaCoreApis.StrategyQuota](docs/StrategyQuota.md)
 - [AthenaCoreApis.Tier](docs/Tier.md)
 - [AthenaCoreApis.TierList](docs/TierList.md)
 - [AthenaCoreApis.TierType](docs/TierType.md)
 - [AthenaCoreApis.UpdateAccountRequest](docs/UpdateAccountRequest.md)
 - [AthenaCoreApis.UpdatePasswordRequest](docs/UpdatePasswordRequest.md)
 - [AthenaCoreApis.UpdatePhoneRequest](docs/UpdatePhoneRequest.md)
 - [AthenaCoreApis.WechatSession](docs/WechatSession.md)


## Documentation for Authorization



### BearerAuth

- **Type**: Bearer authentication (JWT)

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