https://github.com/louis70109/lotifysampleapi
https://github.com/louis70109/lotifysampleapi
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/louis70109/lotifysampleapi
- Owner: louis70109
- Created: 2020-10-11T12:26:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-11T12:44:09.000Z (over 4 years ago)
- Last Synced: 2025-01-31T22:11:23.422Z (4 months ago)
- Language: JavaScript
- Size: 6.38 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lotify_sample_api
LotifySampleApi - JavaScript client for lotify_sample_api
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.0.1
- Package version: 0.0.1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
## Installation
### For [Node.js](https://nodejs.org/)
#### npm
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
Then install it via:
```shell
npm install lotify_sample_api --save
```
Finally, you need to build the module:
```shell
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:
```shell
npm install
```
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
```shell
npm link
```
To use the link you just defined in your project, switch to the directory you want to use your lotify_sample_api from, and run:
```shell
npm link /path/to/
```
Finally, you need to build the module:
```shell
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:
```shell
npm install GIT_USER_ID/GIT_REPO_ID --save
```
### For browser
The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
```shell
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:
```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following JS code:
```javascript
var LotifySampleApi = require('lotify_sample_api');
var api = new LotifySampleApi.CodeApi()
var body = new LotifySampleApi.CodeRequestBody(); // {CodeRequestBody} Code
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.codeChangeToken(body, callback);
```
## Documentation for API Endpoints
All URIs are relative to *https://mopcon-demo.herokuapp.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LotifySampleApi.CodeApi* | [**codeChangeToken**](docs/CodeApi.md#codeChangeToken) | **POST** /notify/change |
*LotifySampleApi.ImageApi* | [**sendImageFile**](docs/ImageApi.md#sendImageFile) | **POST** /notify/file |
*LotifySampleApi.ImageApi* | [**sendImageUrl**](docs/ImageApi.md#sendImageUrl) | **POST** /notify/url |
*LotifySampleApi.LinkApi* | [**getLink**](docs/LinkApi.md#getLink) | **POST** /notify/link |
*LotifySampleApi.RevokeApi* | [**revokeToken**](docs/RevokeApi.md#revokeToken) | **POST** /notify/revoke |
*LotifySampleApi.StickerApi* | [**sendSticker**](docs/StickerApi.md#sendSticker) | **POST** /notify/sticker |
*LotifySampleApi.TextApi* | [**sendText**](docs/TextApi.md#sendText) | **POST** /notify/send |
## Documentation for Models
- [LotifySampleApi.CodeRequestBody](docs/CodeRequestBody.md)
- [LotifySampleApi.CodeResponse](docs/CodeResponse.md)
- [LotifySampleApi.ImageUrlRequestBody](docs/ImageUrlRequestBody.md)
- [LotifySampleApi.LinkRequestBody](docs/LinkRequestBody.md)
- [LotifySampleApi.LinkResponse](docs/LinkResponse.md)
- [LotifySampleApi.NotifyResponse](docs/NotifyResponse.md)
- [LotifySampleApi.RevokeRequestBody](docs/RevokeRequestBody.md)
- [LotifySampleApi.StickerRequestBody](docs/StickerRequestBody.md)
- [LotifySampleApi.TextRequestBody](docs/TextRequestBody.md)
## Documentation for Authorization
All endpoints do not require authorization.