get_around_owner 1.0.1 → 1.0.3

data/README.md

@@ -1,226 +1,391 @@
-# get_around_owner
+# getaround-api
 
 GetAroundOwner - the Ruby gem for the Getaround Owner API
 
-# Quick Start
+# 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. 
 
-The Owner API uses the JSON format, and must be accessed over a [secure connection](https://en.wikipedia.org/wiki/HTTPS).
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-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:
+- API version: 1.0.0
+- Package version: 1.0.2
+- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
 
-```bash
-query=\"end_date=2018-08-08T00%3A00%3A00%2B00%3A00&start_date=2018-08-01T00%3A00%3A00%2B00%3A00\"
+## Installation
 
-curl -i \"https://api-eu.getaround.com/owner/v1/invoices?${query}\" \\
-  -H \"Authorization: Bearer TOKEN\" \\
-  -H \"Accept:application/json\" \\
-  -H \"Content-Type:application/json\"
-```
+### Build a gem
 
-And here’s how to get the invoice with the id 12345:
+To build the Ruby code into a gem:
 
-```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\"\"
+```shell
+gem build getaround-api.gemspec
 ```
 
-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
+Then either install the gem locally:
 
-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.
+```shell
+gem install ./getaround-api-1.0.2.gem
+```
+(for development, run `gem install --dev ./getaround-api-1.0.2.gem` to install the development dependencies)
 
-Unauthenticated requests will return a 401 status.
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
+Finally add this to the Gemfile:
 
-# Pagination
+    gem 'getaround-api', '~> 1.0.2'
 
-The page number and the number of items per page can be set with the “page” and “per_page” params.
+### Install from Git
 
-For example, this request will return the second page of invoices, and 50 invoices per page:
+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:
 
-`https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50`
+    gem 'getaround-api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
 
-Both of these params are optional. The default page size is 30 items.
+### Include the Ruby code directly
 
-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.
+Include the Ruby code directly using `-I` as follows:
 
-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\"
+```shell
+ruby -Ilib script.rb
 ```
 
+## Getting Started
 
-# 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.
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'getaround-api'
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-Also, there is a limitation on the size of the range of dates given in params in some requests.
+api_instance = GetAroundOwner::CarsApi.new
+id = GetAroundOwner::null.new #  | ID of car to return
 
-All requests that need start_date and end_date, do not accept a range bigger than 30 days.
 
+begin
+  #Find a car by ID
+  result = api_instance.get_car_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CarsApi->get_car_by_id: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-# Webhooks
+api_instance = GetAroundOwner::CarsApi.new
+opts = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
 
-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.
+begin
+  #Find all cars
+  result = api_instance.get_cars(opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CarsApi->get_cars: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-### Setup
+api_instance = GetAroundOwner::CheckinsApi.new
+rental_id = GetAroundOwner::null.new #  | ID of the rental related to the checkin to return
 
-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:
+begin
+  #Find a checkin by rental ID
+  result = api_instance.get_checkin_by_rental_id(rental_id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CheckinsApi->get_checkin_by_rental_id: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-- Return a `2xx` HTTP status code.
-- Be a secure `https` endpoint with a valid SSL certificate.
+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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
 
-### Testing
+begin
+  #List of checkins that occurred between two dates
+  result = api_instance.get_checkins(start_date, end_date, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CheckinsApi->get_checkins: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-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:
+api_instance = GetAroundOwner::CheckoutsApi.new
+rental_id = GetAroundOwner::null.new #  | ID of the rental related to the checkout to return
 
-<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:
+begin
+  #Find a checkout by rental ID
+  result = api_instance.get_checkout_by_rental_id(rental_id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CheckoutsApi->get_checkout_by_rental_id: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-```json
-{
-  \"data\": {
-    \"ping\": \"pong\"
-  },
-  \"type\": \"ping\",
-  \"occurred_at\": \"2019-04-18T08:30:05Z\"
+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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
 }
-```
 
-### 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.
+begin
+  #List of checkouts that occurred between two dates
+  result = api_instance.get_checkouts(start_date, end_date, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling CheckoutsApi->get_checkouts: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-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:
+api_instance = GetAroundOwner::InvoicesApi.new
+id = GetAroundOwner::null.new #  | ID of invoice to return
 
-```ruby
-require 'sinatra'
-require 'json'
 
-post '/payload' do
-  push = JSON.parse(params[:payload])
-  \"I got some JSON: \#{push.inspect}\"
+begin
+  #Find an invoice by ID
+  result = api_instance.get_invoice_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling InvoicesApi->get_invoice_by_id: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
 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:
+api_instance = GetAroundOwner::InvoicesApi.new
+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
+}
 
