homie_api

HomieApi - JavaScript client for homie_api 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.v3.generators.javascript.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 homie_api --save

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 HomieApi = require('homie_api');
var defaultClient = HomieApi.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 HomieApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authLogoutPost(callback);

Documentation for API Endpoints

All URIs are relative to /api/homie

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- HomieApi.AuthApi | authLogoutPost | POST /auth/logout | HomieApi.AuthApi | authMeGet | GET /auth/me | HomieApi.AuthApi | authSigninPost | POST /auth/signin | HomieApi.AuthApi | authSigninSmsPost | POST /auth/signin-sms | HomieApi.AuthApi | authSignupPost | POST /auth/signup | HomieApi.AuthApi | authSignupSmsCheckPost | POST /auth/signup-sms-check | HomieApi.AuthApi | authSignupSmsPost | POST /auth/signup-sms | HomieApi.BalanceApi | balanceHistoryGet | GET /balance/history | HomieApi.DictionaryApi | dictCitiesCountryIdGet | GET /dict/cities/{country_id} | HomieApi.DictionaryApi | dictClothingSizesGet | GET /dict/clothing-sizes | HomieApi.DictionaryApi | dictCountriesGet | GET /dict/countries | HomieApi.DictionaryApi | dictCurrenciesGet | GET /dict/currencies | HomieApi.DictionaryApi | dictMissionStatusesGet | GET /dict/mission-statuses | HomieApi.DictionaryApi | dictTransactionTypesGet | GET /dict/transaction-types | HomieApi.MissionsApi | missionIdCompletePost | POST /mission/{id}/complete | HomieApi.MissionsApi | missionIdUnassignPost | POST /mission/{id}/unassign | HomieApi.MissionsApi | missionListGet | GET /mission/list | HomieApi.MissionsAvailableApi | missionAvailableIdAssignPost | POST /mission-available/{id}/assign | HomieApi.MissionsAvailableApi | missionAvailableListGet | GET /mission-available/list | HomieApi.VerificationApi | verificationCheckGet | GET /verification/check | HomieApi.VerificationApi | verificationRetryPatch | PATCH /verification/retry |

Documentation for Models

• HomieApi.AuthMeResponse
• HomieApi.AuthSigninRequest
• HomieApi.AuthSigninResponse
• HomieApi.AuthSigninSmsRequest
• HomieApi.AuthSigninSmsResponse
• HomieApi.AuthSignupRequest
• HomieApi.AuthSignupSmsCheckRequest
• HomieApi.AuthSignupSmsCheckResponse
• HomieApi.AuthSignupSmsRequest
• HomieApi.AuthSignupSmsResponse
• HomieApi.BalanceHistoryItem
• HomieApi.BalanceHistoryResponse
• HomieApi.DictCitiesItem
• HomieApi.DictCitiesResponse
• HomieApi.DictClothingSizesResponse
• HomieApi.DictCountriesItem
• HomieApi.DictCountriesResponse
• HomieApi.DictCurrenciesItem
• HomieApi.DictCurrenciesResponse
• HomieApi.DictMissionStatusesResponse
• HomieApi.DictTransactionTypesResponse
• HomieApi.MissionAvailableListItem
• HomieApi.MissionAvailableListResponse
• HomieApi.MissionListItem
• HomieApi.MissionListResponse
• HomieApi.TypesPoint
• HomieApi.UtilsValidatorResponse
• HomieApi.VerificationCheckResponse
• HomieApi.VerificationRetryRequest

Documentation for Authorization

Bearer

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