npm.io
0.0.34 • Published 8 years ago

campaign_ap_is

Licence
MIT
Version
0.0.34
Deps
1
Size
604 kB
Vulns
1
Weekly
0

campaign_ap_is

CampaignApIs - JavaScript client for campaign_ap_is No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 1.0
  • Build package: io.swagger.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 campaign_ap_is --save
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

Finally, switch to the directory you want to use your campaign_ap_is from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('campaign_ap_is') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/campaign_ap_is --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, that's to say your javascript file where you actually use this library):

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 CampaignApIs = require('campaign_ap_is');

var defaultClient = CampaignApIs.ApiClient.instance;

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

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN"

// Configure API key authorization: SubscriptionKey
var SubscriptionKey = defaultClient.authentications['SubscriptionKey'];
SubscriptionKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//SubscriptionKey.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

var api = new CampaignApIs.AlipayApi()

var opts = { 
  'value': new CampaignApIs.SubmitModel(), // {SubmitModel} 
  'apiVersion': "apiVersion_example" // {String} 
};

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

Documentation for API Endpoints

All URIs are relative to https://campaigncore-gameresourcev5.chinacloudsites.cn

Class Method HTTP request Description
CampaignApIs.AlipayApi alipaySubmit POST /Alipay/Submit 支付宝提交页
CampaignApIs.CrowdFundApi crowdFundChangeStatus POST /CrowdFund/ChangeStatus 应援 - 更新状态
CampaignApIs.CrowdFundApi crowdFundDetail GET /CrowdFund/Detail 应援 - 详情
CampaignApIs.CrowdFundApi crowdFundEditProof PUT /CrowdFund/EditProof 修改凭证
CampaignApIs.CrowdFundApi crowdFundGetRule GET /CrowdFund/GetRule 规则
CampaignApIs.CrowdFundApi crowdFundList GET /CrowdFund/List 应援 - 总列表
CampaignApIs.CrowdFundApi crowdFundOrganizeList GET /CrowdFund/OrganizeList 应援 - 我发起列表
CampaignApIs.CrowdFundApi crowdFundOrganizer GET /CrowdFund/Organizer 应援 - 发起者详情
CampaignApIs.CrowdFundApi crowdFundParticipateList GET /CrowdFund/ParticipateList 应援 - 我参与列表
CampaignApIs.CrowdFundApi crowdFundPledge POST /CrowdFund/Pledge 应援 - 捐款 - 新增
CampaignApIs.CrowdFundApi crowdFundPledgeRankingList GET /CrowdFund/PledgeRankingList 应援 - 捐款 - 排行榜
CampaignApIs.CrowdFundApi crowdFundPledgeStatus GET /CrowdFund/PledgeStatus 应援 - 捐款 - 状态
CampaignApIs.CrowdFundApi crowdFundPledges GET /CrowdFund/Pledges 应援 - 捐款 - 列表
CampaignApIs.CrowdFundApi crowdFundPost POST /CrowdFund/Post 应援 - 新增
CampaignApIs.CrowdFundApi crowdFundProof POST /CrowdFund/Proof 新增凭证
CampaignApIs.CrowdFundApi crowdFundPut PUT /CrowdFund/Put 应援 - 修改
CampaignApIs.CrowdFundApi crowdFundReport POST /CrowdFund/Report 新增举报
CampaignApIs.CrowdFundApi crowdFundReportList GET /CrowdFund/ReportList 举报列表
CampaignApIs.CrowdFundApi crowdFundRule POST /CrowdFund/Rule 新增规则
CampaignApIs.CrowdFundApi crowdFundSetPledgeStatus PUT /CrowdFund/SetPledgeStatusAsync 应援 - 捐款 - 更新状态
CampaignApIs.CrowdFundApi crowdFundShareCount POST /CrowdFund/ShareCount 分享数据
CampaignApIs.CrowdFundApi crowdFundViewCount POST /CrowdFund/ViewCount 浏览数据
CampaignApIs.CrowdFundApi crowdFundWithdraw POST /CrowdFund/Withdraw 应援 - 发起收款
CampaignApIs.DrawingApi drawingAnswer POST /Drawing/Answer
CampaignApIs.DrawingApi drawingAnswerList GET /Drawing/AnswerList
CampaignApIs.DrawingApi drawingDrawingList GET /Drawing/DrawingList
CampaignApIs.DrawingApi drawingPost POST /Drawing/Post
CampaignApIs.GameApi gameAddImage POST /Game/AddImage add image to instance
CampaignApIs.GameApi gameCodes GET /Game/Codes 游戏 - 错误码表
CampaignApIs.GameApi gameDelete DELETE /Game/Delete 游戏 - 删除
CampaignApIs.GameApi gameDeleteImage DELETE /Game/DeleteImage Delete game image
CampaignApIs.GameApi gameDeleteInstance DELETE /Game/DeleteInstance Delete game instance
CampaignApIs.GameApi gameDetail GET /Game/Detail 游戏 - 详情
CampaignApIs.GameApi gameEditInstance PUT /Game/EditInstance Edit game instance
CampaignApIs.GameApi gameGet GET /Game/Get 游戏 - 列表
CampaignApIs.GameApi gameInstance GET /Game/Instance Get game instance
CampaignApIs.GameApi gameInstances GET /Game/Instances Get game instances
CampaignApIs.GameApi gamePost POST /Game/Post 游戏 - 创建
CampaignApIs.GameApi gamePostInstance POST /Game/PostInstance Create new game instance
CampaignApIs.GameApi gamePut PUT /Game/Put 游戏 - 更新
CampaignApIs.GeneralApi generalCheckIn POST /General/CheckIn 地点打卡
CampaignApIs.GeneralApi generalCheckInRanking GET /General/CheckInRanking 打卡排名
CampaignApIs.GeneralApi generalIndividualRanking GET /General/IndividualRanking 用户个人排名
CampaignApIs.GeneralApi generalPostRanking POST /General/PostRanking 新增/更新得分
CampaignApIs.GeneralApi generalRanking GET /General/GetRanking 排行榜
CampaignApIs.GeneralApi generalSendSms POST /General/SendSms 发送短信 (服务商:https://sendcloud.sohu.com)
CampaignApIs.GeneralApi generalUploadImage POST /General/UploadImage 上传照片
CampaignApIs.GeneralApi generalVerifyPhone POST /General/VerifyPhone 验证手机号
CampaignApIs.WechatApi wechatAccessToken GET /Wechat/AccessToken 获取微信 Access Token
CampaignApIs.WechatApi wechatGetUserInfo GET /Wechat/GetUserInfo 用户信息
CampaignApIs.WechatApi wechatHeaderImage POST /Wechat/HeaderImage 下载微信头像
CampaignApIs.WechatApi wechatMiniProgramLogin GET /Wechat/MiniProgramLogin 登录微信小程序
CampaignApIs.WechatApi wechatMiniProgramSession GET /Wechat/MiniProgramSession 解码微信小程序信息
CampaignApIs.WechatApi wechatShareSignature GET /Wechat/ShareSignature 朋友圈分享签名

Documentation for Models

Documentation for Authorization

AccessToken
  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
OAuth2
SubscriptionKey
  • Type: API key
  • API key parameter name: Ocp-Apim-Subscription-Key
  • Location: HTTP header