-```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}\"
+begin
+  #Find invoices emitted between dates
+  result = api_instance.get_invoices(opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling InvoicesApi->get_invoices: #{e}"
 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'])
+# Setup authorization
+GetAroundOwner.configure do |config|
 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.
+api_instance = GetAroundOwner::InvoicesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
+opts = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
 
-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.
+begin
+  #Find invoices associated to a rental
+  result = api_instance.get_invoices_for_rental(rental_id, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling InvoicesApi->get_invoices_for_rental: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-### Best Practices
+api_instance = GetAroundOwner::MessagesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
+opts = { 
+  body: GetAroundOwner::RentalIdMessagesJsonBody.new # RentalIdMessagesJsonBody | Message to create
+}
 
-- **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.
+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
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
+api_instance = GetAroundOwner::MessagesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
+id = GetAroundOwner::null.new #  | ID of message to return
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0
-- Package version: 1.0.0
-- Generator version: 7.6.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+begin
+  #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 "Exception when calling MessagesApi->get_message_by_id: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-## Installation
+api_instance = GetAroundOwner::MessagesApi.new
+rental_id = GetAroundOwner::null.new #  | ID of rental
 
-### Build a gem
 
-To build the Ruby code into a gem:
+begin
+  #Find messages associated to a rental
+  result = api_instance.get_messages_for_rental(rental_id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling MessagesApi->get_messages_for_rental: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-```shell
-gem build get_around_owner.gemspec
-```
+api_instance = GetAroundOwner::PayoutsApi.new
+id = GetAroundOwner::null.new #  | ID of payout to return
 
-Then either install the gem locally:
 
-```shell
-gem install ./get_around_owner-1.0.0.gem
-```
+begin
+  #Find a payout by ID
+  result = api_instance.get_payout_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling PayoutsApi->get_payout_by_id: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-(for development, run `gem install --dev ./get_around_owner-1.0.0.gem` to install the development dependencies)
+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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+begin
+  #Find payouts paid between dates
+  result = api_instance.get_payouts(start_date, end_date, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling PayoutsApi->get_payouts: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-Finally add this to the Gemfile:
+api_instance = GetAroundOwner::RentalsApi.new
+id = GetAroundOwner::null.new #  | ID of rental to return
 
-    gem 'get_around_owner', '~> 1.0.0'
 
-### Install from Git
+begin
+  #Find a rental by ID
+  result = api_instance.get_rental_by_id(id)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling RentalsApi->get_rental_by_id: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-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:
+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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
 
-    gem 'get_around_owner', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+begin
+  #Find rentals booked between dates
+  result = api_instance.get_rentals(start_date, end_date, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling RentalsApi->get_rentals: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-### Include the Ruby code directly
+api_instance = GetAroundOwner::UnavailabilitiesApi.new
+car_id = GetAroundOwner::null.new #  | ID of car
+opts = { 
+  body: GetAroundOwner::CarIdUnavailabilitiesJsonBody.new # CarIdUnavailabilitiesJsonBody | Unavailability to create
+}
 
-Include the Ruby code directly using `-I` as follows:
+begin
+  #Create Unavailability related to a car between dates
+  api_instance.create_unavailabilities(car_id, opts)
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling UnavailabilitiesApi->create_unavailabilities: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-```shell
-ruby -Ilib script.rb
-```
+api_instance = GetAroundOwner::UnavailabilitiesApi.new
+car_id = GetAroundOwner::null.new #  | ID of car
 
-## Getting Started
 
-Please follow the [installation](#installation) procedure and then run the following code:
+begin
+  #Destroy Unavailability related to a car between dates
+  api_instance.destroy_unavailability(car_id)
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling UnavailabilitiesApi->destroy_unavailability: #{e}"
+end
+# Setup authorization
+GetAroundOwner.configure do |config|
+end
 
-```ruby
-# Load the gem
-require 'get_around_owner'
+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 = { 
+  page: GetAroundOwner::null.new, #  | Page number
+  per_page: GetAroundOwner::null.new #  | Page size
+}
 
+begin
+  #Find Unavailabilities related to a car between dates
+  result = api_instance.get_unavailabilities_for_car(start_date, end_date, car_id, opts)
+  p result
+rescue GetAroundOwner::ApiError => e
+  puts "Exception when calling UnavailabilitiesApi->get_unavailabilities_for_car: #{e}"
+end
 # Setup authorization
 GetAroundOwner.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-  # Configure a proc to get access tokens in lieu of the static access_token configuration
-  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
 end
 
-api_instance = GetAroundOwner::CarsApi.new
-id = '1' # String | ID of car to return
+api_instance = GetAroundOwner::UsersApi.new
+id = GetAroundOwner::null.new #  | ID of user to return
+
 
 begin
-  #Find a car by ID
-  result = api_instance.get_car_by_id(id)
+  #Find a user by ID (Users are customers who rent one of your cars)
+  result = api_instance.get_user_by_id(id)
   p result
 rescue GetAroundOwner::ApiError => e
-  puts "Exception when calling CarsApi->get_car_by_id: #{e}"
+  puts "Exception when calling UsersApi->get_user_by_id: #{e}"
 end
