docspring 1.0.0

data/docs/PendingTemplate.md

@@ -0,0 +1,22 @@
+# DocSpring::PendingTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_interval** | **String** |  | [optional] 
+**webhook_url** | **String** |  | [optional] 
+**parent_folder_id** | **String** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
+**allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**public_submissions** | **BOOLEAN** |  | [optional] 
+**slack_webhook_url** | **String** |  | [optional] 
+**path** | **String** |  | [optional] 
+**public_web_form** | **BOOLEAN** |  | [optional] 
+**editable_submissions** | **BOOLEAN** |  | [optional] 
+**expire_submissions** | **BOOLEAN** |  | [optional] 
+**name** | **String** |  | [optional] 
+**template_type** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+
+

data/docs/RenameFolderData.md

@@ -0,0 +1,8 @@
+# DocSpring::RenameFolderData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+
+

data/docs/Submission.md

@@ -0,0 +1,21 @@
+# DocSpring::Submission
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**template_id** | **String** |  | [optional] 
+**test** | **BOOLEAN** |  | 
+**editable** | **BOOLEAN** |  | [optional] 
+**expired** | **BOOLEAN** |  | 
+**expires_at** | **String** |  | [optional] 
+**processed_at** | **String** |  | [optional] 
+**state** | **String** |  | 
+**metadata** | **Object** |  | [optional] 
+**download_url** | **String** |  | [optional] 
+**permanent_download_url** | **String** |  | [optional] 
+**batch_id** | **String** |  | [optional] 
+**data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) |  | [optional] 
+**actions** | [**Array<SubmissionAction>**](SubmissionAction.md) |  | [optional] 
+
+

data/docs/SubmissionAction.md

@@ -0,0 +1,13 @@
+# DocSpring::SubmissionAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**integration_id** | **String** |  | 
+**state** | **String** |  | 
+**action_category** | **String** |  | 
+**action_type** | **String** |  | 
+**result_data** | **Object** |  | 
+
+

data/docs/SubmissionBatch.md

@@ -0,0 +1,16 @@
+# DocSpring::SubmissionBatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pending_count** | **Integer** |  | [optional] 
+**completion_percentage** | **Integer** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+**total_count** | **Integer** |  | [optional] 
+**submissions** | [**Array<Submission>**](Submission.md) |  | [optional] 
+**processed_at** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**error_count** | **Integer** |  | [optional] 
+
+

data/docs/SubmissionBatchData.md

@@ -0,0 +1,11 @@
+# DocSpring::SubmissionBatchData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **Object** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
+**template_id** | **String** |  | [optional] 
+**submissions** | [**Array<SubmissionDataBatchRequest>**](SubmissionDataBatchRequest.md) |  | 
+
+

data/docs/SubmissionData.md

@@ -0,0 +1,13 @@
+# DocSpring::SubmissionData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | **BOOLEAN** |  | [optional] 
+**data** | **Object** |  | 
+**html** | **String** |  | [optional] 
+**css** | **String** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+**data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) |  | [optional] 
+
+

data/docs/SubmissionDataBatchRequest.md

@@ -0,0 +1,13 @@
+# DocSpring::SubmissionDataBatchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**css** | **String** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
+**data** | **Object** |  | [optional] 
+**template_id** | **String** |  | [optional] 
+**html** | **String** |  | [optional] 
+
+

data/docs/SubmissionDataRequest.md

@@ -0,0 +1,24 @@
+# DocSpring::SubmissionDataRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**email** | **String** |  | 
+**order** | **Integer** |  | 
+**fields** | **Array<String>** |  | 
+**metadata** | **Object** |  | 
+**state** | **String** |  | 
+**viewed_at** | **String** |  | [optional] 
+**completed_at** | **String** |  | [optional] 
+**auth_type** | **String** |  | [optional] 
+**auth_second_factor_type** | **String** |  | [optional] 
+**auth_provider** | **String** |  | [optional] 
+**auth_session_started_at** | **String** |  | [optional] 
+**auth_session_id_hash** | **String** |  | [optional] 
+**auth_user_id_hash** | **String** |  | [optional] 
+**auth_username_hash** | **String** |  | [optional] 
+**auth_phone_number_hash** | **String** |  | [optional] 
+
+

data/docs/Template.md

@@ -0,0 +1,25 @@
+# DocSpring::Template
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_interval** | **String** |  | [optional] 
+**webhook_url** | **String** |  | [optional] 
+**parent_folder_id** | **String** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
+**allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**public_submissions** | **BOOLEAN** |  | [optional] 
+**slack_webhook_url** | **String** |  | [optional] 
+**path** | **String** |  | [optional] 
+**public_web_form** | **BOOLEAN** |  | [optional] 
+**editable_submissions** | **BOOLEAN** |  | [optional] 
+**expire_submissions** | **BOOLEAN** |  | [optional] 
+**name** | **String** |  | [optional] 
+**permanent_document_url** | **String** |  | [optional] 
+**template_type** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**page_dimensions** | **Array<Array<Float>>** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+**document_url** | **String** |  | [optional] 
+
+

