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
@@ -1,17 +1,14 @@
1
1
  =begin
2
2
  #Getaround Owner API
3
3
 
4
- ## 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.
4
+ ## 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.
5
5
 
6
- The version of the OpenAPI document: 1.0.0
6
+ OpenAPI spec version: 1.0.0
7
7
  Contact: owner-api@getaround.com
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.6.0
10
-
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.66
11
10
  =end
12
11
 
13
- require 'cgi'
14
-
15
12
  module GetAroundOwner
16
13
  class PayoutsApi
17
14
  attr_accessor :api_client
@@ -21,9 +18,9 @@ module GetAroundOwner
21
18
  end
22
19
  # Find a payout by ID
23
20
  # Find a payout by ID
24
- # @param id [String] ID of payout to return
21
+ # @param id ID of payout to return
25
22
  # @param [Hash] opts the optional parameters
26
- # @return [GetaroundPayout]
23
+ # @return [Payout]
27
24
  def get_payout_by_id(id, opts = {})
28
25
  data, _status_code, _headers = get_payout_by_id_with_http_info(id, opts)
29
26
  data
@@ -31,9 +28,9 @@ module GetAroundOwner
31
28
 
32
29
  # Find a payout by ID
33
30
  # Find a payout by ID
34
- # @param id [String] ID of payout to return
31
+ # @param id ID of payout to return
35
32
  # @param [Hash] opts the optional parameters
36
- # @return [Array<(GetaroundPayout, Integer, Hash)>] GetaroundPayout data, response status code and response headers
33
+ # @return [Array<(Payout, Integer, Hash)>] Payout data, response status code and response headers
37
34
  def get_payout_by_id_with_http_info(id, opts = {})
38
35
  if @api_client.config.debugging
39
36
  @api_client.config.logger.debug 'Calling API: PayoutsApi.get_payout_by_id ...'
@@ -43,7 +40,7 @@ module GetAroundOwner
43
40
  fail ArgumentError, "Missing the required parameter 'id' when calling PayoutsApi.get_payout_by_id"
44
41
  end
45
42
  # resource path
46
- local_var_path = '/payouts/{id}.json'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
43
+ local_var_path = '/payouts/{id}.json'.sub('{' + 'id' + '}', id.to_s)
47
44
 
48
45
  # query parameters
49
46
  query_params = opts[:query_params] || {}
@@ -57,39 +54,32 @@ module GetAroundOwner
57
54
  form_params = opts[:form_params] || {}
58
55
 
59
56
  # http body (model)
60
- post_body = opts[:debug_body]
61
-
62
- # return_type
63
- return_type = opts[:debug_return_type] || 'GetaroundPayout'
57
+ post_body = opts[:body]
64
58
 
65
- # auth_names
66
- auth_names = opts[:debug_auth_names] || ['bearerAuth']
59
+ return_type = opts[:return_type] || 'Payout'
67
60
 
68
- new_options = opts.merge(
69
- :operation => :"PayoutsApi.get_payout_by_id",
61
+ auth_names = opts[:auth_names] || ['bearerAuth']
62
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
70
63
  :header_params => header_params,
71
64
  :query_params => query_params,
72
65
  :form_params => form_params,
73
66
  :body => post_body,
74
67
  :auth_names => auth_names,
75
- :return_type => return_type
76
- )
68
+ :return_type => return_type)
77
69
 
78
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
70
  if @api_client.config.debugging
80
71
  @api_client.config.logger.debug "API called: PayoutsApi#get_payout_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
72
  end
82
73
  return data, status_code, headers
83
74
  end
84
-
85
75
  # Find payouts paid between dates
86
76
  # Find payouts paid between dates
87
- # @param start_date [Time] Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
88
- # @param end_date [Time] End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
77
+ # @param start_date Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
78
+ # @param end_date End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
89
79
  # @param [Hash] opts the optional parameters
