get_around_owner 1.0.0 → 1.0.3

data/docs/CarId.md

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

data/docs/CarIdUnavailabilitiesJsonBody.md

@@ -0,0 +1,9 @@
+# GetAroundOwner::CarIdUnavailabilitiesJsonBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**starts_at** | [****](.md) | Start date and time of the unavailability in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) with a 30 min granularity. | 
+**ends_at** | [****](.md) | End date and time of the unavailability in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) with a 30 min granularity. | 
+**reason** | [****](.md) | Reason of the unavailability | [optional] 
+

data/docs/CarsApi.md

@@ -2,70 +2,48 @@
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_car_by_id**](CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID |
-| [**get_cars**](CarsApi.md#get_cars) | **GET** /cars.json | Find all cars |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_car_by_id**](CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID
+[**get_cars**](CarsApi.md#get_cars) | **GET** /cars.json | Find all cars
 
-
-## get_car_by_id
-
-> <GetaroundCar> get_car_by_id(id)
+# **get_car_by_id**
+> Car get_car_by_id(id)
 
 Find a car by ID
 
 Find a car 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::CarsApi.new
-id = '1' # String | ID of car to return
+id = GetAroundOwner::null.new #  | ID of car to return
+
 
 begin
-  # Find a car by ID
+  #Find a car by ID
   result = api_instance.get_car_by_id(id)
   p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CarsApi->get_car_by_id: #{e}"
-end
-```
-
-#### Using the get_car_by_id_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GetaroundCar>, Integer, Hash)> get_car_by_id_with_http_info(id)
-
-```ruby
-begin
-  # Find a car by ID
-  data, status_code, headers = api_instance.get_car_by_id_with_http_info(id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GetaroundCar>
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CarsApi->get_car_by_id_with_http_info: #{e}"
+  puts "Exception when calling CarsApi->get_car_by_id: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | ID of car to return |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of car to return | 
 
 ### Return type
 
-[**GetaroundCar**](GetaroundCar.md)
+[**Car**](Car.md)
 
 ### Authorization
 
@@ -73,72 +51,51 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## get_cars
 
-> <Array<GetaroundCarsIndexInner>> get_cars(opts)
+# **get_cars**
+> CarsIndex get_cars(opts)
 
 Find all cars
 
 Find all cars
 
-### 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::CarsApi.new
-opts = {
-  page: 'page_example', # String | Page number
-  per_page: 'per_page_example' # String | Page size
+opts = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
 }
 
 begin
-  # Find all cars
+  #Find all cars
   result = api_instance.get_cars(opts)
   p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CarsApi->get_cars: #{e}"
-end
-```
-
-#### Using the get_cars_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<GetaroundCarsIndexInner>>, Integer, Hash)> get_cars_with_http_info(opts)
-
-```ruby
-begin
-  # Find all cars
-  data, status_code, headers = api_instance.get_cars_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<GetaroundCarsIndexInner>>
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CarsApi->get_cars_with_http_info: #{e}"
+  puts "Exception when calling CarsApi->get_cars: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **page** | **String** | Page number | [optional] |
-| **per_page** | **String** | Page size | [optional][default to &#39;30&#39;] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | [****](.md)| Page number | [optional] 
+ **per_page** | [****](.md)| Page size | [optional] [default to 30]
 
 ### Return type
 
-[**Array&lt;GetaroundCarsIndexInner&gt;**](GetaroundCarsIndexInner.md)
+[**CarsIndex**](CarsIndex.md)
 
 ### Authorization
 
@@ -146,6 +103,8 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 

data/docs/CarsIndex.md

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

data/docs/Checkin.md

@@ -0,0 +1,10 @@
+# GetAroundOwner::Checkin
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rental_id** | [****](.md) | Rental's ID linked to this checkin | 
+**mileage** | [****](.md) | The vehicle’s mileage at checkin (in local units, eg: FR: km, GB: miles, ...) | [optional] 
+**fuel_level** | [****](.md) | The vehicle’s fuel level at checkin (in percentage) | [optional] 
+**occurred_at** | [****](.md) | Checkin's time in ISO8601 format | 
+

data/docs/CheckinsApi.md

@@ -2,70 +2,113 @@
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**car_checked_in_rental_post**](CheckinsApi.md#car_checked_in_rental_post) | **POST** /carCheckedInRental | Rental started for one of your cars |
+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)
 
-## car_checked_in_rental_post
+Find a checkin by rental ID
 
-> car_checked_in_rental_post(opts)
-
-Rental started for one of your cars
-
-### Examples
+Find a checkin by rental ID
 
+### Example
 ```ruby
-require 'time'
-require 'get_around_owner'
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
 
 api_instance = GetAroundOwner::CheckinsApi.new
-opts = {
-  getaround_rentals_car_checked_in:  # GetaroundRentalsCarCheckedIn | This event is triggered when a rental starts and the car has been unlocked
-}
+rental_id = GetAroundOwner::null.new #  | ID of the rental related to the checkin to return
+
 
 begin
-  # Rental started for one of your cars
-  api_instance.car_checked_in_rental_post(opts)
+  #Find a checkin by rental ID
+  result = api_instance.get_checkin_by_rental_id(rental_id)
+  p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CheckinsApi->car_checked_in_rental_post: #{e}"
+  puts "Exception when calling CheckinsApi->get_checkin_by_rental_id: #{e}"
 end
 ```
 
-#### Using the car_checked_in_rental_post_with_http_info variant
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of the rental related to the checkin to return | 
+
+### Return type
+
+[**Checkin**](Checkin.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> car_checked_in_rental_post_with_http_info(opts)
+# **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'
+# 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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
+
 begin
-  # Rental started for one of your cars
-  data, status_code, headers = api_instance.car_checked_in_rental_post_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #List of checkins that occurred between two dates
+  result = api_instance.get_checkins(start_date, end_date, opts)
+  p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CheckinsApi->car_checked_in_rental_post_with_http_info: #{e}"
+  puts "Exception when calling CheckinsApi->get_checkins: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **getaround_rentals_car_checked_in** | [**GetaroundRentalsCarCheckedIn**](GetaroundRentalsCarCheckedIn.md) | This event is triggered when a rental starts and the car has been unlocked | [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)
+[**CheckinsIndex**](CheckinsIndex.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
+
+
 

data/docs/CheckinsIndex.md

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

data/docs/Checkout.md

@@ -0,0 +1,11 @@
+# GetAroundOwner::Checkout
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rental_id** | [****](.md) | Rental's ID linked to this checkout | 
+**mileage** | [****](.md) | The vehicle’s mileage at checkout (in local units, eg: FR: km, GB: miles, ...) | [optional] 
+**fuel_level** | [****](.md) | The vehicle’s fuel level at checkout (in percentage) | [optional] 
+**distance_driven** | [****](.md) | The number of kilometers driven during this rental | 
+**occurred_at** | [****](.md) | Checkout's time in ISO8601 format | 
+

data/docs/CheckoutsApi.md

@@ -2,70 +2,113 @@
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**car_checked_out_rental_post**](CheckoutsApi.md#car_checked_out_rental_post) | **POST** /carCheckedOutRental | Rental ended for one of your cars |
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_checkout_by_rental_id**](CheckoutsApi.md#get_checkout_by_rental_id) | **GET** /rentals/{rental_id}/checkout.json | Find a checkout by rental ID
+[**get_checkouts**](CheckoutsApi.md#get_checkouts) | **GET** /checkouts.json | List of checkouts that occurred between two dates
 
+# **get_checkout_by_rental_id**
+> Checkout get_checkout_by_rental_id(rental_id)
 
-## car_checked_out_rental_post
+Find a checkout by rental ID
 
-> car_checked_out_rental_post(opts)
-
-Rental ended for one of your cars
-
-### Examples
+Find a checkout by rental ID
 
+### Example
 ```ruby
-require 'time'
-require 'get_around_owner'
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
 
 api_instance = GetAroundOwner::CheckoutsApi.new
-opts = {
-  getaround_rentals_car_checked_out:  # GetaroundRentalsCarCheckedOut | This event is triggered when a rental ends and the car has been locked
-}
+rental_id = GetAroundOwner::null.new #  | ID of the rental related to the checkout to return
+
 
 begin
-  # Rental ended for one of your cars
-  api_instance.car_checked_out_rental_post(opts)
+  #Find a checkout by rental ID
+  result = api_instance.get_checkout_by_rental_id(rental_id)
+  p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CheckoutsApi->car_checked_out_rental_post: #{e}"
+  puts "Exception when calling CheckoutsApi->get_checkout_by_rental_id: #{e}"
 end
 ```
 
-#### Using the car_checked_out_rental_post_with_http_info variant
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of the rental related to the checkout to return | 
+
+### Return type
+
+[**Checkout**](Checkout.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> car_checked_out_rental_post_with_http_info(opts)
+# **get_checkouts**
+> CheckoutsIndex get_checkouts(start_date, end_date, opts)
 
+List of checkouts that occurred between two dates
+
+List of checkouts that occurred between two dates
+
+### Example
 ```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::CheckoutsApi.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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
+
 begin
-  # Rental ended for one of your cars
-  data, status_code, headers = api_instance.car_checked_out_rental_post_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #List of checkouts that occurred between two dates
+  result = api_instance.get_checkouts(start_date, end_date, opts)
+  p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling CheckoutsApi->car_checked_out_rental_post_with_http_info: #{e}"
+  puts "Exception when calling CheckoutsApi->get_checkouts: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **getaround_rentals_car_checked_out** | [**GetaroundRentalsCarCheckedOut**](GetaroundRentalsCarCheckedOut.md) | This event is triggered when a rental ends and the car has been locked | [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)
+[**CheckoutsIndex**](CheckoutsIndex.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
+
+
 

data/docs/CheckoutsIndex.md

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

data/docs/EndsAt.md

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

data/docs/Invoice.md

@@ -0,0 +1,15 @@
+# GetAroundOwner::Invoice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [****](.md) | The invoice ID | 
+**pdf_url** | [****](.md) | The temporary url (lifetime: 20min) to download the pdf of the tax invoice is generated each to time you call the endpoint. Also, the 'links' variable will not be present if there is no uploaded invoice yet. This could happen if the job to generate & upload the invoice is not done yet. | 
+**product_type** | [****](.md) | The type of product the invoice is related to | 
+**product_id** | [****](.md) | The id of the product the invoice is related to | 
+**emitted_at** | [****](.md) | The date at which the invoice was emitted | 
+**total_price** | [****](.md) | The invoice amount, which is what you will receive (or which will be debited from your account if it is negative) | 
+**currency** | [****](.md) | The currency of the invoice amount (ISO 4217 alphabetic code) | 
+**entity_type** | [****](.md) | The type of entity the invoice is related to | 
+**charges** | [****](.md) | Array of charges | [optional] 
+