-
 ```
 
 ## Documentation for API Endpoints
@@ -250,54 +415,46 @@ Class | Method | HTTP request | Description
 *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::GetaroundCar](docs/GetaroundCar.md)
- - [GetAroundOwner::GetaroundCarsIndexInner](docs/GetaroundCarsIndexInner.md)
- - [GetAroundOwner::GetaroundCheckin](docs/GetaroundCheckin.md)
- - [GetAroundOwner::GetaroundCheckinsIndexInner](docs/GetaroundCheckinsIndexInner.md)
- - [GetAroundOwner::GetaroundCheckout](docs/GetaroundCheckout.md)
- - [GetAroundOwner::GetaroundCreateMessagesRequest](docs/GetaroundCreateMessagesRequest.md)
- - [GetAroundOwner::GetaroundCreateUnavailabilitiesRequest](docs/GetaroundCreateUnavailabilitiesRequest.md)
- - [GetAroundOwner::GetaroundDestroyUnavailabilityRequest](docs/GetaroundDestroyUnavailabilityRequest.md)
- - [GetAroundOwner::GetaroundInvoice](docs/GetaroundInvoice.md)
- - [GetAroundOwner::GetaroundInvoiceChargesInner](docs/GetaroundInvoiceChargesInner.md)
- - [GetAroundOwner::GetaroundInvoicesIndexInner](docs/GetaroundInvoicesIndexInner.md)
- - [GetAroundOwner::GetaroundMessage](docs/GetaroundMessage.md)
- - [GetAroundOwner::GetaroundMessagesSent](docs/GetaroundMessagesSent.md)
- - [GetAroundOwner::GetaroundMessagesSentAllOfData](docs/GetaroundMessagesSentAllOfData.md)
- - [GetAroundOwner::GetaroundPayout](docs/GetaroundPayout.md)
- - [GetAroundOwner::GetaroundPayoutInvoicesInner](docs/GetaroundPayoutInvoicesInner.md)
- - [GetAroundOwner::GetaroundPayoutsIndexInner](docs/GetaroundPayoutsIndexInner.md)
- - [GetAroundOwner::GetaroundReason](docs/GetaroundReason.md)
- - [GetAroundOwner::GetaroundRental](docs/GetaroundRental.md)
- - [GetAroundOwner::GetaroundRentalInvoicesIndexInner](docs/GetaroundRentalInvoicesIndexInner.md)
- - [GetAroundOwner::GetaroundRentalMessagesIndexInner](docs/GetaroundRentalMessagesIndexInner.md)
- - [GetAroundOwner::GetaroundRentalsBooked](docs/GetaroundRentalsBooked.md)
- - [GetAroundOwner::GetaroundRentalsBookedAllOfData](docs/GetaroundRentalsBookedAllOfData.md)
- - [GetAroundOwner::GetaroundRentalsCanceled](docs/GetaroundRentalsCanceled.md)
- - [GetAroundOwner::GetaroundRentalsCarCheckedIn](docs/GetaroundRentalsCarCheckedIn.md)
- - [GetAroundOwner::GetaroundRentalsCarCheckedOut](docs/GetaroundRentalsCarCheckedOut.md)
- - [GetAroundOwner::GetaroundRentalsCarSwitched](docs/GetaroundRentalsCarSwitched.md)
- - [GetAroundOwner::GetaroundRentalsIndexInner](docs/GetaroundRentalsIndexInner.md)
- - [GetAroundOwner::GetaroundRentalsTimesChanged](docs/GetaroundRentalsTimesChanged.md)
- - [GetAroundOwner::GetaroundUnavailabilitiesCreated](docs/GetaroundUnavailabilitiesCreated.md)
- - [GetAroundOwner::GetaroundUnavailabilitiesCreatedAllOfData](docs/GetaroundUnavailabilitiesCreatedAllOfData.md)
- - [GetAroundOwner::GetaroundUnavailabilitiesDeleted](docs/GetaroundUnavailabilitiesDeleted.md)
- - [GetAroundOwner::GetaroundUnavailabilitiesDeletedAllOfData](docs/GetaroundUnavailabilitiesDeletedAllOfData.md)
- - [GetAroundOwner::GetaroundUnavailability](docs/GetaroundUnavailability.md)
- - [GetAroundOwner::GetaroundUser](docs/GetaroundUser.md)
- - [GetAroundOwner::GetaroundUsersUpdated](docs/GetaroundUsersUpdated.md)
- - [GetAroundOwner::GetaroundUsersUpdatedAllOfData](docs/GetaroundUsersUpdatedAllOfData.md)
- - [GetAroundOwner::GetaroundWebhook](docs/GetaroundWebhook.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
 
 
-Authentication schemes defined for the API:
 ### bearerAuth
 
-- **Type**: Bearer authentication
 

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Car.md

@@ -0,0 +1,12 @@
+# GetAroundOwner::Car
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [****](.md) | The car ID | 
+**state** | [****](.md) | State of the vehicle can be a) active (only state where the vehicle can be booked by a user) b) inactive (temporary state when a vehicle is unavailable for rental) c) pending_approval (temporary state when a vehicle is under review for quality or other checks) and d) deleted (when a vehicle is permanently unavailable for rental) | 
+**plate_number** | [****](.md) | Vehicle's plate number | 
+**brand** | [****](.md) | Vehicle's brand (ex: Volkswagen) | 
+**model** | [****](.md) | Vehicle's model (ex: Polo) | 
+**display_address** | [****](.md) | Location where the vehicle is parked | 
+