athena_management_apis v1.1.1
athena_management_apis
AthenaManagementApis - JavaScript client for athena_management_apis 后台管理系统 APIs This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0-SNAPSHOT
- Package version: 1.0.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install athena_management_apis --save
Finally, you need to build the module:
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:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your athena_management_apis from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
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:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. 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):
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:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var AthenaManagementApis = require('athena_management_apis');
var api = new AthenaManagementApis.AICreationApi()
var opts = {
'createArticleRequest': new AthenaManagementApis.CreateArticleRequest() // {CreateArticleRequest}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createArticle(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8080/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AthenaManagementApis.AICreationApi | createArticle | POST /articles | 创建模板Article |
AthenaManagementApis.AICreationApi | createTemplate | POST /templates | 创建智能文案模板 |
AthenaManagementApis.AICreationApi | deleteArticle | DELETE /articles/{id} | 删除相关的Article文案模板 |
AthenaManagementApis.AICreationApi | deleteTemplate | DELETE /templates/{id} | 删除相关的模板 |
AthenaManagementApis.AICreationApi | getArticle | GET /articles/{id} | 查询自动生成文章的详情 |
AthenaManagementApis.AICreationApi | getTemplate | GET /templates/{id} | 查询创作模板详情 |
AthenaManagementApis.AICreationApi | getWriting | GET /writings/{id} | 查询writing的详情 |
AthenaManagementApis.AICreationApi | listArticles | GET /articles | 根据用户电话号码查询、标题查询生成的文章列表或者导出csv文件 |
AthenaManagementApis.AICreationApi | listTemplates | GET /templates | 根据类型、状态查询模板 |
AthenaManagementApis.AICreationApi | listWritings | GET /writings | 根据用户Id,模板类型,状态,利益点,品牌名,品类,产品名,时间范围查询writing列表,根据format参数选择返回数据的类型 |
AthenaManagementApis.AICreationApi | updateArticle | PUT /articles/{id} | 更新模板自动生成文案的详情 |
AthenaManagementApis.AICreationApi | updateTemplate | PUT /templates/{id} | 修改创作模板内容 |
AthenaManagementApis.AICreationApi | updateWriting | PUT /writings/{id} | 更新writing的内容 |
AthenaManagementApis.AccountApi | deletePlan | DELETE /plans/{id} | 根据账户套餐id删除账户套餐 |
AthenaManagementApis.AccountApi | getAccount | GET /accounts/{id} | 查询用户详细信息 |
AthenaManagementApis.AccountApi | getAccountAvailablePlans | GET /accounts/{id}/plans | 查询用户可用的套餐 |
AthenaManagementApis.AccountApi | listAccounts | GET /accounts | 根据电话号码、用户名查询用户列表 |
AthenaManagementApis.AccountApi | updateAccount | PUT /accounts/{id} | 修改用户信息 |
AthenaManagementApis.AnalysisApi | getAnalysis | GET /analyses/{id} | 查询分析记录的详情 |
AthenaManagementApis.AnalysisApi | listAnalyses | GET /analyses | 根据用户号码、平台、报告名称查询分析记录 |
AthenaManagementApis.CollectionApi | getCollection | GET /collections/{id} | 查询内容包的详情 |
AthenaManagementApis.CollectionApi | listCollections | GET /collections | 根据用户电话、平台、关键词查询内容包列表 |
AthenaManagementApis.OrderApi | getOrder | GET /orders/{id} | 根据id查询订单 |
AthenaManagementApis.OrderApi | listOrders | GET /orders | 根据用户Id、会员套餐类型(服务应用类型,会员套餐级别,平台)、订单状态、创建时间查询账户订单列表 |
AthenaManagementApis.PlanApi | createPlan | POST /plans | 创建新的账号套餐 |
AthenaManagementApis.PlanApi | getPlan | GET /plans/{id} | 根据账户套餐id查询账户套餐 |
AthenaManagementApis.PlanApi | listPlans | GET /plans | 根据用户Id、状态、套餐类型(服务应用类型,会员套餐级别,平台)、购买时间查询账户套餐列表 |
AthenaManagementApis.PlanApi | updatePlan | PUT /plans/{id} | 更新账户套餐 |
AthenaManagementApis.TierApi | createTier | POST /tiers | 创建会员套餐 |
AthenaManagementApis.TierApi | deleteTier | DELETE /tiers/{id} | 删除会员套餐 |
AthenaManagementApis.TierApi | getTier | GET /tiers/{id} | 根据id查询会员套餐 |
AthenaManagementApis.TierApi | listTiers | GET /tiers | 根据application、平台、会员套餐级别查询会员套餐列表 |
AthenaManagementApis.TierApi | updateTier | PUT /tiers/{id} | 更新会员套餐 |
Documentation for Models
- AthenaManagementApis.Account
- AthenaManagementApis.AccountList
- AthenaManagementApis.AccountOrderBy
- AthenaManagementApis.Analysis
- AthenaManagementApis.AnalysisList
- AthenaManagementApis.AnalysisOrderBy
- AthenaManagementApis.AnalysisState
- AthenaManagementApis.Application
- AthenaManagementApis.Article
- AthenaManagementApis.ArticleRequest
- AthenaManagementApis.ArticlesList
- AthenaManagementApis.Brand
- AthenaManagementApis.CertificationType
- AthenaManagementApis.Collection
- AthenaManagementApis.CollectionList
- AthenaManagementApis.CreateArticleRequest
- AthenaManagementApis.CreatePlanRequest
- AthenaManagementApis.CreateTemplateRequest
- AthenaManagementApis.CreateTierRequest
- AthenaManagementApis.CreatorQuota
- AthenaManagementApis.EngagementLevel
- AthenaManagementApis.ErrorBody
- AthenaManagementApis.FansLevel
- AthenaManagementApis.FaultBody
- AthenaManagementApis.Filter
- AthenaManagementApis.Format
- AthenaManagementApis.InlineResponseDefault
- AthenaManagementApis.Order
- AthenaManagementApis.OrderList
- AthenaManagementApis.OrderOrderBy
- AthenaManagementApis.OrderState
- AthenaManagementApis.Ordering
- AthenaManagementApis.Pagination
- AthenaManagementApis.PayMethod
- AthenaManagementApis.Payment
- AthenaManagementApis.PaymentState
- AthenaManagementApis.Plan
- AthenaManagementApis.PlanList
- AthenaManagementApis.PlanOrderBy
- AthenaManagementApis.PlanStatus
- AthenaManagementApis.Platform
- AthenaManagementApis.StrategyQuota
- AthenaManagementApis.Template
- AthenaManagementApis.TemplateList
- AthenaManagementApis.TemplateStatus
- AthenaManagementApis.TemplateType
- AthenaManagementApis.Tier
- AthenaManagementApis.TierList
- AthenaManagementApis.TierType
- AthenaManagementApis.UpdateAccountRequest
- AthenaManagementApis.UpdateArticleRequest
- AthenaManagementApis.UpdatePlanRequest
- AthenaManagementApis.UpdateTemplateRequest
- AthenaManagementApis.UpdateTierRequest
- AthenaManagementApis.UpdateWritingRequest
- AthenaManagementApis.Writing
- AthenaManagementApis.WritingList
- AthenaManagementApis.WritingOrderBy
- AthenaManagementApis.WritingRequest
- AthenaManagementApis.WritingStatus
Documentation for Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
BearerAuth
- Type: Bearer authentication (Bearer)