get_around_owner 1.0.0 → 1.0.3
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.
- checksums.yaml +4 -4
- data/Owner API v1.json +2938 -0
- data/README.md +338 -181
- data/Rakefile +0 -2
- data/docs/Car.md +12 -0
- data/docs/CarId.md +6 -0
- data/docs/CarIdUnavailabilitiesJsonBody.md +9 -0
- data/docs/CarsApi.md +38 -79
- data/docs/CarsIndex.md +6 -0
- data/docs/Checkin.md +10 -0
- data/docs/CheckinsApi.md +76 -33
- data/docs/CheckinsIndex.md +6 -0
- data/docs/Checkout.md +11 -0
- data/docs/CheckoutsApi.md +76 -33
- data/docs/CheckoutsIndex.md +6 -0
- data/docs/EndsAt.md +6 -0
- data/docs/Invoice.md +15 -0
- data/docs/InvoicesApi.md +62 -124
- data/docs/InvoicesIndex.md +6 -0
- data/docs/Message.md +11 -0
- data/docs/MessagesApi.md +122 -31
- data/docs/MessagesSent.md +6 -0
- data/docs/Payout.md +12 -0
- data/docs/PayoutsApi.md +42 -83
- data/docs/PayoutsIndex.md +6 -0
- data/docs/Rental.md +14 -0
- data/docs/RentalIdMessagesJsonBody.md +7 -0
- data/docs/RentalInvoicesIndex.md +6 -0
- data/docs/RentalMessagesIndex.md +6 -0
- data/docs/RentalsApi.md +54 -203
- data/docs/RentalsBooked.md +6 -0
- data/docs/RentalsCanceled.md +6 -0
- data/docs/RentalsCarCheckedIn.md +6 -0
- data/docs/RentalsCarCheckedOut.md +6 -0
- data/docs/RentalsCarSwitched.md +6 -0
- data/docs/RentalsIndex.md +6 -0
- data/docs/RentalsTimesChanged.md +6 -0
- data/docs/StartsAt.md +6 -0
- data/docs/UnavailabilitiesApi.md +100 -68
- data/docs/UnavailabilitiesCreated.md +6 -0
- data/docs/UnavailabilitiesDeleted.md +6 -0
- data/docs/UnavailabilitiesIndex.md +6 -0
- data/docs/Unavailability.md +10 -0
- data/docs/User.md +19 -0
- data/docs/UsersApi.md +27 -41
- data/docs/UsersUpdated.md +6 -0
- data/docs/Webhook.md +9 -0
- data/get_around_owner-1.0.0.gem +0 -0
- data/get_around_owner-1.0.1.gem +0 -0
- data/get_around_owner.gemspec +16 -3
- data/getaround-api.gemspec +38 -0
- data/git_push.sh +9 -11
- data/lib/{get_around_owner → getaround-api}/api/cars_api.rb +25 -41
- data/lib/getaround-api/api/checkins_api.rb +146 -0
- data/lib/getaround-api/api/checkouts_api.rb +146 -0
- data/lib/{get_around_owner → getaround-api}/api/invoices_api.rb +43 -66
- data/lib/getaround-api/api/messages_api.rb +198 -0
- data/lib/{get_around_owner → getaround-api}/api/payouts_api.rb +29 -45
- data/lib/getaround-api/api/rentals_api.rb +146 -0
- data/lib/getaround-api/api/unavailabilities_api.rb +208 -0
- data/lib/{get_around_owner/api/messages_api.rb → getaround-api/api/users_api.rb} +31 -37
- data/lib/{get_around_owner → getaround-api}/api_client.rb +71 -77
- data/lib/{get_around_owner → getaround-api}/api_error.rb +5 -6
- data/lib/{get_around_owner → getaround-api}/configuration.rb +13 -106
- data/lib/{get_around_owner/models/getaround_car.rb → getaround-api/models/car.rb} +36 -56
- data/lib/{get_around_owner/models/getaround_users_updated_all_of_data.rb → getaround-api/models/car_id.rb} +33 -50
- data/lib/{get_around_owner/models/getaround_destroy_unavailability_request.rb → getaround-api/models/car_id_unavailabilities_json_body.rb} +45 -47
- data/lib/{get_around_owner/models/getaround_rentals_booked_all_of_data.rb → getaround-api/models/cars_index.rb} +33 -50
- data/lib/{get_around_owner/models/getaround_checkin.rb → getaround-api/models/checkin.rb} +34 -65
- data/lib/{get_around_owner/models/getaround_rentals_index_inner.rb → getaround-api/models/checkins_index.rb} +32 -58
- data/lib/{get_around_owner/models/getaround_checkout.rb → getaround-api/models/checkout.rb} +35 -70
- data/lib/getaround-api/models/checkouts_index.rb +197 -0
- data/lib/getaround-api/models/ends_at.rb +198 -0
- data/lib/{get_around_owner/models/getaround_invoice.rb → getaround-api/models/invoice.rb} +45 -113
- data/lib/getaround-api/models/invoices_index.rb +198 -0
- data/lib/{get_around_owner/models/getaround_message.rb → getaround-api/models/message.rb} +35 -53
- data/lib/getaround-api/models/messages_sent.rb +197 -0
- data/lib/{get_around_owner/models/getaround_payout.rb → getaround-api/models/payout.rb} +37 -101
- data/lib/getaround-api/models/payouts_index.rb +198 -0
- data/lib/{get_around_owner/models/getaround_rental.rb → getaround-api/models/rental.rb} +38 -100
- data/lib/{get_around_owner/models/getaround_create_messages_request.rb → getaround-api/models/rental_id_messages_json_body.rb} +31 -41
- data/lib/getaround-api/models/rental_invoices_index.rb +198 -0
- data/lib/getaround-api/models/rental_messages_index.rb +198 -0
- data/lib/getaround-api/models/rentals_booked.rb +197 -0
- data/lib/getaround-api/models/rentals_canceled.rb +197 -0
- data/lib/getaround-api/models/rentals_car_checked_in.rb +197 -0
- data/lib/getaround-api/models/rentals_car_checked_out.rb +197 -0
- data/lib/getaround-api/models/rentals_car_switched.rb +197 -0
- data/lib/getaround-api/models/rentals_index.rb +198 -0
- data/lib/getaround-api/models/rentals_times_changed.rb +197 -0
- data/lib/getaround-api/models/starts_at.rb +198 -0
- data/lib/{get_around_owner/models/getaround_cars_index_inner.rb → getaround-api/models/unavailabilities_created.rb} +32 -58
- data/lib/getaround-api/models/unavailabilities_deleted.rb +197 -0
- data/lib/getaround-api/models/unavailabilities_index.rb +198 -0
- data/lib/{get_around_owner/models/getaround_unavailabilities_created_all_of_data.rb → getaround-api/models/unavailability.rb} +51 -65
- data/lib/{get_around_owner/models/getaround_user.rb → getaround-api/models/user.rb} +43 -75
- data/lib/getaround-api/models/users_updated.rb +197 -0
- data/lib/{get_around_owner/models/getaround_webhook.rb → getaround-api/models/webhook.rb} +38 -47
- data/lib/{get_around_owner → getaround-api}/version.rb +5 -6
- data/lib/getaround-api.rb +81 -0
- data/openapi.yml +2298 -0
- data/spec/api/cars_api_spec.rb +13 -14
- data/spec/api/checkins_api_spec.rb +13 -14
- data/spec/api/checkouts_api_spec.rb +13 -14
- data/spec/api/invoices_api_spec.rb +19 -20
- data/spec/api/messages_api_spec.rb +14 -15
- data/spec/api/payouts_api_spec.rb +13 -14
- data/spec/api/rentals_api_spec.rb +13 -14
- data/spec/api/unavailabilities_api_spec.rb +14 -16
- data/spec/api/users_api_spec.rb +9 -10
- data/spec/api_client_spec.rb +225 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/{models/getaround_checkins_index_inner_spec.rb → configuration_spec.rb} +26 -21
- data/spec/models/{getaround_reason_spec.rb → car_id_spec.rb} +18 -14
- data/spec/models/{getaround_unavailabilities_deleted_all_of_data_spec.rb → car_id_unavailabilities_json_body_spec.rb} +24 -20
- data/spec/models/{getaround_car_spec.rb → car_spec.rb} +24 -20
- data/spec/models/cars_index_spec.rb +34 -0
- data/spec/models/{getaround_checkin_spec.rb → checkin_spec.rb} +22 -18
- data/spec/models/checkins_index_spec.rb +34 -0
- data/spec/models/{getaround_checkout_spec.rb → checkout_spec.rb} +23 -19
- data/spec/models/checkouts_index_spec.rb +34 -0
- data/spec/models/ends_at_spec.rb +34 -0
- data/spec/models/{getaround_invoice_spec.rb → invoice_spec.rb} +27 -31
- data/spec/models/invoices_index_spec.rb +34 -0
- data/spec/models/{getaround_message_spec.rb → message_spec.rb} +23 -19
- data/spec/models/messages_sent_spec.rb +34 -0
- data/spec/models/{getaround_payout_spec.rb → payout_spec.rb} +24 -24
- data/spec/models/payouts_index_spec.rb +34 -0
- data/spec/models/{getaround_create_messages_request_spec.rb → rental_id_messages_json_body_spec.rb} +19 -15
- data/spec/models/{getaround_rentals_index_inner_spec.rb → rental_invoices_index_spec.rb} +16 -18
- data/spec/models/rental_messages_index_spec.rb +34 -0
- data/spec/models/{getaround_rental_spec.rb → rental_spec.rb} +26 -22
- data/spec/models/rentals_booked_spec.rb +34 -0
- data/spec/models/rentals_canceled_spec.rb +34 -0
- data/spec/models/rentals_car_checked_in_spec.rb +34 -0
- data/spec/models/rentals_car_checked_out_spec.rb +34 -0
- data/spec/models/rentals_car_switched_spec.rb +34 -0
- data/spec/models/rentals_index_spec.rb +34 -0
- data/spec/models/rentals_times_changed_spec.rb +34 -0
- data/spec/models/starts_at_spec.rb +34 -0
- data/spec/models/{getaround_cars_index_inner_spec.rb → unavailabilities_created_spec.rb} +16 -18
- data/spec/models/{getaround_payouts_index_inner_spec.rb → unavailabilities_deleted_spec.rb} +16 -18
- data/spec/models/unavailabilities_index_spec.rb +34 -0
- data/spec/models/{getaround_unavailabilities_created_all_of_data_spec.rb → unavailability_spec.rb} +22 -18
- data/spec/models/{getaround_user_spec.rb → user_spec.rb} +31 -27
- data/spec/models/users_updated_spec.rb +34 -0
- data/spec/models/{getaround_webhook_spec.rb → webhook_spec.rb} +21 -17
- data/spec/spec_helper.rb +5 -6
- metadata +237 -132
- data/lib/get_around_owner/api/checkins_api.rb +0 -82
- data/lib/get_around_owner/api/checkouts_api.rb +0 -82
- data/lib/get_around_owner/api/rentals_api.rb +0 -262
- data/lib/get_around_owner/api/unavailabilities_api.rb +0 -142
- data/lib/get_around_owner/api/users_api.rb +0 -82
- data/lib/get_around_owner/models/getaround_checkins_index_inner.rb +0 -222
- data/lib/get_around_owner/models/getaround_create_unavailabilities_request.rb +0 -283
- data/lib/get_around_owner/models/getaround_invoice_charges_inner.rb +0 -225
- data/lib/get_around_owner/models/getaround_invoices_index_inner.rb +0 -223
- data/lib/get_around_owner/models/getaround_messages_sent.rb +0 -257
- data/lib/get_around_owner/models/getaround_messages_sent_all_of_data.rb +0 -225
- data/lib/get_around_owner/models/getaround_payout_invoices_inner.rb +0 -223
- data/lib/get_around_owner/models/getaround_payouts_index_inner.rb +0 -223
- data/lib/get_around_owner/models/getaround_reason.rb +0 -45
- data/lib/get_around_owner/models/getaround_rental_invoices_index_inner.rb +0 -223
- data/lib/get_around_owner/models/getaround_rental_messages_index_inner.rb +0 -223
- data/lib/get_around_owner/models/getaround_rentals_booked.rb +0 -257
- data/lib/get_around_owner/models/getaround_rentals_canceled.rb +0 -257
- data/lib/get_around_owner/models/getaround_rentals_car_checked_in.rb +0 -257
- data/lib/get_around_owner/models/getaround_rentals_car_checked_out.rb +0 -257
- data/lib/get_around_owner/models/getaround_rentals_car_switched.rb +0 -257
- data/lib/get_around_owner/models/getaround_rentals_times_changed.rb +0 -257
- data/lib/get_around_owner/models/getaround_unavailabilities_created.rb +0 -257
- data/lib/get_around_owner/models/getaround_unavailabilities_deleted.rb +0 -257
- data/lib/get_around_owner/models/getaround_unavailabilities_deleted_all_of_data.rb +0 -235
- data/lib/get_around_owner/models/getaround_unavailability.rb +0 -302
- data/lib/get_around_owner/models/getaround_users_updated.rb +0 -257
- data/lib/get_around_owner.rb +0 -86
- data/spec/models/getaround_create_unavailabilities_request_spec.rb +0 -52
- data/spec/models/getaround_destroy_unavailability_request_spec.rb +0 -42
- data/spec/models/getaround_invoice_charges_inner_spec.rb +0 -42
- data/spec/models/getaround_invoices_index_inner_spec.rb +0 -36
- data/spec/models/getaround_messages_sent_all_of_data_spec.rb +0 -42
- data/spec/models/getaround_messages_sent_spec.rb +0 -48
- data/spec/models/getaround_payout_invoices_inner_spec.rb +0 -36
- data/spec/models/getaround_rental_invoices_index_inner_spec.rb +0 -36
- data/spec/models/getaround_rental_messages_index_inner_spec.rb +0 -36
- data/spec/models/getaround_rentals_booked_all_of_data_spec.rb +0 -36
- data/spec/models/getaround_rentals_booked_spec.rb +0 -48
- data/spec/models/getaround_rentals_canceled_spec.rb +0 -48
- data/spec/models/getaround_rentals_car_checked_in_spec.rb +0 -48
- data/spec/models/getaround_rentals_car_checked_out_spec.rb +0 -48
- data/spec/models/getaround_rentals_car_switched_spec.rb +0 -48
- data/spec/models/getaround_rentals_times_changed_spec.rb +0 -48
- data/spec/models/getaround_unavailabilities_created_spec.rb +0 -48
- data/spec/models/getaround_unavailabilities_deleted_spec.rb +0 -48
- data/spec/models/getaround_unavailability_spec.rb +0 -58
- data/spec/models/getaround_users_updated_all_of_data_spec.rb +0 -36
- data/spec/models/getaround_users_updated_spec.rb +0 -48
@@ -1,22 +1,20 @@
|
|
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:
|
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
|
-
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
7
|
Contact: owner-api@getaround.com
|
8
|
-
Generated by: https://
|
9
|
-
|
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
12
|
require 'date'
|
14
13
|
require 'json'
|
15
14
|
require 'logger'
|
16
15
|
require 'tempfile'
|
17
|
-
require 'time'
|
18
16
|
require 'typhoeus'
|
19
|
-
|
17
|
+
require 'uri'
|
20
18
|
|
21
19
|
module GetAroundOwner
|
22
20
|
class ApiClient
|
@@ -32,7 +30,7 @@ module GetAroundOwner
|
|
32
30
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
33
31
|
def initialize(config = Configuration.default)
|
34
32
|
@config = config
|
35
|
-
@user_agent = "
|
33
|
+
@user_agent = "Swagger-Codegen/#{VERSION}/ruby"
|
36
34
|
@default_headers = {
|
37
35
|
'Content-Type' => 'application/json',
|
38
36
|
'User-Agent' => @user_agent
|
@@ -46,10 +44,9 @@ module GetAroundOwner
|
|
46
44
|
# Call an API with given options.
|
47
45
|
#
|
48
46
|
# @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
|
49
|
-
# the data deserialized from response body (
|
47
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
50
48
|
def call_api(http_method, path, opts = {})
|
51
49
|
request = build_request(http_method, path, opts)
|
52
|
-
tempfile = download_file(request) if opts[:return_type] == 'File'
|
53
50
|
response = request.run
|
54
51
|
|
55
52
|
if @config.debugging
|
@@ -71,9 +68,7 @@ module GetAroundOwner
|
|
71
68
|
end
|
72
69
|
end
|
73
70
|
|
74
|
-
if opts[:return_type]
|
75
|
-
data = tempfile
|
76
|
-
elsif opts[:return_type]
|
71
|
+
if opts[:return_type]
|
77
72
|
data = deserialize(response, opts[:return_type])
|
78
73
|
else
|
79
74
|
data = nil
|
@@ -91,13 +86,12 @@ module GetAroundOwner
|
|
91
86
|
# @option opts [Object] :body HTTP body (JSON/XML)
|
92
87
|
# @return [Typhoeus::Request] A Typhoeus Request
|
93
88
|
def build_request(http_method, path, opts = {})
|
94
|
-
url = build_request_url(path
|
89
|
+
url = build_request_url(path)
|
95
90
|
http_method = http_method.to_sym.downcase
|
96
91
|
|
97
92
|
header_params = @default_headers.merge(opts[:header_params] || {})
|
98
93
|
query_params = opts[:query_params] || {}
|
99
94
|
form_params = opts[:form_params] || {}
|
100
|
-
follow_location = opts[:follow_location] || true
|
101
95
|
|
102
96
|
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
103
97
|
|
@@ -114,8 +108,7 @@ module GetAroundOwner
|
|
114
108
|
:ssl_verifyhost => _verify_ssl_host,
|
115
109
|
:sslcert => @config.cert_file,
|
116
110
|
:sslkey => @config.key_file,
|
117
|
-
:verbose => @config.debugging
|
118
|
-
:followlocation => follow_location
|
111
|
+
:verbose => @config.debugging
|
119
112
|
}
|
120
113
|
|
121
114
|
# set custom cert, if provided
|
@@ -129,7 +122,9 @@ module GetAroundOwner
|
|
129
122
|
end
|
130
123
|
end
|
131
124
|
|
132
|
-
Typhoeus::Request.new(url, req_opts)
|
125
|
+
request = Typhoeus::Request.new(url, req_opts)
|
126
|
+
download_file(request) if opts[:return_type] == 'File'
|
127
|
+
request
|
133
128
|
end
|
134
129
|
|
135
130
|
# Builds the HTTP request body
|
@@ -160,49 +155,6 @@ module GetAroundOwner
|
|
160
155
|
data
|
161
156
|
end
|
162
157
|
|
163
|
-
# Save response body into a file in (the defined) temporary folder, using the filename
|
164
|
-
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
165
|
-
# The response body is written to the file in chunks in order to handle files which
|
166
|
-
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
167
|
-
# process can use.
|
168
|
-
#
|
169
|
-
# @see Configuration#temp_folder_path
|
170
|
-
#
|
171
|
-
# @return [Tempfile] the tempfile generated
|
172
|
-
def download_file(request)
|
173
|
-
tempfile = nil
|
174
|
-
encoding = nil
|
175
|
-
request.on_headers do |response|
|
176
|
-
content_disposition = response.headers['Content-Disposition']
|
177
|
-
if content_disposition && content_disposition =~ /filename=/i
|
178
|
-
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
179
|
-
prefix = sanitize_filename(filename)
|
180
|
-
else
|
181
|
-
prefix = 'download-'
|
182
|
-
end
|
183
|
-
prefix = prefix + '-' unless prefix.end_with?('-')
|
184
|
-
encoding = response.body.encoding
|
185
|
-
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
186
|
-
end
|
187
|
-
request.on_body do |chunk|
|
188
|
-
chunk.force_encoding(encoding)
|
189
|
-
tempfile.write(chunk)
|
190
|
-
end
|
191
|
-
# run the request to ensure the tempfile is created successfully before returning it
|
192
|
-
request.run
|
193
|
-
if tempfile
|
194
|
-
tempfile.close
|
195
|
-
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
196
|
-
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
197
|
-
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
198
|
-
"explicitly with `tempfile.delete`"
|
199
|
-
else
|
200
|
-
fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}")
|
201
|
-
end
|
202
|
-
|
203
|
-
tempfile
|
204
|
-
end
|
205
|
-
|
206
158
|
# Check if the given MIME is a JSON MIME.
|
207
159
|
# JSON MIME examples:
|
208
160
|
# application/json
|
@@ -212,7 +164,7 @@ module GetAroundOwner
|
|
212
164
|
# @param [String] mime MIME
|
213
165
|
# @return [Boolean] True if the MIME is application/json
|
214
166
|
def json_mime?(mime)
|
215
|
-
(mime == '*/*') || !(mime =~
|
167
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
216
168
|
end
|
217
169
|
|
218
170
|
# Deserialize the response to the given return type.
|
@@ -221,10 +173,15 @@ module GetAroundOwner
|
|
221
173
|
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
222
174
|
def deserialize(response, return_type)
|
223
175
|
body = response.body
|
176
|
+
|
177
|
+
# handle file downloading - return the File instance processed in request callbacks
|
178
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
179
|
+
return @tempfile if return_type == 'File'
|
180
|
+
|
224
181
|
return nil if body.nil? || body.empty?
|
225
182
|
|
226
183
|
# return response body directly for String return type
|
227
|
-
return body
|
184
|
+
return body if return_type == 'String'
|
228
185
|
|
229
186
|
# ensuring a default content type
|
230
187
|
content_type = response.headers['Content-Type'] || 'application/json'
|
@@ -234,7 +191,7 @@ module GetAroundOwner
|
|
234
191
|
begin
|
235
192
|
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
236
193
|
rescue JSON::ParserError => e
|
237
|
-
if %w(String Date
|
194
|
+
if %w(String Date DateTime).include?(return_type)
|
238
195
|
data = body
|
239
196
|
else
|
240
197
|
raise e
|
@@ -259,9 +216,9 @@ module GetAroundOwner
|
|
259
216
|
data.to_f
|
260
217
|
when 'Boolean'
|
261
218
|
data == true
|
262
|
-
when '
|
219
|
+
when 'DateTime'
|
263
220
|
# parse date time (expecting ISO 8601 format)
|
264
|
-
|
221
|
+
DateTime.parse data
|
265
222
|
when 'Date'
|
266
223
|
# parse date time (expecting ISO 8601 format)
|
267
224
|
Date.parse data
|
@@ -279,9 +236,46 @@ module GetAroundOwner
|
|
279
236
|
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
280
237
|
end
|
281
238
|
else
|
282
|
-
# models
|
283
|
-
|
284
|
-
|
239
|
+
# models, e.g. Pet
|
240
|
+
GetAroundOwner.const_get(return_type).build_from_hash(data)
|
241
|
+
end
|
242
|
+
end
|
243
|
+
|
244
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
245
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
246
|
+
# The response body is written to the file in chunks in order to handle files which
|
247
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
248
|
+
# process can use.
|
249
|
+
#
|
250
|
+
# @see Configuration#temp_folder_path
|
251
|
+
def download_file(request)
|
252
|
+
tempfile = nil
|
253
|
+
encoding = nil
|
254
|
+
request.on_headers do |response|
|
255
|
+
content_disposition = response.headers['Content-Disposition']
|
256
|
+
if content_disposition && content_disposition =~ /filename=/i
|
257
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
258
|
+
prefix = sanitize_filename(filename)
|
259
|
+
else
|
260
|
+
prefix = 'download-'
|
261
|
+
end
|
262
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
263
|
+
encoding = response.body.encoding
|
264
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
265
|
+
@tempfile = tempfile
|
266
|
+
end
|
267
|
+
request.on_body do |chunk|
|
268
|
+
chunk.force_encoding(encoding)
|
269
|
+
tempfile.write(chunk)
|
270
|
+
end
|
271
|
+
request.on_complete do |response|
|
272
|
+
if tempfile
|
273
|
+
tempfile.close
|
274
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
275
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
276
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
277
|
+
"explicitly with `tempfile.delete`"
|
278
|
+
end
|
285
279
|
end
|
286
280
|
end
|
287
281
|
|
@@ -291,16 +285,16 @@ module GetAroundOwner
|
|
291
285
|
# @param [String] filename the filename to be sanitized
|
292
286
|
# @return [String] the sanitized filename
|
293
287
|
def sanitize_filename(filename)
|
294
|
-
filename.
|
288
|
+
filename.gsub(/.*[\/\\]/, '')
|
295
289
|
end
|
296
290
|
|
297
|
-
def build_request_url(path
|
291
|
+
def build_request_url(path)
|
298
292
|
# Add leading and trailing slashes to path
|
299
293
|
path = "/#{path}".gsub(/\/+/, '/')
|
300
|
-
@config.base_url
|
294
|
+
@config.base_url + path
|
301
295
|
end
|
302
296
|
|
303
|
-
# Update
|
297
|
+
# Update hearder and query params based on authentication settings.
|
304
298
|
#
|
305
299
|
# @param [Hash] header_params Header parameters
|
306
300
|
# @param [Hash] query_params Query parameters
|
@@ -312,14 +306,14 @@ module GetAroundOwner
|
|
312
306
|
case auth_setting[:in]
|
313
307
|
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
314
308
|
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
315
|
-
else fail ArgumentError, 'Authentication token must be in `query`
|
309
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
316
310
|
end
|
317
311
|
end
|
318
312
|
end
|
319
313
|
|
320
314
|
# Sets user agent in HTTP header
|
321
315
|
#
|
322
|
-
# @param [String] user_agent User agent (e.g.
|
316
|
+
# @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
|
323
317
|
def user_agent=(user_agent)
|
324
318
|
@user_agent = user_agent
|
325
319
|
@default_headers['User-Agent'] = @user_agent
|
@@ -339,8 +333,8 @@ module GetAroundOwner
|
|
339
333
|
# @param [Array] content_types array for Content-Type
|
340
334
|
# @return [String] the Content-Type header (e.g. application/json)
|
341
335
|
def select_header_content_type(content_types)
|
342
|
-
#
|
343
|
-
return if content_types.nil? || content_types.empty?
|
336
|
+
# use application/json by default
|
337
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
344
338
|
# use JSON when present, otherwise use the first one
|
345
339
|
json_content_type = content_types.find { |s| json_mime?(s) }
|
346
340
|
json_content_type || content_types.first
|
@@ -1,13 +1,12 @@
|
|
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:
|
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
|
-
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
7
|
Contact: owner-api@getaround.com
|
8
|
-
Generated by: https://
|
9
|
-
|
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
12
|
module GetAroundOwner
|
@@ -32,7 +31,6 @@ module GetAroundOwner
|
|
32
31
|
end
|
33
32
|
else
|
34
33
|
super arg
|
35
|
-
@message = arg
|
36
34
|
end
|
37
35
|
end
|
38
36
|
|
@@ -54,5 +52,6 @@ module GetAroundOwner
|
|
54
52
|
|
55
53
|
msg
|
56
54
|
end
|
55
|
+
|
57
56
|
end
|
58
57
|
end
|
@@ -1,13 +1,12 @@
|
|
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:
|
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
|
-
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
7
|
Contact: owner-api@getaround.com
|
8
|
-
Generated by: https://
|
9
|
-
|
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
12
|
module GetAroundOwner
|
@@ -21,18 +20,6 @@ module GetAroundOwner
|
|
21
20
|
# Defines url base path
|
22
21
|
attr_accessor :base_path
|
23
22
|
|
24
|
-
# Define server configuration index
|
25
|
-
attr_accessor :server_index
|
26
|
-
|
27
|
-
# Define server operation configuration index
|
28
|
-
attr_accessor :server_operation_index
|
29
|
-
|
30
|
-
# Default server variables
|
31
|
-
attr_accessor :server_variables
|
32
|
-
|
33
|
-
# Default server operation variables
|
34
|
-
attr_accessor :server_operation_variables
|
35
|
-
|
36
23
|
# Defines API keys used with API Key authentications.
|
37
24
|
#
|
38
25
|
# @return [Hash] key: parameter name, value: parameter value (API key)
|
@@ -62,16 +49,6 @@ module GetAroundOwner
|
|
62
49
|
# Defines the access token (Bearer) used with OAuth2.
|
63
50
|
attr_accessor :access_token
|
64
51
|
|
65
|
-
# Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
|
66
|
-
# Overrides the access_token if set
|
67
|
-
# @return [Proc]
|
68
|
-
attr_accessor :access_token_getter
|
69
|
-
|
70
|
-
# Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
|
71
|
-
# HTTP responses with return type `File` will be returned as a stream of binary data.
|
72
|
-
# Default to false.
|
73
|
-
attr_accessor :return_binary_data
|
74
|
-
|
75
52
|
# Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
|
76
53
|
# details will be logged with `logger.debug` (see the `logger` attribute).
|
77
54
|
# Default to false.
|
@@ -143,7 +120,6 @@ module GetAroundOwner
|
|
143
120
|
# https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
|
144
121
|
attr_accessor :params_encoding
|
145
122
|
|
146
|
-
|
147
123
|
attr_accessor :inject_format
|
148
124
|
|
149
125
|
attr_accessor :force_ending_format
|
@@ -151,20 +127,16 @@ module GetAroundOwner
|
|
151
127
|
def initialize
|
152
128
|
@scheme = 'https'
|
153
129
|
@host = 'api-eu.getaround.com'
|
154
|
-
@base_path = '/owner/v1'
|
155
|
-
@server_index = nil
|
156
|
-
@server_operation_index = {}
|
157
|
-
@server_variables = {}
|
158
|
-
@server_operation_variables = {}
|
130
|
+
@base_path = 'https://api-eu.getaround.com/owner/v1'
|
159
131
|
@api_key = {}
|
160
132
|
@api_key_prefix = {}
|
133
|
+
@timeout = 0
|
161
134
|
@client_side_validation = true
|
162
135
|
@verify_ssl = true
|
163
136
|
@verify_ssl_host = true
|
137
|
+
@params_encoding = nil
|
164
138
|
@cert_file = nil
|
165
139
|
@key_file = nil
|
166
|
-
@timeout = 0
|
167
|
-
@params_encoding = nil
|
168
140
|
@debugging = false
|
169
141
|
@inject_format = false
|
170
142
|
@force_ending_format = false
|
@@ -198,34 +170,20 @@ module GetAroundOwner
|
|
198
170
|
@base_path = '' if @base_path == '/'
|
199
171
|
end
|
200
172
|
|
201
|
-
|
202
|
-
|
203
|
-
if operation_server_settings.key?(operation) then
|
204
|
-
index = server_operation_index.fetch(operation, server_index)
|
205
|
-
server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
|
206
|
-
else
|
207
|
-
server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
|
208
|
-
end
|
173
|
+
def base_url
|
174
|
+
"#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
|
209
175
|
end
|
210
176
|
|
211
177
|
# Gets API key (with prefix if set).
|
212
178
|
# @param [String] param_name the parameter name of API key auth
|
213
|
-
def api_key_with_prefix(param_name
|
214
|
-
key = @api_key[param_name]
|
215
|
-
key = @api_key.fetch(param_alias, key) unless param_alias.nil?
|
179
|
+
def api_key_with_prefix(param_name)
|
216
180
|
if @api_key_prefix[param_name]
|
217
|
-
"#{@api_key_prefix[param_name]} #{
|
181
|
+
"#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
|
218
182
|
else
|
219
|
-
|
183
|
+
@api_key[param_name]
|
220
184
|
end
|
221
185
|
end
|
222
186
|
|
223
|
-
# Gets access_token using access_token_getter or uses the static access_token
|
224
|
-
def access_token_with_refresh
|
225
|
-
return access_token if access_token_getter.nil?
|
226
|
-
access_token_getter.call
|
227
|
-
end
|
228
|
-
|
229
187
|
# Gets Basic Auth token string
|
230
188
|
def basic_auth_token
|
231
189
|
'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
|
@@ -239,60 +197,9 @@ module GetAroundOwner
|
|
239
197
|
type: 'bearer',
|
240
198
|
in: 'header',
|
241
199
|
key: 'Authorization',
|
242
|
-
value: "Bearer #{
|
200
|
+
value: "Bearer #{access_token}"
|
243
201
|
},
|
244
202
|
}
|
245
203
|
end
|
246
|
-
|
247
|
-
# Returns an array of Server setting
|
248
|
-
def server_settings
|
249
|
-
[
|
250
|
-
{
|
251
|
-
url: "https://api-eu.getaround.com/owner/v1",
|
252
|
-
description: "Production server",
|
253
|
-
}
|
254
|
-
]
|
255
|
-
end
|
256
|
-
|
257
|
-
def operation_server_settings
|
258
|
-
{
|
259
|
-
}
|
260
|
-
end
|
261
|
-
|
262
|
-
# Returns URL based on server settings
|
263
|
-
#
|
264
|
-
# @param index array index of the server settings
|
265
|
-
# @param variables hash of variable and the corresponding value
|
266
|
-
def server_url(index, variables = {}, servers = nil)
|
267
|
-
servers = server_settings if servers == nil
|
268
|
-
|
269
|
-
# check array index out of bound
|
270
|
-
if (index.nil? || index < 0 || index >= servers.size)
|
271
|
-
fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
|
272
|
-
end
|
273
|
-
|
274
|
-
server = servers[index]
|
275
|
-
url = server[:url]
|
276
|
-
|
277
|
-
return url unless server.key? :variables
|
278
|
-
|
279
|
-
# go through variable and assign a value
|
280
|
-
server[:variables].each do |name, variable|
|
281
|
-
if variables.key?(name)
|
282
|
-
if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
|
283
|
-
url.gsub! "{" + name.to_s + "}", variables[name]
|
284
|
-
else
|
285
|
-
fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
|
286
|
-
end
|
287
|
-
else
|
288
|
-
# use default value
|
289
|
-
url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
|
290
|
-
end
|
291
|
-
end
|
292
|
-
|
293
|
-
url
|
294
|
-
end
|
295
|
-
|
296
|
-
|
297
204
|
end
|
298
205
|
end
|