get_around_owner 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c638413f4550121d634e65b4a07975dd143a3c534c2cdf69e3689d23b6f5d122
-  data.tar.gz: 5c0a8d3a314b3d6fe675e940e00ac54dbf63325edd357ddb8bb90d32022d6015
+  metadata.gz: 6a83c364ee219420076d42bdea794b4d6c711a56414c6c3df7a65dba57363081
+  data.tar.gz: dd7446021c346645d03a34f96f8fbd5c01bc97fc6299f1d1e4b212fc170de7e2
 SHA512:
-  metadata.gz: 729b0c4684a53b7cf1e0dad66bc2a4db45ffc2236f618f9607037f043229be650f18dfa181e931b5778367723dbaf427e24f179c044dd758adaa0425d9a0d69d
-  data.tar.gz: 2871ed0d6f97618e7df4db14b312604e97342b523aad831e277ca286d2762d68f4dd658f1c19c3264c45b2217dcc76a0891bf6650375fe00ac87939ac3d7d925
+  metadata.gz: '089b9a94b1aa85340efe45f94c4362d735bee32e5b4f8d3b410337d5502e0125196c42db392f20b769c2273f1cb307a96895debd5cccdde5c6cb307ae7b61706'
+  data.tar.gz: e9f49fa42094499658dc0a4bbaaf55145be6101238b089cc73cbd1c9620e637b2aedb961ce90616041e40bbfa36afbbc513cbd743f59def55e669bc382333509

data/README.md

@@ -1,13 +1,13 @@
-# getaround-api
+# get_around_owner
 
 GetAroundOwner - the Ruby gem for the Getaround Owner API
 
