approveapi 1.0.7 → 1.0.8

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/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/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/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.1
+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/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/docs/AnswerMetadata.md

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

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/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/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/docs/CreatePromptRequest.md

@@ -0,0 +1,19 @@
+# ApproveAPISwagger::CreatePromptRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** | The user to send the approval request to. Can be either an email address or a phone number. | 
+**body** | **String** | The body of the approval request to show the user. | 
+**title** | **String** | The title of an approval request. Defaults to an empty string. | [optional] 
+**approve_text** | **String** | The approve action text. Defaults to 'Approve'. | [optional] 
+**approve_redirect_url** | **String** | An HTTPS URL to redirect the user to if the prompt is approved. This URL is kept secret until the user is redirected to it. | [optional] 
+**reject_text** | **String** | The reject action text. If not specified the reject button will NOT be rendered, and the user will only see an approve action button. | [optional] 
+**reject_redirect_url** | **String** | An HTTPS URL to redirect the user to if the prompt is rejected. This URL is kept secret until the user is redirected to it. | [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] 
+**expires_in** | **Float** | The number of seconds until this request can no longer be answered. | [optional] 
+**metadata** | [**PromptMetadata**](PromptMetadata.md) |  | [optional] 
+**internal_data** | **Hash<String, String>** |  | [optional] 
+**idempotency_key** | **String** | Allows calling `create_prompt` multiple times idempotently, such that a prompt is sent at-most once. This key should contain sufficient randomness. Idempotent requests are stored for 24 hours. After that time, the same key will create a new request. | [optional] 
+
+

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/docs/Error.md

@@ -0,0 +1,8 @@
+# ApproveAPISwagger::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | A human readable API error message. | 
+
+

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/docs/Prompt.md

@@ -0,0 +1,13 @@
+# ApproveAPISwagger::Prompt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique id for this prompt. | 
+**sent_at** | **Float** | The unix timestamp when this prompt was sent. | 
+**is_expired** | **BOOLEAN** | Whether the prompt can still be answered. | 
+**request** | [**CreatePromptRequest**](CreatePromptRequest.md) |  | 
+**answer** | [**PromptAnswer**](PromptAnswer.md) |  | [optional] 
+**metadata** | [**PromptMetadata**](PromptMetadata.md) |  | [optional] 
+
+

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/docs/PromptAnswer.md

@@ -0,0 +1,10 @@
+# ApproveAPISwagger::PromptAnswer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **BOOLEAN** | The user's answer to whether or not they approve this prompt. | 
+**time** | **Float** | The unix timestamp when the user answered the prompt. | 
+**metadata** | [**AnswerMetadata**](AnswerMetadata.md) |  | [optional] 
+
+

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/docs/PromptMetadata.md

@@ -0,0 +1,12 @@
+# ApproveAPISwagger::PromptMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location** | **String** | The physical location, like Oakland, CA, of the action. | [optional] 
+**time** | **String** | The date/time of the action. | [optional] 
+**ip_address** | **String** | The IP address of the computer initiating the action. | [optional] 
+**browser** | **String** | The web browser initiating the action, i.e. Chrome. | [optional] 
+**operating_system** | **String** | The operating system initiating the action, i.e. Mac OS X. | [optional] 
+
+

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/docs/PromptStatus.md

@@ -0,0 +1,9 @@
+# ApproveAPISwagger::PromptStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_answered** | **BOOLEAN** | Whether the prompt has been answered or not. | 
+**is_expired** | **BOOLEAN** | Whether the prompt can still be answered. | 
+
+

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://openapi-generator.tech
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/lib/approveapi_swagger.rb

@@ -0,0 +1,47 @@
+=begin
+#ApproveAPISwagger
+
+#The simple API to request a user's approval on anything via email + sms.
+
+OpenAPI spec version: 1.0.1
+Contact: dev@approveapi.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-SNAPSHOT
+
+=end
+
+# Common files
+require 'approveapi_swagger/api_client'
+require 'approveapi_swagger/api_error'
+require 'approveapi_swagger/version'
+require 'approveapi_swagger/configuration'
+
+# Models
+require 'approveapi_swagger/models/answer_metadata'
+require 'approveapi_swagger/models/create_prompt_request'
+require 'approveapi_swagger/models/error'
+require 'approveapi_swagger/models/prompt'
+require 'approveapi_swagger/models/prompt_answer'
+require 'approveapi_swagger/models/prompt_metadata'
+require 'approveapi_swagger/models/prompt_status'
+
+# APIs
+require 'approveapi_swagger/api/approve_api'
+
+module ApproveAPISwagger
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ApproveAPISwagger.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.6.0/gems/approveapi_swagger-1.0.6/lib/approveapi_swagger/api/approve_api.rb

@@ -0,0 +1,186 @@
+=begin
+#ApproveAPISwagger
+
+#The simple API to request a user's approval on anything via email + sms.
+
+OpenAPI spec version: 1.0.1
+Contact: dev@approveapi.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module ApproveAPISwagger
+  class ApproveApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Sending a prompt
+    # Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
+    # @param create_prompt_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Prompt]
+    def create_prompt(create_prompt_request, opts = {})
+      data, _status_code, _headers = create_prompt_with_http_info(create_prompt_request, opts)
+      data
+    end
+
+    # Sending a prompt
+    # Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
+    # @param create_prompt_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Prompt, Fixnum, Hash)>] Prompt data, response status code and response headers
+    def create_prompt_with_http_info(create_prompt_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApproveApi.create_prompt ...'
+      end
+      # verify the required parameter 'create_prompt_request' is set
+      if @api_client.config.client_side_validation && create_prompt_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_prompt_request' when calling ApproveApi.create_prompt"
+      end
+      # resource path
+      local_var_path = '/prompt'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(create_prompt_request)
+      auth_names = ['apiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Prompt')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApproveApi#create_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve a prompt
+    # Retrieve the prompt object with the given ID.
+    # @param id The identifier for a pending or completed prompt. This is returned when you create a prompt.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :long_poll If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.
+    # @return [Prompt]
+    def get_prompt(id, opts = {})
+      data, _status_code, _headers = get_prompt_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve a prompt
+    # Retrieve the prompt object with the given ID.
+    # @param id The identifier for a pending or completed prompt. This is returned when you create a prompt.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :long_poll If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.
+    # @return [Array<(Prompt, Fixnum, Hash)>] Prompt data, response status code and response headers
+    def get_prompt_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApproveApi.get_prompt ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ApproveApi.get_prompt"
+      end
+      # resource path
+      local_var_path = '/prompt/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'long_poll'] = opts[:'long_poll'] if !opts[:'long_poll'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Prompt')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApproveApi#get_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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.
+    # @param id The prompt identifier.
+    # @param [Hash] opts the optional parameters
+    # @return [PromptStatus]
+    def get_prompt_status(id, opts = {})
+      data, _status_code, _headers = get_prompt_status_with_http_info(id, opts)
+      data
+    end
+
+    # 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.
+    # @param id The prompt identifier.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PromptStatus, Fixnum, Hash)>] PromptStatus data, response status code and response headers
+    def get_prompt_status_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApproveApi.get_prompt_status ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ApproveApi.get_prompt_status"
+      end
+      # resource path
+      local_var_path = '/prompt/{id}/status'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PromptStatus')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApproveApi#get_prompt_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end