90
- # @option opts [String] :page Page number
91
- # @option opts [String] :per_page Page size (default to '30')
92
- # @return [Array<GetaroundPayoutsIndexInner>]
80
+ # @option opts [] :page Page number
81
+ # @option opts [] :per_page Page size (default to 30)
82
+ # @return [PayoutsIndex]
93
83
  def get_payouts(start_date, end_date, opts = {})
94
84
  data, _status_code, _headers = get_payouts_with_http_info(start_date, end_date, opts)
95
85
  data
@@ -97,12 +87,12 @@ module GetAroundOwner
97
87
 
98
88
  # Find payouts paid between dates
99
89
  # Find payouts paid between dates
100
- # @param start_date [Time] Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
101
- # @param end_date [Time] End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
90
+ # @param start_date Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
91
+ # @param end_date End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
102
92
  # @param [Hash] opts the optional parameters
103
- # @option opts [String] :page Page number
104
- # @option opts [String] :per_page Page size (default to '30')
105
- # @return [Array<(Array<GetaroundPayoutsIndexInner>, Integer, Hash)>] Array<GetaroundPayoutsIndexInner> data, response status code and response headers
93
+ # @option opts [] :page Page number
94
+ # @option opts [] :per_page Page size
95
+ # @return [Array<(PayoutsIndex, Integer, Hash)>] PayoutsIndex data, response status code and response headers
106
96
  def get_payouts_with_http_info(start_date, end_date, opts = {})
107
97
  if @api_client.config.debugging
108
98
  @api_client.config.logger.debug 'Calling API: PayoutsApi.get_payouts ...'
@@ -134,25 +124,19 @@ module GetAroundOwner
134
124
  form_params = opts[:form_params] || {}
135
125
 
136
126
  # http body (model)
137
- post_body = opts[:debug_body]
138
-
139
- # return_type
140
- return_type = opts[:debug_return_type] || 'Array<GetaroundPayoutsIndexInner>'
127
+ post_body = opts[:body]
141
128
 
142
- # auth_names
143
- auth_names = opts[:debug_auth_names] || ['bearerAuth']
129
+ return_type = opts[:return_type] || 'PayoutsIndex'
144
130
 
145
- new_options = opts.merge(
146
- :operation => :"PayoutsApi.get_payouts",
131
+ auth_names = opts[:auth_names] || ['bearerAuth']
132
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
147
133
  :header_params => header_params,
148
134
  :query_params => query_params,
149
135
  :form_params => form_params,
150
136
  :body => post_body,
151
137
  :auth_names => auth_names,
152
- :return_type => return_type
153
- )
138
+ :return_type => return_type)
154
139
 
155
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
156
140
  if @api_client.config.debugging
157
141
  @api_client.config.logger.debug "API called: PayoutsApi#get_payouts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
158
142
  end
@@ -1,17 +1,14 @@
1
1
  =begin
2
2
  #Getaround Owner API
3
3
 
4
- ## 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.
4
+ ## 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.
5
5
 
6
- The version of the OpenAPI document: 1.0.0
6
+ OpenAPI spec version: 1.0.0
7
7
  Contact: owner-api@getaround.com
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.6.0
10
-
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.66
11
10
  =end
12
11
 
13
- require 'cgi'
14
-
15
12
  module GetAroundOwner
16
13
  class RentalsApi
17
14
  attr_accessor :api_client
@@ -19,242 +16,129 @@ module GetAroundOwner
19
16
  def initialize(api_client = ApiClient.default)
20
17
  @api_client = api_client
21
18
  end
22
- # New rental booked for one of your cars
19
+ # Find a rental by ID
20
+ # Find a rental by ID
21
+ # @param id ID of rental to return
23
22
  # @param [Hash] opts the optional parameters
24
- # @option opts [GetaroundRentalsBooked] :getaround_rentals_booked This event is triggered when a new rental booking has been created for one of your cars
25
- # @return [nil]
26
- def booked_rental_post(opts = {})
27
- booked_rental_post_with_http_info(opts)
28
- nil
23
+ # @return [Rental]
24
+ def get_rental_by_id(id, opts = {})
25
+ data, _status_code, _headers = get_rental_by_id_with_http_info(id, opts)
26
+ data
29
27
  end