-# Quick Start  The Owner API uses the JSON format, and must be accessed over a [secure connection](https://en.wikipedia.org/wiki/HTTPS).  Let’s assume that the access token provided by your account manager is “TOKEN”.  Here’s how to get the list of ids of all your invoices from the first week of August with a shell script:  ```bash query=\"end_date=2018-08-08T00%3A00%3A00%2B00%3A00&start_date=2018-08-01T00%3A00%3A00%2B00%3A00\"  curl -i \"https://api-eu.getaround.com/owner/v1/invoices?${query}\" \\   -H \"Authorization: Bearer TOKEN\" \\   -H \"Accept:application/json\" \\   -H \"Content-Type:application/json\" ```  And here’s how to get the invoice with the id 12345:  ```bash curl -i \"https://api-eu.getaround.com/owner/v1/invoices/12345\" \\   -H \"Authorization: Bearer TOKEN\" \\   -H \"Accept: application/json\" \\   -H \"Content-Type: application/json\"\" ```  See the [endpoints section](#tag/Invoices) of this guide for details about the response format.  Dates in request params should follow the ISO 8601 standard.   # Authentication  All requests must be authenticated with a [bearer token header](https://tools.ietf.org/html/rfc6750#section-2.1). You token will be sent to you by your account manager.  Unauthenticated requests will return a 401 status.   # Pagination  The page number and the number of items per page can be set with the “page” and “per_page” params.  For example, this request will return the second page of invoices, and 50 invoices per page:  `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50`  Both of these params are optional. The default page size is 30 items.  The Getaround Owner API follows the [RFC 8288 convention](https://datatracker.ietf.org/doc/html/rfc8288) of using the `Link` header to provide the `next` page URL. Please don't build the pagination URLs yourself. The `next` page will be missing when you are requesting the last available page.  Here's an example response header from requesting the second page of invoices `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50` ``` Link: <https://api-eu.getaround.com/owner/v1/invoices?page=3&per_page=50>; rel=\"next\" ```   # Throttling policy and Date range limitation  We have throttling policy that prevents you to perform more than 100 requests per min from the same IP.  Also, there is a limitation on the size of the range of dates given in params in some requests.  All requests that need start_date and end_date, do not accept a range bigger than 30 days.   # Webhooks  Getaround can send webhook events that notify your application when certain events happen on your account. This is especially useful to follow the lifecycle of rentals, tracking for example bookings or cancellations.  ### Setup  To set up an endpoint, you need to define a route on your server for receiving events, and then <a href=\"mailto:owner-api@getaround.com\">ask Getaround</a> to add this URL to your account.  To acknowledge receipt of a event, your endpoint must:  - Return a `2xx` HTTP status code. - Be a secure `https` endpoint with a valid SSL certificate.  ### Testing  Once Getaround has set up the endpoint, and it is properly configured as described above, a test `ping` event can be sent by clicking the button below:  <form action=\"/docs/api/owner/fire_ping_webhook\" method=\"post\"><input type=\"submit\" value=\"Send Ping Event\"></form>  You should receive the following JSON payload:  ```json {   \"data\": {     \"ping\": \"pong\"   },   \"type\": \"ping\",   \"occurred_at\": \"2019-04-18T08:30:05Z\" } ```  ### Retries  Webhook deliveries will be attempted for up to three days with an exponential back off. After that point the delivery will be abandoned.  ### Verifying Signatures  Getaround will also provide you with a secret token, which is used to create a hash signature with each payload.  This hash signature is passed along with each request in the headers as `X-Drivy-Signature`. Suppose you have a basic server listening to webhooks that looks like this:  ```ruby require 'sinatra' require 'json'  post '/payload' do   push = JSON.parse(params[:payload])   \"I got some JSON: #{push.inspect}\" end ```  The goal is to compute a hash using your secret token, and ensure that the hash from Getaround matches. Getaround uses an HMAC hexdigest to compute the hash, so you could change your server to look a little like this:  ```ruby post '/payload' do   request.body.rewind   payload_body = request.body.read   verify_signature(payload_body)   push = JSON.parse(params[:payload])   \"I got some JSON: #{push.inspect}\" end  def verify_signature(payload_body)   signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['SECRET_TOKEN'], payload_body)   return halt 500, \"Signatures didn't match!\" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_DRIVY_SIGNATURE']) end ```  Obviously, your language and server implementations may differ from this code. There are a couple of important things to point out, however:  No matter which implementation you use, the hash signature starts with `sha1=`, using the key of your secret token and your payload body.  Using a plain `==` operator is not advised. A method like secure_compare performs a \"constant time\" string comparison, which renders it safe from certain timing attacks against regular equality operators.  ### Best Practices  - **Acknowledge events immediately**. If your webhook script performs complex logic, or makes network calls, it’s possible that the script would time out before Getaround sees its complete execution. Ideally, your webhook handler code (acknowledging receipt of an event by returning a `2xx` status code) is separate of any other logic you do for that event. - **Handle duplicate events**. Webhook endpoints might occasionally receive the same event more than once. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events. - **Do not expect events in order**. Getaround does not guarantee delivery of events in the order in which they are generated. Your endpoint should therefore handle this accordingly. We do provide an `occurred_at` timestamp for each event, though, to help reconcile ordering. 
+# Quick Start The Owner API uses the JSON format, and must be accessed over a [secure connection](https://en.wikipedia.org/wiki/HTTPS). Let’s assume that the access token provided by your account manager is “TOKEN”. Here’s how to get the list of ids of all your invoices from the first week of August with a shell script: `bash query=\"end_date=2018-08-08T00%3A00%3A00%2B00%3A00&start_date=2018-08-01T00%3A00%3A00%2B00%3A00\"  curl -i \"https://api-eu.getaround.com/owner/v1/invoices?${query}\" \\   -H \"Authorization: Bearer TOKEN\" \\   -H \"Accept:application/json\" \\   -H \"Content-Type:application/json\" ` And here’s how to get the invoice with the id 12345: `bash curl -i \"https://api-eu.getaround.com/owner/v1/invoices/12345\" \\   -H \"Authorization: Bearer TOKEN\" \\   -H \"Accept: application/json\" \\   -H \"Content-Type: application/json\"\" ` See the [endpoints section](#tag/Invoices) of this guide for details about the response format. Dates in request params should follow the ISO 8601 standard. # Authentication All requests must be authenticated with a [bearer token header](https://tools.ietf.org/html/rfc6750#section-2.1). You token will be sent to you by your account manager. Unauthenticated requests will return a 401 status. # Pagination The page number and the number of items per page can be set with the “page” and “per_page” params. For example, this request will return the second page of invoices, and 50 invoices per page: `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50` Both of these params are optional. The default page size is 30 items. The Getaround Owner API follows the [RFC 8288 convention](https://datatracker.ietf.org/doc/html/rfc8288) of using the `Link` header to provide the `next` page URL. Please don't build the pagination URLs yourself. The `next` page will be missing when you are requesting the last available page. Here's an example response header from requesting the second page of invoices `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50` `Link: <https://api-eu.getaround.com/owner/v1/invoices?page=3&per_page=50>; rel=\"next\"` # Throttling policy and Date range limitation We have throttling policy that prevents you to perform more than 100 requests per min from the same IP. Also, there is a limitation on the size of the range of dates given in params in some requests. All requests that need start_date and end_date, do not accept a range bigger than 30 days. # Webhooks Getaround can send webhook events that notify your application when certain events happen on your account. This is especially useful to follow the lifecycle of rentals, tracking for example bookings or cancellations. ### Setup To set up an endpoint, you need to define a route on your server for receiving events, and then <a href=\"mailto:owner-api@getaround.com\">ask Getaround</a> to add this URL to your account. To acknowledge receipt of a event, your endpoint must: - Return a `2xx` HTTP status code. - Be a secure `https` endpoint with a valid SSL certificate. ### Testing Once Getaround has set up the endpoint, and it is properly configured as described above, a test `ping` event can be sent by clicking the button below: <form action=\"/docs/api/owner/fire_ping_webhook\" method=\"post\"><input type=\"submit\" value=\"Send Ping Event\"></form> You should receive the following JSON payload: `json {   \"data\": {     \"ping\": \"pong\"   },   \"type\": \"ping\",   \"occurred_at\": \"2019-04-18T08:30:05Z\" } ` ### Retries Webhook deliveries will be attempted for up to three days with an exponential back off. After that point the delivery will be abandoned. ### Verifying Signatures Getaround will also provide you with a secret token, which is used to create a hash signature with each payload. This hash signature is passed along with each request in the headers as `X-Drivy-Signature`. Suppose you have a basic server listening to webhooks that looks like this: `ruby require 'sinatra' require 'json'  post '/payload' do   push = JSON.parse(params[:payload])   \"I got some JSON: #{push.inspect}\" end ` The goal is to compute a hash using your secret token, and ensure that the hash from Getaround matches. Getaround uses an HMAC hexdigest to compute the hash, so you could change your server to look a little like this: `ruby post '/payload' do   request.body.rewind   payload_body = request.body.read   verify_signature(payload_body)   push = JSON.parse(params[:payload])   \"I got some JSON: #{push.inspect}\" end  def verify_signature(payload_body)   signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['SECRET_TOKEN'], payload_body)   return halt 500, \"Signatures didn't match!\" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_DRIVY_SIGNATURE']) end ` Obviously, your language and server implementations may differ from this code. There are a couple of important things to point out, however: No matter which implementation you use, the hash signature starts with `sha1=`, using the key of your secret token and your payload body. Using a plain `==` operator is not advised. A method like secure_compare performs a \"constant time\" string comparison, which renders it safe from certain timing attacks against regular equality operators. ### Best Practices - **Acknowledge events immediately**. If your webhook script performs complex logic, or makes network calls, it’s possible that the script would time out before Getaround sees its complete execution. Ideally, your webhook handler code (acknowledging receipt of an event by returning a `2xx` status code) is separate of any other logic you do for that event. - **Handle duplicate events**. Webhook endpoints might occasionally receive the same event more than once. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events. - **Do not expect events in order**. Getaround does not guarantee delivery of events in the order in which they are generated. Your endpoint should therefore handle this accordingly. We do provide an `occurred_at` timestamp for each event, though, to help reconcile ordering.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.0
-- Package version: 1.0.2
+- Package version: 1.0.5
 - Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
 
 ## Installation
