mtutor_one_api_client_dev v1.0.0
mtutor_one_api_client_dev
MtutorOneApiClientDev - JavaScript client for mtutor_one_api_client_dev 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.0
- Package version: 1.0.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 mtutor_one_api_client_dev --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 mtutor_one_api_client_dev from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('mtutor_one_api_client_dev')
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/mtutor_one_api_client_dev then install it via:
npm install YOUR_USERNAME/mtutor_one_api_client_dev --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 MtutorOneApiClientDev = require('mtutor_one_api_client_dev');
var defaultClient = MtutorOneApiClientDev.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"
var api = new MtutorOneApiClientDev.EssayApi()
var jobId = "jobId_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.essayReceive(jobId, callback);
Documentation for API Endpoints
All URIs are relative to https://dev-service.mtutor.engkoo.com
Class | Method | HTTP request | Description |
---|---|---|---|
MtutorOneApiClientDev.EssayApi | essayReceive | GET /api/OneAPI?engineId=68858D5B-4999-4099-A5B9-45F3EE222246 | |
MtutorOneApiClientDev.EssayApi | essaySubmit | POST /api/OneAPI?engineId=68858D5B-4999-4099-A5B9-45F3EE222246 | |
MtutorOneApiClientDev.KeywordApi | keywordReceive | GET /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&keywordspotting | |
MtutorOneApiClientDev.KeywordApi | keywordSubmit | POST /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&keywordspotting | |
MtutorOneApiClientDev.NativeKidApi | nativeKidReceive | GET /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&native-kid-16k | |
MtutorOneApiClientDev.NativeKidApi | nativeKidSubmit | POST /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&native-kid-16k | |
MtutorOneApiClientDev.OauthApi | oauth | POST /oauth/login | |
MtutorOneApiClientDev.PronunciationApi | receive | GET /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE | |
MtutorOneApiClientDev.PronunciationApi | submit | POST /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE | |
MtutorOneApiClientDev.ProsodicApi | prosodicReceive | GET /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&rate-speech&prosodic=1 | |
MtutorOneApiClientDev.ProsodicApi | prosodicSubmit | POST /api/OneAPI?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&rate-speech&prosodic=1 | |
MtutorOneApiClientDev.RateChatApi | rateChatReceive | GET /api/OneAPI?engineId=10C8E4E1-BA22-4D03-B786-440BA085C06A&multi-model=rate-chat&modelName=rate-chat | |
MtutorOneApiClientDev.RateChatApi | rateChatSubmit | POST /api/OneAPI?engineId=10C8E4E1-BA22-4D03-B786-440BA085C06A&multi-model=rate-chat&modelName=rate-chat |
Documentation for Models
- MtutorOneApiClientDev.AccessToken
- MtutorOneApiClientDev.EssayReceiveResponse
- MtutorOneApiClientDev.EssayReceiveResponseData
- MtutorOneApiClientDev.EssayReceiveResponseDataResult
- MtutorOneApiClientDev.EssayReceiveResponseDataResultV1
- MtutorOneApiClientDev.EssaySubmitRequest
- MtutorOneApiClientDev.EssaySubmitRequestData
- MtutorOneApiClientDev.KeywordSubmitRequest
- MtutorOneApiClientDev.KeywordSubmitRequestData
- MtutorOneApiClientDev.NativeKidSubmitRequest
- MtutorOneApiClientDev.NativeKidSubmitRequestData
- MtutorOneApiClientDev.PronunciationSubmitRequest
- MtutorOneApiClientDev.ProsodicSubmitRequest
- MtutorOneApiClientDev.ProsodicSubmitRequestData
- MtutorOneApiClientDev.RateChatReceiveResponse
- MtutorOneApiClientDev.RateChatReceiveResponseData
- MtutorOneApiClientDev.RateChatReceiveResponseDataResult
- MtutorOneApiClientDev.RateChatReceiveResponseDataResultSpeechDetails
- MtutorOneApiClientDev.RateChatReceiveResponseDataResultSpeechDetailsPhonDetails
- MtutorOneApiClientDev.RateChatReceiveResponseDataResultSpeechDetailsSyllDetails
- MtutorOneApiClientDev.RateChatReceiveResponseDataResultSpeechDetailsWordDetails
- MtutorOneApiClientDev.RateChatSubmitRequest
- MtutorOneApiClientDev.RateChatSubmitRequestData
- MtutorOneApiClientDev.ReceiveResponse
- MtutorOneApiClientDev.ReceiveResponseData
- MtutorOneApiClientDev.ReceiveResponseDataResult
- MtutorOneApiClientDev.ReceiveResponseDataResultDetail
- MtutorOneApiClientDev.SubmitResponse
- MtutorOneApiClientDev.SubmitResponseData
Documentation for Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
6 years ago