get_around_owner 1.0.1 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (232) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -0
  3. data/Owner API v1.json +2938 -0
  4. data/README.md +359 -203
  5. data/Rakefile +8 -0
  6. data/docs/Car.md +12 -0
  7. data/docs/CarId.md +6 -0
  8. data/docs/CarIdUnavailabilitiesJsonBody.md +9 -0
  9. data/docs/CarsApi.md +109 -0
  10. data/docs/CarsIndex.md +6 -0
  11. data/docs/Checkin.md +10 -0
  12. data/docs/CheckinsApi.md +113 -0
  13. data/docs/CheckinsIndex.md +6 -0
  14. data/docs/Checkout.md +11 -0
  15. data/docs/CheckoutsApi.md +113 -0
  16. data/docs/CheckoutsIndex.md +6 -0
  17. data/docs/EndsAt.md +6 -0
  18. data/docs/GetaroundCar.md +28 -0
  19. data/docs/GetaroundCarsIndexInner.md +18 -0
  20. data/docs/GetaroundCheckin.md +24 -0
  21. data/docs/GetaroundCheckinsIndexInner.md +18 -0
  22. data/docs/GetaroundCheckout.md +26 -0
  23. data/docs/GetaroundCreateMessagesRequest.md +18 -0
  24. data/docs/GetaroundCreateUnavailabilitiesRequest.md +22 -0
  25. data/docs/GetaroundDestroyUnavailabilityRequest.md +20 -0
  26. data/docs/GetaroundInvoice.md +34 -0
  27. data/docs/GetaroundInvoiceChargesInner.md +20 -0
  28. data/docs/GetaroundInvoicesIndexInner.md +18 -0
  29. data/docs/GetaroundMessage.md +26 -0
  30. data/docs/GetaroundMessagesSent.md +22 -0
  31. data/docs/GetaroundMessagesSentAllOfData.md +20 -0
  32. data/docs/GetaroundPayout.md +28 -0
  33. data/docs/GetaroundPayoutInvoicesInner.md +18 -0
  34. data/docs/GetaroundPayoutsIndexInner.md +18 -0
  35. data/docs/GetaroundReason.md +15 -0
  36. data/docs/GetaroundRental.md +32 -0
  37. data/docs/GetaroundRentalInvoicesIndexInner.md +18 -0
  38. data/docs/GetaroundRentalMessagesIndexInner.md +18 -0
  39. data/docs/GetaroundRentalsBooked.md +22 -0
  40. data/docs/GetaroundRentalsBookedAllOfData.md +18 -0
  41. data/docs/GetaroundRentalsCanceled.md +22 -0
  42. data/docs/GetaroundRentalsCarCheckedIn.md +22 -0
  43. data/docs/GetaroundRentalsCarCheckedOut.md +22 -0
  44. data/docs/GetaroundRentalsCarSwitched.md +22 -0
  45. data/docs/GetaroundRentalsIndexInner.md +18 -0
  46. data/docs/GetaroundRentalsTimesChanged.md +22 -0
  47. data/docs/GetaroundUnavailabilitiesCreated.md +22 -0
  48. data/docs/GetaroundUnavailabilitiesCreatedAllOfData.md +24 -0
  49. data/docs/GetaroundUnavailabilitiesDeleted.md +22 -0
  50. data/docs/GetaroundUnavailabilitiesDeletedAllOfData.md +22 -0
  51. data/docs/GetaroundUnavailability.md +24 -0
  52. data/docs/GetaroundUser.md +42 -0
  53. data/docs/GetaroundUsersUpdated.md +22 -0
  54. data/docs/GetaroundUsersUpdatedAllOfData.md +18 -0
  55. data/docs/GetaroundWebhook.md +22 -0
  56. data/docs/Invoice.md +15 -0
  57. data/docs/InvoicesApi.md +168 -0
  58. data/docs/InvoicesIndex.md +6 -0
  59. data/docs/Message.md +11 -0
  60. data/docs/MessagesApi.md +161 -0
  61. data/docs/MessagesSent.md +6 -0
  62. data/docs/Payout.md +12 -0
  63. data/docs/PayoutsApi.md +113 -0
  64. data/docs/PayoutsIndex.md +6 -0
  65. data/docs/Rental.md +14 -0
  66. data/docs/RentalIdMessagesJsonBody.md +7 -0
  67. data/docs/RentalInvoicesIndex.md +6 -0
  68. data/docs/RentalMessagesIndex.md +6 -0
  69. data/docs/RentalsApi.md +113 -0
  70. data/docs/RentalsBooked.md +6 -0
  71. data/docs/RentalsCanceled.md +6 -0
  72. data/docs/RentalsCarCheckedIn.md +6 -0
  73. data/docs/RentalsCarCheckedOut.md +6 -0
  74. data/docs/RentalsCarSwitched.md +6 -0
  75. data/docs/RentalsIndex.md +6 -0
  76. data/docs/RentalsTimesChanged.md +6 -0
  77. data/docs/StartsAt.md +6 -0
  78. data/docs/UnavailabilitiesApi.md +166 -0
  79. data/docs/UnavailabilitiesCreated.md +6 -0
  80. data/docs/UnavailabilitiesDeleted.md +6 -0
  81. data/docs/UnavailabilitiesIndex.md +6 -0
  82. data/docs/Unavailability.md +10 -0
  83. data/docs/User.md +19 -0
  84. data/docs/UsersApi.md +56 -0
  85. data/docs/UsersUpdated.md +6 -0
  86. data/docs/Webhook.md +9 -0
  87. data/get_around_owner-1.0.0.gem +0 -0
  88. data/get_around_owner-1.0.1.gem +0 -0
  89. data/get_around_owner-1.0.3.gem +0 -0
  90. data/get_around_owner.gemspec +39 -0
  91. data/getaround-api.gemspec +38 -0
  92. data/git_push.sh +55 -0
  93. data/lib/get_around_owner/api/cars_api.rb +25 -41
  94. data/lib/get_around_owner/api/checkins_api.rb +99 -35
  95. data/lib/get_around_owner/api/checkouts_api.rb +99 -35
  96. data/lib/get_around_owner/api/invoices_api.rb +43 -66
  97. data/lib/get_around_owner/api/messages_api.rb +149 -33
  98. data/lib/get_around_owner/api/payouts_api.rb +29 -45
  99. data/lib/get_around_owner/api/rentals_api.rb +67 -183
  100. data/lib/get_around_owner/api/unavailabilities_api.rb +124 -58
  101. data/lib/get_around_owner/api/users_api.rb +30 -36
  102. data/lib/get_around_owner/api_client.rb +71 -77
  103. data/lib/get_around_owner/api_error.rb +5 -6
  104. data/lib/get_around_owner/configuration.rb +13 -106
  105. data/lib/get_around_owner/models/{getaround_car.rb → car.rb} +36 -56
  106. data/lib/get_around_owner/models/{getaround_users_updated_all_of_data.rb → car_id.rb} +33 -50
  107. data/lib/get_around_owner/models/{getaround_destroy_unavailability_request.rb → car_id_unavailabilities_json_body.rb} +45 -47
  108. data/lib/get_around_owner/models/{getaround_rentals_booked_all_of_data.rb → cars_index.rb} +33 -50
  109. data/lib/get_around_owner/models/{getaround_checkin.rb → checkin.rb} +34 -65
  110. data/lib/get_around_owner/models/{getaround_payouts_index_inner.rb → checkins_index.rb} +32 -58
  111. data/lib/get_around_owner/models/{getaround_checkout.rb → checkout.rb} +35 -70
  112. data/lib/get_around_owner/models/checkouts_index.rb +197 -0
  113. data/lib/get_around_owner/models/ends_at.rb +198 -0
  114. data/lib/get_around_owner/models/{getaround_invoice.rb → invoice.rb} +45 -113
  115. data/lib/get_around_owner/models/invoices_index.rb +198 -0
  116. data/lib/get_around_owner/models/{getaround_message.rb → message.rb} +35 -53
  117. data/lib/get_around_owner/models/messages_sent.rb +197 -0
  118. data/lib/get_around_owner/models/{getaround_payout.rb → payout.rb} +37 -101
  119. data/lib/get_around_owner/models/payouts_index.rb +198 -0
  120. data/lib/get_around_owner/models/{getaround_rental.rb → rental.rb} +38 -100
  121. data/lib/get_around_owner/models/{getaround_create_messages_request.rb → rental_id_messages_json_body.rb} +31 -41
  122. data/lib/get_around_owner/models/rental_invoices_index.rb +198 -0
  123. data/lib/get_around_owner/models/rental_messages_index.rb +198 -0
  124. data/lib/get_around_owner/models/rentals_booked.rb +197 -0
  125. data/lib/get_around_owner/models/rentals_canceled.rb +197 -0
  126. data/lib/get_around_owner/models/rentals_car_checked_in.rb +197 -0
  127. data/lib/get_around_owner/models/rentals_car_checked_out.rb +197 -0
  128. data/lib/get_around_owner/models/rentals_car_switched.rb +197 -0
  129. data/lib/get_around_owner/models/rentals_index.rb +198 -0
  130. data/lib/get_around_owner/models/rentals_times_changed.rb +197 -0
  131. data/lib/get_around_owner/models/starts_at.rb +198 -0
  132. data/lib/get_around_owner/models/{getaround_cars_index_inner.rb → unavailabilities_created.rb} +32 -58
  133. data/lib/get_around_owner/models/unavailabilities_deleted.rb +197 -0
  134. data/lib/get_around_owner/models/unavailabilities_index.rb +198 -0
  135. data/lib/get_around_owner/models/{getaround_unavailabilities_created_all_of_data.rb → unavailability.rb} +51 -65
  136. data/lib/get_around_owner/models/{getaround_user.rb → user.rb} +43 -75
  137. data/lib/get_around_owner/models/users_updated.rb +197 -0
  138. data/lib/get_around_owner/models/{getaround_webhook.rb → webhook.rb} +38 -47
  139. data/lib/get_around_owner/version.rb +5 -6
  140. data/lib/get_around_owner.rb +38 -43
  141. data/openapi.yml +2298 -0
  142. data/spec/api/cars_api_spec.rb +13 -14
  143. data/spec/api/checkins_api_spec.rb +13 -14
  144. data/spec/api/checkouts_api_spec.rb +13 -14
  145. data/spec/api/invoices_api_spec.rb +19 -20
  146. data/spec/api/messages_api_spec.rb +14 -15
  147. data/spec/api/payouts_api_spec.rb +13 -14
  148. data/spec/api/rentals_api_spec.rb +13 -14
  149. data/spec/api/unavailabilities_api_spec.rb +14 -16
  150. data/spec/api/users_api_spec.rb +9 -10
  151. data/spec/api_client_spec.rb +225 -0
  152. data/spec/base_object_spec.rb +109 -0
  153. data/spec/{models/getaround_checkins_index_inner_spec.rb → configuration_spec.rb} +26 -21
  154. data/spec/models/{getaround_reason_spec.rb → car_id_spec.rb} +18 -14
  155. data/spec/models/{getaround_unavailabilities_deleted_all_of_data_spec.rb → car_id_unavailabilities_json_body_spec.rb} +24 -20
  156. data/spec/models/{getaround_car_spec.rb → car_spec.rb} +24 -20
  157. data/spec/models/{getaround_rentals_index_inner_spec.rb → cars_index_spec.rb} +16 -18
  158. data/spec/models/{getaround_checkin_spec.rb → checkin_spec.rb} +22 -18
  159. data/spec/models/checkins_index_spec.rb +34 -0
  160. data/spec/models/{getaround_checkout_spec.rb → checkout_spec.rb} +23 -19
  161. data/spec/models/checkouts_index_spec.rb +34 -0
  162. data/spec/models/ends_at_spec.rb +34 -0
  163. data/spec/models/{getaround_invoice_spec.rb → invoice_spec.rb} +27 -31
  164. data/spec/models/invoices_index_spec.rb +34 -0
  165. data/spec/models/{getaround_message_spec.rb → message_spec.rb} +23 -19
  166. data/spec/models/messages_sent_spec.rb +34 -0
  167. data/spec/models/{getaround_payout_spec.rb → payout_spec.rb} +24 -24
  168. data/spec/models/payouts_index_spec.rb +34 -0
  169. data/spec/models/{getaround_create_messages_request_spec.rb → rental_id_messages_json_body_spec.rb} +19 -15
  170. data/spec/models/rental_invoices_index_spec.rb +34 -0
  171. data/spec/models/rental_messages_index_spec.rb +34 -0
  172. data/spec/models/{getaround_rental_spec.rb → rental_spec.rb} +26 -22
  173. data/spec/models/rentals_booked_spec.rb +34 -0
  174. data/spec/models/rentals_canceled_spec.rb +34 -0
  175. data/spec/models/rentals_car_checked_in_spec.rb +34 -0
  176. data/spec/models/rentals_car_checked_out_spec.rb +34 -0
  177. data/spec/models/rentals_car_switched_spec.rb +34 -0
  178. data/spec/models/rentals_index_spec.rb +34 -0
  179. data/spec/models/rentals_times_changed_spec.rb +34 -0
  180. data/spec/models/starts_at_spec.rb +34 -0
  181. data/spec/models/{getaround_cars_index_inner_spec.rb → unavailabilities_created_spec.rb} +16 -18
  182. data/spec/models/{getaround_payouts_index_inner_spec.rb → unavailabilities_deleted_spec.rb} +16 -18
  183. data/spec/models/unavailabilities_index_spec.rb +34 -0
  184. data/spec/models/{getaround_unavailabilities_created_all_of_data_spec.rb → unavailability_spec.rb} +22 -18
  185. data/spec/models/{getaround_user_spec.rb → user_spec.rb} +31 -27
  186. data/spec/models/users_updated_spec.rb +34 -0
  187. data/spec/models/{getaround_webhook_spec.rb → webhook_spec.rb} +21 -17
  188. data/spec/spec_helper.rb +4 -5
  189. metadata +276 -119
  190. data/lib/get_around_owner/models/getaround_checkins_index_inner.rb +0 -222
  191. data/lib/get_around_owner/models/getaround_create_unavailabilities_request.rb +0 -283
  192. data/lib/get_around_owner/models/getaround_invoice_charges_inner.rb +0 -225
  193. data/lib/get_around_owner/models/getaround_invoices_index_inner.rb +0 -223
  194. data/lib/get_around_owner/models/getaround_messages_sent.rb +0 -257
  195. data/lib/get_around_owner/models/getaround_messages_sent_all_of_data.rb +0 -225
  196. data/lib/get_around_owner/models/getaround_payout_invoices_inner.rb +0 -223
  197. data/lib/get_around_owner/models/getaround_reason.rb +0 -45
  198. data/lib/get_around_owner/models/getaround_rental_invoices_index_inner.rb +0 -223
  199. data/lib/get_around_owner/models/getaround_rental_messages_index_inner.rb +0 -223
  200. data/lib/get_around_owner/models/getaround_rentals_booked.rb +0 -257
  201. data/lib/get_around_owner/models/getaround_rentals_canceled.rb +0 -257
  202. data/lib/get_around_owner/models/getaround_rentals_car_checked_in.rb +0 -257
  203. data/lib/get_around_owner/models/getaround_rentals_car_checked_out.rb +0 -257
  204. data/lib/get_around_owner/models/getaround_rentals_car_switched.rb +0 -257
  205. data/lib/get_around_owner/models/getaround_rentals_index_inner.rb +0 -223
  206. data/lib/get_around_owner/models/getaround_rentals_times_changed.rb +0 -257
  207. data/lib/get_around_owner/models/getaround_unavailabilities_created.rb +0 -257
  208. data/lib/get_around_owner/models/getaround_unavailabilities_deleted.rb +0 -257
  209. data/lib/get_around_owner/models/getaround_unavailabilities_deleted_all_of_data.rb +0 -235
  210. data/lib/get_around_owner/models/getaround_unavailability.rb +0 -302
  211. data/lib/get_around_owner/models/getaround_users_updated.rb +0 -257
  212. data/spec/models/getaround_create_unavailabilities_request_spec.rb +0 -52
  213. data/spec/models/getaround_destroy_unavailability_request_spec.rb +0 -42
  214. data/spec/models/getaround_invoice_charges_inner_spec.rb +0 -42
  215. data/spec/models/getaround_invoices_index_inner_spec.rb +0 -36
  216. data/spec/models/getaround_messages_sent_all_of_data_spec.rb +0 -42
  217. data/spec/models/getaround_messages_sent_spec.rb +0 -48
  218. data/spec/models/getaround_payout_invoices_inner_spec.rb +0 -36
  219. data/spec/models/getaround_rental_invoices_index_inner_spec.rb +0 -36
  220. data/spec/models/getaround_rental_messages_index_inner_spec.rb +0 -36
  221. data/spec/models/getaround_rentals_booked_all_of_data_spec.rb +0 -36
  222. data/spec/models/getaround_rentals_booked_spec.rb +0 -48
  223. data/spec/models/getaround_rentals_canceled_spec.rb +0 -48
  224. data/spec/models/getaround_rentals_car_checked_in_spec.rb +0 -48
  225. data/spec/models/getaround_rentals_car_checked_out_spec.rb +0 -48
  226. data/spec/models/getaround_rentals_car_switched_spec.rb +0 -48
  227. data/spec/models/getaround_rentals_times_changed_spec.rb +0 -48
  228. data/spec/models/getaround_unavailabilities_created_spec.rb +0 -48
  229. data/spec/models/getaround_unavailabilities_deleted_spec.rb +0 -48
  230. data/spec/models/getaround_unavailability_spec.rb +0 -58
  231. data/spec/models/getaround_users_updated_all_of_data_spec.rb +0 -36
  232. data/spec/models/getaround_users_updated_spec.rb +0 -48
