get_around_owner 1.0.0 → 1.0.3

data/docs/PayoutsApi.md

@@ -2,70 +2,48 @@
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_payout_by_id**](PayoutsApi.md#get_payout_by_id) | **GET** /payouts/{id}.json | Find a payout by ID |
-| [**get_payouts**](PayoutsApi.md#get_payouts) | **GET** /payouts.json | Find payouts paid between dates |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_payout_by_id**](PayoutsApi.md#get_payout_by_id) | **GET** /payouts/{id}.json | Find a payout by ID
+[**get_payouts**](PayoutsApi.md#get_payouts) | **GET** /payouts.json | Find payouts paid between dates
 
-
-## get_payout_by_id
-
-> <GetaroundPayout> get_payout_by_id(id)
+# **get_payout_by_id**
+> Payout get_payout_by_id(id)
 
 Find a payout by ID
 
 Find a payout by ID
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
-require 'get_around_owner'
+# load the gem
+require 'getaround-api'
 # setup authorization
 GetAroundOwner.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
 api_instance = GetAroundOwner::PayoutsApi.new
-id = '1' # String | ID of payout to return
+id = GetAroundOwner::null.new #  | ID of payout to return
+
 
 begin
-  # Find a payout by ID
+  #Find a payout by ID
   result = api_instance.get_payout_by_id(id)
   p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling PayoutsApi->get_payout_by_id: #{e}"
-end
-```
-
-#### Using the get_payout_by_id_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GetaroundPayout>, Integer, Hash)> get_payout_by_id_with_http_info(id)
-
-```ruby
-begin
-  # Find a payout by ID
-  data, status_code, headers = api_instance.get_payout_by_id_with_http_info(id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GetaroundPayout>
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling PayoutsApi->get_payout_by_id_with_http_info: #{e}"
+  puts "Exception when calling PayoutsApi->get_payout_by_id: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | ID of payout to return |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of payout to return | 
 
 ### Return type
 
-[**GetaroundPayout**](GetaroundPayout.md)
+[**Payout**](Payout.md)
 
 ### Authorization
 
@@ -73,76 +51,55 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## get_payouts
 
-> <Array<GetaroundPayoutsIndexInner>> get_payouts(start_date, end_date, opts)
+# **get_payouts**
+> PayoutsIndex get_payouts(start_date, end_date, opts)
 
 Find payouts paid between dates
 
 Find payouts paid between dates
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
-require 'get_around_owner'
+# load the gem
+require 'getaround-api'
 # setup authorization
 GetAroundOwner.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
 api_instance = GetAroundOwner::PayoutsApi.new
-start_date = Time.parse('2013-10-20T19:20:30+01:00') # Time | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
-end_date = Time.parse('2013-10-20T19:20:30+01:00') # Time | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
-opts = {
-  page: 'page_example', # String | Page number
-  per_page: 'per_page_example' # String | Page size
+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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
 }
 
 begin
-  # Find payouts paid between dates
+  #Find payouts paid between dates
   result = api_instance.get_payouts(start_date, end_date, opts)
   p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling PayoutsApi->get_payouts: #{e}"
-end
-```
-
-#### Using the get_payouts_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<GetaroundPayoutsIndexInner>>, Integer, Hash)> get_payouts_with_http_info(start_date, end_date, opts)
-
-```ruby
-begin
-  # Find payouts paid between dates
-  data, status_code, headers = api_instance.get_payouts_with_http_info(start_date, end_date, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<GetaroundPayoutsIndexInner>>
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling PayoutsApi->get_payouts_with_http_info: #{e}"
+  puts "Exception when calling PayoutsApi->get_payouts: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **start_date** | **Time** | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |  |
-| **end_date** | **Time** | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |  |
-| **page** | **String** | Page number | [optional] |
-| **per_page** | **String** | Page size | [optional][default to &#39;30&#39;] |
+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
 
-[**Array&lt;GetaroundPayoutsIndexInner&gt;**](GetaroundPayoutsIndexInner.md)
+[**PayoutsIndex**](PayoutsIndex.md)
 
 ### Authorization
 
@@ -150,6 +107,8 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 

data/docs/PayoutsIndex.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::PayoutsIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/Rental.md

@@ -0,0 +1,14 @@
+# GetAroundOwner::Rental
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [****](.md) | Rental's id | 
+**car_id** | [****](.md) | Vehicle's id | 
+**user_id** | [****](.md) | User id of the rental's driver | 
+**starts_at** | [****](.md) | Rental's started time in ISO8601 format | 
+**ends_at** | [****](.md) | Rental's ended time in ISO8601 format | 
+**booked_at** | [****](.md) | Rental's booked time in ISO8601 format | 
+**price** | [****](.md) | Price set by the owner (in cents 0.01€) | 
+**insurance_fee** | [****](.md) | Insurance amount collected (in cents 0.01€) | 
+

data/docs/RentalIdMessagesJsonBody.md

@@ -0,0 +1,7 @@
+# GetAroundOwner::RentalIdMessagesJsonBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [****](.md) | Content of the message (2000 characters max) | 
+

data/docs/RentalInvoicesIndex.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalInvoicesIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalMessagesIndex.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalMessagesIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalsApi.md

@@ -2,262 +2,113 @@
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**booked_rental_post**](RentalsApi.md#booked_rental_post) | **POST** /bookedRental | New rental booked for one of your cars |
-| [**canceled_rental_post**](RentalsApi.md#canceled_rental_post) | **POST** /canceledRental | Canceled rental for one of your cars |
-| [**car_switched_rental_post**](RentalsApi.md#car_switched_rental_post) | **POST** /carSwitchedRental | There was a switch car on one of your rental |
-| [**times_changed_rental_post**](RentalsApi.md#times_changed_rental_post) | **POST** /timesChangedRental | Rental time change for one of your car |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_rental_by_id**](RentalsApi.md#get_rental_by_id) | **GET** /rentals/{id}.json | Find a rental by ID
+[**get_rentals**](RentalsApi.md#get_rentals) | **GET** /rentals.json | Find rentals booked between dates
 
+# **get_rental_by_id**
+> Rental get_rental_by_id(id)
 
-## booked_rental_post
+Find a rental by ID
 
-> booked_rental_post(opts)
-
-New rental booked for one of your cars
-
-### Examples
+Find a rental by ID
 
+### Example
 ```ruby
-require 'time'
-require 'get_around_owner'
-
-api_instance = GetAroundOwner::RentalsApi.new
-opts = {
-  getaround_rentals_booked:  # GetaroundRentalsBooked | This event is triggered when a new rental booking has been created for one of your cars
-}
-
-begin
-  # New rental booked for one of your cars
-  api_instance.booked_rental_post(opts)
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->booked_rental_post: #{e}"
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
 end
-```
-
-#### Using the booked_rental_post_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> booked_rental_post_with_http_info(opts)
-
-```ruby
-begin
-  # New rental booked for one of your cars
-  data, status_code, headers = api_instance.booked_rental_post_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->booked_rental_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **getaround_rentals_booked** | [**GetaroundRentalsBooked**](GetaroundRentalsBooked.md) | This event is triggered when a new rental booking has been created for one of your cars | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## canceled_rental_post
-
-> canceled_rental_post(opts)
-
-Canceled rental for one of your cars
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
 
 api_instance = GetAroundOwner::RentalsApi.new
-opts = {
-  getaround_rentals_canceled:  # GetaroundRentalsCanceled | This event is triggered when a rental has been canceled for one of your cars
-}
-
-begin
-  # Canceled rental for one of your cars
-  api_instance.canceled_rental_post(opts)
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->canceled_rental_post: #{e}"
-end
-```
-
-#### Using the canceled_rental_post_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+id = GetAroundOwner::null.new #  | ID of rental to return
 
-> <Array(nil, Integer, Hash)> canceled_rental_post_with_http_info(opts)
 
-```ruby
 begin
-  # Canceled rental for one of your cars
-  data, status_code, headers = api_instance.canceled_rental_post_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #Find a rental by ID
+  result = api_instance.get_rental_by_id(id)
+  p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->canceled_rental_post_with_http_info: #{e}"
+  puts "Exception when calling RentalsApi->get_rental_by_id: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **getaround_rentals_canceled** | [**GetaroundRentalsCanceled**](GetaroundRentalsCanceled.md) | This event is triggered when a rental has been canceled for one of your cars | [optional] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of rental to return | 
 
 ### Return type
 
-nil (empty response body)
+[**Rental**](Rental.md)
 
 ### Authorization
 
-No authorization required
+[bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: Not defined
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## car_switched_rental_post
 
-> car_switched_rental_post(opts)
+# **get_rentals**
+> RentalsIndex get_rentals(start_date, end_date, opts)
 
-There was a switch car on one of your rental
+Find rentals booked between dates
 
-### Examples
+Find rentals booked between dates
 
+### Example
 ```ruby
-require 'time'
-require 'get_around_owner'
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
 
 api_instance = GetAroundOwner::RentalsApi.new
-opts = {
-  getaround_rentals_car_switched:  # GetaroundRentalsCarSwitched | This event is triggered when an owner or customer service team member switches the car used to perform a given rental
+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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
 }
 
 begin
-  # There was a switch car on one of your rental
-  api_instance.car_switched_rental_post(opts)
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->car_switched_rental_post: #{e}"
-end
-```
-
-#### Using the car_switched_rental_post_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> car_switched_rental_post_with_http_info(opts)
-
-```ruby
-begin
-  # There was a switch car on one of your rental
-  data, status_code, headers = api_instance.car_switched_rental_post_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #Find rentals booked between dates
+  result = api_instance.get_rentals(start_date, end_date, opts)
+  p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->car_switched_rental_post_with_http_info: #{e}"
+  puts "Exception when calling RentalsApi->get_rentals: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **getaround_rentals_car_switched** | [**GetaroundRentalsCarSwitched**](GetaroundRentalsCarSwitched.md) | This event is triggered when an owner or customer service team member switches the car used to perform a given rental | [optional] |
+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
 
-nil (empty response body)
+[**RentalsIndex**](RentalsIndex.md)
 
 ### Authorization
 
-No authorization required
+[bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
-## times_changed_rental_post
-
-> times_changed_rental_post(opts)
-
-Rental time change for one of your car
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-
-api_instance = GetAroundOwner::RentalsApi.new
-opts = {
-  getaround_rentals_times_changed:  # GetaroundRentalsTimesChanged | This event is triggered when the start or end time of a rental has been changed for one of your cars
-}
-
-begin
-  # Rental time change for one of your car
-  api_instance.times_changed_rental_post(opts)
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->times_changed_rental_post: #{e}"
-end
-```
-
-#### Using the times_changed_rental_post_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> times_changed_rental_post_with_http_info(opts)
-
-```ruby
-begin
-  # Rental time change for one of your car
-  data, status_code, headers = api_instance.times_changed_rental_post_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->times_changed_rental_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **getaround_rentals_times_changed** | [**GetaroundRentalsTimesChanged**](GetaroundRentalsTimesChanged.md) | This event is triggered when the start or end time of a rental has been changed for one of your cars | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: Not defined
 

data/docs/RentalsBooked.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalsBooked
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalsCanceled.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalsCanceled
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalsCarCheckedIn.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalsCarCheckedIn
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalsCarCheckedOut.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalsCarCheckedOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalsCarSwitched.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalsCarSwitched
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalsIndex.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalsIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/RentalsTimesChanged.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::RentalsTimesChanged
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/StartsAt.md

@@ -0,0 +1,6 @@
+# GetAroundOwner::StartsAt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+