get_around_owner 1.0.1 → 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

@@ -0,0 +1,110 @@
+# GetAroundOwner::CarsApi
+
+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
+
+# **get_car_by_id**
+> Car get_car_by_id(id)
+
+Find a car by ID
+
+Find a car by ID
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::CarsApi.new
+id = GetAroundOwner::null.new #  | ID of car to return
+
+
+begin
+  #Find a car by ID
+  result = api_instance.get_car_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CarsApi->get_car_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of car to return | 
+
+### Return type
+
+[**Car**](Car.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_cars**
+> CarsIndex get_cars(opts)
+
+Find all cars
+
+Find all cars
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::CarsApi.new
+opts = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
+
+begin
+  #Find all cars
+  result = api_instance.get_cars(opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CarsApi->get_cars: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | [****](.md)| Page number | [optional] 
+ **per_page** | [****](.md)| Page size | [optional] [default to 30]
+
+### Return type
+
+[**CarsIndex**](CarsIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **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

@@ -0,0 +1,114 @@
+# 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
+
+# **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'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::CheckinsApi.new
+rental_id = GetAroundOwner::null.new #  | ID of the rental related to the checkin to return
+
+
+begin
+  #Find a checkin by rental ID
+  result = api_instance.get_checkin_by_rental_id(rental_id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CheckinsApi->get_checkin_by_rental_id: #{e}"
+end
+```
+
+### 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
+
+
+
+# **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
+  #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 "Exception when calling CheckinsApi->get_checkins: #{e}"
+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]
+
+### Return type
+
+[**CheckinsIndex**](CheckinsIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **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

@@ -0,0 +1,114 @@
+# GetAroundOwner::CheckoutsApi
+
+All URIs are relative to *https://api-eu.getaround.com/owner/v1*
+
+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)
+
+Find a checkout by rental ID
+
+Find a checkout by rental ID
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::CheckoutsApi.new
+rental_id = GetAroundOwner::null.new #  | ID of the rental related to the checkout to return
+
+
+begin
+  #Find a checkout by rental ID
+  result = api_instance.get_checkout_by_rental_id(rental_id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CheckoutsApi->get_checkout_by_rental_id: #{e}"
+end
+```
+
+### 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
+
+
+
+# **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
+  #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 "Exception when calling CheckoutsApi->get_checkouts: #{e}"
+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]
+
+### Return type
+
+[**CheckoutsIndex**](CheckoutsIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **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/GetaroundCar.md

@@ -0,0 +1,28 @@
+# GetAroundOwner::GetaroundCar
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The car ID |  |
+| **state** | **String** | State of the vehicle can be a) active (only state where the vehicle can be booked by a user) b) inactive (temporary state when a vehicle is unavailable for rental) c) pending_approval (temporary state when a vehicle is under review for quality or other checks) and d) deleted (when a vehicle is permanently unavailable for rental) |  |
+| **plate_number** | **String** | Vehicle's plate number |  |
+| **brand** | **String** | Vehicle's brand (ex: Volkswagen) |  |
+| **model** | **String** | Vehicle's model (ex: Polo) |  |
+| **display_address** | **String** | Location where the vehicle is parked |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundCar.new(
+  id: null,
+  state: null,
+  plate_number: null,
+  brand: null,
+  model: null,
+  display_address: null
+)
+```
+

data/docs/GetaroundCarsIndexInner.md

@@ -0,0 +1,18 @@
+# GetAroundOwner::GetaroundCarsIndexInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The car ID |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundCarsIndexInner.new(
+  id: null
+)
+```
+

data/docs/GetaroundCheckin.md

@@ -0,0 +1,24 @@
+# GetAroundOwner::GetaroundCheckin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rental_id** | **Integer** | Rental's ID linked to this checkin |  |
+| **mileage** | **Integer** | The vehicle’s mileage at checkin (in local units, eg: FR: km, GB: miles, ...) | [optional] |
+| **fuel_level** | **Integer** | The vehicle’s fuel level at checkin (in percentage) | [optional] |
+| **occurred_at** | **Time** | Checkin's time in ISO8601 format |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundCheckin.new(
+  rental_id: null,
+  mileage: null,
+  fuel_level: null,
+  occurred_at: null
+)
+```
+

data/docs/GetaroundCheckinsIndexInner.md

@@ -0,0 +1,18 @@
+# GetAroundOwner::GetaroundCheckinsIndexInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rental_id** | **Integer** | The rental ID |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundCheckinsIndexInner.new(
+  rental_id: null
+)
+```
+

data/docs/GetaroundCheckout.md

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

data/docs/GetaroundCreateMessagesRequest.md

@@ -0,0 +1,18 @@
+# GetAroundOwner::GetaroundCreateMessagesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | Content of the message (2000 characters max) |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundCreateMessagesRequest.new(
+  content: null
+)
+```
+

data/docs/GetaroundCreateUnavailabilitiesRequest.md

@@ -0,0 +1,22 @@
+# GetAroundOwner::GetaroundCreateUnavailabilitiesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **starts_at** | **Time** | 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** | **Time** | 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** | **String** | Reason of the unavailability | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundCreateUnavailabilitiesRequest.new(
+  starts_at: null,
+  ends_at: null,
+  reason: null
+)
+```
+

data/docs/GetaroundDestroyUnavailabilityRequest.md

@@ -0,0 +1,20 @@
+# GetAroundOwner::GetaroundDestroyUnavailabilityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **starts_at** | **Time** | 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** | **Time** | 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. |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundDestroyUnavailabilityRequest.new(
+  starts_at: null,
+  ends_at: null
+)
+```
+

data/docs/GetaroundInvoice.md

@@ -0,0 +1,34 @@
+# GetAroundOwner::GetaroundInvoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The invoice ID |  |
+| **pdf_url** | **String** | 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** | **String** | The type of product the invoice is related to |  |
+| **product_id** | **Integer** | The id of the product the invoice is related to |  |
+| **emitted_at** | **Time** | The date at which the invoice was emitted |  |
+| **total_price** | **Integer** | The invoice amount, which is what you will receive (or which will be debited from your account if it is negative) |  |
+| **currency** | **String** | The currency of the invoice amount (ISO 4217 alphabetic code) |  |
+| **entity_type** | **String** | The type of entity the invoice is related to |  |
+| **charges** | [**Array<GetaroundInvoiceChargesInner>**](GetaroundInvoiceChargesInner.md) | Array of charges | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundInvoice.new(
+  id: null,
+  pdf_url: null,
+  product_type: null,
+  product_id: null,
+  emitted_at: null,
+  total_price: null,
+  currency: null,
+  entity_type: null,
+  charges: null
+)
+```
+

data/docs/GetaroundInvoiceChargesInner.md

@@ -0,0 +1,20 @@
+# GetAroundOwner::GetaroundInvoiceChargesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**GetaroundAnyOf**](GetaroundAnyOf.md) |  | [optional] |
+| **amount** | **Integer** | The charge's amount | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundInvoiceChargesInner.new(
+  type: null,
+  amount: null
+)
+```
+

data/docs/GetaroundInvoicesIndexInner.md

@@ -0,0 +1,18 @@
+# GetAroundOwner::GetaroundInvoicesIndexInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The invoice ID |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundInvoicesIndexInner.new(
+  id: null
+)
+```
+