get_around_owner 1.0.0 → 1.0.1

data/docs/InvoicesApi.md

@@ -1,231 +0,0 @@
-# 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
-
-> <GetaroundInvoice> get_invoice_by_id(id)
-
-Find an invoice by ID
-
-Find an invoice by ID
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-# setup authorization
-GetAroundOwner.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = GetAroundOwner::InvoicesApi.new
-id = '1' # String | 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 "Error when calling InvoicesApi->get_invoice_by_id: #{e}"
-end
-```
-
-#### Using the get_invoice_by_id_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GetaroundInvoice>, Integer, Hash)> get_invoice_by_id_with_http_info(id)
-
-```ruby
-begin
-  # Find an invoice by ID
-  data, status_code, headers = api_instance.get_invoice_by_id_with_http_info(id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GetaroundInvoice>
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling InvoicesApi->get_invoice_by_id_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | ID of invoice to return |  |
-
-### Return type
-
-[**GetaroundInvoice**](GetaroundInvoice.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_invoices
-
-> <Array<GetaroundInvoicesIndexInner>> get_invoices(opts)
-
-Find invoices emitted between dates
-
-Find invoices emitted between dates
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-# setup authorization
-GetAroundOwner.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = GetAroundOwner::InvoicesApi.new
-opts = {
-  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)
-  page: 'page_example', # String | Page number
-  per_page: 'per_page_example' # String | Page size
-}
-
-begin
-  # Find invoices emitted between dates
-  result = api_instance.get_invoices(opts)
-  p result
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling InvoicesApi->get_invoices: #{e}"
-end
-```
-
-#### Using the get_invoices_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<GetaroundInvoicesIndexInner>>, Integer, Hash)> get_invoices_with_http_info(opts)
-
-```ruby
-begin
-  # Find invoices emitted between dates
-  data, status_code, headers = api_instance.get_invoices_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<GetaroundInvoicesIndexInner>>
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling InvoicesApi->get_invoices_with_http_info: #{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) | [optional] |
-| **end_date** | **Time** | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) | [optional] |
-| **page** | **String** | Page number | [optional] |
-| **per_page** | **String** | Page size | [optional][default to &#39;30&#39;] |
-
-### Return type
-
-[**Array&lt;GetaroundInvoicesIndexInner&gt;**](GetaroundInvoicesIndexInner.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_invoices_for_rental
-
-> <Array<GetaroundRentalInvoicesIndexInner>> get_invoices_for_rental(rental_id, opts)
-
-Find invoices associated to a rental
-
-Find invoices associated to a rental
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-# setup authorization
-GetAroundOwner.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = GetAroundOwner::InvoicesApi.new
-rental_id = '1' # String | ID of rental
-opts = {
-  page: 'page_example', # String | Page number
-  per_page: 'per_page_example' # String | 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 "Error when calling InvoicesApi->get_invoices_for_rental: #{e}"
-end
-```
-
-#### Using the get_invoices_for_rental_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<GetaroundRentalInvoicesIndexInner>>, Integer, Hash)> get_invoices_for_rental_with_http_info(rental_id, opts)
-
-```ruby
-begin
-  # Find invoices associated to a rental
-  data, status_code, headers = api_instance.get_invoices_for_rental_with_http_info(rental_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<GetaroundRentalInvoicesIndexInner>>
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling InvoicesApi->get_invoices_for_rental_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **rental_id** | **String** | ID of rental |  |
-| **page** | **String** | Page number | [optional] |
-| **per_page** | **String** | Page size | [optional][default to &#39;30&#39;] |
-
-### Return type
-
-[**Array&lt;GetaroundRentalInvoicesIndexInner&gt;**](GetaroundRentalInvoicesIndexInner.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/MessagesApi.md

@@ -1,71 +0,0 @@
-# GetAroundOwner::MessagesApi
-
-All URIs are relative to *https://api-eu.getaround.com/owner/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**sent_message_post**](MessagesApi.md#sent_message_post) | **POST** /sentMessage | New message sent |
-
-
-## sent_message_post
-
-> sent_message_post(opts)
-
-New message sent
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-
-api_instance = GetAroundOwner::MessagesApi.new
-opts = {
-  getaround_messages_sent:  # GetaroundMessagesSent | This event is triggered when a new message has been sent for one of your rentals
-}
-
-begin
-  # New message sent
-  api_instance.sent_message_post(opts)
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling MessagesApi->sent_message_post: #{e}"
-end
-```
-
-#### Using the sent_message_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)> sent_message_post_with_http_info(opts)
-
-```ruby
-begin
-  # New message sent
-  data, status_code, headers = api_instance.sent_message_post_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling MessagesApi->sent_message_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **getaround_messages_sent** | [**GetaroundMessagesSent**](GetaroundMessagesSent.md) | This event is triggered when a new message has been sent for one of your rentals | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-

data/docs/PayoutsApi.md

@@ -1,155 +0,0 @@
-# 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
-
-> <GetaroundPayout> get_payout_by_id(id)
-
-Find a payout by ID
-
-Find a payout by ID
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-# 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
-
-begin
-  # 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}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | ID of payout to return |  |
-
-### Return type
-
-[**GetaroundPayout**](GetaroundPayout.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_payouts
-
-> <Array<GetaroundPayoutsIndexInner>> get_payouts(start_date, end_date, opts)
-
-Find payouts paid between dates
-
-Find payouts paid between dates
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-# 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
-}
-
-begin
-  # 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}"
-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;] |
-
-### Return type
-
-[**Array&lt;GetaroundPayoutsIndexInner&gt;**](GetaroundPayoutsIndexInner.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/RentalsApi.md

@@ -1,263 +0,0 @@
-# GetAroundOwner::RentalsApi
-
-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 |
-
-
-## booked_rental_post
-
-> booked_rental_post(opts)
-
-New rental booked for one of your cars
-
-### Examples
-
-```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}"
-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.
-
-> <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
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->canceled_rental_post_with_http_info: #{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] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## car_switched_rental_post
-
-> car_switched_rental_post(opts)
-
-There was a switch car on one of your rental
-
-### Examples
-
-```ruby
-require 'time'
-require 'get_around_owner'
-
-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
-}
-
-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
-rescue GetAroundOwner::ApiError => e
-  puts "Error when calling RentalsApi->car_switched_rental_post_with_http_info: #{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] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## 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
-