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.
- checksums.yaml +4 -4
- data/Gemfile +9 -0
- data/Owner API v1.json +2938 -0
- data/README.md +359 -203
- data/Rakefile +8 -0
- data/docs/Car.md +12 -0
- data/docs/CarId.md +6 -0
- data/docs/CarIdUnavailabilitiesJsonBody.md +9 -0
- data/docs/CarsApi.md +109 -0
- data/docs/CarsIndex.md +6 -0
- data/docs/Checkin.md +10 -0
- data/docs/CheckinsApi.md +113 -0
- data/docs/CheckinsIndex.md +6 -0
- data/docs/Checkout.md +11 -0
- data/docs/CheckoutsApi.md +113 -0
- data/docs/CheckoutsIndex.md +6 -0
- data/docs/EndsAt.md +6 -0
- data/docs/GetaroundCar.md +28 -0
- data/docs/GetaroundCarsIndexInner.md +18 -0
- data/docs/GetaroundCheckin.md +24 -0
- data/docs/GetaroundCheckinsIndexInner.md +18 -0
- data/docs/GetaroundCheckout.md +26 -0
- data/docs/GetaroundCreateMessagesRequest.md +18 -0
- data/docs/GetaroundCreateUnavailabilitiesRequest.md +22 -0
- data/docs/GetaroundDestroyUnavailabilityRequest.md +20 -0
- data/docs/GetaroundInvoice.md +34 -0
- data/docs/GetaroundInvoiceChargesInner.md +20 -0
- data/docs/GetaroundInvoicesIndexInner.md +18 -0
- data/docs/GetaroundMessage.md +26 -0
- data/docs/GetaroundMessagesSent.md +22 -0
- data/docs/GetaroundMessagesSentAllOfData.md +20 -0
- data/docs/GetaroundPayout.md +28 -0
- data/docs/GetaroundPayoutInvoicesInner.md +18 -0
- data/docs/GetaroundPayoutsIndexInner.md +18 -0
- data/docs/GetaroundReason.md +15 -0
- data/docs/GetaroundRental.md +32 -0
- data/docs/GetaroundRentalInvoicesIndexInner.md +18 -0
- data/docs/GetaroundRentalMessagesIndexInner.md +18 -0
- data/docs/GetaroundRentalsBooked.md +22 -0
- data/docs/GetaroundRentalsBookedAllOfData.md +18 -0
- data/docs/GetaroundRentalsCanceled.md +22 -0
- data/docs/GetaroundRentalsCarCheckedIn.md +22 -0
- data/docs/GetaroundRentalsCarCheckedOut.md +22 -0
- data/docs/GetaroundRentalsCarSwitched.md +22 -0
- data/docs/GetaroundRentalsIndexInner.md +18 -0
- data/docs/GetaroundRentalsTimesChanged.md +22 -0
- data/docs/GetaroundUnavailabilitiesCreated.md +22 -0
- data/docs/GetaroundUnavailabilitiesCreatedAllOfData.md +24 -0
- data/docs/GetaroundUnavailabilitiesDeleted.md +22 -0
- data/docs/GetaroundUnavailabilitiesDeletedAllOfData.md +22 -0
- data/docs/GetaroundUnavailability.md +24 -0
- data/docs/GetaroundUser.md +42 -0
- data/docs/GetaroundUsersUpdated.md +22 -0
- data/docs/GetaroundUsersUpdatedAllOfData.md +18 -0
- data/docs/GetaroundWebhook.md +22 -0
- data/docs/Invoice.md +15 -0
- data/docs/InvoicesApi.md +168 -0
- data/docs/InvoicesIndex.md +6 -0
- data/docs/Message.md +11 -0
- data/docs/MessagesApi.md +161 -0
- data/docs/MessagesSent.md +6 -0
- data/docs/Payout.md +12 -0
- data/docs/PayoutsApi.md +113 -0
- 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 +113 -0
- 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 +166 -0
- 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 +56 -0
- 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-1.0.3.gem +0 -0
- data/get_around_owner.gemspec +39 -0
- data/getaround-api.gemspec +38 -0
- data/git_push.sh +55 -0
- data/lib/get_around_owner/api/cars_api.rb +25 -41
- data/lib/get_around_owner/api/checkins_api.rb +99 -35
- data/lib/get_around_owner/api/checkouts_api.rb +99 -35
- data/lib/get_around_owner/api/invoices_api.rb +43 -66
- data/lib/get_around_owner/api/messages_api.rb +149 -33
- data/lib/get_around_owner/api/payouts_api.rb +29 -45
- data/lib/get_around_owner/api/rentals_api.rb +67 -183
- data/lib/get_around_owner/api/unavailabilities_api.rb +124 -58
- data/lib/get_around_owner/api/users_api.rb +30 -36
- data/lib/get_around_owner/api_client.rb +71 -77
- data/lib/get_around_owner/api_error.rb +5 -6
- data/lib/get_around_owner/configuration.rb +13 -106
- data/lib/get_around_owner/models/{getaround_car.rb → car.rb} +36 -56
- data/lib/get_around_owner/models/{getaround_users_updated_all_of_data.rb → car_id.rb} +33 -50
- data/lib/get_around_owner/models/{getaround_destroy_unavailability_request.rb → car_id_unavailabilities_json_body.rb} +45 -47
- data/lib/get_around_owner/models/{getaround_rentals_booked_all_of_data.rb → cars_index.rb} +33 -50
- data/lib/get_around_owner/models/{getaround_checkin.rb → checkin.rb} +34 -65
- data/lib/get_around_owner/models/{getaround_payouts_index_inner.rb → checkins_index.rb} +32 -58
- data/lib/get_around_owner/models/{getaround_checkout.rb → checkout.rb} +35 -70
- data/lib/get_around_owner/models/checkouts_index.rb +197 -0
- data/lib/get_around_owner/models/ends_at.rb +198 -0
- data/lib/get_around_owner/models/{getaround_invoice.rb → invoice.rb} +45 -113
- data/lib/get_around_owner/models/invoices_index.rb +198 -0
- data/lib/get_around_owner/models/{getaround_message.rb → message.rb} +35 -53
- data/lib/get_around_owner/models/messages_sent.rb +197 -0
- data/lib/get_around_owner/models/{getaround_payout.rb → payout.rb} +37 -101
- data/lib/get_around_owner/models/payouts_index.rb +198 -0
- data/lib/get_around_owner/models/{getaround_rental.rb → rental.rb} +38 -100
- data/lib/get_around_owner/models/{getaround_create_messages_request.rb → rental_id_messages_json_body.rb} +31 -41
- data/lib/get_around_owner/models/rental_invoices_index.rb +198 -0
- data/lib/get_around_owner/models/rental_messages_index.rb +198 -0
- data/lib/get_around_owner/models/rentals_booked.rb +197 -0
- data/lib/get_around_owner/models/rentals_canceled.rb +197 -0
- data/lib/get_around_owner/models/rentals_car_checked_in.rb +197 -0
- data/lib/get_around_owner/models/rentals_car_checked_out.rb +197 -0
- data/lib/get_around_owner/models/rentals_car_switched.rb +197 -0
- data/lib/get_around_owner/models/rentals_index.rb +198 -0
- data/lib/get_around_owner/models/rentals_times_changed.rb +197 -0
- data/lib/get_around_owner/models/starts_at.rb +198 -0
- data/lib/get_around_owner/models/{getaround_cars_index_inner.rb → unavailabilities_created.rb} +32 -58
- data/lib/get_around_owner/models/unavailabilities_deleted.rb +197 -0
- data/lib/get_around_owner/models/unavailabilities_index.rb +198 -0
- data/lib/get_around_owner/models/{getaround_unavailabilities_created_all_of_data.rb → unavailability.rb} +51 -65
- data/lib/get_around_owner/models/{getaround_user.rb → user.rb} +43 -75
- data/lib/get_around_owner/models/users_updated.rb +197 -0
- data/lib/get_around_owner/models/{getaround_webhook.rb → webhook.rb} +38 -47
- data/lib/get_around_owner/version.rb +5 -6
- data/lib/get_around_owner.rb +38 -43
- 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/{getaround_rentals_index_inner_spec.rb → cars_index_spec.rb} +16 -18
- 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/rental_invoices_index_spec.rb +34 -0
- 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 +4 -5
- metadata +276 -119
- 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_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_index_inner.rb +0 -223
- 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/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,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:
|
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
|
-
require 'cgi'
|
14
|
-
|
15
12
|
module GetAroundOwner
|
16
13
|
class UnavailabilitiesApi
|
17
14
|
attr_accessor :api_client
|
@@ -19,25 +16,33 @@ module GetAroundOwner
|
|
19
16
|
def initialize(api_client = ApiClient.default)
|
20
17
|
@api_client = api_client
|
21
18
|
end
|
22
|
-
# Unavailability
|
19
|
+
# Create Unavailability related to a car between dates
|
20
|
+
# Set a car as unavailable between 2 dates
|
21
|
+
# @param car_id ID of car
|
23
22
|
# @param [Hash] opts the optional parameters
|
24
|
-
# @option opts [
|
23
|
+
# @option opts [CarIdUnavailabilitiesJsonBody] :body Unavailability to create
|
25
24
|
# @return [nil]
|
26
|
-
def
|
27
|
-
|
25
|
+
def create_unavailabilities(car_id, opts = {})
|
26
|
+
create_unavailabilities_with_http_info(car_id, opts)
|
28
27
|
nil
|
29
28
|
end
|
30
29
|
|
31
|
-
# Unavailability
|
30
|
+
# Create Unavailability related to a car between dates
|
31
|
+
# Set a car as unavailable between 2 dates
|
32
|
+
# @param car_id ID of car
|
32
33
|
# @param [Hash] opts the optional parameters
|
33
|
-
# @option opts [
|
34
|
+
# @option opts [CarIdUnavailabilitiesJsonBody] :body Unavailability to create
|
34
35
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
35
|
-
def
|
36
|
+
def create_unavailabilities_with_http_info(car_id, opts = {})
|
36
37
|
if @api_client.config.debugging
|
37
|
-
@api_client.config.logger.debug 'Calling API: UnavailabilitiesApi.
|
38
|
+
@api_client.config.logger.debug 'Calling API: UnavailabilitiesApi.create_unavailabilities ...'
|
39
|
+
end
|
40
|
+
# verify the required parameter 'car_id' is set
|
41
|
+
if @api_client.config.client_side_validation && car_id.nil?
|
42
|
+
fail ArgumentError, "Missing the required parameter 'car_id' when calling UnavailabilitiesApi.create_unavailabilities"
|
38
43
|
end
|
39
44
|
# resource path
|
40
|
-
local_var_path = '/
|
45
|
+
local_var_path = '/cars/{car_id}/unavailabilities.json'.sub('{' + 'car_id' + '}', car_id.to_s)
|
41
46
|
|
42
47
|
# query parameters
|
43
48
|
query_params = opts[:query_params] || {}
|
@@ -45,96 +50,157 @@ module GetAroundOwner
|
|
45
50
|
# header parameters
|
46
51
|
header_params = opts[:header_params] || {}
|
47
52
|
# HTTP header 'Content-Type'
|
48
|
-
|
49
|
-
if !content_type.nil?
|
50
|
-
header_params['Content-Type'] = content_type
|
51
|
-
end
|
53
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
52
54
|
|
53
55
|
# form parameters
|
54
56
|
form_params = opts[:form_params] || {}
|
55
57
|
|
56
58
|
# http body (model)
|
57
|
-
post_body = opts[:
|
58
|
-
|
59
|
-
# return_type
|
60
|
-
return_type = opts[:debug_return_type]
|
59
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
|
61
60
|
|
62
|
-
|
63
|
-
auth_names = opts[:debug_auth_names] || []
|
61
|
+
return_type = opts[:return_type]
|
64
62
|
|
65
|
-
|
66
|
-
|
63
|
+
auth_names = opts[:auth_names] || ['bearerAuth']
|
64
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
67
65
|
:header_params => header_params,
|
68
66
|
:query_params => query_params,
|
69
67
|
:form_params => form_params,
|
70
68
|
:body => post_body,
|
71
69
|
:auth_names => auth_names,
|
72
|
-
:return_type => return_type
|
73
|
-
)
|
70
|
+
:return_type => return_type)
|
74
71
|
|
75
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
72
|
if @api_client.config.debugging
|
77
|
-
@api_client.config.logger.debug "API called: UnavailabilitiesApi#
|
73
|
+
@api_client.config.logger.debug "API called: UnavailabilitiesApi#create_unavailabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
74
|
end
|
79
75
|
return data, status_code, headers
|
80
76
|
end
|
81
|
-
|
82
|
-
#
|
77
|
+
# Destroy Unavailability related to a car between dates
|
78
|
+
# Set a car as available between 2 dates
|
79
|
+
# @param car_id ID of car
|
83
80
|
# @param [Hash] opts the optional parameters
|
84
|
-
# @option opts [GetaroundUnavailabilitiesDeleted] :getaround_unavailabilities_deleted This event is triggered whenever an unavailability is deleted (through the API or directly in the app/website). It shows the unavailability that has just been deleted, with the same timestamps as those entered by the user. It does not show the changes of other potential overlapping unavailabilities. For example: if an unavailability was already set between June 10 and June 20, and if the user deletes an unavailability between June 18 and June 22 (to set their car as available between this dates), this webhook will only send information about the newly deleted June 18 - June 22 unavailability. It will not show that, under the hood, the unavailability from June 10 to June 20 has be deleted, and that a new unavailability from June 10 to June 18 has been created.
|
85
81
|
# @return [nil]
|
86
|
-
def
|
87
|
-
|
82
|
+
def destroy_unavailability(car_id, opts = {})
|
83
|
+
destroy_unavailability_with_http_info(car_id, opts)
|
88
84
|
nil
|
89
85
|
end
|
90
86
|
|
91
|
-
#
|
87
|
+
# Destroy Unavailability related to a car between dates
|
88
|
+
# Set a car as available between 2 dates
|
89
|
+
# @param car_id ID of car
|
92
90
|
# @param [Hash] opts the optional parameters
|
93
|
-
# @option opts [GetaroundUnavailabilitiesDeleted] :getaround_unavailabilities_deleted This event is triggered whenever an unavailability is deleted (through the API or directly in the app/website). It shows the unavailability that has just been deleted, with the same timestamps as those entered by the user. It does not show the changes of other potential overlapping unavailabilities. For example: if an unavailability was already set between June 10 and June 20, and if the user deletes an unavailability between June 18 and June 22 (to set their car as available between this dates), this webhook will only send information about the newly deleted June 18 - June 22 unavailability. It will not show that, under the hood, the unavailability from June 10 to June 20 has be deleted, and that a new unavailability from June 10 to June 18 has been created.
|
94
91
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
95
|
-
def
|
92
|
+
def destroy_unavailability_with_http_info(car_id, opts = {})
|
96
93
|
if @api_client.config.debugging
|
97
|
-
@api_client.config.logger.debug 'Calling API: UnavailabilitiesApi.
|
94
|
+
@api_client.config.logger.debug 'Calling API: UnavailabilitiesApi.destroy_unavailability ...'
|
95
|
+
end
|
96
|
+
# verify the required parameter 'car_id' is set
|
97
|
+
if @api_client.config.client_side_validation && car_id.nil?
|
98
|
+
fail ArgumentError, "Missing the required parameter 'car_id' when calling UnavailabilitiesApi.destroy_unavailability"
|
98
99
|
end
|
99
100
|
# resource path
|
100
|
-
local_var_path = '/
|
101
|
+
local_var_path = '/cars/{car_id}/unavailabilities.json'.sub('{' + 'car_id' + '}', car_id.to_s)
|
101
102
|
|
102
103
|
# query parameters
|
103
104
|
query_params = opts[:query_params] || {}
|
104
105
|
|
105
106
|
# header parameters
|
106
107
|
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
|
112
108
|
|
113
109
|
# form parameters
|
114
110
|
form_params = opts[:form_params] || {}
|
115
111
|
|
116
112
|
# http body (model)
|
117
|
-
post_body = opts[:
|
113
|
+
post_body = opts[:body]
|
118
114
|
|
119
|
-
|
120
|
-
|
115
|
+
return_type = opts[:return_type]
|
116
|
+
|
117
|
+
auth_names = opts[:auth_names] || ['bearerAuth']
|
118
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
119
|
+
:header_params => header_params,
|
120
|
+
:query_params => query_params,
|
121
|
+
:form_params => form_params,
|
122
|
+
:body => post_body,
|
123
|
+
:auth_names => auth_names,
|
124
|
+
:return_type => return_type)
|
125
|
+
|
126
|
+
if @api_client.config.debugging
|
127
|
+
@api_client.config.logger.debug "API called: UnavailabilitiesApi#destroy_unavailability\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
128
|
+
end
|
129
|
+
return data, status_code, headers
|
130
|
+
end
|
131
|
+
# Find Unavailabilities related to a car between dates
|
132
|
+
# Find between 2 dates when you’ve set a car as unavailable
|
133
|
+
# @param start_date Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
134
|
+
# @param end_date End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
135
|
+
# @param car_id ID of the car
|
136
|
+
# @param [Hash] opts the optional parameters
|
137
|
+
# @option opts [] :page Page number
|
138
|
+
# @option opts [] :per_page Page size (default to 30)
|
139
|
+
# @return [UnavailabilitiesIndex]
|
140
|
+
def get_unavailabilities_for_car(start_date, end_date, car_id, opts = {})
|
141
|
+
data, _status_code, _headers = get_unavailabilities_for_car_with_http_info(start_date, end_date, car_id, opts)
|
142
|
+
data
|
143
|
+
end
|
144
|
+
|
145
|
+
# Find Unavailabilities related to a car between dates
|
146
|
+
# Find between 2 dates when you’ve set a car as unavailable
|
147
|
+
# @param start_date Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
148
|
+
# @param end_date End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
149
|
+
# @param car_id ID of the car
|
150
|
+
# @param [Hash] opts the optional parameters
|
151
|
+
# @option opts [] :page Page number
|
152
|
+
# @option opts [] :per_page Page size
|
153
|
+
# @return [Array<(UnavailabilitiesIndex, Integer, Hash)>] UnavailabilitiesIndex data, response status code and response headers
|
154
|
+
def get_unavailabilities_for_car_with_http_info(start_date, end_date, car_id, opts = {})
|
155
|
+
if @api_client.config.debugging
|
156
|
+
@api_client.config.logger.debug 'Calling API: UnavailabilitiesApi.get_unavailabilities_for_car ...'
|
157
|
+
end
|
158
|
+
# verify the required parameter 'start_date' is set
|
159
|
+
if @api_client.config.client_side_validation && start_date.nil?
|
160
|
+
fail ArgumentError, "Missing the required parameter 'start_date' when calling UnavailabilitiesApi.get_unavailabilities_for_car"
|
161
|
+
end
|
162
|
+
# verify the required parameter 'end_date' is set
|
163
|
+
if @api_client.config.client_side_validation && end_date.nil?
|
164
|
+
fail ArgumentError, "Missing the required parameter 'end_date' when calling UnavailabilitiesApi.get_unavailabilities_for_car"
|
165
|
+
end
|
166
|
+
# verify the required parameter 'car_id' is set
|
167
|
+
if @api_client.config.client_side_validation && car_id.nil?
|
168
|
+
fail ArgumentError, "Missing the required parameter 'car_id' when calling UnavailabilitiesApi.get_unavailabilities_for_car"
|
169
|
+
end
|
170
|
+
# resource path
|
171
|
+
local_var_path = '/cars/{car_id}/unavailabilities.json'.sub('{' + 'car_id' + '}', car_id.to_s)
|
172
|
+
|
173
|
+
# query parameters
|
174
|
+
query_params = opts[:query_params] || {}
|
175
|
+
query_params[:'start_date'] = start_date
|
176
|
+
query_params[:'end_date'] = end_date
|
177
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
178
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
179
|
+
|
180
|
+
# header parameters
|
181
|
+
header_params = opts[:header_params] || {}
|
182
|
+
# HTTP header 'Accept' (if needed)
|
183
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
184
|
+
|
185
|
+
# form parameters
|
186
|
+
form_params = opts[:form_params] || {}
|
187
|
+
|
188
|
+
# http body (model)
|
189
|
+
post_body = opts[:body]
|
121
190
|
|
122
|
-
|
123
|
-
auth_names = opts[:debug_auth_names] || []
|
191
|
+
return_type = opts[:return_type] || 'UnavailabilitiesIndex'
|
124
192
|
|
125
|
-
|
126
|
-
|
193
|
+
auth_names = opts[:auth_names] || ['bearerAuth']
|
194
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
127
195
|
:header_params => header_params,
|
128
196
|
:query_params => query_params,
|
129
197
|
:form_params => form_params,
|
130
198
|
:body => post_body,
|
131
199
|
:auth_names => auth_names,
|
132
|
-
:return_type => return_type
|
133
|
-
)
|
200
|
+
:return_type => return_type)
|
134
201
|
|
135
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
136
202
|
if @api_client.config.debugging
|
137
|
-
@api_client.config.logger.debug "API called: UnavailabilitiesApi#
|
203
|
+
@api_client.config.logger.debug "API called: UnavailabilitiesApi#get_unavailabilities_for_car\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
138
204
|
end
|
139
205
|
return data, status_code, headers
|
140
206
|
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:
|
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
|
-
require 'cgi'
|
14
|
-
|
15
12
|
module GetAroundOwner
|
16
13
|
class UsersApi
|
17
14
|
attr_accessor :api_client
|
@@ -19,62 +16,59 @@ module GetAroundOwner
|
|
19
16
|
def initialize(api_client = ApiClient.default)
|
20
17
|
@api_client = api_client
|
21
18
|
end
|
22
|
-
#
|
19
|
+
# Find a user by ID (Users are customers who rent one of your cars)
|
20
|
+
# Find a user by ID (Users are customers who rent one of your cars)
|
21
|
+
# @param id ID of user to return
|
23
22
|
# @param [Hash] opts the optional parameters
|
24
|
-
# @
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
nil
|
23
|
+
# @return [User]
|
24
|
+
def get_user_by_id(id, opts = {})
|
25
|
+
data, _status_code, _headers = get_user_by_id_with_http_info(id, opts)
|
26
|
+
data
|
29
27
|
end
|
30
28
|
|
31
|
-
#
|
29
|
+
# Find a user by ID (Users are customers who rent one of your cars)
|
30
|
+
# Find a user by ID (Users are customers who rent one of your cars)
|
31
|
+
# @param id ID of user to return
|
32
32
|
# @param [Hash] opts the optional parameters
|
33
|
-
# @
|
34
|
-
|
35
|
-
def updated_user_post_with_http_info(opts = {})
|
33
|
+
# @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
|
34
|
+
def get_user_by_id_with_http_info(id, opts = {})
|
36
35
|
if @api_client.config.debugging
|
37
|
-
@api_client.config.logger.debug 'Calling API: UsersApi.
|
36
|
+
@api_client.config.logger.debug 'Calling API: UsersApi.get_user_by_id ...'
|
37
|
+
end
|
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 UsersApi.get_user_by_id"
|
38
41
|
end
|
39
42
|
# resource path
|
40
|
-
local_var_path = '/
|
43
|
+
local_var_path = '/users/{id}.json'.sub('{' + 'id' + '}', id.to_s)
|
41
44
|
|
42
45
|
# query parameters
|
43
46
|
query_params = opts[:query_params] || {}
|
44
47
|
|
45
48
|
# header parameters
|
46
49
|
header_params = opts[:header_params] || {}
|
47
|
-
# HTTP header '
|
48
|
-
|
49
|
-
if !content_type.nil?
|
50
|
-
header_params['Content-Type'] = content_type
|
51
|
-
end
|
50
|
+
# HTTP header 'Accept' (if needed)
|
51
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
52
52
|
|
53
53
|
# form parameters
|
54
54
|
form_params = opts[:form_params] || {}
|
55
55
|
|
56
56
|
# http body (model)
|
57
|
-
post_body = opts[:
|
58
|
-
|
59
|
-
# return_type
|
60
|
-
return_type = opts[:debug_return_type]
|
57
|
+
post_body = opts[:body]
|
61
58
|
|
62
|
-
|
63
|
-
auth_names = opts[:debug_auth_names] || []
|
59
|
+
return_type = opts[:return_type] || 'User'
|
64
60
|
|
65
|
-
|
66
|
-
|
61
|
+
auth_names = opts[:auth_names] || ['bearerAuth']
|
62
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
67
63
|
:header_params => header_params,
|
68
64
|
:query_params => query_params,
|
69
65
|
:form_params => form_params,
|
70
66
|
:body => post_body,
|
71
67
|
:auth_names => auth_names,
|
72
|
-
:return_type => return_type
|
73
|
-
)
|
68
|
+
:return_type => return_type)
|
74
69
|
|
75
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
70
|
if @api_client.config.debugging
|
77
|
-
@api_client.config.logger.debug "API called: UsersApi#
|
71
|
+
@api_client.config.logger.debug "API called: UsersApi#get_user_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
72
|
end
|
79
73
|
return data, status_code, headers
|
80
74
|
end
|