signwell_sdk

SignWell - the Ruby gem for the SignWell Developer API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

API version: v1
Package version: 0.1.0
Generator version: 7.12.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build signwell_sdk.gemspec

Then either install the gem locally:

gem install ./signwell_sdk-0.1.0.gem

(for development, run gem install --dev ./signwell_sdk-0.1.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 'signwell_sdk', '~> 0.1.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 'signwell_sdk', :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:

# Load the gem
require 'signwell_sdk'

# Setup authorization
SignWell.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['X-Api-Key'] = '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['X-Api-Key'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = SignWell::APIApplicationApi.new
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 

begin
  #Delete API Application
  api_instance.delete_api_application(id)
rescue SignWell::ApiError => e
  puts "Exception when calling APIApplicationApi->delete_api_application: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://www.signwell.com

Class	Method	HTTP request	Description
SignWell::APIApplicationApi	delete_api_application	DELETE /api/v1/api_applications/id	Delete API Application
SignWell::APIApplicationApi	get_api_application	GET /api/v1/api_applications/id	Get API Application
SignWell::BulkSendApi	create_bulk_send	POST /api/v1/bulk_sends	Create Bulk Send
SignWell::BulkSendApi	get_bulk_send	GET /api/v1/bulk_sends/id	Get Bulk Send
SignWell::BulkSendApi	get_bulk_send_csv_template	GET /api/v1/bulk_sends/csv_template	Get Bulk Send CSV Template
SignWell::BulkSendApi	get_bulk_send_documents	GET /api/v1/bulk_sends/id/documents	Get Bulk Send Documents
SignWell::BulkSendApi	list_bulk_sends	GET /api/v1/bulk_sends	List Bulk Sendings
SignWell::BulkSendApi	validate_bulk_send_csv	POST /api/v1/bulk_sends/validate_csv	Validate Bulk Send CSV
SignWell::DocumentApi	create_document	POST /api/v1/documents	Create Document
SignWell::DocumentApi	create_document_from_template	POST /api/v1/document_templates/documents	Create Document from Template
SignWell::DocumentApi	delete_document	DELETE /api/v1/documents/id	Delete Document
SignWell::DocumentApi	get_completed_pdf	GET /api/v1/documents/id/completed_pdf	Completed PDF
SignWell::DocumentApi	get_document	GET /api/v1/documents/id	Get Document
SignWell::DocumentApi	send_document	POST /api/v1/documents/id/send	Update and Send Document
SignWell::DocumentApi	send_reminder	POST /api/v1/documents/id/remind	Send Reminder
SignWell::MeApi	get_me	GET /api/v1/me	Get credentials
SignWell::TemplateApi	create_template	POST /api/v1/document_templates	Create Template
SignWell::TemplateApi	delete_template	DELETE /api/v1/document_templates/id	Delete Template
SignWell::TemplateApi	get_template	GET /api/v1/document_templates/id	Get Template
SignWell::TemplateApi	update_template	PUT /api/v1/document_templates/id	Update Template
SignWell::WebhooksApi	create_webhook	POST /api/v1/hooks	Create Webhook
SignWell::WebhooksApi	delete_webhook	DELETE /api/v1/hooks/id	Delete Webhook
SignWell::WebhooksApi	list_webhooks	GET /api/v1/hooks	List Webhooks