SignRequest Ruby Client
SignRequestClient - the offical Ruby client for SignRequest.com
Installation
Add this to the Gemfile:
gem 'signrequest_client', '~> 1.2.0'
And then run:
bundle install
API Documentation
Full API documentation, including code samples, can be found here: https://signrequest.com/api/v1/docs/
Getting Started
The client needs to be configured with an API token from your team api settings page.
# Setup authorization
SignRequestClient.configure do |config|
config.api_key['Authorization'] = 'YOUR API KEY'
config.api_key_prefix['Authorization'] = 'Token'
end
documents_api = SignRequestClient::DocumentsApi.new
document = SignRequestClient::Document.new
document.file_from_url = 'https://docs.google.com/document/d/1oI2R1SxfMNZXiz3jCQvorpoklF9xq_dCJnOpkI-zo80/edit?usp=sharing'
begin
result = documents_api.documents_create(document)
p result
rescue SignRequestClient::ApiError => e
puts "Exception when calling ApiTokensApi->api_tokens_create: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://signrequest.com/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
SignRequestClient::ApiTokensApi | api_tokens_list | GET /api-tokens/ | Retrieve a list of API tokens |
SignRequestClient::DocumentAttachmentsApi | document_attachments_create | POST /document-attachments/ | Create a Document Attachment |
SignRequestClient::DocumentAttachmentsApi | document_attachments_list | GET /document-attachments/ | Retrieve a list of Document Attachments |
SignRequestClient::DocumentAttachmentsApi | document_attachments_read | GET /document-attachments/{uuid}/ | Retrieve a Document Attachment |
SignRequestClient::DocumentsApi | documents_create | POST /documents/ | Create a Document |
SignRequestClient::DocumentsApi | documents_delete | DELETE /documents/{uuid}/ | Delete a Document |
SignRequestClient::DocumentsApi | documents_list | GET /documents/ | Retrieve a list of Documents |
SignRequestClient::DocumentsApi | documents_read | GET /documents/{uuid}/ | Retrieve a Document |
SignRequestClient::DocumentsSearchApi | documents_search_list | GET /documents-search/ | Search documents |
SignRequestClient::EventsApi | events_list | GET /events/ | Retrieve a list of Events |
SignRequestClient::EventsApi | events_read | GET /events/{id}/ | Retrieve an Event |
SignRequestClient::SignrequestQuickCreateApi | signrequest_quick_create_create | POST /signrequest-quick-create/ | Quick create a SignRequest |
SignRequestClient::SignrequestsApi | signrequests_cancel_signrequest | POST /signrequests/{uuid}/cancel_signrequest/ | Cancel a SignRequest |
SignRequestClient::SignrequestsApi | signrequests_create | POST /signrequests/ | Create a SignRequest |
SignRequestClient::SignrequestsApi | signrequests_list | GET /signrequests/ | Retrieve a list of SignRequests |
SignRequestClient::SignrequestsApi | signrequests_read | GET /signrequests/{uuid}/ | Retrieve a SignRequest |
SignRequestClient::SignrequestsApi | signrequests_resend_signrequest_email | POST /signrequests/{uuid}/resend_signrequest_email/ | Resend a SignRequest |
SignRequestClient::TeamMembersApi | team_members_list | GET /team-members/ | Retrieve a list of Team Members |
SignRequestClient::TeamMembersApi | team_members_read | GET /team-members/{uuid}/ | Retrieve a Team Member |
SignRequestClient::TeamsApi | teams_create | POST /teams/ | Create a Team |
SignRequestClient::TeamsApi | teams_delete | DELETE /teams/{subdomain}/ | Delete a Team |
SignRequestClient::TeamsApi | teams_invite_member | POST /teams/{subdomain}/invite_member/ | Invite a Team Member |
SignRequestClient::TeamsApi | teams_list | GET /teams/ | Retrieve a list of Teams |
SignRequestClient::TeamsApi | teams_partial_update | PATCH /teams/{subdomain}/ | Update a Team |
SignRequestClient::TeamsApi | teams_read | GET /teams/{subdomain}/ | Retrieve a Team |
SignRequestClient::TemplatesApi | templates_list | GET /templates/ | Retrieve a list of Templates |
SignRequestClient::TemplatesApi | templates_read | GET /templates/{uuid}/ | Retrieve a Template |
SignRequestClient::WebhooksApi | webhooks_create | POST /webhooks/ | Create a Webhook |
SignRequestClient::WebhooksApi | webhooks_delete | DELETE /webhooks/{uuid}/ | Delete a Webhook |
SignRequestClient::WebhooksApi | webhooks_list | GET /webhooks/ | Retrieve a list of Webhooks |
SignRequestClient::WebhooksApi | webhooks_partial_update | PATCH /webhooks/{uuid}/ | Partially update a Webhook |
SignRequestClient::WebhooksApi | webhooks_read | GET /webhooks/{uuid}/ | Retrieve a Webhook |
SignRequestClient::WebhooksApi | webhooks_update | PUT /webhooks/{uuid}/ | Update a Webhook |
Documentation for Models
- SignRequestClient::AuthToken
- SignRequestClient::Document
- SignRequestClient::DocumentAttachment
- SignRequestClient::DocumentSearch
- SignRequestClient::DocumentSignerTemplateConf
- SignRequestClient::DocumentSigningLog
- SignRequestClient::DocumentSignrequest
- SignRequestClient::DocumentTeam
- SignRequestClient::Event
- SignRequestClient::FileFromSf
- SignRequestClient::InlineDocumentSignerIntegrationData
- SignRequestClient::InlineIntegrationData
- SignRequestClient::InlinePrefillTags
- SignRequestClient::InlineResponse200
- SignRequestClient::InlineResponse2001
- SignRequestClient::InlineResponse2002
- SignRequestClient::InlineResponse2003
- SignRequestClient::InlineResponse2004
- SignRequestClient::InlineResponse2005
- SignRequestClient::InlineResponse2006
- SignRequestClient::InlineResponse2007
- SignRequestClient::InlineResponse2008
- SignRequestClient::InlineResponse2009
- SignRequestClient::InlineResponse201
- SignRequestClient::InlineResponse2011
- SignRequestClient::InlineSignRequest
- SignRequestClient::InlineTeam
- SignRequestClient::InlineTeamMember
- SignRequestClient::InviteMember
- SignRequestClient::Placeholder
- SignRequestClient::RequiredAttachment
- SignRequestClient::SignRequest
- SignRequestClient::SignRequestQuickCreate
- SignRequestClient::Signer
- SignRequestClient::SignerAttachment
- SignRequestClient::SignerInputs
- SignRequestClient::SigningLog
- SignRequestClient::Team
- SignRequestClient::TeamMember
- SignRequestClient::Template
- SignRequestClient::User
- SignRequestClient::WebhookSubscription
Documentation for Authorization
Token
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header