get_around_owner 1.0.1 → 1.0.4

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: get_around_owner
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - OpenAPI-Generator
-- yann120
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -51,13 +50,176 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-description: Getaround Owner API Wrapper
+description: '# 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. '
 email:
+- owner-api@getaround.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Owner API v1.json
 - README.md
+- Rakefile
+- docs/Car.md
+- docs/CarId.md
+- docs/CarIdUnavailabilitiesJsonBody.md
+- docs/CarsApi.md
+- docs/CarsIndex.md
+- docs/Checkin.md
+- docs/CheckinsApi.md
+- docs/CheckinsIndex.md
+- docs/Checkout.md
+- docs/CheckoutsApi.md
+- docs/CheckoutsIndex.md
+- docs/EndsAt.md
+- docs/GetaroundCar.md
+- docs/GetaroundCarsIndexInner.md
+- docs/GetaroundCheckin.md
+- docs/GetaroundCheckinsIndexInner.md
+- docs/GetaroundCheckout.md
+- docs/GetaroundCreateMessagesRequest.md
+- docs/GetaroundCreateUnavailabilitiesRequest.md
+- docs/GetaroundDestroyUnavailabilityRequest.md
+- docs/GetaroundInvoice.md
+- docs/GetaroundInvoiceChargesInner.md
+- docs/GetaroundInvoicesIndexInner.md
+- docs/GetaroundMessage.md
+- docs/GetaroundMessagesSent.md
+- docs/GetaroundMessagesSentAllOfData.md
+- docs/GetaroundPayout.md
+- docs/GetaroundPayoutInvoicesInner.md
+- docs/GetaroundPayoutsIndexInner.md
+- docs/GetaroundReason.md
+- docs/GetaroundRental.md
+- docs/GetaroundRentalInvoicesIndexInner.md
+- docs/GetaroundRentalMessagesIndexInner.md
+- docs/GetaroundRentalsBooked.md
+- docs/GetaroundRentalsBookedAllOfData.md
+- docs/GetaroundRentalsCanceled.md
+- docs/GetaroundRentalsCarCheckedIn.md
+- docs/GetaroundRentalsCarCheckedOut.md
+- docs/GetaroundRentalsCarSwitched.md
+- docs/GetaroundRentalsIndexInner.md
+- docs/GetaroundRentalsTimesChanged.md
+- docs/GetaroundUnavailabilitiesCreated.md
+- docs/GetaroundUnavailabilitiesCreatedAllOfData.md
+- docs/GetaroundUnavailabilitiesDeleted.md
+- docs/GetaroundUnavailabilitiesDeletedAllOfData.md
+- docs/GetaroundUnavailability.md
+- docs/GetaroundUser.md
+- docs/GetaroundUsersUpdated.md
+- docs/GetaroundUsersUpdatedAllOfData.md
+- docs/GetaroundWebhook.md
+- docs/Invoice.md
+- docs/InvoicesApi.md
+- docs/InvoicesIndex.md
+- docs/Message.md
+- docs/MessagesApi.md
+- docs/MessagesSent.md
+- docs/Payout.md
+- docs/PayoutsApi.md
+- docs/PayoutsIndex.md
+- docs/Rental.md
+- docs/RentalIdMessagesJsonBody.md
+- docs/RentalInvoicesIndex.md
+- docs/RentalMessagesIndex.md
+- docs/RentalsApi.md
+- docs/RentalsBooked.md
+- docs/RentalsCanceled.md
+- docs/RentalsCarCheckedIn.md
+- docs/RentalsCarCheckedOut.md
+- docs/RentalsCarSwitched.md
+- docs/RentalsIndex.md
+- docs/RentalsTimesChanged.md
+- docs/StartsAt.md
+- docs/UnavailabilitiesApi.md
+- docs/UnavailabilitiesCreated.md
+- docs/UnavailabilitiesDeleted.md
+- docs/UnavailabilitiesIndex.md
+- docs/Unavailability.md
+- docs/User.md
+- docs/UsersApi.md
+- docs/UsersUpdated.md
+- docs/Webhook.md
+- get_around_owner-1.0.0.gem
+- get_around_owner-1.0.1.gem
+- get_around_owner-1.0.3.gem
+- get_around_owner.gemspec
+- getaround-api.gemspec
+- git_push.sh
 - lib/get_around_owner.rb
 - lib/get_around_owner/api/cars_api.rb
 - lib/get_around_owner/api/checkins_api.rb
@@ -71,45 +233,42 @@ files:
 - lib/get_around_owner/api_client.rb
 - lib/get_around_owner/api_error.rb
 - lib/get_around_owner/configuration.rb
