mtutor_one_api_client v1.0.1

mtutor_one_api_client

MtutorOneApiClient - JavaScript client for mtutor_one_api_client 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 --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 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('mtutor_one_api_client') 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 then install it via:

    npm install YOUR_USERNAME/mtutor_one_api_client --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 MtutorOneApiClient = require('mtutor_one_api_client');

var defaultClient = MtutorOneApiClient.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 MtutorOneApiClient.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://api-service.mtutor.engkoo.com

Documentation for Models

• MtutorOneApiClient.AccessToken
• MtutorOneApiClient.EssayReceiveResponse
• MtutorOneApiClient.EssayReceiveResponseData
• MtutorOneApiClient.EssayReceiveResponseDataResult
• MtutorOneApiClient.EssayReceiveResponseDataResultV1
• MtutorOneApiClient.EssaySubmitRequest
• MtutorOneApiClient.EssaySubmitRequestData
• MtutorOneApiClient.KeywordSubmitRequest
• MtutorOneApiClient.KeywordSubmitRequestData
• MtutorOneApiClient.NativeKidSubmitRequest
• MtutorOneApiClient.NativeKidSubmitRequestData
• MtutorOneApiClient.PronunciationSubmitRequest
• MtutorOneApiClient.ProsodicSubmitRequest
• MtutorOneApiClient.ProsodicSubmitRequestData
• MtutorOneApiClient.RateChatReceiveResponse
• MtutorOneApiClient.RateChatReceiveResponseData
• MtutorOneApiClient.RateChatReceiveResponseDataResult
• MtutorOneApiClient.RateChatReceiveResponseDataResultSpeechDetails
• MtutorOneApiClient.RateChatReceiveResponseDataResultSpeechDetailsPhonDetails
• MtutorOneApiClient.RateChatReceiveResponseDataResultSpeechDetailsSyllDetails
• MtutorOneApiClient.RateChatReceiveResponseDataResultSpeechDetailsWordDetails
• MtutorOneApiClient.RateChatSubmitRequest
• MtutorOneApiClient.RateChatSubmitRequestData
• MtutorOneApiClient.ReceiveResponse
• MtutorOneApiClient.ReceiveResponseData
• MtutorOneApiClient.ReceiveResponseDataResult
• MtutorOneApiClient.ReceiveResponseDataResultDetail
• MtutorOneApiClient.SubmitResponse
• MtutorOneApiClient.SubmitResponseData

Documentation for Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header