approveapi_swagger¶ ↑
ApproveAPISwagger
- the Ruby gem for the ApproveAPISwagger
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.0
-
Package version: 1.0.0
-
Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation¶ ↑
Build a gem¶ ↑
To build the Ruby code into a gem:
gem build approveapi_swagger.gemspec
Then either install the gem locally:
gem install ./approveapi_swagger-1.0.0.gem
(for development, run gem install --dev ./approveapi_swagger-1.0.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'approveapi_swagger', '~> 1.0.0'
Install from Git¶ ↑
If the Ruby gem is hosted at a git repository: github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'approveapi_swagger', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly¶ ↑
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started¶ ↑
Please follow the installation procedure and then run the following code: “`ruby
Load the gem¶ ↑
require 'approveapi_swagger'
Setup authorization¶ ↑
ApproveAPISwagger.configure
do |config| # Configure HTTP basic authorization: apiKey config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end
api_instance = ApproveAPISwagger::ApproveApi.new
create_prompt_request = ApproveAPISwagger::CreatePromptRequest.new
# CreatePromptRequest |
begin #Sending a prompt result = api_instance.create_prompt(create_prompt_request) p result rescue ApproveAPISwagger::ApiError
=> e puts “Exception when calling ApproveApi->create_prompt: #{e}” end
“`
Documentation for API Endpoints¶ ↑
All URIs are relative to approve.sh
Class | Method | HTTP request | Description ———— | ————- | ————- | ————- ApproveAPISwagger::ApproveApi | create_prompt | POST /prompt | Sending a prompt ApproveAPISwagger::ApproveApi | get_prompt | GET /prompt/id} | Retrieve a prompt ApproveAPISwagger::ApproveApi | {get_prompt_status | GET /prompt/{id}/status | Check prompt status
Documentation for Models¶ ↑
Documentation for Authorization¶ ↑
apiKey¶ ↑
-
Type: HTTP basic authentication