signrequest_client 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +43 -44
- data/docs/ApiTokensApi.md +13 -9
- data/docs/Document.md +16 -19
- data/docs/DocumentAttachment.md +5 -5
- data/docs/DocumentAttachmentsApi.md +9 -6
- data/docs/DocumentSearch.md +5 -5
- data/docs/DocumentsApi.md +12 -65
- data/docs/DocumentsSearchApi.md +23 -58
- data/docs/Event.md +0 -1
- data/docs/EventsApi.md +6 -4
- data/docs/InlineResponse201.md +9 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/InlineSignRequest.md +15 -15
- data/docs/SignRequest.md +15 -15
- data/docs/SignRequestQuickCreate.md +25 -25
- data/docs/SignerAttachment.md +1 -1
- data/docs/SigningLog.md +2 -2
- data/docs/SignrequestQuickCreateApi.md +3 -2
- data/docs/SignrequestsApi.md +21 -22
- data/docs/TeamMember.md +0 -1
- data/docs/TeamMembersApi.md +6 -4
- data/docs/TeamsApi.md +20 -72
- data/docs/Template.md +2 -3
- data/docs/TemplatesApi.md +6 -4
- data/docs/WebhookSubscription.md +1 -2
- data/docs/WebhooksApi.md +18 -12
- data/lib/signrequest_client.rb +2 -0
- data/lib/signrequest_client/api/api_tokens_api.rb +10 -10
- data/lib/signrequest_client/api/document_attachments_api.rb +6 -6
- data/lib/signrequest_client/api/documents_api.rb +8 -69
- data/lib/signrequest_client/api/documents_search_api.rb +31 -59
- data/lib/signrequest_client/api/events_api.rb +4 -4
- data/lib/signrequest_client/api/signrequest_quick_create_api.rb +2 -2
- data/lib/signrequest_client/api/signrequests_api.rb +24 -36
- data/lib/signrequest_client/api/team_members_api.rb +4 -4
- data/lib/signrequest_client/api/teams_api.rb +20 -81
- data/lib/signrequest_client/api/templates_api.rb +4 -4
- data/lib/signrequest_client/api/webhooks_api.rb +12 -12
- data/lib/signrequest_client/models/document.rb +19 -30
- data/lib/signrequest_client/models/document_attachment.rb +5 -0
- data/lib/signrequest_client/models/document_search.rb +60 -79
- data/lib/signrequest_client/models/event.rb +3 -12
- data/lib/signrequest_client/models/inline_prefill_tags.rb +1 -1
- data/lib/signrequest_client/models/inline_response_201.rb +240 -0
- data/lib/signrequest_client/models/inline_response_201_1.rb +226 -0
- data/lib/signrequest_client/models/inline_sign_request.rb +46 -38
- data/lib/signrequest_client/models/sign_request.rb +15 -0
- data/lib/signrequest_client/models/sign_request_quick_create.rb +25 -0
- data/lib/signrequest_client/models/signer_attachment.rb +1 -0
- data/lib/signrequest_client/models/signing_log.rb +7 -5
- data/lib/signrequest_client/models/team_member.rb +1 -10
- data/lib/signrequest_client/models/template.rb +3 -10
- data/lib/signrequest_client/models/webhook_subscription.rb +4 -12
- data/lib/signrequest_client/version.rb +1 -1
- data/pkg/signrequest_client-0.1.0.gem +0 -0
- data/spec/models/inline_response_201_1_spec.rb +46 -0
- data/spec/models/inline_response_201_spec.rb +52 -0
- metadata +11 -3
data/docs/TeamMember.md
CHANGED
@@ -6,7 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**uuid** | **String** | | [optional]
|
7
7
|
**url** | **String** | | [optional]
|
8
8
|
**user** | [**User**](User.md) | | [optional]
|
9
|
-
**team** | [**InlineTeam**](InlineTeam.md) | | [optional]
|
10
9
|
**is_admin** | **BOOLEAN** | | [optional]
|
11
10
|
**is_active** | **BOOLEAN** | | [optional]
|
12
11
|
**is_owner** | **BOOLEAN** | | [optional]
|
data/docs/TeamMembersApi.md
CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**team_members_list**](TeamMembersApi.md#team_members_list) | **GET** /team-members/ |
|
8
|
-
[**team_members_read**](TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ |
|
7
|
+
[**team_members_list**](TeamMembersApi.md#team_members_list) | **GET** /team-members/ | Retrieve a list of Team Members
|
8
|
+
[**team_members_read**](TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | Retrieve a Team Member
|
9
9
|
|
10
10
|
|
11
11
|
# **team_members_list**
|
12
12
|
> InlineResponse2006 team_members_list(opts)
|
13
13
|
|
14
|
-
|
14
|
+
Retrieve a list of Team Members
|
15
15
|
|
16
16
|
|
17
17
|
|
@@ -41,6 +41,7 @@ opts = {
|
|
41
41
|
}
|
42
42
|
|
43
43
|
begin
|
44
|
+
#Retrieve a list of Team Members
|
44
45
|
result = api_instance.team_members_list(opts)
|
45
46
|
p result
|
46
47
|
rescue SignRequestClient::ApiError => e
|
@@ -79,7 +80,7 @@ Name | Type | Description | Notes
|
|
79
80
|
# **team_members_read**
|
80
81
|
> TeamMember team_members_read(uuid)
|
81
82
|
|
82
|
-
|
83
|
+
Retrieve a Team Member
|
83
84
|
|
84
85
|
|
85
86
|
|
@@ -101,6 +102,7 @@ uuid = "uuid_example" # String |
|
|
101
102
|
|
102
103
|
|
103
104
|
begin
|
105
|
+
#Retrieve a Team Member
|
104
106
|
result = api_instance.team_members_read(uuid)
|
105
107
|
p result
|
106
108
|
rescue SignRequestClient::ApiError => e
|
data/docs/TeamsApi.md
CHANGED
@@ -4,20 +4,19 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**teams_create**](TeamsApi.md#teams_create) | **POST** /teams/ |
|
8
|
-
[**teams_invite_member**](TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ |
|
9
|
-
[**teams_list**](TeamsApi.md#teams_list) | **GET** /teams/ |
|
10
|
-
[**teams_partial_update**](TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ |
|
11
|
-
[**teams_read**](TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ |
|
12
|
-
[**teams_update**](TeamsApi.md#teams_update) | **PUT** /teams/{subdomain}/ |
|
7
|
+
[**teams_create**](TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team
|
8
|
+
[**teams_invite_member**](TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member
|
9
|
+
[**teams_list**](TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams
|
10
|
+
[**teams_partial_update**](TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team
|
11
|
+
[**teams_read**](TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ | Retrieve a Team
|
13
12
|
|
14
13
|
|
15
14
|
# **teams_create**
|
16
15
|
> Team teams_create(data)
|
17
16
|
|
17
|
+
Create a Team
|
18
18
|
|
19
|
-
|
20
|
-
If your application requires to create Teams and act on behalf of them you need to become an integration partner. 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/*
|
19
|
+
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/*
|
21
20
|
|
22
21
|
### Example
|
23
22
|
```ruby
|
@@ -37,6 +36,7 @@ data = SignRequestClient::Team.new # Team |
|
|
37
36
|
|
38
37
|
|
39
38
|
begin
|
39
|
+
#Create a Team
|
40
40
|
result = api_instance.teams_create(data)
|
41
41
|
p result
|
42
42
|
rescue SignRequestClient::ApiError => e
|
@@ -68,9 +68,9 @@ Name | Type | Description | Notes
|
|
68
68
|
# **teams_invite_member**
|
69
69
|
> InviteMember teams_invite_member(subdomain, data)
|
70
70
|
|
71
|
+
Invite a Team Member
|
71
72
|
|
72
|
-
|
73
|
-
If your application requires to create Teams and act on behalf of them you need to become an integration partner. 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/*
|
73
|
+
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/*
|
74
74
|
|
75
75
|
### Example
|
76
76
|
```ruby
|
@@ -92,6 +92,7 @@ data = SignRequestClient::InviteMember.new # InviteMember |
|
|
92
92
|
|
93
93
|
|
94
94
|
begin
|
95
|
+
#Invite a Team Member
|
95
96
|
result = api_instance.teams_invite_member(subdomain, data)
|
96
97
|
p result
|
97
98
|
rescue SignRequestClient::ApiError => e
|
@@ -124,9 +125,9 @@ Name | Type | Description | Notes
|
|
124
125
|
# **teams_list**
|
125
126
|
> InlineResponse2007 teams_list(opts)
|
126
127
|
|
128
|
+
Retrieve a list of Teams
|
127
129
|
|
128
|
-
|
129
|
-
If your application requires to create Teams and act on behalf of them you need to become an integration partner. 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/*
|
130
|
+
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/*
|
130
131
|
|
131
132
|
### Example
|
132
133
|
```ruby
|
@@ -148,6 +149,7 @@ opts = {
|
|
148
149
|
}
|
149
150
|
|
150
151
|
begin
|
152
|
+
#Retrieve a list of Teams
|
151
153
|
result = api_instance.teams_list(opts)
|
152
154
|
p result
|
153
155
|
rescue SignRequestClient::ApiError => e
|
@@ -180,9 +182,9 @@ Name | Type | Description | Notes
|
|
180
182
|
# **teams_partial_update**
|
181
183
|
> Team teams_partial_update(subdomain, data)
|
182
184
|
|
185
|
+
Update a Team
|
183
186
|
|
184
|
-
|
185
|
-
If your application requires to create Teams and act on behalf of them you need to become an integration partner. 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/*
|
187
|
+
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/*
|
186
188
|
|
187
189
|
### Example
|
188
190
|
```ruby
|
@@ -204,6 +206,7 @@ data = SignRequestClient::Team.new # Team |
|
|
204
206
|
|
205
207
|
|
206
208
|
begin
|
209
|
+
#Update a Team
|
207
210
|
result = api_instance.teams_partial_update(subdomain, data)
|
208
211
|
p result
|
209
212
|
rescue SignRequestClient::ApiError => e
|
@@ -236,9 +239,9 @@ Name | Type | Description | Notes
|
|
236
239
|
# **teams_read**
|
237
240
|
> Team teams_read(subdomain, )
|
238
241
|
|
242
|
+
Retrieve a Team
|
239
243
|
|
240
|
-
|
241
|
-
If your application requires to create Teams and act on behalf of them you need to become an integration partner. 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/*
|
244
|
+
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/*
|
242
245
|
|
243
246
|
### Example
|
244
247
|
```ruby
|
@@ -258,6 +261,7 @@ subdomain = "subdomain_example" # String |
|
|
258
261
|
|
259
262
|
|
260
263
|
begin
|
264
|
+
#Retrieve a Team
|
261
265
|
result = api_instance.teams_read(subdomain, )
|
262
266
|
p result
|
263
267
|
rescue SignRequestClient::ApiError => e
|
@@ -286,59 +290,3 @@ Name | Type | Description | Notes
|
|
286
290
|
|
287
291
|
|
288
292
|
|
289
|
-
# **teams_update**
|
290
|
-
> Team teams_update(subdomain, data)
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
If your application requires to create Teams and act on behalf of them you need to become an integration partner. 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/*
|
295
|
-
|
296
|
-
### Example
|
297
|
-
```ruby
|
298
|
-
# load the gem
|
299
|
-
require 'signrequest_client'
|
300
|
-
# setup authorization
|
301
|
-
SignRequestClient.configure do |config|
|
302
|
-
# Configure API key authorization: Token
|
303
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
304
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
305
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
306
|
-
end
|
307
|
-
|
308
|
-
api_instance = SignRequestClient::TeamsApi.new
|
309
|
-
|
310
|
-
subdomain = "subdomain_example" # String |
|
311
|
-
|
312
|
-
data = SignRequestClient::Team.new # Team |
|
313
|
-
|
314
|
-
|
315
|
-
begin
|
316
|
-
result = api_instance.teams_update(subdomain, data)
|
317
|
-
p result
|
318
|
-
rescue SignRequestClient::ApiError => e
|
319
|
-
puts "Exception when calling TeamsApi->teams_update: #{e}"
|
320
|
-
end
|
321
|
-
```
|
322
|
-
|
323
|
-
### Parameters
|
324
|
-
|
325
|
-
Name | Type | Description | Notes
|
326
|
-
------------- | ------------- | ------------- | -------------
|
327
|
-
**subdomain** | **String**| |
|
328
|
-
**data** | [**Team**](Team.md)| |
|
329
|
-
|
330
|
-
### Return type
|
331
|
-
|
332
|
-
[**Team**](Team.md)
|
333
|
-
|
334
|
-
### Authorization
|
335
|
-
|
336
|
-
[Token](../README.md#Token)
|
337
|
-
|
338
|
-
### HTTP request headers
|
339
|
-
|
340
|
-
- **Content-Type**: application/json
|
341
|
-
- **Accept**: application/json
|
342
|
-
|
343
|
-
|
344
|
-
|
data/docs/Template.md
CHANGED
@@ -4,11 +4,10 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | | [optional]
|
7
|
-
**name** | **String** |
|
7
|
+
**name** | **String** | Defaults to filename | [optional]
|
8
8
|
**uuid** | **String** | | [optional]
|
9
9
|
**user** | [**User**](User.md) | | [optional]
|
10
|
-
**
|
11
|
-
**who** | **String** | | [optional]
|
10
|
+
**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional]
|
12
11
|
**signers** | [**Array<DocumentSignerTemplateConf>**](DocumentSignerTemplateConf.md) | | [optional]
|
13
12
|
|
14
13
|
|
data/docs/TemplatesApi.md
CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**templates_list**](TemplatesApi.md#templates_list) | **GET** /templates/ |
|
8
|
-
[**templates_read**](TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ |
|
7
|
+
[**templates_list**](TemplatesApi.md#templates_list) | **GET** /templates/ | Retrieve a list of Templates
|
8
|
+
[**templates_read**](TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ | Retrieve a Template
|
9
9
|
|
10
10
|
|
11
11
|
# **templates_list**
|
12
12
|
> InlineResponse2008 templates_list(opts)
|
13
13
|
|
14
|
-
|
14
|
+
Retrieve a list of Templates
|
15
15
|
|
16
16
|
|
17
17
|
|
@@ -35,6 +35,7 @@ opts = {
|
|
35
35
|
}
|
36
36
|
|
37
37
|
begin
|
38
|
+
#Retrieve a list of Templates
|
38
39
|
result = api_instance.templates_list(opts)
|
39
40
|
p result
|
40
41
|
rescue SignRequestClient::ApiError => e
|
@@ -67,7 +68,7 @@ Name | Type | Description | Notes
|
|
67
68
|
# **templates_read**
|
68
69
|
> Template templates_read(uuid)
|
69
70
|
|
70
|
-
|
71
|
+
Retrieve a Template
|
71
72
|
|
72
73
|
|
73
74
|
|
@@ -89,6 +90,7 @@ uuid = "uuid_example" # String |
|
|
89
90
|
|
90
91
|
|
91
92
|
begin
|
93
|
+
#Retrieve a Template
|
92
94
|
result = api_instance.templates_read(uuid)
|
93
95
|
p result
|
94
96
|
rescue SignRequestClient::ApiError => e
|
data/docs/WebhookSubscription.md
CHANGED
@@ -5,11 +5,10 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | | [optional]
|
7
7
|
**uuid** | **String** | | [optional]
|
8
|
-
**name** | **String** |
|
8
|
+
**name** | **String** | Optional name to easily identify what webhook is used for | [optional]
|
9
9
|
**event_type** | **String** | |
|
10
10
|
**callback_url** | **String** | |
|
11
11
|
**integration** | **String** | | [optional]
|
12
|
-
**team** | [**InlineTeam**](InlineTeam.md) | | [optional]
|
13
12
|
**created** | **DateTime** | | [optional]
|
14
13
|
|
15
14
|
|
data/docs/WebhooksApi.md
CHANGED
@@ -4,18 +4,18 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**webhooks_create**](WebhooksApi.md#webhooks_create) | **POST** /webhooks/ |
|
8
|
-
[**webhooks_delete**](WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ |
|
9
|
-
[**webhooks_list**](WebhooksApi.md#webhooks_list) | **GET** /webhooks/ |
|
10
|
-
[**webhooks_partial_update**](WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ |
|
11
|
-
[**webhooks_read**](WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ |
|
12
|
-
[**webhooks_update**](WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ |
|
7
|
+
[**webhooks_create**](WebhooksApi.md#webhooks_create) | **POST** /webhooks/ | Create a Webhook
|
8
|
+
[**webhooks_delete**](WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ | Delete a Webhook
|
9
|
+
[**webhooks_list**](WebhooksApi.md#webhooks_list) | **GET** /webhooks/ | Retrieve a list of Webhooks
|
10
|
+
[**webhooks_partial_update**](WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ | Partially update a Webhook
|
11
|
+
[**webhooks_read**](WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ | Retrieve a Webhook
|
12
|
+
[**webhooks_update**](WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ | Update a Webhook
|
13
13
|
|
14
14
|
|
15
15
|
# **webhooks_create**
|
16
16
|
> WebhookSubscription webhooks_create(data)
|
17
17
|
|
18
|
-
|
18
|
+
Create a Webhook
|
19
19
|
|
20
20
|
|
21
21
|
|
@@ -37,6 +37,7 @@ data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
|
|
37
37
|
|
38
38
|
|
39
39
|
begin
|
40
|
+
#Create a Webhook
|
40
41
|
result = api_instance.webhooks_create(data)
|
41
42
|
p result
|
42
43
|
rescue SignRequestClient::ApiError => e
|
@@ -68,7 +69,7 @@ Name | Type | Description | Notes
|
|
68
69
|
# **webhooks_delete**
|
69
70
|
> webhooks_delete(uuid, )
|
70
71
|
|
71
|
-
|
72
|
+
Delete a Webhook
|
72
73
|
|
73
74
|
|
74
75
|
|
@@ -90,6 +91,7 @@ uuid = "uuid_example" # String |
|
|
90
91
|
|
91
92
|
|
92
93
|
begin
|
94
|
+
#Delete a Webhook
|
93
95
|
api_instance.webhooks_delete(uuid, )
|
94
96
|
rescue SignRequestClient::ApiError => e
|
95
97
|
puts "Exception when calling WebhooksApi->webhooks_delete: #{e}"
|
@@ -120,7 +122,7 @@ nil (empty response body)
|
|
120
122
|
# **webhooks_list**
|
121
123
|
> InlineResponse2009 webhooks_list(opts)
|
122
124
|
|
123
|
-
|
125
|
+
Retrieve a list of Webhooks
|
124
126
|
|
125
127
|
|
126
128
|
|
@@ -144,6 +146,7 @@ opts = {
|
|
144
146
|
}
|
145
147
|
|
146
148
|
begin
|
149
|
+
#Retrieve a list of Webhooks
|
147
150
|
result = api_instance.webhooks_list(opts)
|
148
151
|
p result
|
149
152
|
rescue SignRequestClient::ApiError => e
|
@@ -176,7 +179,7 @@ Name | Type | Description | Notes
|
|
176
179
|
# **webhooks_partial_update**
|
177
180
|
> WebhookSubscription webhooks_partial_update(uuid, data)
|
178
181
|
|
179
|
-
|
182
|
+
Partially update a Webhook
|
180
183
|
|
181
184
|
|
182
185
|
|
@@ -200,6 +203,7 @@ data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
|
|
200
203
|
|
201
204
|
|
202
205
|
begin
|
206
|
+
#Partially update a Webhook
|
203
207
|
result = api_instance.webhooks_partial_update(uuid, data)
|
204
208
|
p result
|
205
209
|
rescue SignRequestClient::ApiError => e
|
@@ -232,7 +236,7 @@ Name | Type | Description | Notes
|
|
232
236
|
# **webhooks_read**
|
233
237
|
> WebhookSubscription webhooks_read(uuid, )
|
234
238
|
|
235
|
-
|
239
|
+
Retrieve a Webhook
|
236
240
|
|
237
241
|
|
238
242
|
|
@@ -254,6 +258,7 @@ uuid = "uuid_example" # String |
|
|
254
258
|
|
255
259
|
|
256
260
|
begin
|
261
|
+
#Retrieve a Webhook
|
257
262
|
result = api_instance.webhooks_read(uuid, )
|
258
263
|
p result
|
259
264
|
rescue SignRequestClient::ApiError => e
|
@@ -285,7 +290,7 @@ Name | Type | Description | Notes
|
|
285
290
|
# **webhooks_update**
|
286
291
|
> WebhookSubscription webhooks_update(uuid, data)
|
287
292
|
|
288
|
-
|
293
|
+
Update a Webhook
|
289
294
|
|
290
295
|
|
291
296
|
|
@@ -309,6 +314,7 @@ data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
|
|
309
314
|
|
310
315
|
|
311
316
|
begin
|
317
|
+
#Update a Webhook
|
312
318
|
result = api_instance.webhooks_update(uuid, data)
|
313
319
|
p result
|
314
320
|
rescue SignRequestClient::ApiError => e
|
data/lib/signrequest_client.rb
CHANGED
@@ -37,6 +37,8 @@ require 'signrequest_client/models/inline_response_200_6'
|
|
37
37
|
require 'signrequest_client/models/inline_response_200_7'
|
38
38
|
require 'signrequest_client/models/inline_response_200_8'
|
39
39
|
require 'signrequest_client/models/inline_response_200_9'
|
40
|
+
require 'signrequest_client/models/inline_response_201'
|
41
|
+
require 'signrequest_client/models/inline_response_201_1'
|
40
42
|
require 'signrequest_client/models/inline_sign_request'
|
41
43
|
require 'signrequest_client/models/inline_team'
|
42
44
|
require 'signrequest_client/models/inline_team_member'
|
@@ -20,8 +20,8 @@ module SignRequestClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
|
23
|
-
#
|
24
|
-
#
|
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
25
|
# @param data
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [AuthToken]
|
@@ -30,8 +30,8 @@ module SignRequestClient
|
|
30
30
|
return data
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
34
|
-
#
|
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
35
|
# @param data
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
37
|
# @return [Array<(AuthToken, Fixnum, Hash)>] AuthToken data, response status code and response headers
|
@@ -75,7 +75,7 @@ module SignRequestClient
|
|
75
75
|
return data, status_code, headers
|
76
76
|
end
|
77
77
|
|
78
|
-
#
|
78
|
+
# Delete an API token
|
79
79
|
#
|
80
80
|
# @param key A unique value identifying this api token.
|
81
81
|
# @param [Hash] opts the optional parameters
|
@@ -85,7 +85,7 @@ module SignRequestClient
|
|
85
85
|
return nil
|
86
86
|
end
|
87
87
|
|
88
|
-
#
|
88
|
+
# Delete an API token
|
89
89
|
#
|
90
90
|
# @param key A unique value identifying this api token.
|
91
91
|
# @param [Hash] opts the optional parameters
|
@@ -129,7 +129,7 @@ module SignRequestClient
|
|
129
129
|
return data, status_code, headers
|
130
130
|
end
|
131
131
|
|
132
|
-
#
|
132
|
+
# Retrieve a list of API tokens
|
133
133
|
#
|
134
134
|
# @param [Hash] opts the optional parameters
|
135
135
|
# @option opts [Integer] :page A page number within the paginated result set.
|
@@ -140,7 +140,7 @@ module SignRequestClient
|
|
140
140
|
return data
|
141
141
|
end
|
142
142
|
|
143
|
-
#
|
143
|
+
# Retrieve a list of API tokens
|
144
144
|
#
|
145
145
|
# @param [Hash] opts the optional parameters
|
146
146
|
# @option opts [Integer] :page A page number within the paginated result set.
|
@@ -184,7 +184,7 @@ module SignRequestClient
|
|
184
184
|
return data, status_code, headers
|
185
185
|
end
|
186
186
|
|
187
|
-
#
|
187
|
+
# Retrieve an API token
|
188
188
|
#
|
189
189
|
# @param key A unique value identifying this api token.
|
190
190
|
# @param [Hash] opts the optional parameters
|
@@ -194,7 +194,7 @@ module SignRequestClient
|
|
194
194
|
return data
|
195
195
|
end
|
196
196
|
|
197
|
-
#
|
197
|
+
# Retrieve an API token
|
198
198
|
#
|
199
199
|
# @param key A unique value identifying this api token.
|
200
200
|
# @param [Hash] opts the optional parameters
|