-- lib/get_around_owner/models/getaround_car.rb
-- lib/get_around_owner/models/getaround_cars_index_inner.rb
-- lib/get_around_owner/models/getaround_checkin.rb
-- lib/get_around_owner/models/getaround_checkins_index_inner.rb
-- lib/get_around_owner/models/getaround_checkout.rb
-- lib/get_around_owner/models/getaround_create_messages_request.rb
-- lib/get_around_owner/models/getaround_create_unavailabilities_request.rb
-- lib/get_around_owner/models/getaround_destroy_unavailability_request.rb
-- lib/get_around_owner/models/getaround_invoice.rb
-- lib/get_around_owner/models/getaround_invoice_charges_inner.rb
-- lib/get_around_owner/models/getaround_invoices_index_inner.rb
-- lib/get_around_owner/models/getaround_message.rb
-- lib/get_around_owner/models/getaround_messages_sent.rb
-- lib/get_around_owner/models/getaround_messages_sent_all_of_data.rb
-- lib/get_around_owner/models/getaround_payout.rb
-- lib/get_around_owner/models/getaround_payout_invoices_inner.rb
-- lib/get_around_owner/models/getaround_payouts_index_inner.rb
-- lib/get_around_owner/models/getaround_reason.rb
-- lib/get_around_owner/models/getaround_rental.rb
-- lib/get_around_owner/models/getaround_rental_invoices_index_inner.rb
-- lib/get_around_owner/models/getaround_rental_messages_index_inner.rb
-- lib/get_around_owner/models/getaround_rentals_booked.rb
-- lib/get_around_owner/models/getaround_rentals_booked_all_of_data.rb
-- lib/get_around_owner/models/getaround_rentals_canceled.rb
-- lib/get_around_owner/models/getaround_rentals_car_checked_in.rb
-- lib/get_around_owner/models/getaround_rentals_car_checked_out.rb
-- lib/get_around_owner/models/getaround_rentals_car_switched.rb
-- lib/get_around_owner/models/getaround_rentals_index_inner.rb
-- lib/get_around_owner/models/getaround_rentals_times_changed.rb
-- lib/get_around_owner/models/getaround_unavailabilities_created.rb
-- lib/get_around_owner/models/getaround_unavailabilities_created_all_of_data.rb
-- lib/get_around_owner/models/getaround_unavailabilities_deleted.rb
-- lib/get_around_owner/models/getaround_unavailabilities_deleted_all_of_data.rb
-- lib/get_around_owner/models/getaround_unavailability.rb
-- lib/get_around_owner/models/getaround_user.rb
-- lib/get_around_owner/models/getaround_users_updated.rb
-- lib/get_around_owner/models/getaround_users_updated_all_of_data.rb
-- lib/get_around_owner/models/getaround_webhook.rb
+- lib/get_around_owner/models/car.rb
+- lib/get_around_owner/models/car_id.rb
+- lib/get_around_owner/models/car_id_unavailabilities_json_body.rb
+- lib/get_around_owner/models/cars_index.rb
+- lib/get_around_owner/models/checkin.rb
+- lib/get_around_owner/models/checkins_index.rb
+- lib/get_around_owner/models/checkout.rb
+- lib/get_around_owner/models/checkouts_index.rb
+- lib/get_around_owner/models/ends_at.rb
+- lib/get_around_owner/models/invoice.rb
+- lib/get_around_owner/models/invoices_index.rb
+- lib/get_around_owner/models/message.rb
+- lib/get_around_owner/models/messages_sent.rb
+- lib/get_around_owner/models/payout.rb
+- lib/get_around_owner/models/payouts_index.rb
+- lib/get_around_owner/models/rental.rb
+- lib/get_around_owner/models/rental_id_messages_json_body.rb
+- lib/get_around_owner/models/rental_invoices_index.rb
+- lib/get_around_owner/models/rental_messages_index.rb
+- lib/get_around_owner/models/rentals_booked.rb
+- lib/get_around_owner/models/rentals_canceled.rb
+- lib/get_around_owner/models/rentals_car_checked_in.rb
+- lib/get_around_owner/models/rentals_car_checked_out.rb
+- lib/get_around_owner/models/rentals_car_switched.rb
+- lib/get_around_owner/models/rentals_index.rb
+- lib/get_around_owner/models/rentals_times_changed.rb
+- lib/get_around_owner/models/starts_at.rb
+- lib/get_around_owner/models/unavailabilities_created.rb
+- lib/get_around_owner/models/unavailabilities_deleted.rb
+- lib/get_around_owner/models/unavailabilities_index.rb
+- lib/get_around_owner/models/unavailability.rb
+- lib/get_around_owner/models/user.rb
+- lib/get_around_owner/models/users_updated.rb
+- lib/get_around_owner/models/webhook.rb
 - lib/get_around_owner/version.rb