data/README.md CHANGED
@@ -2,302 +2,458 @@
2
2
 
3
3
  GetAroundOwner - the Ruby gem for the Getaround Owner API
4
4
 
5
- # Quick Start
5
+ # 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.
6
6
 
7
- The Owner API uses the JSON format, and must be accessed over a [secure connection](https://en.wikipedia.org/wiki/HTTPS).
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
- Let’s assume that the access token provided by your account manager is “TOKEN”.
10
-
11
- Here’s how to get the list of ids of all your invoices from the first week of August with a shell script:
9
+ - API version: 1.0.0
10
+ - Package version: 1.0.4
11
+ - Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
12
12
 
13
- ```bash
14
- query=\"end_date=2018-08-08T00%3A00%3A00%2B00%3A00&start_date=2018-08-01T00%3A00%3A00%2B00%3A00\"
13
+ ## Installation
15
14
 
16
- curl -i \"https://api-eu.getaround.com/owner/v1/invoices?${query}\" \\
17
- -H \"Authorization: Bearer TOKEN\" \\
18
- -H \"Accept:application/json\" \\
19
- -H \"Content-Type:application/json\"
20
- ```
15
+ ### Build a gem
21
16
 
22
- And here’s how to get the invoice with the id 12345:
17
+ To build the Ruby code into a gem:
23
18
 
24
- ```bash
25
- curl -i \"https://api-eu.getaround.com/owner/v1/invoices/12345\" \\
26
- -H \"Authorization: Bearer TOKEN\" \\
27
- -H \"Accept: application/json\" \\
28
- -H \"Content-Type: application/json\"\"
19
+ ```shell
20
+ gem build get_around_owner.gemspec
29
21
  ```
30
22
 
31
- See the [endpoints section](#tag/Invoices) of this guide for details about the response format.
32
-
33
- Dates in request params should follow the ISO 8601 standard.
34
-
23
+ Then either install the gem locally:
35
24
 
36
- # Authentication
25
+ ```shell
26
+ gem install ./get_around_owner-1.0.4.gem
27
+ ```
37
28
 
38
- 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.
29
+ (for development, run `gem install --dev ./get_around_owner-1.0.4.gem` to install the development dependencies)
39
30
 
40
- Unauthenticated requests will return a 401 status.
31
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
41
32
 
33
+ Finally add this to the Gemfile:
42
34
 
43
- # Pagination
35
+ gem 'get_around_owner', '~> 1.0.4'
44
36
 
45
- The page number and the number of items per page can be set with the “page” and “per_page” params.
37
+ ### Install from Git
46
38
 
47
- For example, this request will return the second page of invoices, and 50 invoices per page:
39
+ 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:
48
40
 
49
- `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50`
41
+ gem 'get_around_owner', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
50
42
 
51
- Both of these params are optional. The default page size is 30 items.
43
+ ### Include the Ruby code directly
52
44
 
53
- 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.
54
- The `next` page will be missing when you are requesting the last available page.
45
+ Include the Ruby code directly using `-I` as follows:
55
46
 
56
- 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`
57
- ```
58
- Link: <https://api-eu.getaround.com/owner/v1/invoices?page=3&per_page=50>; rel=\"next\"
47
+ ```shell
48
+ ruby -Ilib script.rb
59
49
  ```
60
50
 
51
+ ## Getting Started
61
52
 
62
- # Throttling policy and Date range limitation
53
+ Please follow the [installation](#installation) procedure and then run the following code:
63
54
 
64
- We have throttling policy that prevents you to perform more than 100 requests per min from the same IP.
55
+ ```ruby
56
+ # Load the gem
57
+ require 'get_around_owner'
58
+ # Setup authorization
59
+ GetAroundOwner.configure do |config|
60
+ end
65
61
 
66
- Also, there is a limitation on the size of the range of dates given in params in some requests.
62
+ api_instance = GetAroundOwner::CarsApi.new
63
+ id = GetAroundOwner::null.new # | ID of car to return
67
64
 
68
- All requests that need start_date and end_date, do not accept a range bigger than 30 days.
69
65
 
66
+ begin
67
+ #Find a car by ID
68
+ result = api_instance.get_car_by_id(id)
69
+ p result
70
+ rescue GetAroundOwner::ApiError => e
71
+ puts "Exception when calling CarsApi->get_car_by_id: #{e}"
72
+ end
73
+ # Setup authorization
74
+ GetAroundOwner.configure do |config|
75
+ end
70
76
 
71
- # Webhooks
77
+ api_instance = GetAroundOwner::CarsApi.new
78
+ opts = {
79
+ page: GetAroundOwner::null.new, # | Page number
80
+ per_page: GetAroundOwner::null.new # | Page size
81
+ }
72
82
 
73
- 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.
83
+ begin
84
+ #Find all cars
85
+ result = api_instance.get_cars(opts)
86
+ p result
87
+ rescue GetAroundOwner::ApiError => e
88
+ puts "Exception when calling CarsApi->get_cars: #{e}"
89
+ end
90
+ # Setup authorization
91
+ GetAroundOwner.configure do |config|
92
+ end
74
93
 
75
- ### Setup
94
+ api_instance = GetAroundOwner::CheckinsApi.new
95
+ rental_id = GetAroundOwner::null.new # | ID of the rental related to the checkin to return
76
96
 
77
- 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.
78
97
 
79
- To acknowledge receipt of a event, your endpoint must:
98
+ begin
99
+ #Find a checkin by rental ID
100
+ result = api_instance.get_checkin_by_rental_id(rental_id)
101
+ p result
102
+ rescue GetAroundOwner::ApiError => e
103
+ puts "Exception when calling CheckinsApi->get_checkin_by_rental_id: #{e}"
104
+ end
105
+ # Setup authorization
106
+ GetAroundOwner.configure do |config|
107
+ end
80
108
 
81
- - Return a `2xx` HTTP status code.
82
- - Be a secure `https` endpoint with a valid SSL certificate.
109
+ api_instance = GetAroundOwner::CheckinsApi.new
110
+ start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
111
+ end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
112
+ opts = {
113
+ page: GetAroundOwner::null.new, # | Page number
114
+ per_page: GetAroundOwner::null.new # | Page size
115
+ }
83
116
 
84
- ### Testing
117
+ begin
118
+ #List of checkins that occurred between two dates
119
+ result = api_instance.get_checkins(start_date, end_date, opts)
120
+ p result
121
+ rescue GetAroundOwner::ApiError => e
122
+ puts "Exception when calling CheckinsApi->get_checkins: #{e}"
123
+ end
124
+ # Setup authorization
125
+ GetAroundOwner.configure do |config|
126
+ end
85
127
 
86
- 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:
128
+ api_instance = GetAroundOwner::CheckoutsApi.new
129
+ rental_id = GetAroundOwner::null.new # | ID of the rental related to the checkout to return
87
130
 
88
- <form action=\"/docs/api/owner/fire_ping_webhook\" method=\"post\"><input type=\"submit\" value=\"Send Ping Event\"></form>
89
131
 
90
- You should receive the following JSON payload:
132
+ begin
133
+ #Find a checkout by rental ID
134
+ result = api_instance.get_checkout_by_rental_id(rental_id)
135
+ p result
136
+ rescue GetAroundOwner::ApiError => e
137
+ puts "Exception when calling CheckoutsApi->get_checkout_by_rental_id: #{e}"
138
+ end
139
+ # Setup authorization
140
+ GetAroundOwner.configure do |config|
141
+ end
91
142
 
92
- ```json
93
- {
94
- \"data\": {
95
- \"ping\": \"pong\"
96
- },
97
- \"type\": \"ping\",
98
- \"occurred_at\": \"2019-04-18T08:30:05Z\"
143
+ api_instance = GetAroundOwner::CheckoutsApi.new
144
+ start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
145
+ end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
146
+ opts = {
147
+ page: GetAroundOwner::null.new, # | Page number
148
+ per_page: GetAroundOwner::null.new # | Page size
99
149
  }
100
- ```
101
-
102
- ### Retries
103
150
 
104
- Webhook deliveries will be attempted for up to three days with an exponential back off. After that point the delivery will be abandoned.
105
-
106
- ### Verifying Signatures
107
-
108
- Getaround will also provide you with a secret token, which is used to create a hash signature with each payload.
151
+ begin
152
+ #List of checkouts that occurred between two dates
153
+ result = api_instance.get_checkouts(start_date, end_date, opts)
154
+ p result
155
+ rescue GetAroundOwner::ApiError => e
156
+ puts "Exception when calling CheckoutsApi->get_checkouts: #{e}"
157
+ end
158
+ # Setup authorization
159
+ GetAroundOwner.configure do |config|
160
+ end
109
161
 
110
- 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:
162
+ api_instance = GetAroundOwner::InvoicesApi.new
163
+ id = GetAroundOwner::null.new # | ID of invoice to return
111
164
 
112
- ```ruby
113
- require 'sinatra'
114
- require 'json'
115
165
 
116
- post '/payload' do
117
- push = JSON.parse(params[:payload])
118
- \"I got some JSON: \#{push.inspect}\"
166
+ begin
167
+ #Find an invoice by ID
168
+ result = api_instance.get_invoice_by_id(id)
169
+ p result
170
+ rescue GetAroundOwner::ApiError => e
171
+ puts "Exception when calling InvoicesApi->get_invoice_by_id: #{e}"
172
+ end
173
+ # Setup authorization
174
+ GetAroundOwner.configure do |config|
119
175
  end
120
- ```
121
176
 
122
- 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:
177
+ api_instance = GetAroundOwner::InvoicesApi.new
178
+ opts = {
179
+ start_date: GetAroundOwner::null.new, # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
180
+ end_date: GetAroundOwner::null.new, # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
181
+ page: GetAroundOwner::null.new, # | Page number
182
+ per_page: GetAroundOwner::null.new # | Page size
183
+ }
123
184
 
124
- ```ruby
125
- post '/payload' do
126
- request.body.rewind
127
- payload_body = request.body.read
128
- verify_signature(payload_body)
129
- push = JSON.parse(params[:payload])
130
- \"I got some JSON: \#{push.inspect}\"
185
+ begin
186
+ #Find invoices emitted between dates
187
+ result = api_instance.get_invoices(opts)
188
+ p result
189
+ rescue GetAroundOwner::ApiError => e
190
+ puts "Exception when calling InvoicesApi->get_invoices: #{e}"
131
191
  end
132
-
133
- def verify_signature(payload_body)
134
- signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['SECRET_TOKEN'], payload_body)
135
- return halt 500, \"Signatures didn't match!\" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_DRIVY_SIGNATURE'])
192
+ # Setup authorization
193
+ GetAroundOwner.configure do |config|
136
194
  end
137
- ```
138
-
139
- Obviously, your language and server implementations may differ from this code. There are a couple of important things to point out, however:
140
195
 
141
- No matter which implementation you use, the hash signature starts with `sha1=`, using the key of your secret token and your payload body.
196
+ api_instance = GetAroundOwner::InvoicesApi.new
197
+ rental_id = GetAroundOwner::null.new # | ID of rental
198
+ opts = {
199
+ page: GetAroundOwner::null.new, # | Page number
200
+ per_page: GetAroundOwner::null.new # | Page size
201
+ }
142
202
 
143
- 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.
203
+ begin
204
+ #Find invoices associated to a rental
205
+ result = api_instance.get_invoices_for_rental(rental_id, opts)
206
+ p result
207
+ rescue GetAroundOwner::ApiError => e
208
+ puts "Exception when calling InvoicesApi->get_invoices_for_rental: #{e}"
209
+ end
210
+ # Setup authorization
211
+ GetAroundOwner.configure do |config|
212
+ end
144
213
 
145
- ### Best Practices
214
+ api_instance = GetAroundOwner::MessagesApi.new
215
+ rental_id = GetAroundOwner::null.new # | ID of rental
216
+ opts = {
217
+ body: GetAroundOwner::RentalIdMessagesJsonBody.new # RentalIdMessagesJsonBody | Message to create
218
+ }
146
219
 
147
- - **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.
148
- - **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.
149
- - **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.
220
+ begin
221
+ #Create Message associated to a rental
222
+ result = api_instance.create_messages(rental_id, opts)
223
+ p result
224
+ rescue GetAroundOwner::ApiError => e
225
+ puts "Exception when calling MessagesApi->create_messages: #{e}"
226
+ end
227
+ # Setup authorization
228
+ GetAroundOwner.configure do |config|
229
+ end
150
230
 
231
+ api_instance = GetAroundOwner::MessagesApi.new
232
+ rental_id = GetAroundOwner::null.new # | ID of rental
233
+ id = GetAroundOwner::null.new # | ID of message to return
151
234
 
152
- This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
153
235
 
154
- - API version: 1.0.0
155
- - Package version: 1.0.0
156
- - Generator version: 7.6.0
157
- - Build package: org.openapitools.codegen.languages.RubyClientCodegen
236
+ begin
237
+ #Find a message by ID associated to a rental
238
+ result = api_instance.get_message_by_id(rental_id, id)
239
+ p result
240
+ rescue GetAroundOwner::ApiError => e
241
+ puts "Exception when calling MessagesApi->get_message_by_id: #{e}"
242
+ end
243
+ # Setup authorization
244
+ GetAroundOwner.configure do |config|
245
+ end
158
246
 
159
- ## Installation
247
+ api_instance = GetAroundOwner::MessagesApi.new
248
+ rental_id = GetAroundOwner::null.new # | ID of rental
160
249
 
161
- ### Build a gem
162
250
 
163
- To build the Ruby code into a gem:
251
+ begin
252
+ #Find messages associated to a rental
253
+ result = api_instance.get_messages_for_rental(rental_id)
254
+ p result
255
+ rescue GetAroundOwner::ApiError => e
256
+ puts "Exception when calling MessagesApi->get_messages_for_rental: #{e}"
257
+ end
258
+ # Setup authorization
259
+ GetAroundOwner.configure do |config|
260
+ end
164
261
 
165
- ```shell
166
- gem build get_around_owner.gemspec
167
- ```
262
+ api_instance = GetAroundOwner::PayoutsApi.new
263
+ id = GetAroundOwner::null.new # | ID of payout to return
168
264
 
169
- Then either install the gem locally:
170
265
 
171
- ```shell
172
- gem install ./get_around_owner-1.0.0.gem
173
- ```
266
+ begin
267
+ #Find a payout by ID
268
+ result = api_instance.get_payout_by_id(id)
269
+ p result
270
+ rescue GetAroundOwner::ApiError => e
271
+ puts "Exception when calling PayoutsApi->get_payout_by_id: #{e}"
272
+ end
273
+ # Setup authorization
274
+ GetAroundOwner.configure do |config|
275
+ end
174
276
 
175
- (for development, run `gem install --dev ./get_around_owner-1.0.0.gem` to install the development dependencies)
277
+ api_instance = GetAroundOwner::PayoutsApi.new
278
+ start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
279
+ end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
280
+ opts = {
281
+ page: GetAroundOwner::null.new, # | Page number
282
+ per_page: GetAroundOwner::null.new # | Page size
283
+ }
176
284
 
177
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
285
+ begin
286
+ #Find payouts paid between dates
287
+ result = api_instance.get_payouts(start_date, end_date, opts)
288
+ p result
289
+ rescue GetAroundOwner::ApiError => e
290
+ puts "Exception when calling PayoutsApi->get_payouts: #{e}"
291
+ end
292
+ # Setup authorization
293
+ GetAroundOwner.configure do |config|
294
+ end
178
295
 
179
- Finally add this to the Gemfile:
296
+ api_instance = GetAroundOwner::RentalsApi.new
297
+ id = GetAroundOwner::null.new # | ID of rental to return
180
298
 
181
- gem 'get_around_owner', '~> 1.0.0'
182
299
 
183
- ### Install from Git
300
+ begin
301
+ #Find a rental by ID
302
+ result = api_instance.get_rental_by_id(id)
303
+ p result
304
+ rescue GetAroundOwner::ApiError => e
305
+ puts "Exception when calling RentalsApi->get_rental_by_id: #{e}"
306
+ end
307
+ # Setup authorization
308
+ GetAroundOwner.configure do |config|
309
+ end
184
310
 
185
- 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:
311
+ api_instance = GetAroundOwner::RentalsApi.new
312
+ start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
313
+ end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
314
+ opts = {
315
+ page: GetAroundOwner::null.new, # | Page number
316
+ per_page: GetAroundOwner::null.new # | Page size
317
+ }
186
318
 
187
- gem 'get_around_owner', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
319
+ begin
320
+ #Find rentals booked between dates
321
+ result = api_instance.get_rentals(start_date, end_date, opts)
322
+ p result
323
+ rescue GetAroundOwner::ApiError => e
324
+ puts "Exception when calling RentalsApi->get_rentals: #{e}"
325
+ end
326
+ # Setup authorization
327
+ GetAroundOwner.configure do |config|
328
+ end
188
329
 
189
- ### Include the Ruby code directly
330
+ api_instance = GetAroundOwner::UnavailabilitiesApi.new
331
+ car_id = GetAroundOwner::null.new # | ID of car
332
+ opts = {
333
+ body: GetAroundOwner::CarIdUnavailabilitiesJsonBody.new # CarIdUnavailabilitiesJsonBody | Unavailability to create
334
+ }
190
335
 
191
- Include the Ruby code directly using `-I` as follows:
336
+ begin
337
+ #Create Unavailability related to a car between dates
338
+ api_instance.create_unavailabilities(car_id, opts)
339
+ rescue GetAroundOwner::ApiError => e
340
+ puts "Exception when calling UnavailabilitiesApi->create_unavailabilities: #{e}"
341
+ end
342
+ # Setup authorization
343
+ GetAroundOwner.configure do |config|
344
+ end
192
345
 
193
- ```shell
194
- ruby -Ilib script.rb
195
- ```
346
+ api_instance = GetAroundOwner::UnavailabilitiesApi.new
347
+ car_id = GetAroundOwner::null.new # | ID of car
196
348
 
197
- ## Getting Started
198
349
 
199
- Please follow the [installation](#installation) procedure and then run the following code:
350
+ begin
351
+ #Destroy Unavailability related to a car between dates
352
+ api_instance.destroy_unavailability(car_id)
353
+ rescue GetAroundOwner::ApiError => e
354
+ puts "Exception when calling UnavailabilitiesApi->destroy_unavailability: #{e}"
355
+ end
356
+ # Setup authorization
357
+ GetAroundOwner.configure do |config|
358
+ end
200
359
 
201
- ```ruby
202
- # Load the gem
203
- require 'get_around_owner'
360
+ api_instance = GetAroundOwner::UnavailabilitiesApi.new
361
+ start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
362
+ end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
363
+ car_id = GetAroundOwner::null.new # | ID of the car
364
+ opts = {
365
+ page: GetAroundOwner::null.new, # | Page number
366
+ per_page: GetAroundOwner::null.new # | Page size
367
+ }
204
368
 
369
+ begin
370
+ #Find Unavailabilities related to a car between dates
371
+ result = api_instance.get_unavailabilities_for_car(start_date, end_date, car_id, opts)
372
+ p result
373
+ rescue GetAroundOwner::ApiError => e
374
+ puts "Exception when calling UnavailabilitiesApi->get_unavailabilities_for_car: #{e}"
375
+ end
205
376
  # Setup authorization
206
377
  GetAroundOwner.configure do |config|
207
- # Configure Bearer authorization: bearerAuth
208
- config.access_token = 'YOUR_BEARER_TOKEN'
209
- # Configure a proc to get access tokens in lieu of the static access_token configuration
210
- config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
211
378
  end
212
379
 
213
- api_instance = GetAroundOwner::CarsApi.new
214
- id = '1' # String | ID of car to return
380
+ api_instance = GetAroundOwner::UsersApi.new
381
+ id = GetAroundOwner::null.new # | ID of user to return
382
+
215
383
 
216
384
  begin
217
- #Find a car by ID
218
- result = api_instance.get_car_by_id(id)
385
+ #Find a user by ID (Users are customers who rent one of your cars)
386
+ result = api_instance.get_user_by_id(id)
219
387
  p result
220
388
  rescue GetAroundOwner::ApiError => e
221
- puts "Exception when calling CarsApi->get_car_by_id: #{e}"
389
+ puts "Exception when calling UsersApi->get_user_by_id: #{e}"
222
390
  end
223
-
224
391
  ```
225
392
 
226
393
  ## Documentation for API Endpoints
227
394
 
228
395
  All URIs are relative to *https://api-eu.getaround.com/owner/v1*
229
396
 
230
- Class | Method | HTTP request | Description
231
- ------------ | ------------- | ------------- | -------------
232
- *GetAroundOwner::CarsApi* | [**get_car_by_id**](docs/CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID
233
- *GetAroundOwner::CarsApi* | [**get_cars**](docs/CarsApi.md#get_cars) | **GET** /cars.json | Find all cars
234
- *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
235
- *GetAroundOwner::CheckinsApi* | [**get_checkins**](docs/CheckinsApi.md#get_checkins) | **GET** /checkins.json | List of checkins that occurred between two dates
236
- *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
237
- *GetAroundOwner::CheckoutsApi* | [**get_checkouts**](docs/CheckoutsApi.md#get_checkouts) | **GET** /checkouts.json | List of checkouts that occurred between two dates
238
- *GetAroundOwner::InvoicesApi* | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{id}.json | Find an invoice by ID
239
- *GetAroundOwner::InvoicesApi* | [**get_invoices**](docs/InvoicesApi.md#get_invoices) | **GET** /invoices.json | Find invoices emitted between dates
240
- *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
241
- *GetAroundOwner::MessagesApi* | [**create_messages**](docs/MessagesApi.md#create_messages) | **POST** /rentals/{rental_id}/messages.json | Create Message associated to a rental
242
- *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
243
- *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
244
- *GetAroundOwner::PayoutsApi* | [**get_payout_by_id**](docs/PayoutsApi.md#get_payout_by_id) | **GET** /payouts/{id}.json | Find a payout by ID
245
- *GetAroundOwner::PayoutsApi* | [**get_payouts**](docs/PayoutsApi.md#get_payouts) | **GET** /payouts.json | Find payouts paid between dates
246
- *GetAroundOwner::RentalsApi* | [**get_rental_by_id**](docs/RentalsApi.md#get_rental_by_id) | **GET** /rentals/{id}.json | Find a rental by ID
247
- *GetAroundOwner::RentalsApi* | [**get_rentals**](docs/RentalsApi.md#get_rentals) | **GET** /rentals.json | Find rentals booked between dates
248
- *GetAroundOwner::UnavailabilitiesApi* | [**create_unavailabilities**](docs/UnavailabilitiesApi.md#create_unavailabilities) | **POST** /cars/{car_id}/unavailabilities.json | Create Unavailability related to a car between dates
249
- *GetAroundOwner::UnavailabilitiesApi* | [**destroy_unavailability**](docs/UnavailabilitiesApi.md#destroy_unavailability) | **DELETE** /cars/{car_id}/unavailabilities.json | Destroy Unavailability related to a car between dates
250
- *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
251
- *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)
252
-
397
+ | Class | Method | HTTP request | Description |
398
+ | ------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------- |
399
+ | _GetAroundOwner::CarsApi_ | [**get_car_by_id**](docs/CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID |
400
+ | _GetAroundOwner::CarsApi_ | [**get_cars**](docs/CarsApi.md#get_cars) | **GET** /cars.json | Find all cars |
401
+ | _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 |
402
+ | _GetAroundOwner::CheckinsApi_ | [**get_checkins**](docs/CheckinsApi.md#get_checkins) | **GET** /checkins.json | List of checkins that occurred between two dates |
403
+ | _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 |
404
+ | _GetAroundOwner::CheckoutsApi_ | [**get_checkouts**](docs/CheckoutsApi.md#get_checkouts) | **GET** /checkouts.json | List of checkouts that occurred between two dates |
405
+ | _GetAroundOwner::InvoicesApi_ | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{id}.json | Find an invoice by ID |
406
+ | _GetAroundOwner::InvoicesApi_ | [**get_invoices**](docs/InvoicesApi.md#get_invoices) | **GET** /invoices.json | Find invoices emitted between dates |
407
+ | _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 |
408
+ | _GetAroundOwner::MessagesApi_ | [**create_messages**](docs/MessagesApi.md#create_messages) | **POST** /rentals/{rental_id}/messages.json | Create Message associated to a rental |
409
+ | _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 |
410
+ | _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 |
411
+ | _GetAroundOwner::PayoutsApi_ | [**get_payout_by_id**](docs/PayoutsApi.md#get_payout_by_id) | **GET** /payouts/{id}.json | Find a payout by ID |
412
+ | _GetAroundOwner::PayoutsApi_ | [**get_payouts**](docs/PayoutsApi.md#get_payouts) | **GET** /payouts.json | Find payouts paid between dates |
413
+ | _GetAroundOwner::RentalsApi_ | [**get_rental_by_id**](docs/RentalsApi.md#get_rental_by_id) | **GET** /rentals/{id}.json | Find a rental by ID |
414
+ | _GetAroundOwner::RentalsApi_ | [**get_rentals**](docs/RentalsApi.md#get_rentals) | **GET** /rentals.json | Find rentals booked between dates |
415
+ | _GetAroundOwner::UnavailabilitiesApi_ | [**create_unavailabilities**](docs/UnavailabilitiesApi.md#create_unavailabilities) | **POST** /cars/{car_id}/unavailabilities.json | Create Unavailability related to a car between dates |
416
+ | _GetAroundOwner::UnavailabilitiesApi_ | [**destroy_unavailability**](docs/UnavailabilitiesApi.md#destroy_unavailability) | **DELETE** /cars/{car_id}/unavailabilities.json | Destroy Unavailability related to a car between dates |
417
+ | _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 |
418
+ | _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) |
253
419
 
254
420
  ## Documentation for Models
255
421
 
256
- - [GetAroundOwner::GetaroundCar](docs/GetaroundCar.md)
257
- - [GetAroundOwner::GetaroundCarsIndexInner](docs/GetaroundCarsIndexInner.md)
258
- - [GetAroundOwner::GetaroundCheckin](docs/GetaroundCheckin.md)
259
- - [GetAroundOwner::GetaroundCheckinsIndexInner](docs/GetaroundCheckinsIndexInner.md)
260
- - [GetAroundOwner::GetaroundCheckout](docs/GetaroundCheckout.md)
261
- - [GetAroundOwner::GetaroundCreateMessagesRequest](docs/GetaroundCreateMessagesRequest.md)
262
- - [GetAroundOwner::GetaroundCreateUnavailabilitiesRequest](docs/GetaroundCreateUnavailabilitiesRequest.md)
263
- - [GetAroundOwner::GetaroundDestroyUnavailabilityRequest](docs/GetaroundDestroyUnavailabilityRequest.md)
264
- - [GetAroundOwner::GetaroundInvoice](docs/GetaroundInvoice.md)
265
- - [GetAroundOwner::GetaroundInvoiceChargesInner](docs/GetaroundInvoiceChargesInner.md)
266
- - [GetAroundOwner::GetaroundInvoicesIndexInner](docs/GetaroundInvoicesIndexInner.md)
267
- - [GetAroundOwner::GetaroundMessage](docs/GetaroundMessage.md)
268
- - [GetAroundOwner::GetaroundMessagesSent](docs/GetaroundMessagesSent.md)
269
- - [GetAroundOwner::GetaroundMessagesSentAllOfData](docs/GetaroundMessagesSentAllOfData.md)
270
- - [GetAroundOwner::GetaroundPayout](docs/GetaroundPayout.md)
271
- - [GetAroundOwner::GetaroundPayoutInvoicesInner](docs/GetaroundPayoutInvoicesInner.md)
272
- - [GetAroundOwner::GetaroundPayoutsIndexInner](docs/GetaroundPayoutsIndexInner.md)
273
- - [GetAroundOwner::GetaroundReason](docs/GetaroundReason.md)
274
- - [GetAroundOwner::GetaroundRental](docs/GetaroundRental.md)
275
- - [GetAroundOwner::GetaroundRentalInvoicesIndexInner](docs/GetaroundRentalInvoicesIndexInner.md)
276
- - [GetAroundOwner::GetaroundRentalMessagesIndexInner](docs/GetaroundRentalMessagesIndexInner.md)
277
- - [GetAroundOwner::GetaroundRentalsBooked](docs/GetaroundRentalsBooked.md)
278
- - [GetAroundOwner::GetaroundRentalsBookedAllOfData](docs/GetaroundRentalsBookedAllOfData.md)
279
- - [GetAroundOwner::GetaroundRentalsCanceled](docs/GetaroundRentalsCanceled.md)
280
- - [GetAroundOwner::GetaroundRentalsCarCheckedIn](docs/GetaroundRentalsCarCheckedIn.md)
281
- - [GetAroundOwner::GetaroundRentalsCarCheckedOut](docs/GetaroundRentalsCarCheckedOut.md)
282
- - [GetAroundOwner::GetaroundRentalsCarSwitched](docs/GetaroundRentalsCarSwitched.md)
283
- - [GetAroundOwner::GetaroundRentalsIndexInner](docs/GetaroundRentalsIndexInner.md)
284
- - [GetAroundOwner::GetaroundRentalsTimesChanged](docs/GetaroundRentalsTimesChanged.md)
285
- - [GetAroundOwner::GetaroundUnavailabilitiesCreated](docs/GetaroundUnavailabilitiesCreated.md)
286
- - [GetAroundOwner::GetaroundUnavailabilitiesCreatedAllOfData](docs/GetaroundUnavailabilitiesCreatedAllOfData.md)
287
- - [GetAroundOwner::GetaroundUnavailabilitiesDeleted](docs/GetaroundUnavailabilitiesDeleted.md)
288
- - [GetAroundOwner::GetaroundUnavailabilitiesDeletedAllOfData](docs/GetaroundUnavailabilitiesDeletedAllOfData.md)
289
- - [GetAroundOwner::GetaroundUnavailability](docs/GetaroundUnavailability.md)
290
- - [GetAroundOwner::GetaroundUser](docs/GetaroundUser.md)
291
- - [GetAroundOwner::GetaroundUsersUpdated](docs/GetaroundUsersUpdated.md)
292
- - [GetAroundOwner::GetaroundUsersUpdatedAllOfData](docs/GetaroundUsersUpdatedAllOfData.md)
293
- - [GetAroundOwner::GetaroundWebhook](docs/GetaroundWebhook.md)
294
-
422
+ - [GetAroundOwner::Car](docs/Car.md)
423
+ - [GetAroundOwner::CarId](docs/CarId.md)
424
+ - [GetAroundOwner::CarIdUnavailabilitiesJsonBody](docs/CarIdUnavailabilitiesJsonBody.md)
425
+ - [GetAroundOwner::CarsIndex](docs/CarsIndex.md)
426
+ - [GetAroundOwner::Checkin](docs/Checkin.md)
427
+ - [GetAroundOwner::CheckinsIndex](docs/CheckinsIndex.md)
428
+ - [GetAroundOwner::Checkout](docs/Checkout.md)
429
+ - [GetAroundOwner::CheckoutsIndex](docs/CheckoutsIndex.md)
430
+ - [GetAroundOwner::EndsAt](docs/EndsAt.md)
431
+ - [GetAroundOwner::Invoice](docs/Invoice.md)
432
+ - [GetAroundOwner::InvoicesIndex](docs/InvoicesIndex.md)
433
+ - [GetAroundOwner::Message](docs/Message.md)
434
+ - [GetAroundOwner::MessagesSent](docs/MessagesSent.md)
435
+ - [GetAroundOwner::Payout](docs/Payout.md)
436
+ - [GetAroundOwner::PayoutsIndex](docs/PayoutsIndex.md)
437
+ - [GetAroundOwner::Rental](docs/Rental.md)
438
+ - [GetAroundOwner::RentalIdMessagesJsonBody](docs/RentalIdMessagesJsonBody.md)
439
+ - [GetAroundOwner::RentalInvoicesIndex](docs/RentalInvoicesIndex.md)
440
+ - [GetAroundOwner::RentalMessagesIndex](docs/RentalMessagesIndex.md)
441
+ - [GetAroundOwner::RentalsBooked](docs/RentalsBooked.md)
442
+ - [GetAroundOwner::RentalsCanceled](docs/RentalsCanceled.md)
443
+ - [GetAroundOwner::RentalsCarCheckedIn](docs/RentalsCarCheckedIn.md)
444
+ - [GetAroundOwner::RentalsCarCheckedOut](docs/RentalsCarCheckedOut.md)
445
+ - [GetAroundOwner::RentalsCarSwitched](docs/RentalsCarSwitched.md)
446
+ - [GetAroundOwner::RentalsIndex](docs/RentalsIndex.md)
447
+ - [GetAroundOwner::RentalsTimesChanged](docs/RentalsTimesChanged.md)
448
+ - [GetAroundOwner::StartsAt](docs/StartsAt.md)
449
+ - [GetAroundOwner::UnavailabilitiesCreated](docs/UnavailabilitiesCreated.md)
450
+ - [GetAroundOwner::UnavailabilitiesDeleted](docs/UnavailabilitiesDeleted.md)
451
+ - [GetAroundOwner::UnavailabilitiesIndex](docs/UnavailabilitiesIndex.md)
452
+ - [GetAroundOwner::Unavailability](docs/Unavailability.md)
453
+ - [GetAroundOwner::User](docs/User.md)
454
+ - [GetAroundOwner::UsersUpdated](docs/UsersUpdated.md)
455
+ - [GetAroundOwner::Webhook](docs/Webhook.md)
295
456
 
296
457
  ## Documentation for Authorization
297
458
 
298
-
299
- Authentication schemes defined for the API:
300
459
  ### bearerAuth
301
-
302
- - **Type**: Bearer authentication
303
-