get_around_owner 1.0.0 → 1.0.3

data/docs/InvoicesApi.md

@@ -2,71 +2,49 @@
 
 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 |
+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)
+# **get_invoice_by_id**
+> Invoice get_invoice_by_id(id)
 
 Find an invoice by ID
 
 Find an invoice 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::InvoicesApi.new
-id = '1' # String | ID of invoice to return
+id = GetAroundOwner::null.new #  | ID of invoice to return
+
 
 begin
-  # Find an invoice by ID
+  #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}"
+  puts "Exception when calling InvoicesApi->get_invoice_by_id: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | ID of invoice to return |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [****](.md)| ID of invoice to return | 
 
 ### Return type
 
-[**GetaroundInvoice**](GetaroundInvoice.md)
+[**Invoice**](Invoice.md)
 
 ### Authorization
 
@@ -74,76 +52,55 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## get_invoices
 
-> <Array<GetaroundInvoicesIndexInner>> get_invoices(opts)
+# **get_invoices**
+> InvoicesIndex get_invoices(opts)
 
 Find invoices emitted between dates
 
 Find invoices emitted between dates
 
-### 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::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
+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
+  #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}"
+  puts "Exception when calling InvoicesApi->get_invoices: #{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;] |
+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
 
-[**Array&lt;GetaroundInvoicesIndexInner&gt;**](GetaroundInvoicesIndexInner.md)
+[**InvoicesIndex**](InvoicesIndex.md)
 
 ### Authorization
 
@@ -151,74 +108,53 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## get_invoices_for_rental
 
-> <Array<GetaroundRentalInvoicesIndexInner>> get_invoices_for_rental(rental_id, opts)
+# **get_invoices_for_rental**
+> RentalInvoicesIndex get_invoices_for_rental(rental_id, opts)
 
 Find invoices associated to a rental
 
 Find invoices associated to a rental
 
-### 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::InvoicesApi.new
-rental_id = '1' # String | ID of rental
-opts = {
-  page: 'page_example', # String | Page number
-  per_page: 'per_page_example' # String | Page size
+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
+  #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}"
+  puts "Exception when calling InvoicesApi->get_invoices_for_rental: #{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;] |
+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
 
-[**Array&lt;GetaroundRentalInvoicesIndexInner&gt;**](GetaroundRentalInvoicesIndexInner.md)
+[**RentalInvoicesIndex**](RentalInvoicesIndex.md)
 
 ### Authorization
 
@@ -226,6 +162,8 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **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

@@ -2,70 +2,161 @@
 
 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 |
+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)
 
-## sent_message_post
+Create Message associated to a rental
 
-> sent_message_post(opts)
+Create Message associated to a rental
 
-New message sent
+### 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)
 
-### Examples
+Find a message by ID associated to a rental
 
+Find a message by ID associated to a rental
+
+### Example
 ```ruby
-require 'time'
-require 'get_around_owner'
+# load the gem
+require 'getaround-api'
+# setup authorization
+GetAroundOwner.configure do |config|
+end
 
 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
-}
+rental_id = GetAroundOwner::null.new #  | ID of rental
+id = GetAroundOwner::null.new #  | ID of message to return
+
 
 begin
-  # New message sent
-  api_instance.sent_message_post(opts)
+  #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 "Error when calling MessagesApi->sent_message_post: #{e}"
+  puts "Exception when calling MessagesApi->get_message_by_id: #{e}"
 end
 ```
 
-#### Using the sent_message_post_with_http_info variant
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of rental | 
+ **id** | [****](.md)| ID of message to return | 
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
 
-> <Array(nil, Integer, Hash)> sent_message_post_with_http_info(opts)
+ - **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
-  # 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
+  #Find messages associated to a rental
+  result = api_instance.get_messages_for_rental(rental_id)
+  p result
 rescue GetAroundOwner::ApiError => e
-  puts "Error when calling MessagesApi->sent_message_post_with_http_info: #{e}"
+  puts "Exception when calling MessagesApi->get_messages_for_rental: #{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] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rental_id** | [****](.md)| ID of rental | 
 
 ### Return type
 
-nil (empty response body)
+[**RentalMessagesIndex**](RentalMessagesIndex.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/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] 
+