30
28
 
31
- # New rental booked for one of your cars
29
+ # Find a rental by ID
30
+ # Find a rental by ID
31
+ # @param id ID of rental to return
32
32
  # @param [Hash] opts the optional parameters
33
- # @option opts [GetaroundRentalsBooked] :getaround_rentals_booked This event is triggered when a new rental booking has been created for one of your cars
34
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
35
- def booked_rental_post_with_http_info(opts = {})
33
+ # @return [Array<(Rental, Integer, Hash)>] Rental data, response status code and response headers
34
+ def get_rental_by_id_with_http_info(id, opts = {})
36
35
  if @api_client.config.debugging
37
- @api_client.config.logger.debug 'Calling API: RentalsApi.booked_rental_post ...'
36
+ @api_client.config.logger.debug 'Calling API: RentalsApi.get_rental_by_id ...'
38
37
  end
39
- # resource path
40
- local_var_path = '/bookedRental'
41
-
42
- # query parameters
43
- query_params = opts[:query_params] || {}
44
-
45
- # header parameters
46
- header_params = opts[:header_params] || {}
47
- # HTTP header 'Content-Type'
48
- content_type = @api_client.select_header_content_type(['application/json'])
49
- if !content_type.nil?
50
- header_params['Content-Type'] = content_type
51
- end
52
-
53
- # form parameters
54
- form_params = opts[:form_params] || {}
55
-
56
- # http body (model)
57
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'getaround_rentals_booked'])
58
-
59
- # return_type
60
- return_type = opts[:debug_return_type]
61
-
62
- # auth_names
63
- auth_names = opts[:debug_auth_names] || []
64
-
65
- new_options = opts.merge(
66
- :operation => :"RentalsApi.booked_rental_post",
67
- :header_params => header_params,
68
- :query_params => query_params,
69
- :form_params => form_params,
70
- :body => post_body,
71
- :auth_names => auth_names,
72
- :return_type => return_type
73
- )
74
-
75
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
76
- if @api_client.config.debugging
77
- @api_client.config.logger.debug "API called: RentalsApi#booked_rental_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
- end
79
- return data, status_code, headers
80
- end
81
-
82
- # Canceled rental for one of your cars
83
- # @param [Hash] opts the optional parameters
84
- # @option opts [GetaroundRentalsCanceled] :getaround_rentals_canceled This event is triggered when a rental has been canceled for one of your cars
85
- # @return [nil]
86
- def canceled_rental_post(opts = {})
87
- canceled_rental_post_with_http_info(opts)
88
- nil
89
- end
90
-
91
- # Canceled rental for one of your cars
92
- # @param [Hash] opts the optional parameters
93
- # @option opts [GetaroundRentalsCanceled] :getaround_rentals_canceled This event is triggered when a rental has been canceled for one of your cars
94
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
95
- def canceled_rental_post_with_http_info(opts = {})
96
- if @api_client.config.debugging
97
- @api_client.config.logger.debug 'Calling API: RentalsApi.canceled_rental_post ...'
38
+ # verify the required parameter 'id' is set
39
+ if @api_client.config.client_side_validation && id.nil?
40
+ fail ArgumentError, "Missing the required parameter 'id' when calling RentalsApi.get_rental_by_id"
98
41
  end
99
42
  # resource path
100
- local_var_path = '/canceledRental'
43
+ local_var_path = '/rentals/{id}.json'.sub('{' + 'id' + '}', id.to_s)
101
44
 
102
45
  # query parameters
103
46
  query_params = opts[:query_params] || {}
104
47
 
105
48
  # header parameters
106
49
  header_params = opts[:header_params] || {}
107
- # HTTP header 'Content-Type'
108
- content_type = @api_client.select_header_content_type(['application/json'])
109
- if !content_type.nil?
110
- header_params['Content-Type'] = content_type
111
- end
50
+ # HTTP header 'Accept' (if needed)
51
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
112
52
 