data/docs/Templatesv2Template.md

@@ -0,0 +1,19 @@
+# DocSpring::Templatesv2Template
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_interval** | **String** |  | [optional] 
+**public_web_form** | **BOOLEAN** |  | [optional] 
+**webhook_url** | **String** |  | [optional] 
+**editable_submissions** | **BOOLEAN** |  | [optional] 
+**expire_submissions** | **BOOLEAN** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
+**allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**document** | [**Templatesv2TemplateDocument**](Templatesv2TemplateDocument.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**public_submissions** | **BOOLEAN** |  | [optional] 
+**slack_webhook_url** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+
+

data/docs/Templatesv2TemplateDocument.md

@@ -0,0 +1,10 @@
+# DocSpring::Templatesv2TemplateDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**Templatesv2TemplateDocumentMetadata**](Templatesv2TemplateDocumentMetadata.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**storage** | **String** |  | [optional] 
+
+

data/docs/Templatesv2TemplateDocumentMetadata.md

@@ -0,0 +1,10 @@
+# DocSpring::Templatesv2TemplateDocumentMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **String** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**mime_type** | **String** |  | [optional] 
+
+

data/docs/UpdateDataRequestResponse.md

@@ -0,0 +1,10 @@
+# DocSpring::UpdateDataRequestResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_request** | [**SubmissionDataRequest**](SubmissionDataRequest.md) |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/UpdateSubmissionDataRequestData.md

@@ -0,0 +1,20 @@
+# DocSpring::UpdateSubmissionDataRequestData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**order** | **Integer** |  | [optional] 
+**fields** | **Array<String>** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+**auth_type** | **String** |  | [optional] 
+**auth_second_factor_type** | **String** |  | [optional] 
+**auth_provider** | **String** |  | [optional] 
+**auth_session_started_at** | **String** |  | [optional] 
+**auth_session_id_hash** | **String** |  | [optional] 
+**auth_user_id_hash** | **String** |  | [optional] 
+**auth_username_hash** | **String** |  | [optional] 
+**auth_phone_number_hash** | **String** |  | [optional] 
+
+

data/docspring.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "docspring/version"
+
+Gem::Specification.new do |s|
+  s.name        = "docspring"
+  s.version     = DocSpring::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Form Applications, Inc."]
+  s.email       = ["support@docspring.com"]
+  s.homepage    = "https://github.com/DocSpring/docspring-ruby"
+  s.summary     = "DocSpring API Client"
+  s.description = "Client library for the DocSpring PDF generation and e-signature service"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'ffi', '~> 1.0', '>= 1.9.24'
+  s.add_runtime_dependency 'json', '>= 1.8'
+
+  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'
+
+  # Use git ls-files to ignore anything in .gitignore
+  s.files         = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `git ls-files spec test`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/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/lib/docspring.rb

@@ -0,0 +1,82 @@
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+# Common files
+require 'docspring/api_client'
+require 'docspring/api_error'
+require 'docspring/version'
+require 'docspring/configuration'
+
+# Models
+require 'docspring/models/authentication_error'
+require 'docspring/models/authentication_success_response'
+require 'docspring/models/combine_pdfs_data'
+require 'docspring/models/combined_submission'
+require 'docspring/models/combined_submission_action'
+require 'docspring/models/combined_submission_data'
+require 'docspring/models/create_combined_submission_response'
+require 'docspring/models/create_custom_file_data'
+require 'docspring/models/create_custom_file_response'
+require 'docspring/models/create_folder_data'
+require 'docspring/models/create_submission_batch_response'
+require 'docspring/models/create_submission_batch_submissions_response'
+require 'docspring/models/create_submission_data_request_data'
+require 'docspring/models/create_submission_data_request_token_response'
+require 'docspring/models/create_submission_data_request_token_response_token'
+require 'docspring/models/create_submission_response'
+require 'docspring/models/create_template_data'
+require 'docspring/models/custom_file'
+require 'docspring/models/error'
+require 'docspring/models/folder'
+require 'docspring/models/folders_folder'
+require 'docspring/models/invalid_request'
+require 'docspring/models/move_folder_data'
+require 'docspring/models/move_template_data'
+require 'docspring/models/pending_template'
+require 'docspring/models/rename_folder_data'
+require 'docspring/models/submission'
+require 'docspring/models/submission_action'
+require 'docspring/models/submission_batch'
+require 'docspring/models/submission_batch_data'
+require 'docspring/models/submission_data'
+require 'docspring/models/submission_data_batch_request'
+require 'docspring/models/submission_data_request'
+require 'docspring/models/template'
+require 'docspring/models/templatesv2_template'
+require 'docspring/models/templatesv2_template_document'
+require 'docspring/models/templatesv2_template_document_metadata'
+require 'docspring/models/update_data_request_response'
+require 'docspring/models/update_submission_data_request_data'
+
+# APIs
+require 'docspring/api/pdf_api'
+
+# Custom client
+require 'docspring/api/client'
+
+module DocSpring
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DocSpring.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