+- openapi.yml
 - spec/api/cars_api_spec.rb
 - spec/api/checkins_api_spec.rb
 - spec/api/checkouts_api_spec.rb
@@ -119,46 +278,45 @@ files:
 - spec/api/rentals_api_spec.rb
 - spec/api/unavailabilities_api_spec.rb
 - spec/api/users_api_spec.rb
-- spec/models/getaround_car_spec.rb
-- spec/models/getaround_cars_index_inner_spec.rb
-- spec/models/getaround_checkin_spec.rb
-- spec/models/getaround_checkins_index_inner_spec.rb
-- spec/models/getaround_checkout_spec.rb
-- spec/models/getaround_create_messages_request_spec.rb
-- spec/models/getaround_create_unavailabilities_request_spec.rb
-- spec/models/getaround_destroy_unavailability_request_spec.rb
-- spec/models/getaround_invoice_charges_inner_spec.rb
-- spec/models/getaround_invoice_spec.rb
-- spec/models/getaround_invoices_index_inner_spec.rb
-- spec/models/getaround_message_spec.rb
-- spec/models/getaround_messages_sent_all_of_data_spec.rb
-- spec/models/getaround_messages_sent_spec.rb
-- spec/models/getaround_payout_invoices_inner_spec.rb
-- spec/models/getaround_payout_spec.rb
-- spec/models/getaround_payouts_index_inner_spec.rb
-- spec/models/getaround_reason_spec.rb
-- spec/models/getaround_rental_invoices_index_inner_spec.rb
-- spec/models/getaround_rental_messages_index_inner_spec.rb
-- spec/models/getaround_rental_spec.rb
-- spec/models/getaround_rentals_booked_all_of_data_spec.rb
-- spec/models/getaround_rentals_booked_spec.rb
-- spec/models/getaround_rentals_canceled_spec.rb
-- spec/models/getaround_rentals_car_checked_in_spec.rb
-- spec/models/getaround_rentals_car_checked_out_spec.rb
-- spec/models/getaround_rentals_car_switched_spec.rb
-- spec/models/getaround_rentals_index_inner_spec.rb
-- spec/models/getaround_rentals_times_changed_spec.rb
-- spec/models/getaround_unavailabilities_created_all_of_data_spec.rb
-- spec/models/getaround_unavailabilities_created_spec.rb
-- spec/models/getaround_unavailabilities_deleted_all_of_data_spec.rb
-- spec/models/getaround_unavailabilities_deleted_spec.rb
-- spec/models/getaround_unavailability_spec.rb
-- spec/models/getaround_user_spec.rb
-- spec/models/getaround_users_updated_all_of_data_spec.rb
-- spec/models/getaround_users_updated_spec.rb
-- spec/models/getaround_webhook_spec.rb
+- spec/api_client_spec.rb
+- spec/base_object_spec.rb
+- spec/configuration_spec.rb
+- spec/models/car_id_spec.rb
+- spec/models/car_id_unavailabilities_json_body_spec.rb
+- spec/models/car_spec.rb
+- spec/models/cars_index_spec.rb
+- spec/models/checkin_spec.rb
+- spec/models/checkins_index_spec.rb
+- spec/models/checkout_spec.rb
+- spec/models/checkouts_index_spec.rb
+- spec/models/ends_at_spec.rb
+- spec/models/invoice_spec.rb
+- spec/models/invoices_index_spec.rb
+- spec/models/message_spec.rb
+- spec/models/messages_sent_spec.rb
+- spec/models/payout_spec.rb
+- spec/models/payouts_index_spec.rb
+- spec/models/rental_id_messages_json_body_spec.rb
+- spec/models/rental_invoices_index_spec.rb
+- spec/models/rental_messages_index_spec.rb
+- spec/models/rental_spec.rb
+- spec/models/rentals_booked_spec.rb
+- spec/models/rentals_canceled_spec.rb
+- spec/models/rentals_car_checked_in_spec.rb
+- spec/models/rentals_car_checked_out_spec.rb
+- spec/models/rentals_car_switched_spec.rb
+- spec/models/rentals_index_spec.rb
+- spec/models/rentals_times_changed_spec.rb
+- spec/models/starts_at_spec.rb
+- spec/models/unavailabilities_created_spec.rb
+- spec/models/unavailabilities_deleted_spec.rb
+- spec/models/unavailabilities_index_spec.rb
+- spec/models/unavailability_spec.rb
+- spec/models/user_spec.rb
+- spec/models/users_updated_spec.rb
+- spec/models/webhook_spec.rb
 - spec/spec_helper.rb
