signrequest_client 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/LICENSE +21 -0
- data/README.md +122 -0
- data/Rakefile +9 -0
- data/docs/ApiTokensApi.md +226 -0
- data/docs/AuthToken.md +13 -0
- data/docs/Document.md +33 -0
- data/docs/DocumentAttachment.md +15 -0
- data/docs/DocumentAttachmentsApi.md +179 -0
- data/docs/DocumentSearch.md +22 -0
- data/docs/DocumentSignerTemplateConf.md +14 -0
- data/docs/DocumentsApi.md +301 -0
- data/docs/DocumentsSearchApi.md +119 -0
- data/docs/Event.md +17 -0
- data/docs/EventsApi.md +145 -0
- data/docs/FileFromSf.md +9 -0
- data/docs/InlineDocumentSignerIntegrationData.md +9 -0
- data/docs/InlineIntegrationData.md +9 -0
- data/docs/InlinePrefillTags.md +11 -0
- data/docs/InlineResponse200.md +11 -0
- data/docs/InlineResponse2001.md +11 -0
- data/docs/InlineResponse2002.md +11 -0
- data/docs/InlineResponse2003.md +11 -0
- data/docs/InlineResponse2004.md +11 -0
- data/docs/InlineResponse2005.md +11 -0
- data/docs/InlineResponse2006.md +11 -0
- data/docs/InlineResponse2007.md +11 -0
- data/docs/InlineResponse2008.md +11 -0
- data/docs/InlineResponse2009.md +11 -0
- data/docs/InlineSignRequest.md +25 -0
- data/docs/InlineTeam.md +10 -0
- data/docs/InlineTeamMember.md +13 -0
- data/docs/InviteMember.md +10 -0
- data/docs/Placeholder.md +15 -0
- data/docs/RequiredAttachment.md +9 -0
- data/docs/SignRequest.md +29 -0
- data/docs/SignRequestQuickCreate.md +42 -0
- data/docs/Signer.md +40 -0
- data/docs/SignerAttachment.md +11 -0
- data/docs/SignerInputs.md +14 -0
- data/docs/SigningLog.md +9 -0
- data/docs/SignrequestQuickCreateApi.md +62 -0
- data/docs/SignrequestsApi.md +291 -0
- data/docs/Team.md +15 -0
- data/docs/TeamMember.md +14 -0
- data/docs/TeamMembersApi.md +131 -0
- data/docs/TeamsApi.md +344 -0
- data/docs/Template.md +14 -0
- data/docs/TemplatesApi.md +119 -0
- data/docs/User.md +11 -0
- data/docs/WebhookSubscription.md +15 -0
- data/docs/WebhooksApi.md +340 -0
- data/git_push.sh +55 -0
- data/lib/signrequest_client/api/api_tokens_api.rb +242 -0
- data/lib/signrequest_client/api/document_attachments_api.rb +197 -0
- data/lib/signrequest_client/api/documents_api.rb +330 -0
- data/lib/signrequest_client/api/documents_search_api.rb +133 -0
- data/lib/signrequest_client/api/events_api.rb +172 -0
- data/lib/signrequest_client/api/signrequest_quick_create_api.rb +78 -0
- data/lib/signrequest_client/api/signrequests_api.rb +316 -0
- data/lib/signrequest_client/api/team_members_api.rb +151 -0
- data/lib/signrequest_client/api/teams_api.rb +371 -0
- data/lib/signrequest_client/api/templates_api.rb +133 -0
- data/lib/signrequest_client/api/webhooks_api.rb +364 -0
- data/lib/signrequest_client/api_client.rb +389 -0
- data/lib/signrequest_client/api_error.rb +38 -0
- data/lib/signrequest_client/configuration.rb +209 -0
- data/lib/signrequest_client/models/auth_token.rb +298 -0
- data/lib/signrequest_client/models/document.rb +605 -0
- data/lib/signrequest_client/models/document_attachment.rb +304 -0
- data/lib/signrequest_client/models/document_search.rb +519 -0
- data/lib/signrequest_client/models/document_signer_template_conf.rb +294 -0
- data/lib/signrequest_client/models/event.rb +330 -0
- data/lib/signrequest_client/models/file_from_sf.rb +245 -0
- data/lib/signrequest_client/models/inline_document_signer_integration_data.rb +230 -0
- data/lib/signrequest_client/models/inline_integration_data.rb +230 -0
- data/lib/signrequest_client/models/inline_prefill_tags.rb +231 -0
- data/lib/signrequest_client/models/inline_response_200.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_1.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_2.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_3.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_4.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_5.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_6.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_7.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_8.rb +227 -0
- data/lib/signrequest_client/models/inline_response_200_9.rb +227 -0
- data/lib/signrequest_client/models/inline_sign_request.rb +496 -0
- data/lib/signrequest_client/models/inline_team.rb +247 -0
- data/lib/signrequest_client/models/inline_team_member.rb +249 -0
- data/lib/signrequest_client/models/invite_member.rb +234 -0
- data/lib/signrequest_client/models/placeholder.rb +326 -0
- data/lib/signrequest_client/models/required_attachment.rb +246 -0
- data/lib/signrequest_client/models/sign_request.rb +543 -0
- data/lib/signrequest_client/models/sign_request_quick_create.rb +764 -0
- data/lib/signrequest_client/models/signer.rb +751 -0
- data/lib/signrequest_client/models/signer_attachment.rb +247 -0
- data/lib/signrequest_client/models/signer_inputs.rb +312 -0
- data/lib/signrequest_client/models/signing_log.rb +213 -0
- data/lib/signrequest_client/models/team.rb +367 -0
- data/lib/signrequest_client/models/team_member.rb +258 -0
- data/lib/signrequest_client/models/template.rb +309 -0
- data/lib/signrequest_client/models/user.rb +296 -0
- data/lib/signrequest_client/models/webhook_subscription.rb +366 -0
- data/lib/signrequest_client/version.rb +15 -0
- data/lib/signrequest_client.rb +87 -0
- data/pkg/signrequest_client-0.1.0.gem +0 -0
- data/signrequest_client.gemspec +45 -0
- data/signrequst_client/.git/HEAD +1 -0
- data/signrequst_client/.git/config +7 -0
- data/signrequst_client/.git/description +1 -0
- data/signrequst_client/.git/hooks/applypatch-msg.sample +15 -0
- data/signrequst_client/.git/hooks/commit-msg.sample +24 -0
- data/signrequst_client/.git/hooks/fsmonitor-watchman.sample +114 -0
- data/signrequst_client/.git/hooks/post-update.sample +8 -0
- data/signrequst_client/.git/hooks/pre-applypatch.sample +14 -0
- data/signrequst_client/.git/hooks/pre-commit.sample +49 -0
- data/signrequst_client/.git/hooks/pre-push.sample +53 -0
- data/signrequst_client/.git/hooks/pre-rebase.sample +169 -0
- data/signrequst_client/.git/hooks/pre-receive.sample +24 -0
- data/signrequst_client/.git/hooks/prepare-commit-msg.sample +42 -0
- data/signrequst_client/.git/hooks/update.sample +128 -0
- data/signrequst_client/.git/index +0 -0
- data/signrequst_client/.git/info/exclude +6 -0
- data/signrequst_client/.git/objects/30/68cc8a074ffc0c7b8891cb21d68b5d367cb8c4 +0 -0
- data/signrequst_client/.git/objects/32/c4b7e9f988621ed2ce28954f1aaf088f340848 +2 -0
- data/signrequst_client/.git/objects/3e/8c4c2f8d1d5334612f3072160124e985f27e8c +0 -0
- data/signrequst_client/.git/objects/43/022f711e20ed55baf2470278eb8e428a04856f +0 -0
- data/signrequst_client/.git/objects/6f/8caa83dfb6dc8a987a2829cbfefae18c8870c3 +0 -0
- data/signrequst_client/.git/objects/91/06b2a345b019a799c02e5069affa88370b35dd +0 -0
- data/signrequst_client/.git/objects/aa/58e53f733551ac2bde6f7a50b5a9f16ddbf110 +0 -0
- data/signrequst_client/.git/objects/dc/e67d860af47a4eb630117ce03624bae45dcf26 +3 -0
- data/signrequst_client/.git/objects/f1/c9171bed4c19fd22429ffd68d4cbb2c3ce2fce +0 -0
- data/signrequst_client/.git/objects/f8/e4c2573ebc57d5a365ebe14d5c18cc8d0716c4 +0 -0
- data/spec/api/api_tokens_api_spec.rb +84 -0
- data/spec/api/document_attachments_api_spec.rb +75 -0
- data/spec/api/documents_api_spec.rb +106 -0
- data/spec/api/documents_search_api_spec.rb +60 -0
- data/spec/api/events_api_spec.rb +73 -0
- data/spec/api/signrequest_quick_create_api_spec.rb +47 -0
- data/spec/api/signrequests_api_spec.rb +100 -0
- data/spec/api/team_members_api_spec.rb +66 -0
- data/spec/api/teams_api_spec.rb +111 -0
- data/spec/api/templates_api_spec.rb +60 -0
- data/spec/api/webhooks_api_spec.rb +110 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/auth_token_spec.rb +72 -0
- data/spec/models/document_attachment_spec.rb +84 -0
- data/spec/models/document_search_spec.rb +126 -0
- data/spec/models/document_signer_template_conf_spec.rb +78 -0
- data/spec/models/document_spec.rb +196 -0
- data/spec/models/event_spec.rb +104 -0
- data/spec/models/file_from_sf_spec.rb +48 -0
- data/spec/models/inline_document_signer_integration_data_spec.rb +52 -0
- data/spec/models/inline_integration_data_spec.rb +52 -0
- data/spec/models/inline_prefill_tags_spec.rb +60 -0
- data/spec/models/inline_response_200_1_spec.rb +60 -0
- data/spec/models/inline_response_200_2_spec.rb +60 -0
- data/spec/models/inline_response_200_3_spec.rb +60 -0
- data/spec/models/inline_response_200_4_spec.rb +60 -0
- data/spec/models/inline_response_200_5_spec.rb +60 -0
- data/spec/models/inline_response_200_6_spec.rb +60 -0
- data/spec/models/inline_response_200_7_spec.rb +60 -0
- data/spec/models/inline_response_200_8_spec.rb +60 -0
- data/spec/models/inline_response_200_9_spec.rb +60 -0
- data/spec/models/inline_response_200_spec.rb +60 -0
- data/spec/models/inline_sign_request_spec.rb +148 -0
- data/spec/models/inline_team_member_spec.rb +72 -0
- data/spec/models/inline_team_spec.rb +54 -0
- data/spec/models/invite_member_spec.rb +54 -0
- data/spec/models/placeholder_spec.rb +88 -0
- data/spec/models/required_attachment_spec.rb +48 -0
- data/spec/models/sign_request_quick_create_spec.rb +254 -0
- data/spec/models/sign_request_spec.rb +176 -0
- data/spec/models/signer_attachment_spec.rb +60 -0
- data/spec/models/signer_inputs_spec.rb +82 -0
- data/spec/models/signer_spec.rb +238 -0
- data/spec/models/signing_log_spec.rb +48 -0
- data/spec/models/team_member_spec.rb +78 -0
- data/spec/models/team_spec.rb +84 -0
- data/spec/models/template_spec.rb +82 -0
- data/spec/models/user_spec.rb +60 -0
- data/spec/models/webhook_subscription_spec.rb +92 -0
- data/spec/spec_helper.rb +111 -0
- metadata +461 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 26f17ff60820d3181caabb570d2c758c9e51a266a39fadd90d0465213c20b544
|
4
|
+
data.tar.gz: 724e2cde0d6fb1e17f5a90361bafe7fc312b0f7e27cdb50f15888985652f4bbc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c00d8bf08cff5b479cca7df186208ecef6048afd43dc9f818a5d6b9c3e9be63394ca06ac906313fc83a3b312c22e6b6eb32ebf3fc45d47877211ec4da65fcb59
|
7
|
+
data.tar.gz: 89e223bc6481989e3641b19024eea50871d39fbfe2627e532bc2d5bca62dfebcffdbbd95f248567f510c8778a8a4325fe6703c4dea4f8326a287e1392588502c
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
signrequest_client (0.1.0)
|
5
|
+
json (~> 2.1, >= 2.1.0)
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ZenTest (4.11.1)
|
12
|
+
addressable (2.5.2)
|
13
|
+
public_suffix (>= 2.0.2, < 4.0)
|
14
|
+
autotest (4.4.6)
|
15
|
+
ZenTest (>= 4.4.1)
|
16
|
+
autotest-fsevent (0.2.13)
|
17
|
+
sys-uname
|
18
|
+
autotest-growl (0.2.16)
|
19
|
+
autotest-rails-pure (4.1.2)
|
20
|
+
crack (0.4.3)
|
21
|
+
safe_yaml (~> 1.0.0)
|
22
|
+
diff-lcs (1.3)
|
23
|
+
ethon (0.11.0)
|
24
|
+
ffi (>= 1.3.0)
|
25
|
+
ffi (1.9.25)
|
26
|
+
hashdiff (0.3.7)
|
27
|
+
json (2.1.0)
|
28
|
+
public_suffix (3.0.3)
|
29
|
+
rake (12.0.0)
|
30
|
+
rspec (3.8.0)
|
31
|
+
rspec-core (~> 3.8.0)
|
32
|
+
rspec-expectations (~> 3.8.0)
|
33
|
+
rspec-mocks (~> 3.8.0)
|
34
|
+
rspec-core (3.8.0)
|
35
|
+
rspec-support (~> 3.8.0)
|
36
|
+
rspec-expectations (3.8.1)
|
37
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
38
|
+
rspec-support (~> 3.8.0)
|
39
|
+
rspec-mocks (3.8.0)
|
40
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
41
|
+
rspec-support (~> 3.8.0)
|
42
|
+
rspec-support (3.8.0)
|
43
|
+
safe_yaml (1.0.4)
|
44
|
+
sys-uname (1.0.3)
|
45
|
+
ffi (>= 1.0.0)
|
46
|
+
typhoeus (1.3.0)
|
47
|
+
ethon (>= 0.9.0)
|
48
|
+
vcr (3.0.3)
|
49
|
+
webmock (1.24.6)
|
50
|
+
addressable (>= 2.3.6)
|
51
|
+
crack (>= 0.3.2)
|
52
|
+
hashdiff
|
53
|
+
|
54
|
+
PLATFORMS
|
55
|
+
ruby
|
56
|
+
|
57
|
+
DEPENDENCIES
|
58
|
+
autotest (~> 4.4, >= 4.4.6)
|
59
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
60
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
61
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
62
|
+
rake (~> 12.0.0)
|
63
|
+
rspec (~> 3.6, >= 3.6.0)
|
64
|
+
signrequest_client!
|
65
|
+
vcr (~> 3.0, >= 3.0.1)
|
66
|
+
webmock (~> 1.24, >= 1.24.3)
|
67
|
+
|
68
|
+
BUNDLED WITH
|
69
|
+
1.16.2
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2018 - SignRequest B.V. (https://signrequest.com)
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,122 @@
|
|
1
|
+
# SignRequest API Client
|
2
|
+
|
3
|
+
SignRequestClient - the Ruby gem for the SignRequest API
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this to the Gemfile:
|
8
|
+
|
9
|
+
gem 'signrequest_client', '~> 0.1.0'
|
10
|
+
|
11
|
+
And then run:
|
12
|
+
|
13
|
+
bundle install
|
14
|
+
|
15
|
+
## Getting Started
|
16
|
+
|
17
|
+
The client needs to be configured with an API token from your [team api settings page](https://signrequest.com/#/teams).
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
# Setup authorization
|
21
|
+
SignRequestClient.configure do |config|
|
22
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
23
|
+
config.api_key_prefix['Authorization'] = 'Token'
|
24
|
+
end
|
25
|
+
|
26
|
+
documents_api = SignRequestClient::DocumentsApi.new
|
27
|
+
document = SignRequestClient::Document.new
|
28
|
+
|
29
|
+
begin
|
30
|
+
result = documents_api.documents_create(document)
|
31
|
+
p result
|
32
|
+
rescue SignRequestClient::ApiError => e
|
33
|
+
puts "Exception when calling ApiTokensApi->api_tokens_create: #{e}"
|
34
|
+
end
|
35
|
+
|
36
|
+
```
|
37
|
+
|
38
|
+
## Documentation for API Endpoints
|
39
|
+
|
40
|
+
All URIs are relative to *https://signrequest.com/api/v1*
|
41
|
+
|
42
|
+
Class | Method | HTTP request | Description
|
43
|
+
------------ | ------------- | ------------- | -------------
|
44
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_create**](docs/ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ |
|
45
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_delete**](docs/ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ |
|
46
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_list**](docs/ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ |
|
47
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_read**](docs/ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ |
|
48
|
+
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_create**](docs/DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ |
|
49
|
+
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ |
|
50
|
+
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_read**](docs/DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ |
|
51
|
+
*SignRequestClient::DocumentsApi* | [**documents_create**](docs/DocumentsApi.md#documents_create) | **POST** /documents/ |
|
52
|
+
*SignRequestClient::DocumentsApi* | [**documents_delete**](docs/DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ |
|
53
|
+
*SignRequestClient::DocumentsApi* | [**documents_delete_files**](docs/DocumentsApi.md#documents_delete_files) | **POST** /documents/{uuid}/delete_files/ |
|
54
|
+
*SignRequestClient::DocumentsApi* | [**documents_list**](docs/DocumentsApi.md#documents_list) | **GET** /documents/ |
|
55
|
+
*SignRequestClient::DocumentsApi* | [**documents_read**](docs/DocumentsApi.md#documents_read) | **GET** /documents/{uuid}/ |
|
56
|
+
*SignRequestClient::DocumentsSearchApi* | [**documents_search_list**](docs/DocumentsSearchApi.md#documents_search_list) | **GET** /documents-search/ |
|
57
|
+
*SignRequestClient::DocumentsSearchApi* | [**documents_search_read**](docs/DocumentsSearchApi.md#documents_search_read) | **GET** /documents-search/{id}/ |
|
58
|
+
*SignRequestClient::EventsApi* | [**events_list**](docs/EventsApi.md#events_list) | **GET** /events/ |
|
59
|
+
*SignRequestClient::EventsApi* | [**events_read**](docs/EventsApi.md#events_read) | **GET** /events/{id}/ |
|
60
|
+
*SignRequestClient::SignrequestQuickCreateApi* | [**signrequest_quick_create_create**](docs/SignrequestQuickCreateApi.md#signrequest_quick_create_create) | **POST** /signrequest-quick-create/ |
|
61
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_cancel_signrequest**](docs/SignrequestsApi.md#signrequests_cancel_signrequest) | **POST** /signrequests/{uuid}/cancel_signrequest/ |
|
62
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_create**](docs/SignrequestsApi.md#signrequests_create) | **POST** /signrequests/ |
|
63
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_list**](docs/SignrequestsApi.md#signrequests_list) | **GET** /signrequests/ |
|
64
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_read**](docs/SignrequestsApi.md#signrequests_read) | **GET** /signrequests/{uuid}/ |
|
65
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_resend_signrequest_email**](docs/SignrequestsApi.md#signrequests_resend_signrequest_email) | **POST** /signrequests/{uuid}/resend_signrequest_email/ |
|
66
|
+
*SignRequestClient::TeamMembersApi* | [**team_members_list**](docs/TeamMembersApi.md#team_members_list) | **GET** /team-members/ |
|
67
|
+
*SignRequestClient::TeamMembersApi* | [**team_members_read**](docs/TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ |
|
68
|
+
*SignRequestClient::TeamsApi* | [**teams_create**](docs/TeamsApi.md#teams_create) | **POST** /teams/ |
|
69
|
+
*SignRequestClient::TeamsApi* | [**teams_invite_member**](docs/TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ |
|
70
|
+
*SignRequestClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams/ |
|
71
|
+
*SignRequestClient::TeamsApi* | [**teams_partial_update**](docs/TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ |
|
72
|
+
*SignRequestClient::TeamsApi* | [**teams_read**](docs/TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ |
|
73
|
+
*SignRequestClient::TeamsApi* | [**teams_update**](docs/TeamsApi.md#teams_update) | **PUT** /teams/{subdomain}/ |
|
74
|
+
*SignRequestClient::TemplatesApi* | [**templates_list**](docs/TemplatesApi.md#templates_list) | **GET** /templates/ |
|
75
|
+
*SignRequestClient::TemplatesApi* | [**templates_read**](docs/TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ |
|
76
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_create**](docs/WebhooksApi.md#webhooks_create) | **POST** /webhooks/ |
|
77
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_delete**](docs/WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ |
|
78
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_list**](docs/WebhooksApi.md#webhooks_list) | **GET** /webhooks/ |
|
79
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_partial_update**](docs/WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ |
|
80
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_read**](docs/WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ |
|
81
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_update**](docs/WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ |
|
82
|
+
|
83
|
+
|
84
|
+
## Documentation for Models
|
85
|
+
|
86
|
+
- [SignRequestClient::AuthToken](docs/AuthToken.md)
|
87
|
+
- [SignRequestClient::Document](docs/Document.md)
|
88
|
+
- [SignRequestClient::DocumentAttachment](docs/DocumentAttachment.md)
|
89
|
+
- [SignRequestClient::DocumentSearch](docs/DocumentSearch.md)
|
90
|
+
- [SignRequestClient::DocumentSignerTemplateConf](docs/DocumentSignerTemplateConf.md)
|
91
|
+
- [SignRequestClient::Event](docs/Event.md)
|
92
|
+
- [SignRequestClient::FileFromSf](docs/FileFromSf.md)
|
93
|
+
- [SignRequestClient::InlineDocumentSignerIntegrationData](docs/InlineDocumentSignerIntegrationData.md)
|
94
|
+
- [SignRequestClient::InlineIntegrationData](docs/InlineIntegrationData.md)
|
95
|
+
- [SignRequestClient::InlinePrefillTags](docs/InlinePrefillTags.md)
|
96
|
+
- [SignRequestClient::InlineResponse200](docs/InlineResponse200.md)
|
97
|
+
- [SignRequestClient::InlineResponse2001](docs/InlineResponse2001.md)
|
98
|
+
- [SignRequestClient::InlineResponse2002](docs/InlineResponse2002.md)
|
99
|
+
- [SignRequestClient::InlineResponse2003](docs/InlineResponse2003.md)
|
100
|
+
- [SignRequestClient::InlineResponse2004](docs/InlineResponse2004.md)
|
101
|
+
- [SignRequestClient::InlineResponse2005](docs/InlineResponse2005.md)
|
102
|
+
- [SignRequestClient::InlineResponse2006](docs/InlineResponse2006.md)
|
103
|
+
- [SignRequestClient::InlineResponse2007](docs/InlineResponse2007.md)
|
104
|
+
- [SignRequestClient::InlineResponse2008](docs/InlineResponse2008.md)
|
105
|
+
- [SignRequestClient::InlineResponse2009](docs/InlineResponse2009.md)
|
106
|
+
- [SignRequestClient::InlineSignRequest](docs/InlineSignRequest.md)
|
107
|
+
- [SignRequestClient::InlineTeam](docs/InlineTeam.md)
|
108
|
+
- [SignRequestClient::InlineTeamMember](docs/InlineTeamMember.md)
|
109
|
+
- [SignRequestClient::InviteMember](docs/InviteMember.md)
|
110
|
+
- [SignRequestClient::Placeholder](docs/Placeholder.md)
|
111
|
+
- [SignRequestClient::RequiredAttachment](docs/RequiredAttachment.md)
|
112
|
+
- [SignRequestClient::SignRequest](docs/SignRequest.md)
|
113
|
+
- [SignRequestClient::SignRequestQuickCreate](docs/SignRequestQuickCreate.md)
|
114
|
+
- [SignRequestClient::Signer](docs/Signer.md)
|
115
|
+
- [SignRequestClient::SignerAttachment](docs/SignerAttachment.md)
|
116
|
+
- [SignRequestClient::SignerInputs](docs/SignerInputs.md)
|
117
|
+
- [SignRequestClient::SigningLog](docs/SigningLog.md)
|
118
|
+
- [SignRequestClient::Team](docs/Team.md)
|
119
|
+
- [SignRequestClient::TeamMember](docs/TeamMember.md)
|
120
|
+
- [SignRequestClient::Template](docs/Template.md)
|
121
|
+
- [SignRequestClient::User](docs/User.md)
|
122
|
+
- [SignRequestClient::WebhookSubscription](docs/WebhookSubscription.md)
|
data/Rakefile
ADDED
@@ -0,0 +1,226 @@
|
|
1
|
+
# SignRequestClient::ApiTokensApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://signrequest.com/api/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**api_tokens_create**](ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ |
|
8
|
+
[**api_tokens_delete**](ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ |
|
9
|
+
[**api_tokens_list**](ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ |
|
10
|
+
[**api_tokens_read**](ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ |
|
11
|
+
|
12
|
+
|
13
|
+
# **api_tokens_create**
|
14
|
+
> AuthToken api_tokens_create(data)
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'signrequest_client'
|
24
|
+
# setup authorization
|
25
|
+
SignRequestClient.configure do |config|
|
26
|
+
# Configure API key authorization: Token
|
27
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = SignRequestClient::ApiTokensApi.new
|
33
|
+
|
34
|
+
data = SignRequestClient::AuthToken.new # AuthToken |
|
35
|
+
|
36
|
+
|
37
|
+
begin
|
38
|
+
result = api_instance.api_tokens_create(data)
|
39
|
+
p result
|
40
|
+
rescue SignRequestClient::ApiError => e
|
41
|
+
puts "Exception when calling ApiTokensApi->api_tokens_create: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**data** | [**AuthToken**](AuthToken.md)| |
|
50
|
+
|
51
|
+
### Return type
|
52
|
+
|
53
|
+
[**AuthToken**](AuthToken.md)
|
54
|
+
|
55
|
+
### Authorization
|
56
|
+
|
57
|
+
[Token](../README.md#Token)
|
58
|
+
|
59
|
+
### HTTP request headers
|
60
|
+
|
61
|
+
- **Content-Type**: application/json
|
62
|
+
- **Accept**: application/json
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
# **api_tokens_delete**
|
67
|
+
> api_tokens_delete(key)
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
### Example
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'signrequest_client'
|
77
|
+
# setup authorization
|
78
|
+
SignRequestClient.configure do |config|
|
79
|
+
# Configure API key authorization: Token
|
80
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
81
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
83
|
+
end
|
84
|
+
|
85
|
+
api_instance = SignRequestClient::ApiTokensApi.new
|
86
|
+
|
87
|
+
key = "key_example" # String | A unique value identifying this api token.
|
88
|
+
|
89
|
+
|
90
|
+
begin
|
91
|
+
api_instance.api_tokens_delete(key)
|
92
|
+
rescue SignRequestClient::ApiError => e
|
93
|
+
puts "Exception when calling ApiTokensApi->api_tokens_delete: #{e}"
|
94
|
+
end
|
95
|
+
```
|
96
|
+
|
97
|
+
### Parameters
|
98
|
+
|
99
|
+
Name | Type | Description | Notes
|
100
|
+
------------- | ------------- | ------------- | -------------
|
101
|
+
**key** | **String**| A unique value identifying this api token. |
|
102
|
+
|
103
|
+
### Return type
|
104
|
+
|
105
|
+
nil (empty response body)
|
106
|
+
|
107
|
+
### Authorization
|
108
|
+
|
109
|
+
[Token](../README.md#Token)
|
110
|
+
|
111
|
+
### HTTP request headers
|
112
|
+
|
113
|
+
- **Content-Type**: application/json
|
114
|
+
- **Accept**: application/json
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
# **api_tokens_list**
|
119
|
+
> InlineResponse200 api_tokens_list(opts)
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
### Example
|
126
|
+
```ruby
|
127
|
+
# load the gem
|
128
|
+
require 'signrequest_client'
|
129
|
+
# setup authorization
|
130
|
+
SignRequestClient.configure do |config|
|
131
|
+
# Configure API key authorization: Token
|
132
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
133
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
134
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
135
|
+
end
|
136
|
+
|
137
|
+
api_instance = SignRequestClient::ApiTokensApi.new
|
138
|
+
|
139
|
+
opts = {
|
140
|
+
page: 56, # Integer | A page number within the paginated result set.
|
141
|
+
limit: 56 # Integer | Number of results to return per page.
|
142
|
+
}
|
143
|
+
|
144
|
+
begin
|
145
|
+
result = api_instance.api_tokens_list(opts)
|
146
|
+
p result
|
147
|
+
rescue SignRequestClient::ApiError => e
|
148
|
+
puts "Exception when calling ApiTokensApi->api_tokens_list: #{e}"
|
149
|
+
end
|
150
|
+
```
|
151
|
+
|
152
|
+
### Parameters
|
153
|
+
|
154
|
+
Name | Type | Description | Notes
|
155
|
+
------------- | ------------- | ------------- | -------------
|
156
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
157
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
158
|
+
|
159
|
+
### Return type
|
160
|
+
|
161
|
+
[**InlineResponse200**](InlineResponse200.md)
|
162
|
+
|
163
|
+
### Authorization
|
164
|
+
|
165
|
+
[Token](../README.md#Token)
|
166
|
+
|
167
|
+
### HTTP request headers
|
168
|
+
|
169
|
+
- **Content-Type**: application/json
|
170
|
+
- **Accept**: application/json
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
# **api_tokens_read**
|
175
|
+
> AuthToken api_tokens_read(key)
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
### Example
|
182
|
+
```ruby
|
183
|
+
# load the gem
|
184
|
+
require 'signrequest_client'
|
185
|
+
# setup authorization
|
186
|
+
SignRequestClient.configure do |config|
|
187
|
+
# Configure API key authorization: Token
|
188
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
189
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
190
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
191
|
+
end
|
192
|
+
|
193
|
+
api_instance = SignRequestClient::ApiTokensApi.new
|
194
|
+
|
195
|
+
key = "key_example" # String | A unique value identifying this api token.
|
196
|
+
|
197
|
+
|
198
|
+
begin
|
199
|
+
result = api_instance.api_tokens_read(key)
|
200
|
+
p result
|
201
|
+
rescue SignRequestClient::ApiError => e
|
202
|
+
puts "Exception when calling ApiTokensApi->api_tokens_read: #{e}"
|
203
|
+
end
|
204
|
+
```
|
205
|
+
|
206
|
+
### Parameters
|
207
|
+
|
208
|
+
Name | Type | Description | Notes
|
209
|
+
------------- | ------------- | ------------- | -------------
|
210
|
+
**key** | **String**| A unique value identifying this api token. |
|
211
|
+
|
212
|
+
### Return type
|
213
|
+
|
214
|
+
[**AuthToken**](AuthToken.md)
|
215
|
+
|
216
|
+
### Authorization
|
217
|
+
|
218
|
+
[Token](../README.md#Token)
|
219
|
+
|
220
|
+
### HTTP request headers
|
221
|
+
|
222
|
+
- **Content-Type**: application/json
|
223
|
+
- **Accept**: application/json
|
224
|
+
|
225
|
+
|
226
|
+
|
data/docs/AuthToken.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# SignRequestClient::AuthToken
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | | [optional]
|
7
|
+
**password** | **String** | | [optional]
|
8
|
+
**subdomain** | **String** | |
|
9
|
+
**name** | **String** | | [optional]
|
10
|
+
**key** | **String** | | [optional]
|
11
|
+
**url** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
data/docs/Document.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# SignRequestClient::Document
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | | [optional]
|
7
|
+
**team** | [**InlineTeam**](InlineTeam.md) | | [optional]
|
8
|
+
**uuid** | **String** | | [optional]
|
9
|
+
**user** | [**User**](User.md) | | [optional]
|
10
|
+
**file_as_pdf** | **String** | | [optional]
|
11
|
+
**name** | **String** | | [optional]
|
12
|
+
**external_id** | **String** | | [optional]
|
13
|
+
**frontend_id** | **String** | | [optional]
|
14
|
+
**file** | **String** | | [optional]
|
15
|
+
**file_from_url** | **String** | | [optional]
|
16
|
+
**events_callback_url** | **String** | | [optional]
|
17
|
+
**file_from_content** | **String** | | [optional]
|
18
|
+
**file_from_content_name** | **String** | | [optional]
|
19
|
+
**template** | **String** | | [optional]
|
20
|
+
**prefill_tags** | [**Array<InlinePrefillTags>**](InlinePrefillTags.md) | | [optional]
|
21
|
+
**integrations** | [**Array<InlineIntegrationData>**](InlineIntegrationData.md) | | [optional]
|
22
|
+
**file_from_sf** | [**FileFromSf**](FileFromSf.md) | | [optional]
|
23
|
+
**auto_delete_days** | **Integer** | | [optional]
|
24
|
+
**pdf** | **String** | | [optional]
|
25
|
+
**status** | **String** | | [optional]
|
26
|
+
**signrequest** | [**InlineSignRequest**](InlineSignRequest.md) | | [optional]
|
27
|
+
**api_used** | **BOOLEAN** | | [optional]
|
28
|
+
**signing_log** | [**SigningLog**](SigningLog.md) | | [optional]
|
29
|
+
**security_hash** | **String** | | [optional]
|
30
|
+
**attachments** | [**Array<DocumentAttachment>**](DocumentAttachment.md) | | [optional]
|
31
|
+
**auto_delete_after** | **DateTime** | | [optional]
|
32
|
+
|
33
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# SignRequestClient::DocumentAttachment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | | [optional]
|
7
|
+
**uuid** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**file** | **String** | | [optional]
|
10
|
+
**file_from_content** | **String** | | [optional]
|
11
|
+
**file_from_content_name** | **String** | | [optional]
|
12
|
+
**file_from_url** | **String** | | [optional]
|
13
|
+
**document** | **String** | |
|
14
|
+
|
15
|
+
|