signrequest_client 0.1.0

data/docs/WebhooksApi.md

@@ -0,0 +1,340 @@
+# SignRequestClient::WebhooksApi
+
+All URIs are relative to *https://signrequest.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**webhooks_create**](WebhooksApi.md#webhooks_create) | **POST** /webhooks/ | 
+[**webhooks_delete**](WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ | 
+[**webhooks_list**](WebhooksApi.md#webhooks_list) | **GET** /webhooks/ | 
+[**webhooks_partial_update**](WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ | 
+[**webhooks_read**](WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ | 
+[**webhooks_update**](WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ | 
+
+
+# **webhooks_create**
+> WebhookSubscription webhooks_create(data)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::WebhooksApi.new
+
+data = SignRequestClient::WebhookSubscription.new # WebhookSubscription | 
+
+
+begin
+  result = api_instance.webhooks_create(data)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**WebhookSubscription**](WebhookSubscription.md)|  | 
+
+### Return type
+
+[**WebhookSubscription**](WebhookSubscription.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_delete**
+> webhooks_delete(uuid, )
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::WebhooksApi.new
+
+uuid = "uuid_example" # String | 
+
+
+begin
+  api_instance.webhooks_delete(uuid, )
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_list**
+> InlineResponse2009 webhooks_list(opts)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::WebhooksApi.new
+
+opts = { 
+  page: 56, # Integer | A page number within the paginated result set.
+  limit: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  result = api_instance.webhooks_list(opts)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse2009**](InlineResponse2009.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_partial_update**
+> WebhookSubscription webhooks_partial_update(uuid, data)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::WebhooksApi.new
+
+uuid = "uuid_example" # String | 
+
+data = SignRequestClient::WebhookSubscription.new # WebhookSubscription | 
+
+
+begin
+  result = api_instance.webhooks_partial_update(uuid, data)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_partial_update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+ **data** | [**WebhookSubscription**](WebhookSubscription.md)|  | 
+
+### Return type
+
+[**WebhookSubscription**](WebhookSubscription.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_read**
+> WebhookSubscription webhooks_read(uuid, )
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::WebhooksApi.new
+
+uuid = "uuid_example" # String | 
+
+
+begin
+  result = api_instance.webhooks_read(uuid, )
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+
+### Return type
+
+[**WebhookSubscription**](WebhookSubscription.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_update**
+> WebhookSubscription webhooks_update(uuid, data)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::WebhooksApi.new
+
+uuid = "uuid_example" # String | 
+
+data = SignRequestClient::WebhookSubscription.new # WebhookSubscription | 
+
+
+begin
+  result = api_instance.webhooks_update(uuid, data)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+ **data** | [**WebhookSubscription**](WebhookSubscription.md)|  | 
+
+### Return type
+
+[**WebhookSubscription**](WebhookSubscription.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-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/lib/signrequest_client/api/api_tokens_api.rb

@@ -0,0 +1,242 @@
+=begin
+#SignRequest API
+
+#API for SignRequest.com
+
+OpenAPI spec version: v1
+Contact: tech-support@signrequest.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module SignRequestClient
+  class ApiTokensApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # 
+    # @param data 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthToken]
+    def api_tokens_create(data, opts = {})
+      data, _status_code, _headers = api_tokens_create_with_http_info(data, opts)
+      return data
+    end
+
+    # 
+    # 
+    # @param data 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthToken, Fixnum, Hash)>] AuthToken data, response status code and response headers
+    def api_tokens_create_with_http_info(data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ApiTokensApi.api_tokens_create ..."
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling ApiTokensApi.api_tokens_create"
+      end
+      # resource path
+      local_var_path = "/api-tokens/"
+
+      # 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(data)
+      auth_names = ['Token']
+      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 => 'AuthToken')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiTokensApi#api_tokens_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # 
+    # @param key A unique value identifying this api token.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def api_tokens_delete(key, opts = {})
+      api_tokens_delete_with_http_info(key, opts)
+      return nil
+    end
+
+    # 
+    # 
+    # @param key A unique value identifying this api token.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def api_tokens_delete_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ApiTokensApi.api_tokens_delete ..."
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling ApiTokensApi.api_tokens_delete"
+      end
+      # resource path
+      local_var_path = "/api-tokens/{key}/".sub('{' + 'key' + '}', key.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'])
+      # 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 = nil
+      auth_names = ['Token']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiTokensApi#api_tokens_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @return [InlineResponse200]
+    def api_tokens_list(opts = {})
+      data, _status_code, _headers = api_tokens_list_with_http_info(opts)
+      return data
+    end
+
+    # 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
+    def api_tokens_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ApiTokensApi.api_tokens_list ..."
+      end
+      # resource path
+      local_var_path = "/api-tokens/"
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # 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 = nil
+      auth_names = ['Token']
+      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 => 'InlineResponse200')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiTokensApi#api_tokens_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # 
+    # @param key A unique value identifying this api token.
+    # @param [Hash] opts the optional parameters
+    # @return [AuthToken]
+    def api_tokens_read(key, opts = {})
+      data, _status_code, _headers = api_tokens_read_with_http_info(key, opts)
+      return data
+    end
+
+    # 
+    # 
+    # @param key A unique value identifying this api token.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthToken, Fixnum, Hash)>] AuthToken data, response status code and response headers
+    def api_tokens_read_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ApiTokensApi.api_tokens_read ..."
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling ApiTokensApi.api_tokens_read"
+      end
+      # resource path
+      local_var_path = "/api-tokens/{key}/".sub('{' + 'key' + '}', key.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'])
+      # 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 = nil
+      auth_names = ['Token']
+      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 => 'AuthToken')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiTokensApi#api_tokens_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end