113
53
  # form parameters
114
54
  form_params = opts[:form_params] || {}
115
55
 
116
56
  # http body (model)
117
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'getaround_rentals_canceled'])
57
+ post_body = opts[:body]
118
58
 
119
- # return_type
120
- return_type = opts[:debug_return_type]
59
+ return_type = opts[:return_type] || 'Rental'
121
60
 
122
- # auth_names
123
- auth_names = opts[:debug_auth_names] || []
124
-
125
- new_options = opts.merge(
126
- :operation => :"RentalsApi.canceled_rental_post",
61
+ auth_names = opts[:auth_names] || ['bearerAuth']
62
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
127
63
  :header_params => header_params,
128
64
  :query_params => query_params,
129
65
  :form_params => form_params,
130
66
  :body => post_body,
131
67
  :auth_names => auth_names,
132
- :return_type => return_type
133
- )
68
+ :return_type => return_type)
134
69
 
135
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
136
70
  if @api_client.config.debugging
137
- @api_client.config.logger.debug "API called: RentalsApi#canceled_rental_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
71
+ @api_client.config.logger.debug "API called: RentalsApi#get_rental_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
138
72
  end
139
73
  return data, status_code, headers
140
74
  end
141
-
142
- # There was a switch car on one of your rental
75
+ # Find rentals booked between dates
76
+ # Find rentals booked between dates
77
+ # @param start_date Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
78
+ # @param end_date End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
143
79
  # @param [Hash] opts the optional parameters
144
- # @option opts [GetaroundRentalsCarSwitched] :getaround_rentals_car_switched This event is triggered when an owner or customer service team member switches the car used to perform a given rental
145
- # @return [nil]
146
- def car_switched_rental_post(opts = {})
147
- car_switched_rental_post_with_http_info(opts)
148
- nil
80
+ # @option opts [] :page Page number
81
+ # @option opts [] :per_page Page size (default to 30)
82
+ # @return [RentalsIndex]
83
+ def get_rentals(start_date, end_date, opts = {})
84
+ data, _status_code, _headers = get_rentals_with_http_info(start_date, end_date, opts)
85
+ data
149
86
  end
150
87
 
151
- # There was a switch car on one of your rental
88
+ # Find rentals booked between dates
89
+ # Find rentals booked between dates
90
+ # @param start_date Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
91
+ # @param end_date End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
152
92
  # @param [Hash] opts the optional parameters
153
- # @option opts [GetaroundRentalsCarSwitched] :getaround_rentals_car_switched This event is triggered when an owner or customer service team member switches the car used to perform a given rental
154
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
155
- def car_switched_rental_post_with_http_info(opts = {})
93
+ # @option opts [] :page Page number
94
+ # @option opts [] :per_page Page size
95
+ # @return [Array<(RentalsIndex, Integer, Hash)>] RentalsIndex data, response status code and response headers
96
+ def get_rentals_with_http_info(start_date, end_date, opts = {})
156
97
  if @api_client.config.debugging
157
- @api_client.config.logger.debug 'Calling API: RentalsApi.car_switched_rental_post ...'
98
+ @api_client.config.logger.debug 'Calling API: RentalsApi.get_rentals ...'
158
99
  end
159
- # resource path
160
- local_var_path = '/carSwitchedRental'
161
-
162
- # query parameters
163
- query_params = opts[:query_params] || {}
164
-
165
- # header parameters
166
- header_params = opts[:header_params] || {}
167
- # HTTP header 'Content-Type'
168
- content_type = @api_client.select_header_content_type(['application/json'])
169
- if !content_type.nil?
170
- header_params['Content-Type'] = content_type
100
+ # verify the required parameter 'start_date' is set
101
+ if @api_client.config.client_side_validation && start_date.nil?
102
+ fail ArgumentError, "Missing the required parameter 'start_date' when calling RentalsApi.get_rentals"
171
103
  end
