docs/CheckinsApi.md in get_around_owner-1.0.3 vs docs/CheckinsApi.md in get_around_owner-1.0.4
- old
+ new
@@ -1,25 +1,27 @@
# GetAroundOwner::CheckinsApi
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_checkin_by_rental_id**](CheckinsApi.md#get_checkin_by_rental_id) | **GET** /rentals/{rental_id}/checkin.json | Find a checkin by rental ID
-[**get_checkins**](CheckinsApi.md#get_checkins) | **GET** /checkins.json | List of checkins that occurred between two dates
+| Method | HTTP request | Description |
+| ----------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------ |
+| [**get_checkin_by_rental_id**](CheckinsApi.md#get_checkin_by_rental_id) | **GET** /rentals/{rental_id}/checkin.json | Find a checkin by rental ID |
+| [**get_checkins**](CheckinsApi.md#get_checkins) | **GET** /checkins.json | List of checkins that occurred between two dates |
# **get_checkin_by_rental_id**
+
> Checkin get_checkin_by_rental_id(rental_id)
Find a checkin by rental ID
Find a checkin by rental ID
### Example
+
```ruby
# load the gem
-require 'getaround-api'
+require 'get_around_owner'
# setup authorization
GetAroundOwner.configure do |config|
end
api_instance = GetAroundOwner::CheckinsApi.new
@@ -35,13 +37,13 @@
end
```
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **rental_id** | [****](.md)| ID of the rental related to the checkin to return |
+| Name | Type | Description | Notes |
+| ------------- | --------------- | ------------------------------------------------- | ----- |
+| **rental_id** | [\*\*\*\*](.md) | ID of the rental related to the checkin to return |
### Return type
[**Checkin**](Checkin.md)
@@ -49,34 +51,34 @@
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
-
-
# **get_checkins**
+
> CheckinsIndex get_checkins(start_date, end_date, opts)
List of checkins that occurred between two dates
List of checkins that occurred between two dates
### Example
+
```ruby
# load the gem
-require 'getaround-api'
+require 'get_around_owner'
# setup authorization
GetAroundOwner.configure do |config|
end
api_instance = GetAroundOwner::CheckinsApi.new
start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
-opts = {
+opts = {
page: GetAroundOwner::null.new, # | Page number
per_page: GetAroundOwner::null.new # | Page size
}
begin
@@ -88,16 +90,16 @@
end
```
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **start_date** | [****](.md)| Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
- **end_date** | [****](.md)| End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
- **page** | [****](.md)| Page number | [optional]
- **per_page** | [****](.md)| Page size | [optional] [default to 30]
+| Name | Type | Description | Notes |
+| -------------- | --------------- | ----------------------------------------------------------------------------------------------- | -------------------------- |
+| **start_date** | [\*\*\*\*](.md) | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
+| **end_date** | [\*\*\*\*](.md) | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
+| **page** | [\*\*\*\*](.md) | Page number | [optional] |
+| **per_page** | [\*\*\*\*](.md) | Page size | [optional] [default to 30] |
### Return type
[**CheckinsIndex**](CheckinsIndex.md)
@@ -105,10 +107,7 @@
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json