approveapi_swagger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54b1705a3c13f772a5ade7298e09ed30c2888514d8df397146bba7fc91dc2609
+  data.tar.gz: cfa7f0e50ef8c24481d5e6cddaf07f7f6476f7002f80db73eb6c16abe7e1f519
+SHA512:
+  metadata.gz: c2cc4d7e5166679dc59d0d14cc33bd896b0af07fa1bfae5554d9a79fe1a3e3acf295889b0188781d9b4067158a2ee35d14019e70977abdb4849199184303d019
+  data.tar.gz: 104ac051dfe45426b1f5f3faa4c61fbdef19cf380d6beb0ad86e90660bb2a6538412ad50cc501a8ff2b56e57c5da7748d90b825baefc60411b0480348c6e88ca

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    approveapi_swagger (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  approveapi_swagger!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,105 @@
+# 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](https://openapi-generator.tech) 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:
+
+```shell
+gem build approveapi_swagger.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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: https://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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#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 *https://approve.sh*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ApproveAPISwagger::ApproveApi* | [**create_prompt**](docs/ApproveApi.md#create_prompt) | **POST** /prompt | Sending a prompt
+*ApproveAPISwagger::ApproveApi* | [**get_prompt**](docs/ApproveApi.md#get_prompt) | **GET** /prompt/{id} | Retrieve a prompt
+*ApproveAPISwagger::ApproveApi* | [**get_prompt_status**](docs/ApproveApi.md#get_prompt_status) | **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
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/approveapi_swagger.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#ApproveAPISwagger
+
+#The simple API to request a user's approval on anything via email + sms.
+
+OpenAPI spec version: 1.0.0
+Contact: dev@approveapi.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "approveapi_swagger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "approveapi_swagger"
+  s.version     = ApproveAPISwagger::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["ApproveAPI"]
+  s.email       = ["hello@approveapi.com"]
+  s.homepage    = "https://approveapi.com"
+  s.summary     = "OpenAPI generated client, used internally by the official ruby client 'approveapi' gem."
+  s.description = "The simple API to request a user's approval on anything via email + sms."
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/AnswerMetadata.md

@@ -0,0 +1,10 @@
+# ApproveAPISwagger::AnswerMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operating_system** | **String** |  | [optional] 
+**ip_address** | **String** |  | [optional] 
+**browser** | **String** |  | [optional] 
+
+

data/docs/ApproveApi.md

@@ -0,0 +1,162 @@
+# ApproveAPISwagger::ApproveApi
+
+All URIs are relative to *https://approve.sh*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_prompt**](ApproveApi.md#create_prompt) | **POST** /prompt | Sending a prompt
+[**get_prompt**](ApproveApi.md#get_prompt) | **GET** /prompt/{id} | Retrieve a prompt
+[**get_prompt_status**](ApproveApi.md#get_prompt_status) | **GET** /prompt/{id}/status | Check prompt status
+
+
+# **create_prompt**
+> Prompt create_prompt(create_prompt_request)
+
+Sending a prompt
+
+Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
+
+### Example
+```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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_prompt_request** | [**CreatePromptRequest**](CreatePromptRequest.md)|  | 
+
+### Return type
+
+[**Prompt**](Prompt.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_prompt**
+> Prompt get_prompt(id, opts)
+
+Retrieve a prompt
+
+Retrieve the prompt object with the given ID.
+
+### Example
+```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
+id = 'id_example' # String | The identifier for a pending or completed prompt. This is returned when you create a prompt.
+opts = {
+  long_poll: true # BOOLEAN | If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.
+}
+
+begin
+  #Retrieve a prompt
+  result = api_instance.get_prompt(id, opts)
+  p result
+rescue ApproveAPISwagger::ApiError => e
+  puts "Exception when calling ApproveApi->get_prompt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The identifier for a pending or completed prompt. This is returned when you create a prompt. | 
+ **long_poll** | **BOOLEAN**| If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. | [optional] 
+
+### Return type
+
+[**Prompt**](Prompt.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_prompt_status**
+> PromptStatus get_prompt_status(id)
+
+Check prompt status
+
+Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.
+
+### Example
+```ruby
+# load the gem
+require 'approveapi_swagger'
+
+api_instance = ApproveAPISwagger::ApproveApi.new
+id = 'id_example' # String | The prompt identifier.
+
+begin
+  #Check prompt status
+  result = api_instance.get_prompt_status(id)
+  p result
+rescue ApproveAPISwagger::ApiError => e
+  puts "Exception when calling ApproveApi->get_prompt_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The prompt identifier. | 
+
+### Return type
+
+[**PromptStatus**](PromptStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/CreatePromptRequest.md

@@ -0,0 +1,14 @@
+# ApproveAPISwagger::CreatePromptRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** | The body of the approval request to show the user. | 
+**user** | **String** | The user to send the approval request to. Can be either an email address or a phone number. | 
+**title** | **String** | The title of an approval request. Defaults to an empty string. | [optional] 
+**reject_text** | **String** | The reject action text. Defaults to 'Reject'. | [optional] 
+**approve_text** | **String** | The approve action text. Defaults to 'Approve'. | [optional] 
+**metadata** | [**PromptMetadata**](PromptMetadata.md) |  | [optional] 
+**long_poll** | **BOOLEAN** | If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. | [optional] 
+
+