signrequest_client 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -7
- data/Rakefile +0 -1
- data/docs/ApiTokensApi.md +0 -164
- data/docs/Document.md +6 -0
- data/docs/DocumentAttachment.md +1 -1
- data/docs/DocumentAttachmentsApi.md +4 -4
- data/docs/DocumentSearch.md +5 -5
- data/docs/DocumentSigningLog.md +9 -0
- data/docs/DocumentSignrequest.md +28 -0
- data/docs/DocumentTeam.md +10 -0
- data/docs/DocumentsApi.md +11 -11
- data/docs/DocumentsSearchApi.md +8 -8
- data/docs/Event.md +1 -0
- data/docs/EventsApi.md +13 -13
- data/docs/FileFromSf.md +1 -0
- data/docs/InlineResponse201.md +1 -1
- data/docs/InlineSignRequest.md +3 -0
- data/docs/SignRequest.md +4 -1
- data/docs/SignRequestQuickCreate.md +5 -1
- data/docs/Signer.md +3 -0
- data/docs/SignrequestsApi.md +5 -5
- data/docs/Team.md +2 -0
- data/docs/TeamMember.md +1 -0
- data/docs/TeamMembersApi.md +7 -7
- data/docs/TeamsApi.md +57 -3
- data/docs/Template.md +1 -0
- data/docs/TemplatesApi.md +1 -1
- data/docs/WebhookSubscription.md +1 -0
- data/docs/WebhooksApi.md +4 -4
- data/lib/signrequest_client.rb +4 -1
- data/lib/signrequest_client/api/api_tokens_api.rb +5 -170
- data/lib/signrequest_client/api/document_attachments_api.rb +11 -14
- data/lib/signrequest_client/api/documents_api.rb +14 -18
- data/lib/signrequest_client/api/documents_search_api.rb +5 -6
- data/lib/signrequest_client/api/events_api.rb +8 -10
- data/lib/signrequest_client/api/signrequest_quick_create_api.rb +5 -6
- data/lib/signrequest_client/api/signrequests_api.rb +17 -22
- data/lib/signrequest_client/api/team_members_api.rb +8 -10
- data/lib/signrequest_client/api/teams_api.rb +69 -21
- data/lib/signrequest_client/api/templates_api.rb +8 -10
- data/lib/signrequest_client/api/webhooks_api.rb +20 -26
- data/lib/signrequest_client/api_client.rb +9 -9
- data/lib/signrequest_client/api_error.rb +1 -1
- data/lib/signrequest_client/configuration.rb +2 -2
- data/lib/signrequest_client/models/auth_token.rb +16 -23
- data/lib/signrequest_client/models/document.rb +113 -45
- data/lib/signrequest_client/models/document_attachment.rb +17 -25
- data/lib/signrequest_client/models/document_search.rb +111 -122
- data/lib/signrequest_client/models/document_signer_template_conf.rb +14 -21
- data/lib/signrequest_client/models/document_signing_log.rb +209 -0
- data/lib/signrequest_client/models/document_signrequest.rb +538 -0
- data/lib/signrequest_client/models/document_team.rb +240 -0
- data/lib/signrequest_client/models/event.rb +24 -20
- data/lib/signrequest_client/models/file_from_sf.rb +40 -21
- data/lib/signrequest_client/models/inline_document_signer_integration_data.rb +9 -13
- data/lib/signrequest_client/models/inline_integration_data.rb +9 -13
- data/lib/signrequest_client/models/inline_prefill_tags.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_1.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_2.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_3.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_4.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_5.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_6.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_7.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_8.rb +8 -13
- data/lib/signrequest_client/models/inline_response_200_9.rb +8 -13
- data/lib/signrequest_client/models/inline_response_201.rb +27 -31
- data/lib/signrequest_client/models/inline_response_201_1.rb +11 -15
- data/lib/signrequest_client/models/inline_sign_request.rb +69 -35
- data/lib/signrequest_client/models/inline_team.rb +12 -19
- data/lib/signrequest_client/models/inline_team_member.rb +8 -14
- data/lib/signrequest_client/models/invite_member.rb +10 -15
- data/lib/signrequest_client/models/placeholder.rb +15 -21
- data/lib/signrequest_client/models/required_attachment.rb +14 -20
- data/lib/signrequest_client/models/sign_request.rb +75 -40
- data/lib/signrequest_client/models/sign_request_quick_create.rb +124 -61
- data/lib/signrequest_client/models/signer.rb +103 -60
- data/lib/signrequest_client/models/signer_attachment.rb +10 -17
- data/lib/signrequest_client/models/signer_inputs.rb +14 -20
- data/lib/signrequest_client/models/signing_log.rb +8 -14
- data/lib/signrequest_client/models/team.rb +55 -34
- data/lib/signrequest_client/models/team_member.rb +18 -15
- data/lib/signrequest_client/models/template.rb +23 -20
- data/lib/signrequest_client/models/user.rb +18 -26
- data/lib/signrequest_client/models/webhook_subscription.rb +33 -30
- data/lib/signrequest_client/version.rb +2 -2
- data/signrequest_client-1.0.0.gem +0 -0
- data/signrequest_client.gemspec +4 -4
- data/spec/models/document_signing_log_spec.rb +47 -0
- data/spec/models/document_signrequest_spec.rb +165 -0
- data/spec/models/document_team_spec.rb +53 -0
- metadata +28 -42
data/docs/DocumentsSearchApi.md
CHANGED
@@ -31,14 +31,14 @@ api_instance = SignRequestClient::DocumentsSearchApi.new
|
|
31
31
|
opts = {
|
32
32
|
page: 56, # Integer | A page number within the paginated result set.
|
33
33
|
limit: 56, # Integer | Number of results to return per page.
|
34
|
-
q:
|
35
|
-
autocomplete:
|
36
|
-
name:
|
37
|
-
subdomain:
|
38
|
-
signer_emails:
|
39
|
-
status:
|
40
|
-
who:
|
41
|
-
format:
|
34
|
+
q: 'q_example', # String | Normal search query
|
35
|
+
autocomplete: 'autocomplete_example', # String | Partial search query
|
36
|
+
name: 'name_example', # String | Document name
|
37
|
+
subdomain: 'subdomain_example', # String |
|
38
|
+
signer_emails: 'signer_emails_example', # String | Email needed to sign/approve
|
39
|
+
status: 'status_example', # String | `co`: converting, `ne`: new, `se`: sent, `vi`: viewed, `si`: signed, `do`: downloaded, `sd`: signed and downloaded, `ca`: cancelled, `de`: declined, `ec`: error converting, `es`: error sending, `xp`: expired
|
40
|
+
who: 'who_example', # String | `m`: only me, `mo`: me and others, `o`: only others
|
41
|
+
format: 'format_example', # String | Export format, can be `json` (default), `csv`, or `xls`
|
42
42
|
signer_data: 8.14 # Float | Set to `1` to export with each signer on a separate row
|
43
43
|
}
|
44
44
|
|
data/docs/Event.md
CHANGED
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**delivered_on** | **DateTime** | | [optional]
|
11
11
|
**callback_status_code** | **Integer** | | [optional]
|
12
12
|
**timestamp** | **DateTime** | | [optional]
|
13
|
+
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
|
13
14
|
**document** | [**Document**](Document.md) | | [optional]
|
14
15
|
**signer** | [**Signer**](Signer.md) | | [optional]
|
15
16
|
|
data/docs/EventsApi.md
CHANGED
@@ -30,19 +30,19 @@ end
|
|
30
30
|
api_instance = SignRequestClient::EventsApi.new
|
31
31
|
|
32
32
|
opts = {
|
33
|
-
document__uuid:
|
34
|
-
document__external_id:
|
35
|
-
document__signrequest__who:
|
36
|
-
document__signrequest__from_email:
|
37
|
-
document__status:
|
38
|
-
document__user__email:
|
39
|
-
document__user__first_name:
|
40
|
-
document__user__last_name:
|
41
|
-
delivered:
|
42
|
-
delivered_on:
|
43
|
-
timestamp:
|
44
|
-
status:
|
45
|
-
event_type:
|
33
|
+
document__uuid: 'document__uuid_example', # String |
|
34
|
+
document__external_id: 'document__external_id_example', # String |
|
35
|
+
document__signrequest__who: 'document__signrequest__who_example', # String |
|
36
|
+
document__signrequest__from_email: 'document__signrequest__from_email_example', # String |
|
37
|
+
document__status: 'document__status_example', # String |
|
38
|
+
document__user__email: 'document__user__email_example', # String |
|
39
|
+
document__user__first_name: 'document__user__first_name_example', # String |
|
40
|
+
document__user__last_name: 'document__user__last_name_example', # String |
|
41
|
+
delivered: 'delivered_example', # String |
|
42
|
+
delivered_on: 'delivered_on_example', # String |
|
43
|
+
timestamp: 'timestamp_example', # String |
|
44
|
+
status: 'status_example', # String |
|
45
|
+
event_type: 'event_type_example', # String |
|
46
46
|
page: 56, # Integer | A page number within the paginated result set.
|
47
47
|
limit: 56 # Integer | Number of results to return per page.
|
48
48
|
}
|
data/docs/FileFromSf.md
CHANGED
data/docs/InlineResponse201.md
CHANGED
data/docs/InlineSignRequest.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**is_being_prepared** | **BOOLEAN** | Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) | [optional]
|
9
9
|
**prepare_url** | **String** | | [optional]
|
10
10
|
**redirect_url** | **String** | URL at which SignRequest will redirect to when a document is signed | [optional]
|
11
|
+
**redirect_url_declined** | **String** | URL at which SignRequest will redirect to when a document is declined | [optional]
|
11
12
|
**required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | | [optional]
|
12
13
|
**disable_attachments** | **BOOLEAN** | Disable uploading/adding of attachments | [optional]
|
13
14
|
**disable_text_signatures** | **BOOLEAN** | Disable usage of signatures generated by typing (text) | [optional]
|
@@ -15,6 +16,8 @@ Name | Type | Description | Notes
|
|
15
16
|
**disable_date** | **BOOLEAN** | Disable adding of dates | [optional]
|
16
17
|
**disable_emails** | **BOOLEAN** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
|
17
18
|
**disable_upload_signatures** | **BOOLEAN** | Disable usage of uploaded signatures (images) | [optional]
|
19
|
+
**disable_blockchain_proof** | **BOOLEAN** | Disables storing timestamp proof hashes in blockchain integrations. | [optional]
|
20
|
+
**text_message_verification_locked** | **BOOLEAN** | When true a text message verification is needed before the signer can see the document | [optional]
|
18
21
|
**subject** | **String** | Subject of SignRequest email | [optional]
|
19
22
|
**message** | **String** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional]
|
20
23
|
**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional]
|
data/docs/SignRequest.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**is_being_prepared** | **BOOLEAN** | Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) | [optional]
|
9
9
|
**prepare_url** | **String** | | [optional]
|
10
10
|
**redirect_url** | **String** | URL at which SignRequest will redirect to when a document is signed | [optional]
|
11
|
+
**redirect_url_declined** | **String** | URL at which SignRequest will redirect to when a document is declined | [optional]
|
11
12
|
**required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | Attachments that signers are required to upload | [optional]
|
12
13
|
**disable_attachments** | **BOOLEAN** | Disable uploading/adding of attachments | [optional]
|
13
14
|
**disable_text_signatures** | **BOOLEAN** | Disable usage of signatures generated by typing (text) | [optional]
|
@@ -15,9 +16,11 @@ Name | Type | Description | Notes
|
|
15
16
|
**disable_date** | **BOOLEAN** | Disable adding of dates | [optional]
|
16
17
|
**disable_emails** | **BOOLEAN** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
|
17
18
|
**disable_upload_signatures** | **BOOLEAN** | Disable usage of uploaded signatures (images) | [optional]
|
19
|
+
**disable_blockchain_proof** | **BOOLEAN** | Disables storing timestamp proof hashes in blockchain integrations. | [optional]
|
20
|
+
**text_message_verification_locked** | **BOOLEAN** | When true a text message verification is needed before the signer can see the document | [optional]
|
18
21
|
**subject** | **String** | Subject of SignRequest email | [optional]
|
19
22
|
**message** | **String** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional]
|
20
|
-
**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to
|
23
|
+
**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to 'o']
|
21
24
|
**send_reminders** | **BOOLEAN** | Automatically remind signers to sign a document | [optional]
|
22
25
|
**signers** | [**Array<Signer>**](Signer.md) | |
|
23
26
|
**uuid** | **String** | | [optional]
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**is_being_prepared** | **BOOLEAN** | Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) | [optional]
|
9
9
|
**prepare_url** | **String** | | [optional]
|
10
10
|
**redirect_url** | **String** | URL at which SignRequest will redirect to when a document is signed | [optional]
|
11
|
+
**redirect_url_declined** | **String** | URL at which SignRequest will redirect to when a document is declined | [optional]
|
11
12
|
**required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | Attachments that signers are required to upload | [optional]
|
12
13
|
**disable_attachments** | **BOOLEAN** | Disable uploading/adding of attachments | [optional]
|
13
14
|
**disable_text_signatures** | **BOOLEAN** | Disable usage of signatures generated by typing (text) | [optional]
|
@@ -15,9 +16,11 @@ Name | Type | Description | Notes
|
|
15
16
|
**disable_date** | **BOOLEAN** | Disable adding of dates | [optional]
|
16
17
|
**disable_emails** | **BOOLEAN** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
|
17
18
|
**disable_upload_signatures** | **BOOLEAN** | Disable usage of uploaded signatures (images) | [optional]
|
19
|
+
**disable_blockchain_proof** | **BOOLEAN** | Disables storing timestamp proof hashes in blockchain integrations. | [optional]
|
20
|
+
**text_message_verification_locked** | **BOOLEAN** | When true a text message verification is needed before the signer can see the document | [optional]
|
18
21
|
**subject** | **String** | Subject of SignRequest email | [optional]
|
19
22
|
**message** | **String** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional]
|
20
|
-
**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to
|
23
|
+
**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to 'o']
|
21
24
|
**send_reminders** | **BOOLEAN** | Automatically remind signers to sign a document | [optional]
|
22
25
|
**signers** | [**Array<Signer>**](Signer.md) | |
|
23
26
|
**uuid** | **String** | | [optional]
|
@@ -38,5 +41,6 @@ Name | Type | Description | Notes
|
|
38
41
|
**integrations** | [**Array<InlineIntegrationData>**](InlineIntegrationData.md) | | [optional]
|
39
42
|
**file_from_sf** | [**FileFromSf**](FileFromSf.md) | | [optional]
|
40
43
|
**auto_delete_days** | **Integer** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
|
44
|
+
**auto_expire_days** | **Integer** | Number of days after which a non finished document will be automatically expired | [optional]
|
41
45
|
|
42
46
|
|
data/docs/Signer.md
CHANGED
@@ -31,10 +31,13 @@ Name | Type | Description | Notes
|
|
31
31
|
**message** | **String** | | [optional]
|
32
32
|
**embed_url_user_id** | **String** | | [optional]
|
33
33
|
**inputs** | [**Array<SignerInputs>**](SignerInputs.md) | | [optional]
|
34
|
+
**use_stamp_for_approve_only** | **BOOLEAN** | Place an approval stamp on a document when a signer approves a document | [optional]
|
34
35
|
**embed_url** | **String** | | [optional]
|
35
36
|
**attachments** | [**Array<SignerAttachment>**](SignerAttachment.md) | | [optional]
|
36
37
|
**redirect_url** | **String** | | [optional]
|
38
|
+
**redirect_url_declined** | **String** | | [optional]
|
37
39
|
**after_document** | **String** | | [optional]
|
38
40
|
**integrations** | [**Array<InlineDocumentSignerIntegrationData>**](InlineDocumentSignerIntegrationData.md) | | [optional]
|
41
|
+
**password** | **String** | Require the signer to enter this password before signing a document. This field is write only. | [optional]
|
39
42
|
|
40
43
|
|
data/docs/SignrequestsApi.md
CHANGED
@@ -32,7 +32,7 @@ end
|
|
32
32
|
|
33
33
|
api_instance = SignRequestClient::SignrequestsApi.new
|
34
34
|
|
35
|
-
uuid =
|
35
|
+
uuid = 'uuid_example' # String |
|
36
36
|
|
37
37
|
|
38
38
|
begin
|
@@ -141,8 +141,8 @@ end
|
|
141
141
|
api_instance = SignRequestClient::SignrequestsApi.new
|
142
142
|
|
143
143
|
opts = {
|
144
|
-
who:
|
145
|
-
from_email:
|
144
|
+
who: 'who_example', # String |
|
145
|
+
from_email: 'from_email_example', # String |
|
146
146
|
page: 56, # Integer | A page number within the paginated result set.
|
147
147
|
limit: 56 # Integer | Number of results to return per page.
|
148
148
|
}
|
@@ -201,7 +201,7 @@ end
|
|
201
201
|
|
202
202
|
api_instance = SignRequestClient::SignrequestsApi.new
|
203
203
|
|
204
|
-
uuid =
|
204
|
+
uuid = 'uuid_example' # String |
|
205
205
|
|
206
206
|
|
207
207
|
begin
|
@@ -255,7 +255,7 @@ end
|
|
255
255
|
|
256
256
|
api_instance = SignRequestClient::SignrequestsApi.new
|
257
257
|
|
258
|
-
uuid =
|
258
|
+
uuid = 'uuid_example' # String |
|
259
259
|
|
260
260
|
|
261
261
|
begin
|
data/docs/Team.md
CHANGED
@@ -11,5 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**primary_color** | **String** | | [optional]
|
12
12
|
**events_callback_url** | **String** | | [optional]
|
13
13
|
**members** | [**Array<InlineTeamMember>**](InlineTeamMember.md) | | [optional]
|
14
|
+
**delete_after** | **DateTime** | When filled this team will be deleted after this date | [optional]
|
15
|
+
**sandbox** | **BOOLEAN** | Indicates whether team is in Sandbox mode | [optional]
|
14
16
|
|
15
17
|
|
data/docs/TeamMember.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**uuid** | **String** | | [optional]
|
7
7
|
**url** | **String** | | [optional]
|
8
8
|
**user** | [**User**](User.md) | | [optional]
|
9
|
+
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
|
9
10
|
**is_admin** | **BOOLEAN** | | [optional]
|
10
11
|
**is_active** | **BOOLEAN** | | [optional]
|
11
12
|
**is_owner** | **BOOLEAN** | | [optional]
|
data/docs/TeamMembersApi.md
CHANGED
@@ -30,12 +30,12 @@ end
|
|
30
30
|
api_instance = SignRequestClient::TeamMembersApi.new
|
31
31
|
|
32
32
|
opts = {
|
33
|
-
is_active:
|
34
|
-
is_owner:
|
35
|
-
is_admin:
|
36
|
-
user__email:
|
37
|
-
user__first_name:
|
38
|
-
user__last_name:
|
33
|
+
is_active: 'is_active_example', # String |
|
34
|
+
is_owner: 'is_owner_example', # String |
|
35
|
+
is_admin: 'is_admin_example', # String |
|
36
|
+
user__email: 'user__email_example', # String |
|
37
|
+
user__first_name: 'user__first_name_example', # String |
|
38
|
+
user__last_name: 'user__last_name_example', # String |
|
39
39
|
page: 56, # Integer | A page number within the paginated result set.
|
40
40
|
limit: 56 # Integer | Number of results to return per page.
|
41
41
|
}
|
@@ -98,7 +98,7 @@ end
|
|
98
98
|
|
99
99
|
api_instance = SignRequestClient::TeamMembersApi.new
|
100
100
|
|
101
|
-
uuid =
|
101
|
+
uuid = 'uuid_example' # String |
|
102
102
|
|
103
103
|
|
104
104
|
begin
|
data/docs/TeamsApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**teams_create**](TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team
|
8
|
+
[**teams_delete**](TeamsApi.md#teams_delete) | **DELETE** /teams/{subdomain}/ | Delete a Team
|
8
9
|
[**teams_invite_member**](TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member
|
9
10
|
[**teams_list**](TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams
|
10
11
|
[**teams_partial_update**](TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team
|
@@ -65,6 +66,59 @@ Name | Type | Description | Notes
|
|
65
66
|
|
66
67
|
|
67
68
|
|
69
|
+
# **teams_delete**
|
70
|
+
> teams_delete(subdomain, )
|
71
|
+
|
72
|
+
Delete a Team
|
73
|
+
|
74
|
+
Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
75
|
+
|
76
|
+
### Example
|
77
|
+
```ruby
|
78
|
+
# load the gem
|
79
|
+
require 'signrequest_client'
|
80
|
+
# setup authorization
|
81
|
+
SignRequestClient.configure do |config|
|
82
|
+
# Configure API key authorization: Token
|
83
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
84
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
86
|
+
end
|
87
|
+
|
88
|
+
api_instance = SignRequestClient::TeamsApi.new
|
89
|
+
|
90
|
+
subdomain = 'subdomain_example' # String |
|
91
|
+
|
92
|
+
|
93
|
+
begin
|
94
|
+
#Delete a Team
|
95
|
+
api_instance.teams_delete(subdomain, )
|
96
|
+
rescue SignRequestClient::ApiError => e
|
97
|
+
puts "Exception when calling TeamsApi->teams_delete: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**subdomain** | **String**| |
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
nil (empty response body)
|
110
|
+
|
111
|
+
### Authorization
|
112
|
+
|
113
|
+
[Token](../README.md#Token)
|
114
|
+
|
115
|
+
### HTTP request headers
|
116
|
+
|
117
|
+
- **Content-Type**: application/json
|
118
|
+
- **Accept**: application/json
|
119
|
+
|
120
|
+
|
121
|
+
|
68
122
|
# **teams_invite_member**
|
69
123
|
> InviteMember teams_invite_member(subdomain, data)
|
70
124
|
|
@@ -86,7 +140,7 @@ end
|
|
86
140
|
|
87
141
|
api_instance = SignRequestClient::TeamsApi.new
|
88
142
|
|
89
|
-
subdomain =
|
143
|
+
subdomain = 'subdomain_example' # String |
|
90
144
|
|
91
145
|
data = SignRequestClient::InviteMember.new # InviteMember |
|
92
146
|
|
@@ -200,7 +254,7 @@ end
|
|
200
254
|
|
201
255
|
api_instance = SignRequestClient::TeamsApi.new
|
202
256
|
|
203
|
-
subdomain =
|
257
|
+
subdomain = 'subdomain_example' # String |
|
204
258
|
|
205
259
|
data = SignRequestClient::Team.new # Team |
|
206
260
|
|
@@ -257,7 +311,7 @@ end
|
|
257
311
|
|
258
312
|
api_instance = SignRequestClient::TeamsApi.new
|
259
313
|
|
260
|
-
subdomain =
|
314
|
+
subdomain = 'subdomain_example' # String |
|
261
315
|
|
262
316
|
|
263
317
|
begin
|
data/docs/Template.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Defaults to filename | [optional]
|
8
8
|
**uuid** | **String** | | [optional]
|
9
9
|
**user** | [**User**](User.md) | | [optional]
|
10
|
+
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
|
10
11
|
**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional]
|
11
12
|
**signers** | [**Array<DocumentSignerTemplateConf>**](DocumentSignerTemplateConf.md) | | [optional]
|
12
13
|
|
data/docs/TemplatesApi.md
CHANGED
data/docs/WebhookSubscription.md
CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**event_type** | **String** | |
|
10
10
|
**callback_url** | **String** | |
|
11
11
|
**integration** | **String** | | [optional]
|
12
|
+
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
|
12
13
|
**created** | **DateTime** | | [optional]
|
13
14
|
|
14
15
|
|
data/docs/WebhooksApi.md
CHANGED
@@ -87,7 +87,7 @@ end
|
|
87
87
|
|
88
88
|
api_instance = SignRequestClient::WebhooksApi.new
|
89
89
|
|
90
|
-
uuid =
|
90
|
+
uuid = 'uuid_example' # String |
|
91
91
|
|
92
92
|
|
93
93
|
begin
|
@@ -197,7 +197,7 @@ end
|
|
197
197
|
|
198
198
|
api_instance = SignRequestClient::WebhooksApi.new
|
199
199
|
|
200
|
-
uuid =
|
200
|
+
uuid = 'uuid_example' # String |
|
201
201
|
|
202
202
|
data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
|
203
203
|
|
@@ -254,7 +254,7 @@ end
|
|
254
254
|
|
255
255
|
api_instance = SignRequestClient::WebhooksApi.new
|
256
256
|
|
257
|
-
uuid =
|
257
|
+
uuid = 'uuid_example' # String |
|
258
258
|
|
259
259
|
|
260
260
|
begin
|
@@ -308,7 +308,7 @@ end
|
|
308
308
|
|
309
309
|
api_instance = SignRequestClient::WebhooksApi.new
|
310
310
|
|
311
|
-
uuid =
|
311
|
+
uuid = 'uuid_example' # String |
|
312
312
|
|
313
313
|
data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
|
314
314
|
|
data/lib/signrequest_client.rb
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
OpenAPI spec version: v1
|
7
7
|
Contact: tech-support@signrequest.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.8
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -22,6 +22,9 @@ require 'signrequest_client/models/document'
|
|
22
22
|
require 'signrequest_client/models/document_attachment'
|
23
23
|
require 'signrequest_client/models/document_search'
|
24
24
|
require 'signrequest_client/models/document_signer_template_conf'
|
25
|
+
require 'signrequest_client/models/document_signing_log'
|
26
|
+
require 'signrequest_client/models/document_signrequest'
|
27
|
+
require 'signrequest_client/models/document_team'
|
25
28
|
require 'signrequest_client/models/event'
|
26
29
|
require 'signrequest_client/models/file_from_sf'
|
27
30
|
require 'signrequest_client/models/inline_document_signer_integration_data'
|
@@ -6,11 +6,11 @@
|
|
6
6
|
OpenAPI spec version: v1
|
7
7
|
Contact: tech-support@signrequest.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.8
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
|
-
require
|
13
|
+
require 'uri'
|
14
14
|
|
15
15
|
module SignRequestClient
|
16
16
|
class ApiTokensApi
|
@@ -19,116 +19,6 @@ module SignRequestClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
|
23
|
-
# Create an API token
|
24
|
-
# You can create an API token in the [team api settings page](/#/teams). It is also possible to get or create a token using the REST api with your login credentials.
|
25
|
-
# @param data
|
26
|
-
# @param [Hash] opts the optional parameters
|
27
|
-
# @return [AuthToken]
|
28
|
-
def api_tokens_create(data, opts = {})
|
29
|
-
data, _status_code, _headers = api_tokens_create_with_http_info(data, opts)
|
30
|
-
return data
|
31
|
-
end
|
32
|
-
|
33
|
-
# Create an API token
|
34
|
-
# You can create an API token in the [team api settings page](/#/teams). It is also possible to get or create a token using the REST api with your login credentials.
|
35
|
-
# @param data
|
36
|
-
# @param [Hash] opts the optional parameters
|
37
|
-
# @return [Array<(AuthToken, Fixnum, Hash)>] AuthToken data, response status code and response headers
|
38
|
-
def api_tokens_create_with_http_info(data, opts = {})
|
39
|
-
if @api_client.config.debugging
|
40
|
-
@api_client.config.logger.debug "Calling API: ApiTokensApi.api_tokens_create ..."
|
41
|
-
end
|
42
|
-
# verify the required parameter 'data' is set
|
43
|
-
if @api_client.config.client_side_validation && data.nil?
|
44
|
-
fail ArgumentError, "Missing the required parameter 'data' when calling ApiTokensApi.api_tokens_create"
|
45
|
-
end
|
46
|
-
# resource path
|
47
|
-
local_var_path = "/api-tokens/"
|
48
|
-
|
49
|
-
# query parameters
|
50
|
-
query_params = {}
|
51
|
-
|
52
|
-
# header parameters
|
53
|
-
header_params = {}
|
54
|
-
# HTTP header 'Accept' (if needed)
|
55
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
|
-
# HTTP header 'Content-Type'
|
57
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
58
|
-
|
59
|
-
# form parameters
|
60
|
-
form_params = {}
|
61
|
-
|
62
|
-
# http body (model)
|
63
|
-
post_body = @api_client.object_to_http_body(data)
|
64
|
-
auth_names = ['Token']
|
65
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
66
|
-
:header_params => header_params,
|
67
|
-
:query_params => query_params,
|
68
|
-
:form_params => form_params,
|
69
|
-
:body => post_body,
|
70
|
-
:auth_names => auth_names,
|
71
|
-
:return_type => 'AuthToken')
|
72
|
-
if @api_client.config.debugging
|
73
|
-
@api_client.config.logger.debug "API called: ApiTokensApi#api_tokens_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
74
|
-
end
|
75
|
-
return data, status_code, headers
|
76
|
-
end
|
77
|
-
|
78
|
-
# Delete an API token
|
79
|
-
#
|
80
|
-
# @param key A unique value identifying this api token.
|
81
|
-
# @param [Hash] opts the optional parameters
|
82
|
-
# @return [nil]
|
83
|
-
def api_tokens_delete(key, opts = {})
|
84
|
-
api_tokens_delete_with_http_info(key, opts)
|
85
|
-
return nil
|
86
|
-
end
|
87
|
-
|
88
|
-
# Delete an API token
|
89
|
-
#
|
90
|
-
# @param key A unique value identifying this api token.
|
91
|
-
# @param [Hash] opts the optional parameters
|
92
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
93
|
-
def api_tokens_delete_with_http_info(key, opts = {})
|
94
|
-
if @api_client.config.debugging
|
95
|
-
@api_client.config.logger.debug "Calling API: ApiTokensApi.api_tokens_delete ..."
|
96
|
-
end
|
97
|
-
# verify the required parameter 'key' is set
|
98
|
-
if @api_client.config.client_side_validation && key.nil?
|
99
|
-
fail ArgumentError, "Missing the required parameter 'key' when calling ApiTokensApi.api_tokens_delete"
|
100
|
-
end
|
101
|
-
# resource path
|
102
|
-
local_var_path = "/api-tokens/{key}/".sub('{' + 'key' + '}', key.to_s)
|
103
|
-
|
104
|
-
# query parameters
|
105
|
-
query_params = {}
|
106
|
-
|
107
|
-
# header parameters
|
108
|
-
header_params = {}
|
109
|
-
# HTTP header 'Accept' (if needed)
|
110
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
111
|
-
# HTTP header 'Content-Type'
|
112
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
113
|
-
|
114
|
-
# form parameters
|
115
|
-
form_params = {}
|
116
|
-
|
117
|
-
# http body (model)
|
118
|
-
post_body = nil
|
119
|
-
auth_names = ['Token']
|
120
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
121
|
-
:header_params => header_params,
|
122
|
-
:query_params => query_params,
|
123
|
-
:form_params => form_params,
|
124
|
-
:body => post_body,
|
125
|
-
:auth_names => auth_names)
|
126
|
-
if @api_client.config.debugging
|
127
|
-
@api_client.config.logger.debug "API called: ApiTokensApi#api_tokens_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
128
|
-
end
|
129
|
-
return data, status_code, headers
|
130
|
-
end
|
131
|
-
|
132
22
|
# Retrieve a list of API tokens
|
133
23
|
#
|
134
24
|
# @param [Hash] opts the optional parameters
|
@@ -137,7 +27,7 @@ module SignRequestClient
|
|
137
27
|
# @return [InlineResponse200]
|
138
28
|
def api_tokens_list(opts = {})
|
139
29
|
data, _status_code, _headers = api_tokens_list_with_http_info(opts)
|
140
|
-
|
30
|
+
data
|
141
31
|
end
|
142
32
|
|
143
33
|
# Retrieve a list of API tokens
|
@@ -148,10 +38,10 @@ module SignRequestClient
|
|
148
38
|
# @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
|
149
39
|
def api_tokens_list_with_http_info(opts = {})
|
150
40
|
if @api_client.config.debugging
|
151
|
-
@api_client.config.logger.debug
|
41
|
+
@api_client.config.logger.debug 'Calling API: ApiTokensApi.api_tokens_list ...'
|
152
42
|
end
|
153
43
|
# resource path
|
154
|
-
local_var_path =
|
44
|
+
local_var_path = '/api-tokens/'
|
155
45
|
|
156
46
|
# query parameters
|
157
47
|
query_params = {}
|
@@ -183,60 +73,5 @@ module SignRequestClient
|
|
183
73
|
end
|
184
74
|
return data, status_code, headers
|
185
75
|
end
|
186
|
-
|
187
|
-
# Retrieve an API token
|
188
|
-
#
|
189
|
-
# @param key A unique value identifying this api token.
|
190
|
-
# @param [Hash] opts the optional parameters
|
191
|
-
# @return [AuthToken]
|
192
|
-
def api_tokens_read(key, opts = {})
|
193
|
-
data, _status_code, _headers = api_tokens_read_with_http_info(key, opts)
|
194
|
-
return data
|
195
|
-
end
|
196
|
-
|
197
|
-
# Retrieve an API token
|
198
|
-
#
|
199
|
-
# @param key A unique value identifying this api token.
|
200
|
-
# @param [Hash] opts the optional parameters
|
201
|
-
# @return [Array<(AuthToken, Fixnum, Hash)>] AuthToken data, response status code and response headers
|
202
|
-
def api_tokens_read_with_http_info(key, opts = {})
|
203
|
-
if @api_client.config.debugging
|
204
|
-
@api_client.config.logger.debug "Calling API: ApiTokensApi.api_tokens_read ..."
|
205
|
-
end
|
206
|
-
# verify the required parameter 'key' is set
|
207
|
-
if @api_client.config.client_side_validation && key.nil?
|
208
|
-
fail ArgumentError, "Missing the required parameter 'key' when calling ApiTokensApi.api_tokens_read"
|
209
|
-
end
|
210
|
-
# resource path
|
211
|
-
local_var_path = "/api-tokens/{key}/".sub('{' + 'key' + '}', key.to_s)
|
212
|
-
|
213
|
-
# query parameters
|
214
|
-
query_params = {}
|
215
|
-
|
216
|
-
# header parameters
|
217
|
-
header_params = {}
|
218
|
-
# HTTP header 'Accept' (if needed)
|
219
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
220
|
-
# HTTP header 'Content-Type'
|
221
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
222
|
-
|
223
|
-
# form parameters
|
224
|
-
form_params = {}
|
225
|
-
|
226
|
-
# http body (model)
|
227
|
-
post_body = nil
|
228
|
-
auth_names = ['Token']
|
229
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
230
|
-
:header_params => header_params,
|
231
|
-
:query_params => query_params,
|
232
|
-
:form_params => form_params,
|
233
|
-
:body => post_body,
|
234
|
-
:auth_names => auth_names,
|
235
|
-
:return_type => 'AuthToken')
|
236
|
-
if @api_client.config.debugging
|
237
|
-
@api_client.config.logger.debug "API called: ApiTokensApi#api_tokens_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
238
|
-
end
|
239
|
-
return data, status_code, headers
|
240
|
-
end
|
241
76
|
end
|
242
77
|
end
|