get_around_owner 1.0.1 → 1.0.3

data/docs/InvoicesApi.md

@@ -0,0 +1,169 @@
+# GetAroundOwner::InvoicesApi
+
+All URIs are relative to *https://api-eu.getaround.com/owner/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_invoice_by_id**](InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{id}.json | Find an invoice by ID
+[**get_invoices**](InvoicesApi.md#get_invoices) | **GET** /invoices.json | Find invoices emitted between dates
+[**get_invoices_for_rental**](InvoicesApi.md#get_invoices_for_rental) | **GET** /rentals/{rental_id}/invoices.json | Find invoices associated to a rental
+
+# **get_invoice_by_id**
+> Invoice get_invoice_by_id(id)
+
+Find an invoice by ID
+
+Find an invoice by ID
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::InvoicesApi.new
+id = GetAroundOwner::null.new #  | ID of invoice to return
+
+
+begin
+  #Find an invoice by ID
+  result = api_instance.get_invoice_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling InvoicesApi->get_invoice_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of invoice to return | 
+
+### Return type
+
+[**Invoice**](Invoice.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_invoices**
+> InvoicesIndex get_invoices(opts)
+
+Find invoices emitted between dates
+
+Find invoices emitted between dates
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::InvoicesApi.new
+opts = { 
+  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)
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
+
+begin
+  #Find invoices emitted between dates
+  result = api_instance.get_invoices(opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling InvoicesApi->get_invoices: #{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) | [optional] 
+ **end_date** | [****](.md)| End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) | [optional] 
+ **page** | [****](.md)| Page number | [optional] 
+ **per_page** | [****](.md)| Page size | [optional] [default to 30]
+
+### Return type
+
+[**InvoicesIndex**](InvoicesIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_invoices_for_rental**
+> RentalInvoicesIndex get_invoices_for_rental(rental_id, opts)
+
+Find invoices associated to a rental
+
+Find invoices associated to a rental
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::InvoicesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
+opts = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
+
+begin
+  #Find invoices associated to a rental
+  result = api_instance.get_invoices_for_rental(rental_id, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling InvoicesApi->get_invoices_for_rental: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of rental | 
+ **page** | [****](.md)| Page number | [optional] 
+ **per_page** | [****](.md)| Page size | [optional] [default to 30]
+
+### Return type
+
+[**RentalInvoicesIndex**](RentalInvoicesIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/InvoicesIndex.md

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

data/docs/Message.md

@@ -0,0 +1,11 @@
+# GetAroundOwner::Message
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [****](.md) | The message ID | 
+**rental_id** | [****](.md) | ID of the related rental | 
+**sending_user_id** | [****](.md) | ID of the sending user | 
+**sent_at** | [****](.md) | Date the message was sent | 
+**content** | [****](.md) | Content of message, Personal information detected in messages is hidden | 
+

data/docs/MessagesApi.md

@@ -0,0 +1,162 @@
+# GetAroundOwner::MessagesApi
+
+All URIs are relative to *https://api-eu.getaround.com/owner/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_messages**](MessagesApi.md#create_messages) | **POST** /rentals/{rental_id}/messages.json | Create Message associated to a rental
+[**get_message_by_id**](MessagesApi.md#get_message_by_id) | **GET** /rentals/{rental_id}/messages/{id}.json | Find a message by ID associated to a rental
+[**get_messages_for_rental**](MessagesApi.md#get_messages_for_rental) | **GET** /rentals/{rental_id}/messages.json | Find messages associated to a rental
+
+# **create_messages**
+> Message create_messages(rental_id, opts)
+
+Create Message associated to a rental
+
+Create Message associated to a rental
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::MessagesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
+opts = { 
+  body: GetAroundOwner::RentalIdMessagesJsonBody.new # RentalIdMessagesJsonBody | Message to create
+}
+
+begin
+  #Create Message associated to a rental
+  result = api_instance.create_messages(rental_id, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling MessagesApi->create_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of rental | 
+ **body** | [**RentalIdMessagesJsonBody**](RentalIdMessagesJsonBody.md)| Message to create | [optional] 
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_message_by_id**
+> Message get_message_by_id(rental_id, id)
+
+Find a message by ID associated to a rental
+
+Find a message by ID associated to a rental
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::MessagesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
+id = GetAroundOwner::null.new #  | ID of message to return
+
+
+begin
+  #Find a message by ID associated to a rental
+  result = api_instance.get_message_by_id(rental_id, id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling MessagesApi->get_message_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of rental | 
+ **id** | [****](.md)| ID of message to return | 
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_messages_for_rental**
+> RentalMessagesIndex get_messages_for_rental(rental_id)
+
+Find messages associated to a rental
+
+Find messages associated to a rental
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::MessagesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
+
+
+begin
+  #Find messages associated to a rental
+  result = api_instance.get_messages_for_rental(rental_id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling MessagesApi->get_messages_for_rental: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of rental | 
+
+### Return type
+
+[**RentalMessagesIndex**](RentalMessagesIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/MessagesSent.md

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

data/docs/Payout.md

@@ -0,0 +1,12 @@
+# GetAroundOwner::Payout
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [****](.md) | The payout ID | 
+**amount** | [****](.md) | The amount of the payout, in cents (0.01€) | 
+**currency** | [****](.md) | The currency of the payout (ISO 4217 alphabetic code) | 
+**completed_at** | [****](.md) | The ISO8601 formatted payout completion date | 
+**entity_type** | [****](.md) | The type of entity the payout is related to | 
+**invoices** | [****](.md) | An array of invoices paid by this payout | [optional] 
+

data/docs/PayoutsApi.md

@@ -0,0 +1,114 @@
+# GetAroundOwner::PayoutsApi
+
+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
+
+# **get_payout_by_id**
+> Payout get_payout_by_id(id)
+
+Find a payout by ID
+
+Find a payout by ID
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::PayoutsApi.new
+id = GetAroundOwner::null.new #  | ID of payout to return
+
+
+begin
+  #Find a payout by ID
+  result = api_instance.get_payout_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling PayoutsApi->get_payout_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of payout to return | 
+
+### Return type
+
+[**Payout**](Payout.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payouts**
+> PayoutsIndex get_payouts(start_date, end_date, opts)
+
+Find payouts paid between dates
+
+Find payouts paid between dates
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::PayoutsApi.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
+  #Find payouts paid between dates
+  result = api_instance.get_payouts(start_date, end_date, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling PayoutsApi->get_payouts: #{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
+
+[**PayoutsIndex**](PayoutsIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **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

@@ -0,0 +1,114 @@
+# GetAroundOwner::RentalsApi
+
+All URIs are relative to *https://api-eu.getaround.com/owner/v1*
+
+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)
+
+Find a rental by ID
+
+Find a rental by ID
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::RentalsApi.new
+id = GetAroundOwner::null.new #  | ID of rental to return
+
+
+begin
+  #Find a rental by ID
+  result = api_instance.get_rental_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling RentalsApi->get_rental_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of rental to return | 
+
+### Return type
+
+[**Rental**](Rental.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_rentals**
+> RentalsIndex get_rentals(start_date, end_date, opts)
+
+Find rentals booked between dates
+
+Find rentals booked between dates
+
+### Example
+```ruby
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
+
+api_instance = GetAroundOwner::RentalsApi.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
+  #Find rentals booked between dates
+  result = api_instance.get_rentals(start_date, end_date, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling RentalsApi->get_rentals: #{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
+
+[**RentalsIndex**](RentalsIndex.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

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
+------------ | ------------- | ------------- | -------------
+