approveapi-swagger

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 project:

• API version: 1.0.1
• Package version: 1.0.5
• Build package: org.openapitools.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 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:

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 approveapi-swagger from, and run:

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:

    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, 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 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	POST /prompt	Sending a prompt
ApproveapiSwagger.ApproveApi	getPrompt	GET /prompt/{id}	Retrieve a prompt
ApproveapiSwagger.ApproveApi	getPromptStatus	GET /prompt/{id}/status	Check prompt status

Documentation for Models

• ApproveapiSwagger.AnswerMetadata
• ApproveapiSwagger.CreatePromptRequest
• ApproveapiSwagger.Error
• ApproveapiSwagger.Prompt
• ApproveapiSwagger.PromptAnswer
• ApproveapiSwagger.PromptMetadata
• ApproveapiSwagger.PromptStatus

Documentation for Authorization

apiKey

• Type: HTTP basic authentication