172
-
173
- # form parameters
174
- form_params = opts[:form_params] || {}
175
-
176
- # http body (model)
177
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'getaround_rentals_car_switched'])
178
-
179
- # return_type
180
- return_type = opts[:debug_return_type]
181
-
182
- # auth_names
183
- auth_names = opts[:debug_auth_names] || []
184
-
185
- new_options = opts.merge(
186
- :operation => :"RentalsApi.car_switched_rental_post",
187
- :header_params => header_params,
188
- :query_params => query_params,
189
- :form_params => form_params,
190
- :body => post_body,
191
- :auth_names => auth_names,
192
- :return_type => return_type
193
- )
194
-
195
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
196
- if @api_client.config.debugging
197
- @api_client.config.logger.debug "API called: RentalsApi#car_switched_rental_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
198
- end
199
- return data, status_code, headers
200
- end
201
-
202
- # Rental time change for one of your car
203
- # @param [Hash] opts the optional parameters
204
- # @option opts [GetaroundRentalsTimesChanged] :getaround_rentals_times_changed This event is triggered when the start or end time of a rental has been changed for one of your cars
205
- # @return [nil]
206
- def times_changed_rental_post(opts = {})
207
- times_changed_rental_post_with_http_info(opts)
208
- nil
209
- end
210
-
211
- # Rental time change for one of your car
212
- # @param [Hash] opts the optional parameters
213
- # @option opts [GetaroundRentalsTimesChanged] :getaround_rentals_times_changed This event is triggered when the start or end time of a rental has been changed for one of your cars
214
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
215
- def times_changed_rental_post_with_http_info(opts = {})
216
- if @api_client.config.debugging
217
- @api_client.config.logger.debug 'Calling API: RentalsApi.times_changed_rental_post ...'
104
+ # verify the required parameter 'end_date' is set
105
+ if @api_client.config.client_side_validation && end_date.nil?
106
+ fail ArgumentError, "Missing the required parameter 'end_date' when calling RentalsApi.get_rentals"
218
107
  end
219
108
  # resource path
220
- local_var_path = '/timesChangedRental'
109
+ local_var_path = '/rentals.json'
221
110
 
222
111
  # query parameters
223
112
  query_params = opts[:query_params] || {}
113
+ query_params[:'start_date'] = start_date
114
+ query_params[:'end_date'] = end_date
115
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
116
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
224
117
 
225
118
  # header parameters
226
119
  header_params = opts[:header_params] || {}
227
- # HTTP header 'Content-Type'
228
- content_type = @api_client.select_header_content_type(['application/json'])
229
- if !content_type.nil?
230
- header_params['Content-Type'] = content_type
231
- end
120
+ # HTTP header 'Accept' (if needed)
121
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
232
122
 
233
123
  # form parameters
234
124
  form_params = opts[:form_params] || {}
235
125
 
236
126
  # http body (model)
237
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'getaround_rentals_times_changed'])
238
-
239
- # return_type
240
- return_type = opts[:debug_return_type]
127
+ post_body = opts[:body]
241
128
 
242
- # auth_names
243
- auth_names = opts[:debug_auth_names] || []
129
+ return_type = opts[:return_type] || 'RentalsIndex'
244
130
 
245
- new_options = opts.merge(
246
- :operation => :"RentalsApi.times_changed_rental_post",
131
+ auth_names = opts[:auth_names] || ['bearerAuth']
132
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
247
133
  :header_params => header_params,
248
134
  :query_params => query_params,
249
135
  :form_params => form_params,
250
136
  :body => post_body,
251
137
  :auth_names => auth_names,
252
- :return_type => return_type
253
- )
138
+ :return_type => return_type)
254
139
 
255
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
256
140
  if @api_client.config.debugging
257
- @api_client.config.logger.debug "API called: RentalsApi#times_changed_rental_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
+ @api_client.config.logger.debug "API called: RentalsApi#get_rentals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
258
142
  end
259
143
  return data, status_code, headers
260
144
  end