# approveapi-swagger

ApproveapiSwagger - JavaScript client for approveapi-swagger
The simple API to request a user's approval on anything via email + sms.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.1
- Package version: 1.0.5
- 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 approveapi-swagger --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:

```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
```

Finally, switch to the directory you want to use your approveapi-swagger from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('approveapi-swagger')` 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/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, that's to say your javascript file where you actually 
use this library):

```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 ApproveapiSwagger = require('approveapi-swagger');

var defaultClient = ApproveapiSwagger.ApiClient.instance;
// Configure HTTP basic authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.username = 'YOUR USERNAME'
apiKey.password = 'YOUR PASSWORD'

var api = new ApproveapiSwagger.ApproveApi()
var create_prompt_request = new ApproveapiSwagger.CreatePromptRequest(); // {CreatePromptRequest} 
api.createPrompt(create_prompt_request).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *https://approve.sh*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApproveapiSwagger.ApproveApi* | [**createPrompt**](docs/ApproveApi.md#createPrompt) | **POST** /prompt | Sending a prompt
*ApproveapiSwagger.ApproveApi* | [**getPrompt**](docs/ApproveApi.md#getPrompt) | **GET** /prompt/{id} | Retrieve a prompt
*ApproveapiSwagger.ApproveApi* | [**getPromptStatus**](docs/ApproveApi.md#getPromptStatus) | **GET** /prompt/{id}/status | Check prompt status


## Documentation for Models

 - [ApproveapiSwagger.AnswerMetadata](docs/AnswerMetadata.md)
 - [ApproveapiSwagger.CreatePromptRequest](docs/CreatePromptRequest.md)
 - [ApproveapiSwagger.Error](docs/Error.md)
 - [ApproveapiSwagger.Prompt](docs/Prompt.md)
 - [ApproveapiSwagger.PromptAnswer](docs/PromptAnswer.md)
 - [ApproveapiSwagger.PromptMetadata](docs/PromptMetadata.md)
 - [ApproveapiSwagger.PromptStatus](docs/PromptStatus.md)


## Documentation for Authorization


### apiKey

- **Type**: HTTP basic authentication