get_around_owner 1.0.3 → 1.0.5
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/README.md +77 -78
- data/docs/CarsApi.md +22 -23
- data/docs/CheckinsApi.md +24 -25
- data/docs/CheckoutsApi.md +24 -25
- data/docs/InvoicesApi.md +36 -37
- data/docs/MessagesApi.md +32 -33
- data/docs/PayoutsApi.md +24 -25
- data/docs/RentalsApi.md +24 -25
- data/docs/UnavailabilitiesApi.md +36 -37
- data/docs/UsersApi.md +11 -12
- data/get_around_owner-1.0.3.gem +0 -0
- data/get_around_owner-1.0.4.gem +0 -0
- data/get_around_owner.gemspec +1 -1
- data/getaround-api.gemspec +3 -3
- data/lib/{getaround-api → get_around_owner}/configuration.rb +2 -2
- data/lib/{getaround-api → get_around_owner}/version.rb +1 -1
- data/lib/{getaround-api.rb → get_around_owner.rb} +48 -48
- data/spec/spec_helper.rb +2 -2
- metadata +51 -49
- /data/lib/{getaround-api → get_around_owner}/api/cars_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/checkins_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/checkouts_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/invoices_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/messages_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/payouts_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/rentals_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/unavailabilities_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api/users_api.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api_client.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/api_error.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/car.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/car_id.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/car_id_unavailabilities_json_body.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/cars_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/checkin.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/checkins_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/checkout.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/checkouts_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/ends_at.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/invoice.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/invoices_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/message.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/messages_sent.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/payout.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/payouts_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rental.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rental_id_messages_json_body.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rental_invoices_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rental_messages_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rentals_booked.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rentals_canceled.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rentals_car_checked_in.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rentals_car_checked_out.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rentals_car_switched.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rentals_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/rentals_times_changed.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/starts_at.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/unavailabilities_created.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/unavailabilities_deleted.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/unavailabilities_index.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/unavailability.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/user.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/users_updated.rb +0 -0
- /data/lib/{getaround-api → get_around_owner}/models/webhook.rb +0 -0
data/docs/CheckoutsApi.md
CHANGED
@@ -2,12 +2,13 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
4
|
|
5
|
-
Method
|
6
|
-
|
7
|
-
[**get_checkout_by_rental_id**](CheckoutsApi.md#get_checkout_by_rental_id) | **GET** /rentals/{rental_id}/checkout.json | Find a checkout by rental ID
|
8
|
-
[**get_checkouts**](CheckoutsApi.md#get_checkouts)
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| -------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------- |
|
7
|
+
| [**get_checkout_by_rental_id**](CheckoutsApi.md#get_checkout_by_rental_id) | **GET** /rentals/{rental_id}/checkout.json | Find a checkout by rental ID |
|
8
|
+
| [**get_checkouts**](CheckoutsApi.md#get_checkouts) | **GET** /checkouts.json | List of checkouts that occurred between two dates |
|
9
9
|
|
10
10
|
# **get_checkout_by_rental_id**
|
11
|
+
|
11
12
|
> Checkout get_checkout_by_rental_id(rental_id)
|
12
13
|
|
13
14
|
Find a checkout by rental ID
|
@@ -15,9 +16,10 @@ Find a checkout by rental ID
|
|
15
16
|
Find a checkout by rental ID
|
16
17
|
|
17
18
|
### Example
|
19
|
+
|
18
20
|
```ruby
|
19
21
|
# load the gem
|
20
|
-
require '
|
22
|
+
require 'get_around_owner'
|
21
23
|
# setup authorization
|
22
24
|
GetAroundOwner.configure do |config|
|
23
25
|
end
|
@@ -37,9 +39,9 @@ end
|
|
37
39
|
|
38
40
|
### Parameters
|
39
41
|
|
40
|
-
Name
|
41
|
-
------------- |
|
42
|
-
**rental_id** | [
|
42
|
+
| Name | Type | Description | Notes |
|
43
|
+
| ------------- | --------------- | -------------------------------------------------- | ----- |
|
44
|
+
| **rental_id** | [\*\*\*\*](.md) | ID of the rental related to the checkout to return |
|
43
45
|
|
44
46
|
### Return type
|
45
47
|
|
@@ -51,12 +53,11 @@ Name | Type | Description | Notes
|
|
51
53
|
|
52
54
|
### HTTP request headers
|
53
55
|
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
56
|
+
- **Content-Type**: Not defined
|
57
|
+
- **Accept**: application/json
|
58
58
|
|
59
59
|
# **get_checkouts**
|
60
|
+
|
60
61
|
> CheckoutsIndex get_checkouts(start_date, end_date, opts)
|
61
62
|
|
62
63
|
List of checkouts that occurred between two dates
|
@@ -64,9 +65,10 @@ List of checkouts that occurred between two dates
|
|
64
65
|
List of checkouts that occurred between two dates
|
65
66
|
|
66
67
|
### Example
|
68
|
+
|
67
69
|
```ruby
|
68
70
|
# load the gem
|
69
|
-
require '
|
71
|
+
require 'get_around_owner'
|
70
72
|
# setup authorization
|
71
73
|
GetAroundOwner.configure do |config|
|
72
74
|
end
|
@@ -74,7 +76,7 @@ end
|
|
74
76
|
api_instance = GetAroundOwner::CheckoutsApi.new
|
75
77
|
start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
76
78
|
end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
77
|
-
opts = {
|
79
|
+
opts = {
|
78
80
|
page: GetAroundOwner::null.new, # | Page number
|
79
81
|
per_page: GetAroundOwner::null.new # | Page size
|
80
82
|
}
|
@@ -90,12 +92,12 @@ end
|
|
90
92
|
|
91
93
|
### Parameters
|
92
94
|
|
93
|
-
Name
|
94
|
-
|
95
|
-
**start_date** | [
|
96
|
-
**end_date**
|
97
|
-
**page**
|
98
|
-
**per_page**
|
95
|
+
| Name | Type | Description | Notes |
|
96
|
+
| -------------- | --------------- | ----------------------------------------------------------------------------------------------- | -------------------------- |
|
97
|
+
| **start_date** | [\*\*\*\*](.md) | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
|
98
|
+
| **end_date** | [\*\*\*\*](.md) | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
|
99
|
+
| **page** | [\*\*\*\*](.md) | Page number | [optional] |
|
100
|
+
| **per_page** | [\*\*\*\*](.md) | Page size | [optional] [default to 30] |
|
99
101
|
|
100
102
|
### Return type
|
101
103
|
|
@@ -107,8 +109,5 @@ Name | Type | Description | Notes
|
|
107
109
|
|
108
110
|
### HTTP request headers
|
109
111
|
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
112
|
+
- **Content-Type**: Not defined
|
113
|
+
- **Accept**: application/json
|
data/docs/InvoicesApi.md
CHANGED
@@ -2,13 +2,14 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
4
|
|
5
|
-
Method
|
6
|
-
|
7
|
-
[**get_invoice_by_id**](InvoicesApi.md#get_invoice_by_id)
|
8
|
-
[**get_invoices**](InvoicesApi.md#get_invoices)
|
9
|
-
[**get_invoices_for_rental**](InvoicesApi.md#get_invoices_for_rental) | **GET** /rentals/{rental_id}/invoices.json | Find invoices associated to a rental
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| --------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------ |
|
7
|
+
| [**get_invoice_by_id**](InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{id}.json | Find an invoice by ID |
|
8
|
+
| [**get_invoices**](InvoicesApi.md#get_invoices) | **GET** /invoices.json | Find invoices emitted between dates |
|
9
|
+
| [**get_invoices_for_rental**](InvoicesApi.md#get_invoices_for_rental) | **GET** /rentals/{rental_id}/invoices.json | Find invoices associated to a rental |
|
10
10
|
|
11
11
|
# **get_invoice_by_id**
|
12
|
+
|
12
13
|
> Invoice get_invoice_by_id(id)
|
13
14
|
|
14
15
|
Find an invoice by ID
|
@@ -16,9 +17,10 @@ Find an invoice by ID
|
|
16
17
|
Find an invoice by ID
|
17
18
|
|
18
19
|
### Example
|
20
|
+
|
19
21
|
```ruby
|
20
22
|
# load the gem
|
21
|
-
require '
|
23
|
+
require 'get_around_owner'
|
22
24
|
# setup authorization
|
23
25
|
GetAroundOwner.configure do |config|
|
24
26
|
end
|
@@ -38,9 +40,9 @@ end
|
|
38
40
|
|
39
41
|
### Parameters
|
40
42
|
|
41
|
-
Name
|
42
|
-
|
43
|
-
**id** | [
|
43
|
+
| Name | Type | Description | Notes |
|
44
|
+
| ------ | --------------- | ----------------------- | ----- |
|
45
|
+
| **id** | [\*\*\*\*](.md) | ID of invoice to return |
|
44
46
|
|
45
47
|
### Return type
|
46
48
|
|
@@ -52,12 +54,11 @@ Name | Type | Description | Notes
|
|
52
54
|
|
53
55
|
### HTTP request headers
|
54
56
|
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
57
|
+
- **Content-Type**: Not defined
|
58
|
+
- **Accept**: application/json
|
59
59
|
|
60
60
|
# **get_invoices**
|
61
|
+
|
61
62
|
> InvoicesIndex get_invoices(opts)
|
62
63
|
|
63
64
|
Find invoices emitted between dates
|
@@ -65,15 +66,16 @@ Find invoices emitted between dates
|
|
65
66
|
Find invoices emitted between dates
|
66
67
|
|
67
68
|
### Example
|
69
|
+
|
68
70
|
```ruby
|
69
71
|
# load the gem
|
70
|
-
require '
|
72
|
+
require 'get_around_owner'
|
71
73
|
# setup authorization
|
72
74
|
GetAroundOwner.configure do |config|
|
73
75
|
end
|
74
76
|
|
75
77
|
api_instance = GetAroundOwner::InvoicesApi.new
|
76
|
-
opts = {
|
78
|
+
opts = {
|
77
79
|
start_date: GetAroundOwner::null.new, # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
78
80
|
end_date: GetAroundOwner::null.new, # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
79
81
|
page: GetAroundOwner::null.new, # | Page number
|
@@ -91,12 +93,12 @@ end
|
|
91
93
|
|
92
94
|
### Parameters
|
93
95
|
|
94
|
-
Name
|
95
|
-
|
96
|
-
**start_date** | [
|
97
|
-
**end_date**
|
98
|
-
**page**
|
99
|
-
**per_page**
|
96
|
+
| Name | Type | Description | Notes |
|
97
|
+
| -------------- | --------------- | ----------------------------------------------------------------------------------------------- | -------------------------- |
|
98
|
+
| **start_date** | [\*\*\*\*](.md) | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) | [optional] |
|
99
|
+
| **end_date** | [\*\*\*\*](.md) | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) | [optional] |
|
100
|
+
| **page** | [\*\*\*\*](.md) | Page number | [optional] |
|
101
|
+
| **per_page** | [\*\*\*\*](.md) | Page size | [optional] [default to 30] |
|
100
102
|
|
101
103
|
### Return type
|
102
104
|
|
@@ -108,12 +110,11 @@ Name | Type | Description | Notes
|
|
108
110
|
|
109
111
|
### HTTP request headers
|
110
112
|
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
113
|
+
- **Content-Type**: Not defined
|
114
|
+
- **Accept**: application/json
|
115
115
|
|
116
116
|
# **get_invoices_for_rental**
|
117
|
+
|
117
118
|
> RentalInvoicesIndex get_invoices_for_rental(rental_id, opts)
|
118
119
|
|
119
120
|
Find invoices associated to a rental
|
@@ -121,16 +122,17 @@ Find invoices associated to a rental
|
|
121
122
|
Find invoices associated to a rental
|
122
123
|
|
123
124
|
### Example
|
125
|
+
|
124
126
|
```ruby
|
125
127
|
# load the gem
|
126
|
-
require '
|
128
|
+
require 'get_around_owner'
|
127
129
|
# setup authorization
|
128
130
|
GetAroundOwner.configure do |config|
|
129
131
|
end
|
130
132
|
|
131
133
|
api_instance = GetAroundOwner::InvoicesApi.new
|
132
134
|
rental_id = GetAroundOwner::null.new # | ID of rental
|
133
|
-
opts = {
|
135
|
+
opts = {
|
134
136
|
page: GetAroundOwner::null.new, # | Page number
|
135
137
|
per_page: GetAroundOwner::null.new # | Page size
|
136
138
|
}
|
@@ -146,11 +148,11 @@ end
|
|
146
148
|
|
147
149
|
### Parameters
|
148
150
|
|
149
|
-
Name
|
150
|
-
------------- |
|
151
|
-
**rental_id** | [
|
152
|
-
**page**
|
153
|
-
**per_page**
|
151
|
+
| Name | Type | Description | Notes |
|
152
|
+
| ------------- | --------------- | ------------ | -------------------------- |
|
153
|
+
| **rental_id** | [\*\*\*\*](.md) | ID of rental |
|
154
|
+
| **page** | [\*\*\*\*](.md) | Page number | [optional] |
|
155
|
+
| **per_page** | [\*\*\*\*](.md) | Page size | [optional] [default to 30] |
|
154
156
|
|
155
157
|
### Return type
|
156
158
|
|
@@ -162,8 +164,5 @@ Name | Type | Description | Notes
|
|
162
164
|
|
163
165
|
### HTTP request headers
|
164
166
|
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
167
|
+
- **Content-Type**: Not defined
|
168
|
+
- **Accept**: application/json
|
data/docs/MessagesApi.md
CHANGED
@@ -2,13 +2,14 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
4
|
|
5
|
-
Method
|
6
|
-
|
7
|
-
[**create_messages**](MessagesApi.md#create_messages)
|
8
|
-
[**get_message_by_id**](MessagesApi.md#get_message_by_id)
|
9
|
-
[**get_messages_for_rental**](MessagesApi.md#get_messages_for_rental) | **GET** /rentals/{rental_id}/messages.json
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| --------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------------------- |
|
7
|
+
| [**create_messages**](MessagesApi.md#create_messages) | **POST** /rentals/{rental_id}/messages.json | Create Message associated to a rental |
|
8
|
+
| [**get_message_by_id**](MessagesApi.md#get_message_by_id) | **GET** /rentals/{rental_id}/messages/{id}.json | Find a message by ID associated to a rental |
|
9
|
+
| [**get_messages_for_rental**](MessagesApi.md#get_messages_for_rental) | **GET** /rentals/{rental_id}/messages.json | Find messages associated to a rental |
|
10
10
|
|
11
11
|
# **create_messages**
|
12
|
+
|
12
13
|
> Message create_messages(rental_id, opts)
|
13
14
|
|
14
15
|
Create Message associated to a rental
|
@@ -16,16 +17,17 @@ Create Message associated to a rental
|
|
16
17
|
Create Message associated to a rental
|
17
18
|
|
18
19
|
### Example
|
20
|
+
|
19
21
|
```ruby
|
20
22
|
# load the gem
|
21
|
-
require '
|
23
|
+
require 'get_around_owner'
|
22
24
|
# setup authorization
|
23
25
|
GetAroundOwner.configure do |config|
|
24
26
|
end
|
25
27
|
|
26
28
|
api_instance = GetAroundOwner::MessagesApi.new
|
27
29
|
rental_id = GetAroundOwner::null.new # | ID of rental
|
28
|
-
opts = {
|
30
|
+
opts = {
|
29
31
|
body: GetAroundOwner::RentalIdMessagesJsonBody.new # RentalIdMessagesJsonBody | Message to create
|
30
32
|
}
|
31
33
|
|
@@ -40,10 +42,10 @@ end
|
|
40
42
|
|
41
43
|
### Parameters
|
42
44
|
|
43
|
-
Name
|
44
|
-
------------- |
|
45
|
-
**rental_id** | [
|
46
|
-
**body**
|
45
|
+
| Name | Type | Description | Notes |
|
46
|
+
| ------------- | ----------------------------------------------------------- | ----------------- | ---------- |
|
47
|
+
| **rental_id** | [\*\*\*\*](.md) | ID of rental |
|
48
|
+
| **body** | [**RentalIdMessagesJsonBody**](RentalIdMessagesJsonBody.md) | Message to create | [optional] |
|
47
49
|
|
48
50
|
### Return type
|
49
51
|
|
@@ -55,12 +57,11 @@ Name | Type | Description | Notes
|
|
55
57
|
|
56
58
|
### HTTP request headers
|
57
59
|
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
60
|
+
- **Content-Type**: application/json
|
61
|
+
- **Accept**: application/json
|
62
62
|
|
63
63
|
# **get_message_by_id**
|
64
|
+
|
64
65
|
> Message get_message_by_id(rental_id, id)
|
65
66
|
|
66
67
|
Find a message by ID associated to a rental
|
@@ -68,9 +69,10 @@ Find a message by ID associated to a rental
|
|
68
69
|
Find a message by ID associated to a rental
|
69
70
|
|
70
71
|
### Example
|
72
|
+
|
71
73
|
```ruby
|
72
74
|
# load the gem
|
73
|
-
require '
|
75
|
+
require 'get_around_owner'
|
74
76
|
# setup authorization
|
75
77
|
GetAroundOwner.configure do |config|
|
76
78
|
end
|
@@ -91,10 +93,10 @@ end
|
|
91
93
|
|
92
94
|
### Parameters
|
93
95
|
|
94
|
-
Name
|
95
|
-
------------- |
|
96
|
-
**rental_id** | [
|
97
|
-
**id**
|
96
|
+
| Name | Type | Description | Notes |
|
97
|
+
| ------------- | --------------- | ----------------------- | ----- |
|
98
|
+
| **rental_id** | [\*\*\*\*](.md) | ID of rental |
|
99
|
+
| **id** | [\*\*\*\*](.md) | ID of message to return |
|
98
100
|
|
99
101
|
### Return type
|
100
102
|
|
@@ -106,12 +108,11 @@ Name | Type | Description | Notes
|
|
106
108
|
|
107
109
|
### HTTP request headers
|
108
110
|
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
111
|
+
- **Content-Type**: Not defined
|
112
|
+
- **Accept**: application/json
|
113
113
|
|
114
114
|
# **get_messages_for_rental**
|
115
|
+
|
115
116
|
> RentalMessagesIndex get_messages_for_rental(rental_id)
|
116
117
|
|
117
118
|
Find messages associated to a rental
|
@@ -119,9 +120,10 @@ Find messages associated to a rental
|
|
119
120
|
Find messages associated to a rental
|
120
121
|
|
121
122
|
### Example
|
123
|
+
|
122
124
|
```ruby
|
123
125
|
# load the gem
|
124
|
-
require '
|
126
|
+
require 'get_around_owner'
|
125
127
|
# setup authorization
|
126
128
|
GetAroundOwner.configure do |config|
|
127
129
|
end
|
@@ -141,9 +143,9 @@ end
|
|
141
143
|
|
142
144
|
### Parameters
|
143
145
|
|
144
|
-
Name
|
145
|
-
------------- |
|
146
|
-
**rental_id** | [
|
146
|
+
| Name | Type | Description | Notes |
|
147
|
+
| ------------- | --------------- | ------------ | ----- |
|
148
|
+
| **rental_id** | [\*\*\*\*](.md) | ID of rental |
|
147
149
|
|
148
150
|
### Return type
|
149
151
|
|
@@ -155,8 +157,5 @@ Name | Type | Description | Notes
|
|
155
157
|
|
156
158
|
### HTTP request headers
|
157
159
|
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
160
|
+
- **Content-Type**: Not defined
|
161
|
+
- **Accept**: application/json
|
data/docs/PayoutsApi.md
CHANGED
@@ -2,12 +2,13 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
4
|
|
5
|
-
Method
|
6
|
-
|
7
|
-
[**get_payout_by_id**](PayoutsApi.md#get_payout_by_id) | **GET** /payouts/{id}.json | Find a payout by ID
|
8
|
-
[**get_payouts**](PayoutsApi.md#get_payouts)
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------------------------------------------------------ | -------------------------- | ------------------------------- |
|
7
|
+
| [**get_payout_by_id**](PayoutsApi.md#get_payout_by_id) | **GET** /payouts/{id}.json | Find a payout by ID |
|
8
|
+
| [**get_payouts**](PayoutsApi.md#get_payouts) | **GET** /payouts.json | Find payouts paid between dates |
|
9
9
|
|
10
10
|
# **get_payout_by_id**
|
11
|
+
|
11
12
|
> Payout get_payout_by_id(id)
|
12
13
|
|
13
14
|
Find a payout by ID
|
@@ -15,9 +16,10 @@ Find a payout by ID
|
|
15
16
|
Find a payout by ID
|
16
17
|
|
17
18
|
### Example
|
19
|
+
|
18
20
|
```ruby
|
19
21
|
# load the gem
|
20
|
-
require '
|
22
|
+
require 'get_around_owner'
|
21
23
|
# setup authorization
|
22
24
|
GetAroundOwner.configure do |config|
|
23
25
|
end
|
@@ -37,9 +39,9 @@ end
|
|
37
39
|
|
38
40
|
### Parameters
|
39
41
|
|
40
|
-
Name
|
41
|
-
|
42
|
-
**id** | [
|
42
|
+
| Name | Type | Description | Notes |
|
43
|
+
| ------ | --------------- | ---------------------- | ----- |
|
44
|
+
| **id** | [\*\*\*\*](.md) | ID of payout to return |
|
43
45
|
|
44
46
|
### Return type
|
45
47
|
|
@@ -51,12 +53,11 @@ Name | Type | Description | Notes
|
|
51
53
|
|
52
54
|
### HTTP request headers
|
53
55
|
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
56
|
+
- **Content-Type**: Not defined
|
57
|
+
- **Accept**: application/json
|
58
58
|
|
59
59
|
# **get_payouts**
|
60
|
+
|
60
61
|
> PayoutsIndex get_payouts(start_date, end_date, opts)
|
61
62
|
|
62
63
|
Find payouts paid between dates
|
@@ -64,9 +65,10 @@ Find payouts paid between dates
|
|
64
65
|
Find payouts paid between dates
|
65
66
|
|
66
67
|
### Example
|
68
|
+
|
67
69
|
```ruby
|
68
70
|
# load the gem
|
69
|
-
require '
|
71
|
+
require 'get_around_owner'
|
70
72
|
# setup authorization
|
71
73
|
GetAroundOwner.configure do |config|
|
72
74
|
end
|
@@ -74,7 +76,7 @@ end
|
|
74
76
|
api_instance = GetAroundOwner::PayoutsApi.new
|
75
77
|
start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
76
78
|
end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
77
|
-
opts = {
|
79
|
+
opts = {
|
78
80
|
page: GetAroundOwner::null.new, # | Page number
|
79
81
|
per_page: GetAroundOwner::null.new # | Page size
|
80
82
|
}
|
@@ -90,12 +92,12 @@ end
|
|
90
92
|
|
91
93
|
### Parameters
|
92
94
|
|
93
|
-
Name
|
94
|
-
|
95
|
-
**start_date** | [
|
96
|
-
**end_date**
|
97
|
-
**page**
|
98
|
-
**per_page**
|
95
|
+
| Name | Type | Description | Notes |
|
96
|
+
| -------------- | --------------- | ----------------------------------------------------------------------------------------------- | -------------------------- |
|
97
|
+
| **start_date** | [\*\*\*\*](.md) | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
|
98
|
+
| **end_date** | [\*\*\*\*](.md) | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
|
99
|
+
| **page** | [\*\*\*\*](.md) | Page number | [optional] |
|
100
|
+
| **per_page** | [\*\*\*\*](.md) | Page size | [optional] [default to 30] |
|
99
101
|
|
100
102
|
### Return type
|
101
103
|
|
@@ -107,8 +109,5 @@ Name | Type | Description | Notes
|
|
107
109
|
|
108
110
|
### HTTP request headers
|
109
111
|
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
112
|
+
- **Content-Type**: Not defined
|
113
|
+
- **Accept**: application/json
|
data/docs/RentalsApi.md
CHANGED
@@ -2,12 +2,13 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api-eu.getaround.com/owner/v1*
|
4
4
|
|
5
|
-
Method
|
6
|
-
|
7
|
-
[**get_rental_by_id**](RentalsApi.md#get_rental_by_id) | **GET** /rentals/{id}.json | Find a rental by ID
|
8
|
-
[**get_rentals**](RentalsApi.md#get_rentals)
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------------------------------------------------------ | -------------------------- | --------------------------------- |
|
7
|
+
| [**get_rental_by_id**](RentalsApi.md#get_rental_by_id) | **GET** /rentals/{id}.json | Find a rental by ID |
|
8
|
+
| [**get_rentals**](RentalsApi.md#get_rentals) | **GET** /rentals.json | Find rentals booked between dates |
|
9
9
|
|
10
10
|
# **get_rental_by_id**
|
11
|
+
|
11
12
|
> Rental get_rental_by_id(id)
|
12
13
|
|
13
14
|
Find a rental by ID
|
@@ -15,9 +16,10 @@ Find a rental by ID
|
|
15
16
|
Find a rental by ID
|
16
17
|
|
17
18
|
### Example
|
19
|
+
|
18
20
|
```ruby
|
19
21
|
# load the gem
|
20
|
-
require '
|
22
|
+
require 'get_around_owner'
|
21
23
|
# setup authorization
|
22
24
|
GetAroundOwner.configure do |config|
|
23
25
|
end
|
@@ -37,9 +39,9 @@ end
|
|
37
39
|
|
38
40
|
### Parameters
|
39
41
|
|
40
|
-
Name
|
41
|
-
|
42
|
-
**id** | [
|
42
|
+
| Name | Type | Description | Notes |
|
43
|
+
| ------ | --------------- | ---------------------- | ----- |
|
44
|
+
| **id** | [\*\*\*\*](.md) | ID of rental to return |
|
43
45
|
|
44
46
|
### Return type
|
45
47
|
|
@@ -51,12 +53,11 @@ Name | Type | Description | Notes
|
|
51
53
|
|
52
54
|
### HTTP request headers
|
53
55
|
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
56
|
+
- **Content-Type**: Not defined
|
57
|
+
- **Accept**: application/json
|
58
58
|
|
59
59
|
# **get_rentals**
|
60
|
+
|
60
61
|
> RentalsIndex get_rentals(start_date, end_date, opts)
|
61
62
|
|
62
63
|
Find rentals booked between dates
|
@@ -64,9 +65,10 @@ Find rentals booked between dates
|
|
64
65
|
Find rentals booked between dates
|
65
66
|
|
66
67
|
### Example
|
68
|
+
|
67
69
|
```ruby
|
68
70
|
# load the gem
|
69
|
-
require '
|
71
|
+
require 'get_around_owner'
|
70
72
|
# setup authorization
|
71
73
|
GetAroundOwner.configure do |config|
|
72
74
|
end
|
@@ -74,7 +76,7 @@ end
|
|
74
76
|
api_instance = GetAroundOwner::RentalsApi.new
|
75
77
|
start_date = GetAroundOwner::null.new # | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
76
78
|
end_date = GetAroundOwner::null.new # | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)
|
77
|
-
opts = {
|
79
|
+
opts = {
|
78
80
|
page: GetAroundOwner::null.new, # | Page number
|
79
81
|
per_page: GetAroundOwner::null.new # | Page size
|
80
82
|
}
|
@@ -90,12 +92,12 @@ end
|
|
90
92
|
|
91
93
|
### Parameters
|
92
94
|
|
93
|
-
Name
|
94
|
-
|
95
|
-
**start_date** | [
|
96
|
-
**end_date**
|
97
|
-
**page**
|
98
|
-
**per_page**
|
95
|
+
| Name | Type | Description | Notes |
|
96
|
+
| -------------- | --------------- | ----------------------------------------------------------------------------------------------- | -------------------------- |
|
97
|
+
| **start_date** | [\*\*\*\*](.md) | Start date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
|
98
|
+
| **end_date** | [\*\*\*\*](.md) | End date and time in [ISO8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) |
|
99
|
+
| **page** | [\*\*\*\*](.md) | Page number | [optional] |
|
100
|
+
| **per_page** | [\*\*\*\*](.md) | Page size | [optional] [default to 30] |
|
99
101
|
|
100
102
|
### Return type
|
101
103
|
|
@@ -107,8 +109,5 @@ Name | Type | Description | Notes
|
|
107
109
|
|
108
110
|
### HTTP request headers
|
109
111
|
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
112
|
+
- **Content-Type**: Not defined
|
113
|
+
- **Accept**: application/json
|