-homepage: https://rubygems.org/gems/get_around_owner
+homepage: https://openapi-generator.tech
 licenses:
 - Unlicense
 metadata: {}
@@ -191,42 +349,41 @@ test_files:
 - spec/api/unavailabilities_api_spec.rb
 - spec/api/checkouts_api_spec.rb
 - spec/api/users_api_spec.rb
-- spec/models/getaround_rentals_canceled_spec.rb
-- spec/models/getaround_invoice_charges_inner_spec.rb
-- spec/models/getaround_rentals_car_checked_out_spec.rb
-- spec/models/getaround_rental_messages_index_inner_spec.rb
-- spec/models/getaround_users_updated_spec.rb
-- spec/models/getaround_messages_sent_spec.rb
-- spec/models/getaround_unavailabilities_deleted_all_of_data_spec.rb
-- spec/models/getaround_payout_spec.rb
-- spec/models/getaround_checkins_index_inner_spec.rb
-- spec/models/getaround_unavailability_spec.rb
-- spec/models/getaround_invoice_spec.rb
-- spec/models/getaround_message_spec.rb
-- spec/models/getaround_create_messages_request_spec.rb
-- spec/models/getaround_checkout_spec.rb
-- spec/models/getaround_checkin_spec.rb
-- spec/models/getaround_users_updated_all_of_data_spec.rb
-- spec/models/getaround_reason_spec.rb
-- spec/models/getaround_unavailabilities_created_all_of_data_spec.rb
-- spec/models/getaround_invoices_index_inner_spec.rb
-- spec/models/getaround_cars_index_inner_spec.rb
-- spec/models/getaround_rental_invoices_index_inner_spec.rb
-- spec/models/getaround_car_spec.rb
-- spec/models/getaround_rentals_booked_all_of_data_spec.rb
-- spec/models/getaround_payout_invoices_inner_spec.rb
-- spec/models/getaround_create_unavailabilities_request_spec.rb
-- spec/models/getaround_payouts_index_inner_spec.rb
-- spec/models/getaround_destroy_unavailability_request_spec.rb
-- spec/models/getaround_rentals_car_checked_in_spec.rb
-- spec/models/getaround_rentals_times_changed_spec.rb
-- spec/models/getaround_user_spec.rb
-- spec/models/getaround_unavailabilities_deleted_spec.rb
-- spec/models/getaround_rental_spec.rb
-- spec/models/getaround_webhook_spec.rb
-- spec/models/getaround_rentals_booked_spec.rb
-- spec/models/getaround_messages_sent_all_of_data_spec.rb
-- spec/models/getaround_rentals_index_inner_spec.rb
-- spec/models/getaround_rentals_car_switched_spec.rb
-- spec/models/getaround_unavailabilities_created_spec.rb
+- spec/api_client_spec.rb
+- spec/base_object_spec.rb
+- spec/configuration_spec.rb
+- spec/models/webhook_spec.rb
+- spec/models/rentals_canceled_spec.rb
+- spec/models/checkins_index_spec.rb
+- spec/models/unavailabilities_index_spec.rb
+- spec/models/unavailability_spec.rb
+- spec/models/rental_spec.rb
+- spec/models/cars_index_spec.rb
+- spec/models/car_id_spec.rb
+- spec/models/invoices_index_spec.rb
+- spec/models/rental_id_messages_json_body_spec.rb
+- spec/models/rentals_index_spec.rb
+- spec/models/checkout_spec.rb
+- spec/models/rentals_car_checked_out_spec.rb
+- spec/models/checkin_spec.rb
+- spec/models/unavailabilities_deleted_spec.rb
+- spec/models/rental_invoices_index_spec.rb
+- spec/models/message_spec.rb
+- spec/models/car_id_unavailabilities_json_body_spec.rb
+- spec/models/unavailabilities_created_spec.rb
+- spec/models/payout_spec.rb
+- spec/models/starts_at_spec.rb
+- spec/models/invoice_spec.rb
+- spec/models/ends_at_spec.rb
+- spec/models/car_spec.rb
+- spec/models/rental_messages_index_spec.rb
+- spec/models/payouts_index_spec.rb
+- spec/models/rentals_car_switched_spec.rb
+- spec/models/user_spec.rb
+- spec/models/rentals_car_checked_in_spec.rb
+- spec/models/messages_sent_spec.rb
+- spec/models/users_updated_spec.rb
+- spec/models/rentals_times_changed_spec.rb
+- spec/models/checkouts_index_spec.rb
+- spec/models/rentals_booked_spec.rb
 - spec/spec_helper.rb