get_around_owner 1.0.0

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

data/docs/GetaroundMessage.md

@@ -0,0 +1,26 @@
+# GetAroundOwner::GetaroundMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The message ID |  |
+| **rental_id** | **Integer** | ID of the related rental |  |
+| **sending_user_id** | **Integer** | ID of the sending user |  |
+| **sent_at** | **String** | Date the message was sent |  |
+| **content** | **String** | Content of message, Personal information detected in messages is hidden |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundMessage.new(
+  id: null,
+  rental_id: null,
+  sending_user_id: null,
+  sent_at: null,
+  content: null
+)
+```
+

data/docs/GetaroundMessagesSent.md

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

data/docs/GetaroundMessagesSentAllOfData.md

@@ -0,0 +1,20 @@
+# GetAroundOwner::GetaroundMessagesSentAllOfData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **Float** | The message identifier | [optional] |
+| **rental_id** | **Float** | The rental identifier | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundMessagesSentAllOfData.new(
+  message_id: null,
+  rental_id: null
+)
+```
+

data/docs/GetaroundPayout.md

@@ -0,0 +1,28 @@
+# GetAroundOwner::GetaroundPayout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The payout ID |  |
+| **amount** | **Integer** | The amount of the payout, in cents (0.01€) |  |
+| **currency** | **String** | The currency of the payout (ISO 4217 alphabetic code) |  |
+| **completed_at** | **Time** | The ISO8601 formatted payout completion date |  |
+| **entity_type** | **String** | The type of entity the payout is related to |  |
+| **invoices** | [**Array<GetaroundPayoutInvoicesInner>**](GetaroundPayoutInvoicesInner.md) | An array of invoices paid by this payout | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundPayout.new(
+  id: null,
+  amount: null,
+  currency: null,
+  completed_at: null,
+  entity_type: null,
+  invoices: null
+)
+```
+

data/docs/GetaroundPayoutInvoicesInner.md

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

data/docs/GetaroundPayoutsIndexInner.md

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

data/docs/GetaroundReason.md

@@ -0,0 +1,15 @@
+# GetAroundOwner::GetaroundReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundReason.new()
+```
+

data/docs/GetaroundRental.md

@@ -0,0 +1,32 @@
+# GetAroundOwner::GetaroundRental
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Rental's id |  |
+| **car_id** | **Integer** | Vehicle's id |  |
+| **user_id** | **Integer** | User id of the rental's driver |  |
+| **starts_at** | **Time** | Rental's started time in ISO8601 format |  |
+| **ends_at** | **Time** | Rental's ended time in ISO8601 format |  |
+| **booked_at** | **Time** | Rental's booked time in ISO8601 format |  |
+| **price** | **Integer** | Price set by the owner (in cents 0.01€) |  |
+| **insurance_fee** | **Integer** | Insurance amount collected (in cents 0.01€) |  |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundRental.new(
+  id: null,
+  car_id: null,
+  user_id: null,
+  starts_at: null,
+  ends_at: null,
+  booked_at: null,
+  price: null,
+  insurance_fee: null
+)
+```
+

data/docs/GetaroundRentalInvoicesIndexInner.md

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

data/docs/GetaroundRentalMessagesIndexInner.md

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

data/docs/GetaroundRentalsBooked.md

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

data/docs/GetaroundRentalsBookedAllOfData.md

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

data/docs/GetaroundRentalsCanceled.md

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

data/docs/GetaroundRentalsCarCheckedIn.md

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

data/docs/GetaroundRentalsCarCheckedOut.md

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

data/docs/GetaroundRentalsCarSwitched.md

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

data/docs/GetaroundRentalsIndexInner.md

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

data/docs/GetaroundRentalsTimesChanged.md

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

data/docs/GetaroundUnavailabilitiesCreated.md

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

data/docs/GetaroundUnavailabilitiesCreatedAllOfData.md

@@ -0,0 +1,24 @@
+# GetAroundOwner::GetaroundUnavailabilitiesCreatedAllOfData
+
+## 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] |
+| **reason** | [**GetaroundReason**](GetaroundReason.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'get_around_owner'
+
+instance = GetAroundOwner::GetaroundUnavailabilitiesCreatedAllOfData.new(
+  car_id: null,
+  starts_at: null,
+  ends_at: null,
+  reason: null
+)
+```
+