@@ -17,27 +17,28 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/
 To build the Ruby code into a gem:
 
 ```shell
-gem build getaround-api.gemspec
+gem build get_around_owner.gemspec
 ```
 
 Then either install the gem locally:
 
 ```shell
-gem install ./getaround-api-1.0.2.gem
+gem install ./get_around_owner-1.0.5.gem
 ```
-(for development, run `gem install --dev ./getaround-api-1.0.2.gem` to install the development dependencies)
+
+(for development, run `gem install --dev ./get_around_owner-1.0.5.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'getaround-api', '~> 1.0.2'
+    gem 'get_around_owner', '~> 1.0.5'
 
 ### Install from Git
 
 If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
 
-    gem 'getaround-api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+    gem 'get_around_owner', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
 
 ### Include the Ruby code directly
 
@@ -50,9 +51,10 @@ ruby -Ilib script.rb
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
+
 ```ruby
 # Load the gem
-require 'getaround-api'
+require 'get_around_owner'
 # Setup authorization
 GetAroundOwner.configure do |config|
 end
@@ -73,7 +75,7 @@ GetAroundOwner.configure do |config|
 end
 
 api_instance = GetAroundOwner::CarsApi.new
-opts = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -107,7 +109,7 @@ end
 api_instance = GetAroundOwner::CheckinsApi.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 = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -141,7 +143,7 @@ end
 api_instance = GetAroundOwner::CheckoutsApi.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 = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -173,7 +175,7 @@ GetAroundOwner.configure do |config|
 end
 
 api_instance = GetAroundOwner::InvoicesApi.new
-opts = { 
+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
@@ -193,7 +195,7 @@ end
 
 api_instance = GetAroundOwner::InvoicesApi.new
 rental_id = GetAroundOwner::null.new #  | ID of rental
-opts = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -211,7 +213,7 @@ end
 
 api_instance = GetAroundOwner::MessagesApi.new
 rental_id = GetAroundOwner::null.new #  | ID of rental
-opts = { 
+opts = {
   body: GetAroundOwner::RentalIdMessagesJsonBody.new # RentalIdMessagesJsonBody | Message to create
 }
 
@@ -275,7 +277,7 @@ 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 = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -309,7 +311,7 @@ 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 = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -327,7 +329,7 @@ end
 
 api_instance = GetAroundOwner::UnavailabilitiesApi.new
 car_id = GetAroundOwner::null.new #  | ID of car
-opts = { 
+opts = {
   body: GetAroundOwner::CarIdUnavailabilitiesJsonBody.new # CarIdUnavailabilitiesJsonBody | Unavailability to create
 }
 
@@ -359,7 +361,7 @@ api_instance = GetAroundOwner::UnavailabilitiesApi.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)
 car_id = GetAroundOwner::null.new #  | ID of the car
-opts = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -392,69 +394,66 @@ end
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*GetAroundOwner::CarsApi* | [**get_car_by_id**](docs/CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID
-*GetAroundOwner::CarsApi* | [**get_cars**](docs/CarsApi.md#get_cars) | **GET** /cars.json | Find all cars
-*GetAroundOwner::CheckinsApi* | [**get_checkin_by_rental_id**](docs/CheckinsApi.md#get_checkin_by_rental_id) | **GET** /rentals/{rental_id}/checkin.json | Find a checkin by rental ID
-*GetAroundOwner::CheckinsApi* | [**get_checkins**](docs/CheckinsApi.md#get_checkins) | **GET** /checkins.json | List of checkins that occurred between two dates
-*GetAroundOwner::CheckoutsApi* | [**get_checkout_by_rental_id**](docs/CheckoutsApi.md#get_checkout_by_rental_id) | **GET** /rentals/{rental_id}/checkout.json | Find a checkout by rental ID
-*GetAroundOwner::CheckoutsApi* | [**get_checkouts**](docs/CheckoutsApi.md#get_checkouts) | **GET** /checkouts.json | List of checkouts that occurred between two dates
-*GetAroundOwner::InvoicesApi* | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{id}.json | Find an invoice by ID
-*GetAroundOwner::InvoicesApi* | [**get_invoices**](docs/InvoicesApi.md#get_invoices) | **GET** /invoices.json | Find invoices emitted between dates
-*GetAroundOwner::InvoicesApi* | [**get_invoices_for_rental**](docs/InvoicesApi.md#get_invoices_for_rental) | **GET** /rentals/{rental_id}/invoices.json | Find invoices associated to a rental
-*GetAroundOwner::MessagesApi* | [**create_messages**](docs/MessagesApi.md#create_messages) | **POST** /rentals/{rental_id}/messages.json | Create Message associated to a rental
-*GetAroundOwner::MessagesApi* | [**get_message_by_id**](docs/MessagesApi.md#get_message_by_id) | **GET** /rentals/{rental_id}/messages/{id}.json | Find a message by ID associated to a rental
-*GetAroundOwner::MessagesApi* | [**get_messages_for_rental**](docs/MessagesApi.md#get_messages_for_rental) | **GET** /rentals/{rental_id}/messages.json | Find messages associated to a rental
-*GetAroundOwner::PayoutsApi* | [**get_payout_by_id**](docs/PayoutsApi.md#get_payout_by_id) | **GET** /payouts/{id}.json | Find a payout by ID
-*GetAroundOwner::PayoutsApi* | [**get_payouts**](docs/PayoutsApi.md#get_payouts) | **GET** /payouts.json | Find payouts paid between dates
-*GetAroundOwner::RentalsApi* | [**get_rental_by_id**](docs/RentalsApi.md#get_rental_by_id) | **GET** /rentals/{id}.json | Find a rental by ID
-*GetAroundOwner::RentalsApi* | [**get_rentals**](docs/RentalsApi.md#get_rentals) | **GET** /rentals.json | Find rentals booked between dates
-*GetAroundOwner::UnavailabilitiesApi* | [**create_unavailabilities**](docs/UnavailabilitiesApi.md#create_unavailabilities) | **POST** /cars/{car_id}/unavailabilities.json | Create Unavailability related to a car between dates
-*GetAroundOwner::UnavailabilitiesApi* | [**destroy_unavailability**](docs/UnavailabilitiesApi.md#destroy_unavailability) | **DELETE** /cars/{car_id}/unavailabilities.json | Destroy Unavailability related to a car between dates
-*GetAroundOwner::UnavailabilitiesApi* | [**get_unavailabilities_for_car**](docs/UnavailabilitiesApi.md#get_unavailabilities_for_car) | **GET** /cars/{car_id}/unavailabilities.json | Find Unavailabilities related to a car between dates
-*GetAroundOwner::UsersApi* | [**get_user_by_id**](docs/UsersApi.md#get_user_by_id) | **GET** /users/{id}.json | Find a user by ID (Users are customers who rent one of your cars)
+| Class                                 | Method                                                                                       | HTTP request                                    | Description                                                       |
+| ------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------- |
+| _GetAroundOwner::CarsApi_             | [**get_car_by_id**](docs/CarsApi.md#get_car_by_id)                                           | **GET** /cars/{id}.json                         | Find a car by ID                                                  |
+| _GetAroundOwner::CarsApi_             | [**get_cars**](docs/CarsApi.md#get_cars)                                                     | **GET** /cars.json                              | Find all cars                                                     |
+| _GetAroundOwner::CheckinsApi_         | [**get_checkin_by_rental_id**](docs/CheckinsApi.md#get_checkin_by_rental_id)                 | **GET** /rentals/{rental_id}/checkin.json       | Find a checkin by rental ID                                       |
+| _GetAroundOwner::CheckinsApi_         | [**get_checkins**](docs/CheckinsApi.md#get_checkins)                                         | **GET** /checkins.json                          | List of checkins that occurred between two dates                  |
+| _GetAroundOwner::CheckoutsApi_        | [**get_checkout_by_rental_id**](docs/CheckoutsApi.md#get_checkout_by_rental_id)              | **GET** /rentals/{rental_id}/checkout.json      | Find a checkout by rental ID                                      |
+| _GetAroundOwner::CheckoutsApi_        | [**get_checkouts**](docs/CheckoutsApi.md#get_checkouts)                                      | **GET** /checkouts.json                         | List of checkouts that occurred between two dates                 |
+| _GetAroundOwner::InvoicesApi_         | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id)                               | **GET** /invoices/{id}.json                     | Find an invoice by ID                                             |
+| _GetAroundOwner::InvoicesApi_         | [**get_invoices**](docs/InvoicesApi.md#get_invoices)                                         | **GET** /invoices.json                          | Find invoices emitted between dates                               |
+| _GetAroundOwner::InvoicesApi_         | [**get_invoices_for_rental**](docs/InvoicesApi.md#get_invoices_for_rental)                   | **GET** /rentals/{rental_id}/invoices.json      | Find invoices associated to a rental                              |
+| _GetAroundOwner::MessagesApi_         | [**create_messages**](docs/MessagesApi.md#create_messages)                                   | **POST** /rentals/{rental_id}/messages.json     | Create Message associated to a rental                             |
+| _GetAroundOwner::MessagesApi_         | [**get_message_by_id**](docs/MessagesApi.md#get_message_by_id)                               | **GET** /rentals/{rental_id}/messages/{id}.json | Find a message by ID associated to a rental                       |
+| _GetAroundOwner::MessagesApi_         | [**get_messages_for_rental**](docs/MessagesApi.md#get_messages_for_rental)                   | **GET** /rentals/{rental_id}/messages.json      | Find messages associated to a rental                              |
+| _GetAroundOwner::PayoutsApi_          | [**get_payout_by_id**](docs/PayoutsApi.md#get_payout_by_id)                                  | **GET** /payouts/{id}.json                      | Find a payout by ID                                               |
+| _GetAroundOwner::PayoutsApi_          | [**get_payouts**](docs/PayoutsApi.md#get_payouts)                                            | **GET** /payouts.json                           | Find payouts paid between dates                                   |
+| _GetAroundOwner::RentalsApi_          | [**get_rental_by_id**](docs/RentalsApi.md#get_rental_by_id)                                  | **GET** /rentals/{id}.json                      | Find a rental by ID                                               |
+| _GetAroundOwner::RentalsApi_          | [**get_rentals**](docs/RentalsApi.md#get_rentals)                                            | **GET** /rentals.json                           | Find rentals booked between dates                                 |
+| _GetAroundOwner::UnavailabilitiesApi_ | [**create_unavailabilities**](docs/UnavailabilitiesApi.md#create_unavailabilities)           | **POST** /cars/{car_id}/unavailabilities.json   | Create Unavailability related to a car between dates              |
+| _GetAroundOwner::UnavailabilitiesApi_ | [**destroy_unavailability**](docs/UnavailabilitiesApi.md#destroy_unavailability)             | **DELETE** /cars/{car_id}/unavailabilities.json | Destroy Unavailability related to a car between dates             |
+| _GetAroundOwner::UnavailabilitiesApi_ | [**get_unavailabilities_for_car**](docs/UnavailabilitiesApi.md#get_unavailabilities_for_car) | **GET** /cars/{car_id}/unavailabilities.json    | Find Unavailabilities related to a car between dates              |
+| _GetAroundOwner::UsersApi_            | [**get_user_by_id**](docs/UsersApi.md#get_user_by_id)                                        | **GET** /users/{id}.json                        | Find a user by ID (Users are customers who rent one of your cars) |
 
 ## Documentation for Models
 
- - [GetAroundOwner::Car](docs/Car.md)
- - [GetAroundOwner::CarId](docs/CarId.md)
- - [GetAroundOwner::CarIdUnavailabilitiesJsonBody](docs/CarIdUnavailabilitiesJsonBody.md)
- - [GetAroundOwner::CarsIndex](docs/CarsIndex.md)
- - [GetAroundOwner::Checkin](docs/Checkin.md)
- - [GetAroundOwner::CheckinsIndex](docs/CheckinsIndex.md)
- - [GetAroundOwner::Checkout](docs/Checkout.md)
- - [GetAroundOwner::CheckoutsIndex](docs/CheckoutsIndex.md)
- - [GetAroundOwner::EndsAt](docs/EndsAt.md)
- - [GetAroundOwner::Invoice](docs/Invoice.md)
- - [GetAroundOwner::InvoicesIndex](docs/InvoicesIndex.md)
- - [GetAroundOwner::Message](docs/Message.md)
- - [GetAroundOwner::MessagesSent](docs/MessagesSent.md)
- - [GetAroundOwner::Payout](docs/Payout.md)
- - [GetAroundOwner::PayoutsIndex](docs/PayoutsIndex.md)
- - [GetAroundOwner::Rental](docs/Rental.md)
- - [GetAroundOwner::RentalIdMessagesJsonBody](docs/RentalIdMessagesJsonBody.md)
- - [GetAroundOwner::RentalInvoicesIndex](docs/RentalInvoicesIndex.md)
- - [GetAroundOwner::RentalMessagesIndex](docs/RentalMessagesIndex.md)
- - [GetAroundOwner::RentalsBooked](docs/RentalsBooked.md)
- - [GetAroundOwner::RentalsCanceled](docs/RentalsCanceled.md)
- - [GetAroundOwner::RentalsCarCheckedIn](docs/RentalsCarCheckedIn.md)
- - [GetAroundOwner::RentalsCarCheckedOut](docs/RentalsCarCheckedOut.md)
- - [GetAroundOwner::RentalsCarSwitched](docs/RentalsCarSwitched.md)
- - [GetAroundOwner::RentalsIndex](docs/RentalsIndex.md)
- - [GetAroundOwner::RentalsTimesChanged](docs/RentalsTimesChanged.md)
- - [GetAroundOwner::StartsAt](docs/StartsAt.md)
- - [GetAroundOwner::UnavailabilitiesCreated](docs/UnavailabilitiesCreated.md)
- - [GetAroundOwner::UnavailabilitiesDeleted](docs/UnavailabilitiesDeleted.md)
- - [GetAroundOwner::UnavailabilitiesIndex](docs/UnavailabilitiesIndex.md)
- - [GetAroundOwner::Unavailability](docs/Unavailability.md)
- - [GetAroundOwner::User](docs/User.md)
- - [GetAroundOwner::UsersUpdated](docs/UsersUpdated.md)
- - [GetAroundOwner::Webhook](docs/Webhook.md)
+- [GetAroundOwner::Car](docs/Car.md)
+- [GetAroundOwner::CarId](docs/CarId.md)
+- [GetAroundOwner::CarIdUnavailabilitiesJsonBody](docs/CarIdUnavailabilitiesJsonBody.md)
+- [GetAroundOwner::CarsIndex](docs/CarsIndex.md)
+- [GetAroundOwner::Checkin](docs/Checkin.md)
+- [GetAroundOwner::CheckinsIndex](docs/CheckinsIndex.md)
+- [GetAroundOwner::Checkout](docs/Checkout.md)
+- [GetAroundOwner::CheckoutsIndex](docs/CheckoutsIndex.md)
+- [GetAroundOwner::EndsAt](docs/EndsAt.md)
+- [GetAroundOwner::Invoice](docs/Invoice.md)
+- [GetAroundOwner::InvoicesIndex](docs/InvoicesIndex.md)
+- [GetAroundOwner::Message](docs/Message.md)
+- [GetAroundOwner::MessagesSent](docs/MessagesSent.md)
+- [GetAroundOwner::Payout](docs/Payout.md)
+- [GetAroundOwner::PayoutsIndex](docs/PayoutsIndex.md)
+- [GetAroundOwner::Rental](docs/Rental.md)
+- [GetAroundOwner::RentalIdMessagesJsonBody](docs/RentalIdMessagesJsonBody.md)
+- [GetAroundOwner::RentalInvoicesIndex](docs/RentalInvoicesIndex.md)
+- [GetAroundOwner::RentalMessagesIndex](docs/RentalMessagesIndex.md)
+- [GetAroundOwner::RentalsBooked](docs/RentalsBooked.md)
+- [GetAroundOwner::RentalsCanceled](docs/RentalsCanceled.md)
+- [GetAroundOwner::RentalsCarCheckedIn](docs/RentalsCarCheckedIn.md)
+- [GetAroundOwner::RentalsCarCheckedOut](docs/RentalsCarCheckedOut.md)
+- [GetAroundOwner::RentalsCarSwitched](docs/RentalsCarSwitched.md)
+- [GetAroundOwner::RentalsIndex](docs/RentalsIndex.md)
+- [GetAroundOwner::RentalsTimesChanged](docs/RentalsTimesChanged.md)
+- [GetAroundOwner::StartsAt](docs/StartsAt.md)
+- [GetAroundOwner::UnavailabilitiesCreated](docs/UnavailabilitiesCreated.md)
+- [GetAroundOwner::UnavailabilitiesDeleted](docs/UnavailabilitiesDeleted.md)
+- [GetAroundOwner::UnavailabilitiesIndex](docs/UnavailabilitiesIndex.md)
+- [GetAroundOwner::Unavailability](docs/Unavailability.md)
+- [GetAroundOwner::User](docs/User.md)
+- [GetAroundOwner::UsersUpdated](docs/UsersUpdated.md)
+- [GetAroundOwner::Webhook](docs/Webhook.md)
 
 ## Documentation for Authorization
 
-
 ### bearerAuth
-
-

data/docs/CarsApi.md

@@ -2,12 +2,13 @@
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_car_by_id**](CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID
-[**get_cars**](CarsApi.md#get_cars) | **GET** /cars.json | Find all cars
+| Method                                        | HTTP request            | Description      |
+| --------------------------------------------- | ----------------------- | ---------------- |
+| [**get_car_by_id**](CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID |
+| [**get_cars**](CarsApi.md#get_cars)           | **GET** /cars.json      | Find all cars    |
 
 # **get_car_by_id**
+
 > Car get_car_by_id(id)
 
 Find a car by ID
@@ -15,9 +16,10 @@ Find a car by ID
 Find a car by ID
 
 ### Example
+
 ```ruby
 # load the gem
-require 'getaround-api'
+require 'get_around_owner'
 # setup authorization
 GetAroundOwner.configure do |config|
 end
@@ -37,9 +39,9 @@ end
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | [****](.md)| ID of car to return | 
+| Name   | Type            | Description         | Notes |
+| ------ | --------------- | ------------------- | ----- |
+| **id** | [\*\*\*\*](.md) | ID of car to return |
 
 ### Return type
 
@@ -51,12 +53,11 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 # **get_cars**
+
 > CarsIndex get_cars(opts)
 
 Find all cars
@@ -64,15 +65,16 @@ Find all cars
 Find all cars
 
 ### Example
+
 ```ruby
 # load the gem
-require 'getaround-api'
+require 'get_around_owner'
 # setup authorization
 GetAroundOwner.configure do |config|
 end
 
 api_instance = GetAroundOwner::CarsApi.new
-opts = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -88,10 +90,10 @@ end
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **page** | [****](.md)| Page number | [optional] 
- **per_page** | [****](.md)| Page size | [optional] [default to 30]
+| Name         | Type            | Description | Notes                      |
+| ------------ | --------------- | ----------- | -------------------------- |
+| **page**     | [\*\*\*\*](.md) | Page number | [optional]                 |
+| **per_page** | [\*\*\*\*](.md) | Page size   | [optional] [default to 30] |
 
 ### Return type
 
@@ -103,8 +105,5 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json

data/docs/CheckinsApi.md

@@ -2,12 +2,13 @@
 
 All URIs are relative to *https://api-eu.getaround.com/owner/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_checkin_by_rental_id**](CheckinsApi.md#get_checkin_by_rental_id) | **GET** /rentals/{rental_id}/checkin.json | Find a checkin by rental ID
-[**get_checkins**](CheckinsApi.md#get_checkins) | **GET** /checkins.json | List of checkins that occurred between two dates
+| Method                                                                  | HTTP request                              | Description                                      |
+| ----------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------ |
+| [**get_checkin_by_rental_id**](CheckinsApi.md#get_checkin_by_rental_id) | **GET** /rentals/{rental_id}/checkin.json | Find a checkin by rental ID                      |
+| [**get_checkins**](CheckinsApi.md#get_checkins)                         | **GET** /checkins.json                    | List of checkins that occurred between two dates |
 
 # **get_checkin_by_rental_id**
+
 > Checkin get_checkin_by_rental_id(rental_id)
 
 Find a checkin by rental ID
@@ -15,9 +16,10 @@ Find a checkin by rental ID
 Find a checkin by rental ID
 
 ### Example
+
 ```ruby
 # load the gem
-require 'getaround-api'
+require 'get_around_owner'
 # setup authorization
 GetAroundOwner.configure do |config|
 end
@@ -37,9 +39,9 @@ end
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **rental_id** | [****](.md)| ID of the rental related to the checkin to return | 
+| Name          | Type            | Description                                       | Notes |
+| ------------- | --------------- | ------------------------------------------------- | ----- |
+| **rental_id** | [\*\*\*\*](.md) | ID of the rental related to the checkin to return |
 
 ### Return type
 
@@ -51,12 +53,11 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 # **get_checkins**
+
 > CheckinsIndex get_checkins(start_date, end_date, opts)
 
 List of checkins that occurred between two dates
@@ -64,9 +65,10 @@ List of checkins that occurred between two dates
 List of checkins that occurred between two dates
 
 ### Example
+
 ```ruby
 # load the gem
-require 'getaround-api'
+require 'get_around_owner'
 # setup authorization
 GetAroundOwner.configure do |config|
 end
@@ -74,7 +76,7 @@ end
 api_instance = GetAroundOwner::CheckinsApi.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 = { 
+opts = {
   page: GetAroundOwner::null.new, #  | Page number
   per_page: GetAroundOwner::null.new #  | Page size
 }
@@ -90,12 +92,12 @@ 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]
+| 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
 
@@ -107,8 +109,5 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json