get_around_owner 1.0.0

data/docs/GetaroundUnavailabilitiesDeleted.md

@@ -0,0 +1,22 @@
+# GetAroundOwner::GetaroundUnavailabilitiesDeleted
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **Object** |  |  |
+| **data** | [**GetaroundUnavailabilitiesDeletedAllOfData**](GetaroundUnavailabilitiesDeletedAllOfData.md) |  |  |
+| **occurred_at** | **Time** | The webhook event occurred at timestamp |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundUnavailabilitiesDeleted.new(
+  type: null,
+  data: null,
+  occurred_at: null
+)
+```
+

data/docs/GetaroundUnavailabilitiesDeletedAllOfData.md

@@ -0,0 +1,22 @@
+# GetAroundOwner::GetaroundUnavailabilitiesDeletedAllOfData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **car_id** | **Integer** | ID of the related car | [optional] |
+| **starts_at** | **Time** | The ISO8601 formatted beginning of the unavailability's period | [optional] |
+| **ends_at** | **Time** | The ISO8601 formatted ending of the unavailability's period | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundUnavailabilitiesDeletedAllOfData.new(
+  car_id: null,
+  starts_at: null,
+  ends_at: null
+)
+```
+

data/docs/GetaroundUnavailability.md

@@ -0,0 +1,24 @@
+# GetAroundOwner::GetaroundUnavailability
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **car_id** | **Integer** | ID of the related car |  |
+| **starts_at** | **Time** | The ISO8601 formatted beginning of the unavailability's period |  |
+| **ends_at** | **Time** | The ISO8601 formatted ending of the unavailability's period |  |
+| **reason** | **String** | The reason of the unavailability of the car. | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundUnavailability.new(
+  car_id: null,
+  starts_at: null,
+  ends_at: null,
+  reason: null
+)
+```
+

data/docs/GetaroundUser.md

@@ -0,0 +1,42 @@
+# GetAroundOwner::GetaroundUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The user ID |  |
+| **first_name** | **String** | First name(s) |  |
+| **last_name** | **String** | Last name(s) |  |
+| **phone_number** | **String** | The phone number in international format |  |
+| **address_line1** | **String** | Residential address of the user |  |
+| **address_line2** | **String** | Additional address details | [optional] |
+| **postal_code** | **String** | The postal code |  |
+| **city** | **String** | The city |  |
+| **country** | **String** | Address's country format ISO_3166-1_alpha-2 (ex: FR, ES, ...) |  |
+| **birth_date** | **Date** | The birth date |  |
+| **license_country** | **String** | Driving licence country of issue format ISO_3166-1_alpha-2 (ex: FR, ES, ...) |  |
+| **license_first_issue_date** | **Date** | Driving licence first issue date |  |
+| **license_number** | **String** | The license number |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundUser.new(
+  id: null,
+  first_name: null,
+  last_name: null,
+  phone_number: null,
+  address_line1: null,
+  address_line2: null,
+  postal_code: null,
+  city: null,
+  country: null,
+  birth_date: null,
+  license_country: null,
+  license_first_issue_date: null,
+  license_number: null
+)
+```
+

data/docs/GetaroundUsersUpdated.md

@@ -0,0 +1,22 @@
+# GetAroundOwner::GetaroundUsersUpdated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **Object** |  |  |
+| **data** | [**GetaroundUsersUpdatedAllOfData**](GetaroundUsersUpdatedAllOfData.md) |  |  |
+| **occurred_at** | **Time** | The webhook event occurred at timestamp |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundUsersUpdated.new(
+  type: null,
+  data: null,
+  occurred_at: null
+)
+```
+

data/docs/GetaroundUsersUpdatedAllOfData.md

@@ -0,0 +1,18 @@
+# GetAroundOwner::GetaroundUsersUpdatedAllOfData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **Float** | The user identifier | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundUsersUpdatedAllOfData.new(
+  user_id: null
+)
+```
+

data/docs/GetaroundWebhook.md

@@ -0,0 +1,22 @@
+# GetAroundOwner::GetaroundWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The webhook event type |  |
+| **data** | **Object** |  |  |
+| **occurred_at** | **Time** | The webhook event occurred at timestamp |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundWebhook.new(
+  type: null,
+  data: null,
+  occurred_at: null
+)
+```
+

data/docs/InvoicesApi.md

@@ -0,0 +1,231 @@
+# 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

@@ -0,0 +1,71 @@
+# 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

@@ -0,0 +1,155 @@
+# 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
+