You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | Retrieve a list of Document Attachments
*SignRequestClient::SignrequestsApi* | [**signrequests_cancel_signrequest**](docs/SignrequestsApi.md#signrequests_cancel_signrequest) | **POST** /signrequests/{uuid}/cancel_signrequest/ | Cancel a SignRequest
59
+
*SignRequestClient::SignrequestsApi* | [**signrequests_create**](docs/SignrequestsApi.md#signrequests_create) | **POST** /signrequests/ | Create a SignRequest
60
+
*SignRequestClient::SignrequestsApi* | [**signrequests_list**](docs/SignrequestsApi.md#signrequests_list) | **GET** /signrequests/ | Retrieve a list of SignRequests
61
+
*SignRequestClient::SignrequestsApi* | [**signrequests_read**](docs/SignrequestsApi.md#signrequests_read) | **GET** /signrequests/{uuid}/ | Retrieve a SignRequest
62
+
*SignRequestClient::SignrequestsApi* | [**signrequests_resend_signrequest_email**](docs/SignrequestsApi.md#signrequests_resend_signrequest_email) | **POST** /signrequests/{uuid}/resend_signrequest_email/ | Resend a SignRequest
63
+
*SignRequestClient::TeamMembersApi* | [**team_members_list**](docs/TeamMembersApi.md#team_members_list) | **GET** /team-members/ | Retrieve a list of Team Members
64
+
*SignRequestClient::TeamMembersApi* | [**team_members_read**](docs/TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | Retrieve a Team Member
65
+
*SignRequestClient::TeamsApi* | [**teams_create**](docs/TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team
66
+
*SignRequestClient::TeamsApi* | [**teams_invite_member**](docs/TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member
67
+
*SignRequestClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams
68
+
*SignRequestClient::TeamsApi* | [**teams_partial_update**](docs/TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team
69
+
*SignRequestClient::TeamsApi* | [**teams_read**](docs/TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ | Retrieve a Team
70
+
*SignRequestClient::TemplatesApi* | [**templates_list**](docs/TemplatesApi.md#templates_list) | **GET** /templates/ | Retrieve a list of Templates
71
+
*SignRequestClient::TemplatesApi* | [**templates_read**](docs/TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ | Retrieve a Template
72
+
*SignRequestClient::WebhooksApi* | [**webhooks_create**](docs/WebhooksApi.md#webhooks_create) | **POST** /webhooks/ | Create a Webhook
73
+
*SignRequestClient::WebhooksApi* | [**webhooks_delete**](docs/WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ | Delete a Webhook
74
+
*SignRequestClient::WebhooksApi* | [**webhooks_list**](docs/WebhooksApi.md#webhooks_list) | **GET** /webhooks/ | Retrieve a list of Webhooks
[**api_tokens_create**](ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ | Create an API token
8
+
[**api_tokens_delete**](ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | Delete an API token
9
+
[**api_tokens_list**](ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | Retrieve a list of API tokens
10
+
[**api_tokens_read**](ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | Retrieve an API token
11
11
12
12
13
13
# **api_tokens_create**
14
14
> AuthToken api_tokens_create(data)
15
15
16
+
Create an API token
16
17
17
-
18
-
18
+
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.
19
19
20
20
### Example
21
21
```ruby
@@ -35,6 +35,7 @@ data = SignRequestClient::AuthToken.new # AuthToken |
35
35
36
36
37
37
begin
38
+
#Create an API token
38
39
result = api_instance.api_tokens_create(data)
39
40
p result
40
41
rescueSignRequestClient::ApiError => e
@@ -66,7 +67,7 @@ Name | Type | Description | Notes
66
67
# **api_tokens_delete**
67
68
> api_tokens_delete(key)
68
69
69
-
70
+
Delete an API token
70
71
71
72
72
73
@@ -88,6 +89,7 @@ key = "key_example" # String | A unique value identifying this api token.
88
89
89
90
90
91
begin
92
+
#Delete an API token
91
93
api_instance.api_tokens_delete(key)
92
94
rescueSignRequestClient::ApiError => e
93
95
puts"Exception when calling ApiTokensApi->api_tokens_delete: #{e}"
@@ -118,7 +120,7 @@ nil (empty response body)
118
120
# **api_tokens_list**
119
121
> InlineResponse200 api_tokens_list(opts)
120
122
121
-
123
+
Retrieve a list of API tokens
122
124
123
125
124
126
@@ -142,6 +144,7 @@ opts = {
142
144
}
143
145
144
146
begin
147
+
#Retrieve a list of API tokens
145
148
result = api_instance.api_tokens_list(opts)
146
149
p result
147
150
rescueSignRequestClient::ApiError => e
@@ -174,7 +177,7 @@ Name | Type | Description | Notes
174
177
# **api_tokens_read**
175
178
> AuthToken api_tokens_read(key)
176
179
177
-
180
+
Retrieve an API token
178
181
179
182
180
183
@@ -196,6 +199,7 @@ key = "key_example" # String | A unique value identifying this api token.
**file_as_pdf** | **String** | Temporary URL to original file as PDF, expires in five minutes | [optional]
10
+
**name** | **String** | Defaults to filename, including extension | [optional]
11
+
**external_id** | **String** | ID used to reference document in external system | [optional]
12
+
**frontend_id** | **String** | Shared secret used in conjunction with <a href=\"#section/Frontend-API/SignRequest-js-client-(beta)\">SignRequest-js client</a> to grant user access to a document that's not a member of the document's team | [optional]
13
+
**file** | **String** | Temporary URL to original file, expires in five minutes | [optional]
14
+
**file_from_url** | **String** | Publicly accessible URL of document to be downloaded by SignRequest | [optional]
15
+
**events_callback_url** | **String** | URL at which to receive [event callbacks](#section/Events/Events-callback) for this document | [optional]
**auto_delete_days** | **Integer** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
23
+
**pdf** | **String** | Temporary URL to signed document as PDF, expires in five minutes | [optional]
**auto_delete_after** | **DateTime** | Date and time calculated using `auto_delete_days` after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
0 commit comments