get_around_owner 1.0.0 → 1.0.1
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/lib/get_around_owner/version.rb +2 -2
- metadata +2 -53
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/CarsApi.md +0 -151
- data/docs/CheckinsApi.md +0 -71
- data/docs/CheckoutsApi.md +0 -71
- data/docs/GetaroundCar.md +0 -28
- data/docs/GetaroundCarsIndexInner.md +0 -18
- data/docs/GetaroundCheckin.md +0 -24
- data/docs/GetaroundCheckinsIndexInner.md +0 -18
- data/docs/GetaroundCheckout.md +0 -26
- data/docs/GetaroundCreateMessagesRequest.md +0 -18
- data/docs/GetaroundCreateUnavailabilitiesRequest.md +0 -22
- data/docs/GetaroundDestroyUnavailabilityRequest.md +0 -20
- data/docs/GetaroundInvoice.md +0 -34
- data/docs/GetaroundInvoiceChargesInner.md +0 -20
- data/docs/GetaroundInvoicesIndexInner.md +0 -18
- data/docs/GetaroundMessage.md +0 -26
- data/docs/GetaroundMessagesSent.md +0 -22
- data/docs/GetaroundMessagesSentAllOfData.md +0 -20
- data/docs/GetaroundPayout.md +0 -28
- data/docs/GetaroundPayoutInvoicesInner.md +0 -18
- data/docs/GetaroundPayoutsIndexInner.md +0 -18
- data/docs/GetaroundReason.md +0 -15
- data/docs/GetaroundRental.md +0 -32
- data/docs/GetaroundRentalInvoicesIndexInner.md +0 -18
- data/docs/GetaroundRentalMessagesIndexInner.md +0 -18
- data/docs/GetaroundRentalsBooked.md +0 -22
- data/docs/GetaroundRentalsBookedAllOfData.md +0 -18
- data/docs/GetaroundRentalsCanceled.md +0 -22
- data/docs/GetaroundRentalsCarCheckedIn.md +0 -22
- data/docs/GetaroundRentalsCarCheckedOut.md +0 -22
- data/docs/GetaroundRentalsCarSwitched.md +0 -22
- data/docs/GetaroundRentalsIndexInner.md +0 -18
- data/docs/GetaroundRentalsTimesChanged.md +0 -22
- data/docs/GetaroundUnavailabilitiesCreated.md +0 -22
- data/docs/GetaroundUnavailabilitiesCreatedAllOfData.md +0 -24
- data/docs/GetaroundUnavailabilitiesDeleted.md +0 -22
- data/docs/GetaroundUnavailabilitiesDeletedAllOfData.md +0 -22
- data/docs/GetaroundUnavailability.md +0 -24
- data/docs/GetaroundUser.md +0 -42
- data/docs/GetaroundUsersUpdated.md +0 -22
- data/docs/GetaroundUsersUpdatedAllOfData.md +0 -18
- data/docs/GetaroundWebhook.md +0 -22
- data/docs/InvoicesApi.md +0 -231
- data/docs/MessagesApi.md +0 -71
- data/docs/PayoutsApi.md +0 -155
- data/docs/RentalsApi.md +0 -263
- data/docs/UnavailabilitiesApi.md +0 -135
- data/docs/UsersApi.md +0 -71
- data/get_around_owner.gemspec +0 -26
- data/git_push.sh +0 -57
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b93b8c3065fdb031a51fc85c80944717a0b99dc4564cd3bbcefcb19a4128a2b2
|
4
|
+
data.tar.gz: 244b34661579870d26c1f2929b987cdffb7e1a68a5603d0ef29cfdb27f84d3b9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5c29b2198dbbaa7e4a77df988f51f5991d4ae60624c4e2bb241cd7ddd87d232709c8c4c9f87c6774d7ea5f397143a6f8b28d0e11211c8d5d2b3d38ca943dae41
|
7
|
+
data.tar.gz: f454412796b46cad0338f35ef5fd1faca588b941d85226dbba74d13df75eeebd3bbbef541014dcceb9ebb43f017dfe16a4af8c412540cac91a705a03c92f2b69
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Getaround Owner API
|
3
3
|
|
4
|
-
## Quick Start The Owner API uses the JSON format, and must be accessed over a [secure connection](https://en.wikipedia.org/wiki/HTTPS). Let’s assume that the access token provided by your account manager is “TOKEN”. Here’s how to get the list of ids of all your invoices from the first week of August with a shell script: ```bash query=\"end_date=2018-08-08T00%3A00%3A00%2B00%3A00&start_date=2018-08-01T00%3A00%3A00%2B00%3A00\" curl -i \"https://api-eu.getaround.com/owner/v1/invoices?${query}\" \\ -H \"Authorization: Bearer TOKEN\" \\ -H \"Accept:application/json\" \\ -H \"Content-Type:application/json\" ``` And here’s how to get the invoice with the id 12345: ```bash curl -i \"https://api-eu.getaround.com/owner/v1/invoices/12345\" \\ -H \"Authorization: Bearer TOKEN\" \\ -H \"Accept: application/json\" \\ -H \"Content-Type: application/json\"\" ``` See the [endpoints section](#tag/Invoices) of this guide for details about the response format. Dates in request params should follow the ISO 8601 standard. # Authentication All requests must be authenticated with a [bearer token header](https://tools.ietf.org/html/rfc6750#section-2.1). You token will be sent to you by your account manager. Unauthenticated requests will return a 401 status. # Pagination The page number and the number of items per page can be set with the “page” and “per_page” params. For example, this request will return the second page of invoices, and 50 invoices per page: `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50` Both of these params are optional. The default page size is 30 items. The Getaround Owner API follows the [RFC 8288 convention](https://datatracker.ietf.org/doc/html/rfc8288) of using the `Link` header to provide the `next` page URL. Please don't build the pagination URLs yourself. The `next` page will be missing when you are requesting the last available page. Here's an example response header from requesting the second page of invoices `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50` ``` Link: <https://api-eu.getaround.com/owner/v1/invoices?page=3&per_page=50>; rel=\"next\" ``` # Throttling policy and Date range limitation We have throttling policy that prevents you to perform more than 100 requests per min from the same IP. Also, there is a limitation on the size of the range of dates given in params in some requests. All requests that need start_date and end_date, do not accept a range bigger than 30 days. # Webhooks Getaround can send webhook events that notify your application when certain events happen on your account. This is especially useful to follow the lifecycle of rentals, tracking for example bookings or cancellations. ### Setup To set up an endpoint, you need to define a route on your server for receiving events, and then <a href=\"mailto:owner-api@getaround.com\">ask Getaround</a> to add this URL to your account. To acknowledge receipt of a event, your endpoint must: - Return a `2xx` HTTP status code. - Be a secure `https` endpoint with a valid SSL certificate. ### Testing Once Getaround has set up the endpoint, and it is properly configured as described above, a test `ping` event can be sent by clicking the button below: <form action=\"/docs/api/owner/fire_ping_webhook\" method=\"post\"><input type=\"submit\" value=\"Send Ping Event\"></form> You should receive the following JSON payload: ```json { \"data\": { \"ping\": \"pong\" }, \"type\": \"ping\", \"occurred_at\": \"2019-04-18T08:30:05Z\" } ``` ### Retries Webhook deliveries will be attempted for up to three days with an exponential back off. After that point the delivery will be abandoned. ### Verifying Signatures Getaround will also provide you with a secret token, which is used to create a hash signature with each payload. This hash signature is passed along with each request in the headers as `X-Drivy-Signature`. Suppose you have a basic server listening to webhooks that looks like this: ```ruby require 'sinatra' require 'json' post '/payload' do push = JSON.parse(params[:payload]) \"I got some JSON: \#{push.inspect}\" end ``` The goal is to compute a hash using your secret token, and ensure that the hash from Getaround matches. Getaround uses an HMAC hexdigest to compute the hash, so you could change your server to look a little like this: ```ruby post '/payload' do request.body.rewind payload_body = request.body.read verify_signature(payload_body) push = JSON.parse(params[:payload]) \"I got some JSON: \#{push.inspect}\" end def verify_signature(payload_body) signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['SECRET_TOKEN'], payload_body) return halt 500, \"Signatures didn't match!\" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_DRIVY_SIGNATURE']) end ``` Obviously, your language and server implementations may differ from this code. There are a couple of important things to point out, however: No matter which implementation you use, the hash signature starts with `sha1=`, using the key of your secret token and your payload body. Using a plain `==` operator is not advised. A method like secure_compare performs a \"constant time\" string comparison, which renders it safe from certain timing attacks against regular equality operators. ### Best Practices - **Acknowledge events immediately**. If your webhook script performs complex logic, or makes network calls, it’s possible that the script would time out before Getaround sees its complete execution. Ideally, your webhook handler code (acknowledging receipt of an event by returning a `2xx` status code) is separate of any other logic you do for that event. - **Handle duplicate events**. Webhook endpoints might occasionally receive the same event more than once. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events. - **Do not expect events in order**. Getaround does not guarantee delivery of events in the order in which they are generated. Your endpoint should therefore handle this accordingly. We do provide an `occurred_at` timestamp for each event, though, to help reconcile ordering.
|
4
|
+
## Quick Start The Owner API uses the JSON format, and must be accessed over a [secure connection](https://en.wikipedia.org/wiki/HTTPS). Let’s assume that the access token provided by your account manager is “TOKEN”. Here’s how to get the list of ids of all your invoices from the first week of August with a shell script: ```bash query=\"end_date=2018-08-08T00%3A00%3A00%2B00%3A00&start_date=2018-08-01T00%3A00%3A00%2B00%3A00\" curl -i \"https://api-eu.getaround.com/owner/v1/invoices?${query}\" \\ -H \"Authorization: Bearer TOKEN\" \\ -H \"Accept:application/json\" \\ -H \"Content-Type:application/json\" ``` And here’s how to get the invoice with the id 12345: ```bash curl -i \"https://api-eu.getaround.com/owner/v1/invoices/12345\" \\ -H \"Authorization: Bearer TOKEN\" \\ -H \"Accept: application/json\" \\ -H \"Content-Type: application/json\"\" ``` See the [endpoints section](#tag/Invoices) of this guide for details about the response format. Dates in request params should follow the ISO 8601 standard. # Authentication All requests must be authenticated with a [bearer token header](https://tools.ietf.org/html/rfc6750#section-2.1). You token will be sent to you by your account manager. Unauthenticated requests will return a 401 status. # Pagination The page number and the number of items per page can be set with the “page” and “per_page” params. For example, this request will return the second page of invoices, and 50 invoices per page: `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50` Both of these params are optional. The default page size is 30 items. The Getaround Owner API follows the [RFC 8288 convention](https://datatracker.ietf.org/doc/html/rfc8288) of using the `Link` header to provide the `next` page URL. Please don't build the pagination URLs yourself. The `next` page will be missing when you are requesting the last available page. Here's an example response header from requesting the second page of invoices `https://api-eu.getaround.com/owner/v1/invoices?page=2&per_page=50` ``` Link: <https://api-eu.getaround.com/owner/v1/invoices?page=3&per_page=50>; rel=\"next\" ``` # Throttling policy and Date range limitation We have throttling policy that prevents you to perform more than 100 requests per min from the same IP. Also, there is a limitation on the size of the range of dates given in params in some requests. All requests that need start_date and end_date, do not accept a range bigger than 30 days. # Webhooks Getaround can send webhook events that notify your application when certain events happen on your account. This is especially useful to follow the lifecycle of rentals, tracking for example bookings or cancellations. ### Setup To set up an endpoint, you need to define a route on your server for receiving events, and then <a href=\"mailto:owner-api@getaround.com\">ask Getaround</a> to add this URL to your account. To acknowledge receipt of a event, your endpoint must: - Return a `2xx` HTTP status code. - Be a secure `https` endpoint with a valid SSL certificate. ### Testing Once Getaround has set up the endpoint, and it is properly configured as described above, a test `ping` event can be sent by clicking the button below: <form action=\"/docs/api/owner/fire_ping_webhook\" method=\"post\"><input type=\"submit\" value=\"Send Ping Event\"></form> You should receive the following JSON payload: ```json { \"data\": { \"ping\": \"pong\" }, \"type\": \"ping\", \"occurred_at\": \"2019-04-18T08:30:05Z\" } ``` ### Retries Webhook deliveries will be attempted for up to three days with an exponential back off. After that point the delivery will be abandoned. ### Verifying Signatures Getaround will also provide you with a secret token, which is used to create a hash signature with each payload. This hash signature is passed along with each request in the headers as `X-Drivy-Signature`. Suppose you have a basic server listening to webhooks that looks like this: ```ruby require 'sinatra' require 'json' post '/payload' do push = JSON.parse(params[:payload]) \"I got some JSON: \#{push.inspect}\" end ``` The goal is to compute a hash using your secret token, and ensure that the hash from Getaround matches. Getaround uses an HMAC hexdigest to compute the hash, so you could change your server to look a little like this: ```ruby post '/payload' do request.body.rewind payload_body = request.body.read verify_signature(payload_body) push = JSON.parse(params[:payload]) \"I got some JSON: \#{push.inspect}\" end def verify_signature(payload_body) signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['SECRET_TOKEN'], payload_body) return halt 500, \"Signatures didn't match!\" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_DRIVY_SIGNATURE']) end ``` Obviously, your language and server implementations may differ from this code. There are a couple of important things to point out, however: No matter which implementation you use, the hash signature starts with `sha1=`, using the key of your secret token and your payload body. Using a plain `==` operator is not advised. A method like secure_compare performs a \"constant time\" string comparison, which renders it safe from certain timing attacks against regular equality operators. ### Best Practices - **Acknowledge events immediately**. If your webhook script performs complex logic, or makes network calls, it’s possible that the script would time out before Getaround sees its complete execution. Ideally, your webhook handler code (acknowledging receipt of an event by returning a `2xx` status code) is separate of any other logic you do for that event. - **Handle duplicate events**. Webhook endpoints might occasionally receive the same event more than once. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events. - **Do not expect events in order**. Getaround does not guarantee delivery of events in the order in which they are generated. Your endpoint should therefore handle this accordingly. We do provide an `occurred_at` timestamp for each event, though, to help reconcile ordering.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
Contact: owner-api@getaround.com
|
@@ -11,5 +11,5 @@ Generator version: 7.6.0
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
module GetAroundOwner
|
14
|
-
VERSION = '1.0.
|
14
|
+
VERSION = '1.0.1'
|
15
15
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: get_around_owner
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- OpenAPI-Generator
|
@@ -57,58 +57,7 @@ executables: []
|
|
57
57
|
extensions: []
|
58
58
|
extra_rdoc_files: []
|
59
59
|
files:
|
60
|
-
- Gemfile
|
61
60
|
- README.md
|
62
|
-
- Rakefile
|
63
|
-
- docs/CarsApi.md
|
64
|
-
- docs/CheckinsApi.md
|
65
|
-
- docs/CheckoutsApi.md
|
66
|
-
- docs/GetaroundCar.md
|
67
|
-
- docs/GetaroundCarsIndexInner.md
|
68
|
-
- docs/GetaroundCheckin.md
|
69
|
-
- docs/GetaroundCheckinsIndexInner.md
|
70
|
-
- docs/GetaroundCheckout.md
|
71
|
-
- docs/GetaroundCreateMessagesRequest.md
|
72
|
-
- docs/GetaroundCreateUnavailabilitiesRequest.md
|
73
|
-
- docs/GetaroundDestroyUnavailabilityRequest.md
|
74
|
-
- docs/GetaroundInvoice.md
|
75
|
-
- docs/GetaroundInvoiceChargesInner.md
|
76
|
-
- docs/GetaroundInvoicesIndexInner.md
|
77
|
-
- docs/GetaroundMessage.md
|
78
|
-
- docs/GetaroundMessagesSent.md
|
79
|
-
- docs/GetaroundMessagesSentAllOfData.md
|
80
|
-
- docs/GetaroundPayout.md
|
81
|
-
- docs/GetaroundPayoutInvoicesInner.md
|
82
|
-
- docs/GetaroundPayoutsIndexInner.md
|
83
|
-
- docs/GetaroundReason.md
|
84
|
-
- docs/GetaroundRental.md
|
85
|
-
- docs/GetaroundRentalInvoicesIndexInner.md
|
86
|
-
- docs/GetaroundRentalMessagesIndexInner.md
|
87
|
-
- docs/GetaroundRentalsBooked.md
|
88
|
-
- docs/GetaroundRentalsBookedAllOfData.md
|
89
|
-
- docs/GetaroundRentalsCanceled.md
|
90
|
-
- docs/GetaroundRentalsCarCheckedIn.md
|
91
|
-
- docs/GetaroundRentalsCarCheckedOut.md
|
92
|
-
- docs/GetaroundRentalsCarSwitched.md
|
93
|
-
- docs/GetaroundRentalsIndexInner.md
|
94
|
-
- docs/GetaroundRentalsTimesChanged.md
|
95
|
-
- docs/GetaroundUnavailabilitiesCreated.md
|
96
|
-
- docs/GetaroundUnavailabilitiesCreatedAllOfData.md
|
97
|
-
- docs/GetaroundUnavailabilitiesDeleted.md
|
98
|
-
- docs/GetaroundUnavailabilitiesDeletedAllOfData.md
|
99
|
-
- docs/GetaroundUnavailability.md
|
100
|
-
- docs/GetaroundUser.md
|
101
|
-
- docs/GetaroundUsersUpdated.md
|
102
|
-
- docs/GetaroundUsersUpdatedAllOfData.md
|
103
|
-
- docs/GetaroundWebhook.md
|
104
|
-
- docs/InvoicesApi.md
|
105
|
-
- docs/MessagesApi.md
|
106
|
-
- docs/PayoutsApi.md
|
107
|
-
- docs/RentalsApi.md
|
108
|
-
- docs/UnavailabilitiesApi.md
|
109
|
-
- docs/UsersApi.md
|
110
|
-
- get_around_owner.gemspec
|
111
|
-
- git_push.sh
|
112
61
|
- lib/get_around_owner.rb
|
113
62
|
- lib/get_around_owner/api/cars_api.rb
|
114
63
|
- lib/get_around_owner/api/checkins_api.rb
|
@@ -209,7 +158,7 @@ files:
|
|
209
158
|
- spec/models/getaround_users_updated_spec.rb
|
210
159
|
- spec/models/getaround_webhook_spec.rb
|
211
160
|
- spec/spec_helper.rb
|
212
|
-
homepage: https://
|
161
|
+
homepage: https://rubygems.org/gems/get_around_owner
|
213
162
|
licenses:
|
214
163
|
- Unlicense
|
215
164
|
metadata: {}
|
data/Gemfile
DELETED
data/Rakefile
DELETED
data/docs/CarsApi.md
DELETED
@@ -1,151 +0,0 @@
|
|
1
|
-
# GetAroundOwner::CarsApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
|
-
|
5
|
-
| Method | HTTP request | Description |
|
6
|
-
| ------ | ------------ | ----------- |
|
7
|
-
| [**get_car_by_id**](CarsApi.md#get_car_by_id) | **GET** /cars/{id}.json | Find a car by ID |
|
8
|
-
| [**get_cars**](CarsApi.md#get_cars) | **GET** /cars.json | Find all cars |
|
9
|
-
|
10
|
-
|
11
|
-
## get_car_by_id
|
12
|
-
|
13
|
-
> <GetaroundCar> get_car_by_id(id)
|
14
|
-
|
15
|
-
Find a car by ID
|
16
|
-
|
17
|
-
Find a car by ID
|
18
|
-
|
19
|
-
### Examples
|
20
|
-
|
21
|
-
```ruby
|
22
|
-
require 'time'
|
23
|
-
require 'get_around_owner'
|
24
|
-
# setup authorization
|
25
|
-
GetAroundOwner.configure do |config|
|
26
|
-
# Configure Bearer authorization: bearerAuth
|
27
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
28
|
-
end
|
29
|
-
|
30
|
-
api_instance = GetAroundOwner::CarsApi.new
|
31
|
-
id = '1' # String | ID of car to return
|
32
|
-
|
33
|
-
begin
|
34
|
-
# Find a car by ID
|
35
|
-
result = api_instance.get_car_by_id(id)
|
36
|
-
p result
|
37
|
-
rescue GetAroundOwner::ApiError => e
|
38
|
-
puts "Error when calling CarsApi->get_car_by_id: #{e}"
|
39
|
-
end
|
40
|
-
```
|
41
|
-
|
42
|
-
#### Using the get_car_by_id_with_http_info variant
|
43
|
-
|
44
|
-
This returns an Array which contains the response data, status code and headers.
|
45
|
-
|
46
|
-
> <Array(<GetaroundCar>, Integer, Hash)> get_car_by_id_with_http_info(id)
|
47
|
-
|
48
|
-
```ruby
|
49
|
-
begin
|
50
|
-
# Find a car by ID
|
51
|
-
data, status_code, headers = api_instance.get_car_by_id_with_http_info(id)
|
52
|
-
p status_code # => 2xx
|
53
|
-
p headers # => { ... }
|
54
|
-
p data # => <GetaroundCar>
|
55
|
-
rescue GetAroundOwner::ApiError => e
|
56
|
-
puts "Error when calling CarsApi->get_car_by_id_with_http_info: #{e}"
|
57
|
-
end
|
58
|
-
```
|
59
|
-
|
60
|
-
### Parameters
|
61
|
-
|
62
|
-
| Name | Type | Description | Notes |
|
63
|
-
| ---- | ---- | ----------- | ----- |
|
64
|
-
| **id** | **String** | ID of car to return | |
|
65
|
-
|
66
|
-
### Return type
|
67
|
-
|
68
|
-
[**GetaroundCar**](GetaroundCar.md)
|
69
|
-
|
70
|
-
### Authorization
|
71
|
-
|
72
|
-
[bearerAuth](../README.md#bearerAuth)
|
73
|
-
|
74
|
-
### HTTP request headers
|
75
|
-
|
76
|
-
- **Content-Type**: Not defined
|
77
|
-
- **Accept**: application/json
|
78
|
-
|
79
|
-
|
80
|
-
## get_cars
|
81
|
-
|
82
|
-
> <Array<GetaroundCarsIndexInner>> get_cars(opts)
|
83
|
-
|
84
|
-
Find all cars
|
85
|
-
|
86
|
-
Find all cars
|
87
|
-
|
88
|
-
### Examples
|
89
|
-
|
90
|
-
```ruby
|
91
|
-
require 'time'
|
92
|
-
require 'get_around_owner'
|
93
|
-
# setup authorization
|
94
|
-
GetAroundOwner.configure do |config|
|
95
|
-
# Configure Bearer authorization: bearerAuth
|
96
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
97
|
-
end
|
98
|
-
|
99
|
-
api_instance = GetAroundOwner::CarsApi.new
|
100
|
-
opts = {
|
101
|
-
page: 'page_example', # String | Page number
|
102
|
-
per_page: 'per_page_example' # String | Page size
|
103
|
-
}
|
104
|
-
|
105
|
-
begin
|
106
|
-
# Find all cars
|
107
|
-
result = api_instance.get_cars(opts)
|
108
|
-
p result
|
109
|
-
rescue GetAroundOwner::ApiError => e
|
110
|
-
puts "Error when calling CarsApi->get_cars: #{e}"
|
111
|
-
end
|
112
|
-
```
|
113
|
-
|
114
|
-
#### Using the get_cars_with_http_info variant
|
115
|
-
|
116
|
-
This returns an Array which contains the response data, status code and headers.
|
117
|
-
|
118
|
-
> <Array(<Array<GetaroundCarsIndexInner>>, Integer, Hash)> get_cars_with_http_info(opts)
|
119
|
-
|
120
|
-
```ruby
|
121
|
-
begin
|
122
|
-
# Find all cars
|
123
|
-
data, status_code, headers = api_instance.get_cars_with_http_info(opts)
|
124
|
-
p status_code # => 2xx
|
125
|
-
p headers # => { ... }
|
126
|
-
p data # => <Array<GetaroundCarsIndexInner>>
|
127
|
-
rescue GetAroundOwner::ApiError => e
|
128
|
-
puts "Error when calling CarsApi->get_cars_with_http_info: #{e}"
|
129
|
-
end
|
130
|
-
```
|
131
|
-
|
132
|
-
### Parameters
|
133
|
-
|
134
|
-
| Name | Type | Description | Notes |
|
135
|
-
| ---- | ---- | ----------- | ----- |
|
136
|
-
| **page** | **String** | Page number | [optional] |
|
137
|
-
| **per_page** | **String** | Page size | [optional][default to '30'] |
|
138
|
-
|
139
|
-
### Return type
|
140
|
-
|
141
|
-
[**Array<GetaroundCarsIndexInner>**](GetaroundCarsIndexInner.md)
|
142
|
-
|
143
|
-
### Authorization
|
144
|
-
|
145
|
-
[bearerAuth](../README.md#bearerAuth)
|
146
|
-
|
147
|
-
### HTTP request headers
|
148
|
-
|
149
|
-
- **Content-Type**: Not defined
|
150
|
-
- **Accept**: application/json
|
151
|
-
|
data/docs/CheckinsApi.md
DELETED
@@ -1,71 +0,0 @@
|
|
1
|
-
# GetAroundOwner::CheckinsApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
|
-
|
5
|
-
| Method | HTTP request | Description |
|
6
|
-
| ------ | ------------ | ----------- |
|
7
|
-
| [**car_checked_in_rental_post**](CheckinsApi.md#car_checked_in_rental_post) | **POST** /carCheckedInRental | Rental started for one of your cars |
|
8
|
-
|
9
|
-
|
10
|
-
## car_checked_in_rental_post
|
11
|
-
|
12
|
-
> car_checked_in_rental_post(opts)
|
13
|
-
|
14
|
-
Rental started for one of your cars
|
15
|
-
|
16
|
-
### Examples
|
17
|
-
|
18
|
-
```ruby
|
19
|
-
require 'time'
|
20
|
-
require 'get_around_owner'
|
21
|
-
|
22
|
-
api_instance = GetAroundOwner::CheckinsApi.new
|
23
|
-
opts = {
|
24
|
-
getaround_rentals_car_checked_in: # GetaroundRentalsCarCheckedIn | This event is triggered when a rental starts and the car has been unlocked
|
25
|
-
}
|
26
|
-
|
27
|
-
begin
|
28
|
-
# Rental started for one of your cars
|
29
|
-
api_instance.car_checked_in_rental_post(opts)
|
30
|
-
rescue GetAroundOwner::ApiError => e
|
31
|
-
puts "Error when calling CheckinsApi->car_checked_in_rental_post: #{e}"
|
32
|
-
end
|
33
|
-
```
|
34
|
-
|
35
|
-
#### Using the car_checked_in_rental_post_with_http_info variant
|
36
|
-
|
37
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
38
|
-
|
39
|
-
> <Array(nil, Integer, Hash)> car_checked_in_rental_post_with_http_info(opts)
|
40
|
-
|
41
|
-
```ruby
|
42
|
-
begin
|
43
|
-
# Rental started for one of your cars
|
44
|
-
data, status_code, headers = api_instance.car_checked_in_rental_post_with_http_info(opts)
|
45
|
-
p status_code # => 2xx
|
46
|
-
p headers # => { ... }
|
47
|
-
p data # => nil
|
48
|
-
rescue GetAroundOwner::ApiError => e
|
49
|
-
puts "Error when calling CheckinsApi->car_checked_in_rental_post_with_http_info: #{e}"
|
50
|
-
end
|
51
|
-
```
|
52
|
-
|
53
|
-
### Parameters
|
54
|
-
|
55
|
-
| Name | Type | Description | Notes |
|
56
|
-
| ---- | ---- | ----------- | ----- |
|
57
|
-
| **getaround_rentals_car_checked_in** | [**GetaroundRentalsCarCheckedIn**](GetaroundRentalsCarCheckedIn.md) | This event is triggered when a rental starts and the car has been unlocked | [optional] |
|
58
|
-
|
59
|
-
### Return type
|
60
|
-
|
61
|
-
nil (empty response body)
|
62
|
-
|
63
|
-
### Authorization
|
64
|
-
|
65
|
-
No authorization required
|
66
|
-
|
67
|
-
### HTTP request headers
|
68
|
-
|
69
|
-
- **Content-Type**: application/json
|
70
|
-
- **Accept**: Not defined
|
71
|
-
|
data/docs/CheckoutsApi.md
DELETED
@@ -1,71 +0,0 @@
|
|
1
|
-
# GetAroundOwner::CheckoutsApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
|
-
|
5
|
-
| Method | HTTP request | Description |
|
6
|
-
| ------ | ------------ | ----------- |
|
7
|
-
| [**car_checked_out_rental_post**](CheckoutsApi.md#car_checked_out_rental_post) | **POST** /carCheckedOutRental | Rental ended for one of your cars |
|
8
|
-
|
9
|
-
|
10
|
-
## car_checked_out_rental_post
|
11
|
-
|
12
|
-
> car_checked_out_rental_post(opts)
|
13
|
-
|
14
|
-
Rental ended for one of your cars
|
15
|
-
|
16
|
-
### Examples
|
17
|
-
|
18
|
-
```ruby
|
19
|
-
require 'time'
|
20
|
-
require 'get_around_owner'
|
21
|
-
|
22
|
-
api_instance = GetAroundOwner::CheckoutsApi.new
|
23
|
-
opts = {
|
24
|
-
getaround_rentals_car_checked_out: # GetaroundRentalsCarCheckedOut | This event is triggered when a rental ends and the car has been locked
|
25
|
-
}
|
26
|
-
|
27
|
-
begin
|
28
|
-
# Rental ended for one of your cars
|
29
|
-
api_instance.car_checked_out_rental_post(opts)
|
30
|
-
rescue GetAroundOwner::ApiError => e
|
31
|
-
puts "Error when calling CheckoutsApi->car_checked_out_rental_post: #{e}"
|
32
|
-
end
|
33
|
-
```
|
34
|
-
|
35
|
-
#### Using the car_checked_out_rental_post_with_http_info variant
|
36
|
-
|
37
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
38
|
-
|
39
|
-
> <Array(nil, Integer, Hash)> car_checked_out_rental_post_with_http_info(opts)
|
40
|
-
|
41
|
-
```ruby
|
42
|
-
begin
|
43
|
-
# Rental ended for one of your cars
|
44
|
-
data, status_code, headers = api_instance.car_checked_out_rental_post_with_http_info(opts)
|
45
|
-
p status_code # => 2xx
|
46
|
-
p headers # => { ... }
|
47
|
-
p data # => nil
|
48
|
-
rescue GetAroundOwner::ApiError => e
|
49
|
-
puts "Error when calling CheckoutsApi->car_checked_out_rental_post_with_http_info: #{e}"
|
50
|
-
end
|
51
|
-
```
|
52
|
-
|
53
|
-
### Parameters
|
54
|
-
|
55
|
-
| Name | Type | Description | Notes |
|
56
|
-
| ---- | ---- | ----------- | ----- |
|
57
|
-
| **getaround_rentals_car_checked_out** | [**GetaroundRentalsCarCheckedOut**](GetaroundRentalsCarCheckedOut.md) | This event is triggered when a rental ends and the car has been locked | [optional] |
|
58
|
-
|
59
|
-
### Return type
|
60
|
-
|
61
|
-
nil (empty response body)
|
62
|
-
|
63
|
-
### Authorization
|
64
|
-
|
65
|
-
No authorization required
|
66
|
-
|
67
|
-
### HTTP request headers
|
68
|
-
|
69
|
-
- **Content-Type**: application/json
|
70
|
-
- **Accept**: Not defined
|
71
|
-
|
data/docs/GetaroundCar.md
DELETED
@@ -1,28 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundCar
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **Integer** | The car ID | |
|
8
|
-
| **state** | **String** | State of the vehicle can be a) active (only state where the vehicle can be booked by a user) b) inactive (temporary state when a vehicle is unavailable for rental) c) pending_approval (temporary state when a vehicle is under review for quality or other checks) and d) deleted (when a vehicle is permanently unavailable for rental) | |
|
9
|
-
| **plate_number** | **String** | Vehicle's plate number | |
|
10
|
-
| **brand** | **String** | Vehicle's brand (ex: Volkswagen) | |
|
11
|
-
| **model** | **String** | Vehicle's model (ex: Polo) | |
|
12
|
-
| **display_address** | **String** | Location where the vehicle is parked | |
|
13
|
-
|
14
|
-
## Example
|
15
|
-
|
16
|
-
```ruby
|
17
|
-
require 'get_around_owner'
|
18
|
-
|
19
|
-
instance = GetAroundOwner::GetaroundCar.new(
|
20
|
-
id: null,
|
21
|
-
state: null,
|
22
|
-
plate_number: null,
|
23
|
-
brand: null,
|
24
|
-
model: null,
|
25
|
-
display_address: null
|
26
|
-
)
|
27
|
-
```
|
28
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundCarsIndexInner
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **Integer** | The car ID | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'get_around_owner'
|
13
|
-
|
14
|
-
instance = GetAroundOwner::GetaroundCarsIndexInner.new(
|
15
|
-
id: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
data/docs/GetaroundCheckin.md
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundCheckin
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **rental_id** | **Integer** | Rental's ID linked to this checkin | |
|
8
|
-
| **mileage** | **Integer** | The vehicle’s mileage at checkin (in local units, eg: FR: km, GB: miles, ...) | [optional] |
|
9
|
-
| **fuel_level** | **Integer** | The vehicle’s fuel level at checkin (in percentage) | [optional] |
|
10
|
-
| **occurred_at** | **Time** | Checkin's time in ISO8601 format | |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'get_around_owner'
|
16
|
-
|
17
|
-
instance = GetAroundOwner::GetaroundCheckin.new(
|
18
|
-
rental_id: null,
|
19
|
-
mileage: null,
|
20
|
-
fuel_level: null,
|
21
|
-
occurred_at: null
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundCheckinsIndexInner
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **rental_id** | **Integer** | The rental ID | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'get_around_owner'
|
13
|
-
|
14
|
-
instance = GetAroundOwner::GetaroundCheckinsIndexInner.new(
|
15
|
-
rental_id: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
data/docs/GetaroundCheckout.md
DELETED
@@ -1,26 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundCheckout
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **rental_id** | **Integer** | Rental's ID linked to this checkout | |
|
8
|
-
| **mileage** | **Integer** | The vehicle’s mileage at checkout (in local units, eg: FR: km, GB: miles, ...) | [optional] |
|
9
|
-
| **fuel_level** | **Integer** | The vehicle’s fuel level at checkout (in percentage) | [optional] |
|
10
|
-
| **distance_driven** | **Integer** | The number of kilometers driven during this rental | |
|
11
|
-
| **occurred_at** | **Time** | Checkout's time in ISO8601 format | |
|
12
|
-
|
13
|
-
## Example
|
14
|
-
|
15
|
-
```ruby
|
16
|
-
require 'get_around_owner'
|
17
|
-
|
18
|
-
instance = GetAroundOwner::GetaroundCheckout.new(
|
19
|
-
rental_id: null,
|
20
|
-
mileage: null,
|
21
|
-
fuel_level: null,
|
22
|
-
distance_driven: null,
|
23
|
-
occurred_at: null
|
24
|
-
)
|
25
|
-
```
|
26
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundCreateMessagesRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **content** | **String** | Content of the message (2000 characters max) | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'get_around_owner'
|
13
|
-
|
14
|
-
instance = GetAroundOwner::GetaroundCreateMessagesRequest.new(
|
15
|
-
content: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundCreateUnavailabilitiesRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **starts_at** | **Time** | Start date and time of the unavailability in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) with a 30 min granularity. | |
|
8
|
-
| **ends_at** | **Time** | End date and time of the unavailability in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) with a 30 min granularity. | |
|
9
|
-
| **reason** | **String** | Reason of the unavailability | [optional] |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'get_around_owner'
|
15
|
-
|
16
|
-
instance = GetAroundOwner::GetaroundCreateUnavailabilitiesRequest.new(
|
17
|
-
starts_at: null,
|
18
|
-
ends_at: null,
|
19
|
-
reason: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundDestroyUnavailabilityRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **starts_at** | **Time** | Start date and time of the unavailability in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) with a 30 min granularity. | |
|
8
|
-
| **ends_at** | **Time** | End date and time of the unavailability in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) with a 30 min granularity. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'get_around_owner'
|
14
|
-
|
15
|
-
instance = GetAroundOwner::GetaroundDestroyUnavailabilityRequest.new(
|
16
|
-
starts_at: null,
|
17
|
-
ends_at: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
data/docs/GetaroundInvoice.md
DELETED
@@ -1,34 +0,0 @@
|
|
1
|
-
# GetAroundOwner::GetaroundInvoice
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **Integer** | The invoice ID | |
|
8
|
-
| **pdf_url** | **String** | The temporary url (lifetime: 20min) to download the pdf of the tax invoice is generated each to time you call the endpoint. Also, the 'links' variable will not be present if there is no uploaded invoice yet. This could happen if the job to generate & upload the invoice is not done yet. | |
|
9
|
-
| **product_type** | **String** | The type of product the invoice is related to | |
|
10
|
-
| **product_id** | **Integer** | The id of the product the invoice is related to | |
|
11
|
-
| **emitted_at** | **Time** | The date at which the invoice was emitted | |
|
12
|
-
| **total_price** | **Integer** | The invoice amount, which is what you will receive (or which will be debited from your account if it is negative) | |
|
13
|
-
| **currency** | **String** | The currency of the invoice amount (ISO 4217 alphabetic code) | |
|
14
|
-
| **entity_type** | **String** | The type of entity the invoice is related to | |
|
15
|
-
| **charges** | [**Array<GetaroundInvoiceChargesInner>**](GetaroundInvoiceChargesInner.md) | Array of charges | [optional] |
|
16
|
-
|
17
|
-
## Example
|
18
|
-
|
19
|
-
```ruby
|
20
|
-
require 'get_around_owner'
|
21
|
-
|
22
|
-
instance = GetAroundOwner::GetaroundInvoice.new(
|
23
|
-
id: null,
|
24
|
-
pdf_url: null,
|
25
|
-
product_type: null,
|
26
|
-
product_id: null,
|
27
|
-
emitted_at: null,
|
28
|
-
total_price: null,
|
29
|
-
currency: null,
|
30
|
-
entity_type: null,
|
31
|
-
charges: null
|
32
|
-
)
|
33
|
-
```
|
34
|
-
|