docs/EventsApi.md in signrequest_client-0.1.0 vs docs/EventsApi.md in signrequest_client-1.0.0
- old
+ new
@@ -2,21 +2,21 @@
All URIs are relative to *https://signrequest.com/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**events_list**](EventsApi.md#events_list) | **GET** /events/ |
-[**events_read**](EventsApi.md#events_read) | **GET** /events/{id}/ |
+[**events_list**](EventsApi.md#events_list) | **GET** /events/ | Retrieve a list of Events
+[**events_read**](EventsApi.md#events_read) | **GET** /events/{id}/ | Retrieve an Event
# **events_list**
> InlineResponse2004 events_list(opts)
+Retrieve a list of Events
-
### Example
```ruby
# load the gem
require 'signrequest_client'
# setup authorization
@@ -46,10 +46,11 @@
page: 56, # Integer | A page number within the paginated result set.
limit: 56 # Integer | Number of results to return per page.
}
begin
+ #Retrieve a list of Events
result = api_instance.events_list(opts)
p result
rescue SignRequestClient::ApiError => e
puts "Exception when calling EventsApi->events_list: #{e}"
end
@@ -91,14 +92,14 @@
# **events_read**
> Event events_read(id)
+Retrieve an Event
-
### Example
```ruby
# load the gem
require 'signrequest_client'
# setup authorization
@@ -113,9 +114,10 @@
id = 56 # Integer | A unique integer value identifying this event.
begin
+ #Retrieve an Event
result = api_instance.events_read(id)
p result
rescue SignRequestClient::ApiError => e
puts "Exception when calling EventsApi->events_read: #{e}"
end