dock_genius_api_ruby_client 0.1.1.pre.g582ac6 → 0.1.2.pre.ge30447
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/config.json +10 -0
- data/dg-api-gem +1 -0
- data/swagger.yml +3075 -0
- metadata +170 -78
- data/LICENSE +0 -201
- data/README.md +0 -200
- data/dock_genius_api_ruby_client.gemspec +0 -55
- data/docs/AccessToken.md +0 -11
- data/docs/Address.md +0 -16
- data/docs/Customer.md +0 -22
- data/docs/CustomerApi.md +0 -1938
- data/docs/Dock.md +0 -20
- data/docs/DockApi.md +0 -1112
- data/docs/EmailAddress.md +0 -9
- data/docs/GeoPoint.md +0 -9
- data/docs/InlineResponse200.md +0 -8
- data/docs/InlineResponse2001.md +0 -8
- data/docs/InlineResponse2002.md +0 -8
- data/docs/ListingAgent.md +0 -12
- data/docs/Marina.md +0 -15
- data/docs/MarinaApi.md +0 -1602
- data/docs/Phone.md +0 -9
- data/git_push.sh +0 -67
- data/lib/dock_genius_api_ruby_client.rb +0 -65
- data/lib/dock_genius_api_ruby_client/api/customer_api.rb +0 -2363
- data/lib/dock_genius_api_ruby_client/api/dock_api.rb +0 -1352
- data/lib/dock_genius_api_ruby_client/api/marina_api.rb +0 -1945
- data/lib/dock_genius_api_ruby_client/api_client.rb +0 -378
- data/lib/dock_genius_api_ruby_client/api_error.rb +0 -47
- data/lib/dock_genius_api_ruby_client/configuration.rb +0 -207
- data/lib/dock_genius_api_ruby_client/models/access_token.rb +0 -230
- data/lib/dock_genius_api_ruby_client/models/address.rb +0 -281
- data/lib/dock_genius_api_ruby_client/models/customer.rb +0 -330
- data/lib/dock_genius_api_ruby_client/models/dock.rb +0 -327
- data/lib/dock_genius_api_ruby_client/models/email_address.rb +0 -208
- data/lib/dock_genius_api_ruby_client/models/geo_point.rb +0 -208
- data/lib/dock_genius_api_ruby_client/models/inline_response_200.rb +0 -199
- data/lib/dock_genius_api_ruby_client/models/inline_response_200_1.rb +0 -200
- data/lib/dock_genius_api_ruby_client/models/inline_response_200_2.rb +0 -199
- data/lib/dock_genius_api_ruby_client/models/listing_agent.rb +0 -239
- data/lib/dock_genius_api_ruby_client/models/marina.rb +0 -263
- data/lib/dock_genius_api_ruby_client/models/phone.rb +0 -209
- data/lib/dock_genius_api_ruby_client/version.rb +0 -26
- data/spec/api/customer_api_spec.rb +0 -551
- data/spec/api/dock_api_spec.rb +0 -332
- data/spec/api/marina_api_spec.rb +0 -461
- data/spec/api_client_spec.rb +0 -237
- data/spec/configuration_spec.rb +0 -53
- data/spec/models/access_token_spec.rb +0 -71
- data/spec/models/address_spec.rb +0 -101
- data/spec/models/customer_spec.rb +0 -137
- data/spec/models/dock_spec.rb +0 -125
- data/spec/models/email_address_spec.rb +0 -59
- data/spec/models/geo_point_spec.rb +0 -59
- data/spec/models/inline_response_200_1_spec.rb +0 -53
- data/spec/models/inline_response_200_2_spec.rb +0 -53
- data/spec/models/inline_response_200_spec.rb +0 -53
- data/spec/models/listing_agent_spec.rb +0 -77
- data/spec/models/marina_spec.rb +0 -95
- data/spec/models/phone_spec.rb +0 -59
- data/spec/spec_helper.rb +0 -122
data/docs/EmailAddress.md
DELETED
data/docs/GeoPoint.md
DELETED
data/docs/InlineResponse200.md
DELETED
data/docs/InlineResponse2001.md
DELETED
data/docs/InlineResponse2002.md
DELETED
data/docs/ListingAgent.md
DELETED
@@ -1,12 +0,0 @@
|
|
1
|
-
# DockGeniusApiRubyClient::ListingAgent
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | | [optional]
|
7
|
-
**id** | **String** | | [optional]
|
8
|
-
**contact_address** | [**Address**](Address.md) | | [optional]
|
9
|
-
**email_list** | [**Array<EmailAddress>**](EmailAddress.md) | | [optional]
|
10
|
-
**phone_list** | [**Array<Phone>**](Phone.md) | | [optional]
|
11
|
-
|
12
|
-
|
data/docs/Marina.md
DELETED
@@ -1,15 +0,0 @@
|
|
1
|
-
# DockGeniusApiRubyClient::Marina
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | | [optional]
|
7
|
-
**location** | [**GeoPoint**](GeoPoint.md) | |
|
8
|
-
**source** | **String** | | [optional]
|
9
|
-
**created** | **Date** | | [optional]
|
10
|
-
**last_updated** | **Date** | | [optional]
|
11
|
-
**id** | **Float** | | [optional]
|
12
|
-
**physical_address** | [**Address**](Address.md) | | [optional]
|
13
|
-
**_listing_agent** | [**ListingAgent**](ListingAgent.md) | | [optional]
|
14
|
-
|
15
|
-
|
data/docs/MarinaApi.md
DELETED
@@ -1,1602 +0,0 @@
|
|
1
|
-
# DockGeniusApiRubyClient::MarinaApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://localhost/api*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**marina_count**](MarinaApi.md#marina_count) | **GET** /Marinas/count | Count instances of the model matched by where from the data source.
|
8
|
-
[**marina_create**](MarinaApi.md#marina_create) | **POST** /Marinas | Create a new instance of the model and persist it into the data source.
|
9
|
-
[**marina_create_change_stream_get_marinas_change_stream**](MarinaApi.md#marina_create_change_stream_get_marinas_change_stream) | **GET** /Marinas/change-stream | Create a change stream.
|
10
|
-
[**marina_create_change_stream_post_marinas_change_stream**](MarinaApi.md#marina_create_change_stream_post_marinas_change_stream) | **POST** /Marinas/change-stream | Create a change stream.
|
11
|
-
[**marina_delete_by_id**](MarinaApi.md#marina_delete_by_id) | **DELETE** /Marinas/{id} | Delete a model instance by {{id}} from the data source.
|
12
|
-
[**marina_exists_get_marinasid_exists**](MarinaApi.md#marina_exists_get_marinasid_exists) | **GET** /Marinas/{id}/exists | Check whether a model instance exists in the data source.
|
13
|
-
[**marina_exists_head_marinasid**](MarinaApi.md#marina_exists_head_marinasid) | **HEAD** /Marinas/{id} | Check whether a model instance exists in the data source.
|
14
|
-
[**marina_find**](MarinaApi.md#marina_find) | **GET** /Marinas | Find all instances of the model matched by filter from the data source.
|
15
|
-
[**marina_find_by_id**](MarinaApi.md#marina_find_by_id) | **GET** /Marinas/{id} | Find a model instance by {{id}} from the data source.
|
16
|
-
[**marina_find_one**](MarinaApi.md#marina_find_one) | **GET** /Marinas/findOne | Find first instance of the model matched by filter from the data source.
|
17
|
-
[**marina_prototype_count_docks**](MarinaApi.md#marina_prototype_count_docks) | **GET** /Marinas/{id}/docks/count | Counts docks of Marina.
|
18
|
-
[**marina_prototype_create_address**](MarinaApi.md#marina_prototype_create_address) | **POST** /Marinas/{id}/address | Creates a new instance in address of this model.
|
19
|
-
[**marina_prototype_create_docks**](MarinaApi.md#marina_prototype_create_docks) | **POST** /Marinas/{id}/docks | Creates a new instance in docks of this model.
|
20
|
-
[**marina_prototype_create_listing_agent**](MarinaApi.md#marina_prototype_create_listing_agent) | **POST** /Marinas/{id}/listingAgent | Creates a new instance in listingAgent of this model.
|
21
|
-
[**marina_prototype_delete_docks**](MarinaApi.md#marina_prototype_delete_docks) | **DELETE** /Marinas/{id}/docks | Deletes all docks of this model.
|
22
|
-
[**marina_prototype_destroy_address**](MarinaApi.md#marina_prototype_destroy_address) | **DELETE** /Marinas/{id}/address | Deletes address of this model.
|
23
|
-
[**marina_prototype_destroy_by_id_docks**](MarinaApi.md#marina_prototype_destroy_by_id_docks) | **DELETE** /Marinas/{id}/docks/{fk} | Delete a related item by id for docks.
|
24
|
-
[**marina_prototype_destroy_listing_agent**](MarinaApi.md#marina_prototype_destroy_listing_agent) | **DELETE** /Marinas/{id}/listingAgent | Deletes listingAgent of this model.
|
25
|
-
[**marina_prototype_find_by_id_docks**](MarinaApi.md#marina_prototype_find_by_id_docks) | **GET** /Marinas/{id}/docks/{fk} | Find a related item by id for docks.
|
26
|
-
[**marina_prototype_get_address**](MarinaApi.md#marina_prototype_get_address) | **GET** /Marinas/{id}/address | Fetches hasOne relation address.
|
27
|
-
[**marina_prototype_get_docks**](MarinaApi.md#marina_prototype_get_docks) | **GET** /Marinas/{id}/docks | Queries docks of Marina.
|
28
|
-
[**marina_prototype_get_listing_agent**](MarinaApi.md#marina_prototype_get_listing_agent) | **GET** /Marinas/{id}/listingAgent | Fetches hasOne relation listingAgent.
|
29
|
-
[**marina_prototype_update_address**](MarinaApi.md#marina_prototype_update_address) | **PUT** /Marinas/{id}/address | Update address of this model.
|
30
|
-
[**marina_prototype_update_attributes_patch_marinasid**](MarinaApi.md#marina_prototype_update_attributes_patch_marinasid) | **PATCH** /Marinas/{id} | Patch attributes for a model instance and persist it into the data source.
|
31
|
-
[**marina_prototype_update_attributes_put_marinasid**](MarinaApi.md#marina_prototype_update_attributes_put_marinasid) | **PUT** /Marinas/{id} | Patch attributes for a model instance and persist it into the data source.
|
32
|
-
[**marina_prototype_update_by_id_docks**](MarinaApi.md#marina_prototype_update_by_id_docks) | **PUT** /Marinas/{id}/docks/{fk} | Update a related item by id for docks.
|
33
|
-
[**marina_prototype_update_listing_agent**](MarinaApi.md#marina_prototype_update_listing_agent) | **PUT** /Marinas/{id}/listingAgent | Update listingAgent of this model.
|
34
|
-
[**marina_replace_by_id**](MarinaApi.md#marina_replace_by_id) | **POST** /Marinas/{id}/replace | Replace attributes for a model instance and persist it into the data source.
|
35
|
-
[**marina_replace_or_create**](MarinaApi.md#marina_replace_or_create) | **POST** /Marinas/replaceOrCreate | Replace an existing model instance or insert a new one into the data source.
|
36
|
-
[**marina_update_all**](MarinaApi.md#marina_update_all) | **POST** /Marinas/update | Update instances of the model matched by {{where}} from the data source.
|
37
|
-
[**marina_upsert_patch_marinas**](MarinaApi.md#marina_upsert_patch_marinas) | **PATCH** /Marinas | Patch an existing model instance or insert a new one into the data source.
|
38
|
-
[**marina_upsert_put_marinas**](MarinaApi.md#marina_upsert_put_marinas) | **PUT** /Marinas | Patch an existing model instance or insert a new one into the data source.
|
39
|
-
[**marina_upsert_with_where**](MarinaApi.md#marina_upsert_with_where) | **POST** /Marinas/upsertWithWhere | Update an existing model instance or insert a new one into the data source based on the where criteria.
|
40
|
-
|
41
|
-
|
42
|
-
# **marina_count**
|
43
|
-
> InlineResponse200 marina_count(opts)
|
44
|
-
|
45
|
-
Count instances of the model matched by where from the data source.
|
46
|
-
|
47
|
-
### Example
|
48
|
-
```ruby
|
49
|
-
# load the gem
|
50
|
-
require 'dock_genius_api_ruby_client'
|
51
|
-
|
52
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
53
|
-
|
54
|
-
opts = {
|
55
|
-
where: "where_example" # String | Criteria to match model instances
|
56
|
-
}
|
57
|
-
|
58
|
-
begin
|
59
|
-
#Count instances of the model matched by where from the data source.
|
60
|
-
result = api_instance.marina_count(opts)
|
61
|
-
p result
|
62
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
63
|
-
puts "Exception when calling MarinaApi->marina_count: #{e}"
|
64
|
-
end
|
65
|
-
```
|
66
|
-
|
67
|
-
### Parameters
|
68
|
-
|
69
|
-
Name | Type | Description | Notes
|
70
|
-
------------- | ------------- | ------------- | -------------
|
71
|
-
**where** | **String**| Criteria to match model instances | [optional]
|
72
|
-
|
73
|
-
### Return type
|
74
|
-
|
75
|
-
[**InlineResponse200**](InlineResponse200.md)
|
76
|
-
|
77
|
-
### Authorization
|
78
|
-
|
79
|
-
No authorization required
|
80
|
-
|
81
|
-
### HTTP request headers
|
82
|
-
|
83
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
84
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
# **marina_create**
|
89
|
-
> Marina marina_create(opts)
|
90
|
-
|
91
|
-
Create a new instance of the model and persist it into the data source.
|
92
|
-
|
93
|
-
### Example
|
94
|
-
```ruby
|
95
|
-
# load the gem
|
96
|
-
require 'dock_genius_api_ruby_client'
|
97
|
-
|
98
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
99
|
-
|
100
|
-
opts = {
|
101
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | Model instance data
|
102
|
-
}
|
103
|
-
|
104
|
-
begin
|
105
|
-
#Create a new instance of the model and persist it into the data source.
|
106
|
-
result = api_instance.marina_create(opts)
|
107
|
-
p result
|
108
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
109
|
-
puts "Exception when calling MarinaApi->marina_create: #{e}"
|
110
|
-
end
|
111
|
-
```
|
112
|
-
|
113
|
-
### Parameters
|
114
|
-
|
115
|
-
Name | Type | Description | Notes
|
116
|
-
------------- | ------------- | ------------- | -------------
|
117
|
-
**data** | [**Marina**](Marina.md)| Model instance data | [optional]
|
118
|
-
|
119
|
-
### Return type
|
120
|
-
|
121
|
-
[**Marina**](Marina.md)
|
122
|
-
|
123
|
-
### Authorization
|
124
|
-
|
125
|
-
No authorization required
|
126
|
-
|
127
|
-
### HTTP request headers
|
128
|
-
|
129
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
130
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
# **marina_create_change_stream_get_marinas_change_stream**
|
135
|
-
> File marina_create_change_stream_get_marinas_change_stream(opts)
|
136
|
-
|
137
|
-
Create a change stream.
|
138
|
-
|
139
|
-
### Example
|
140
|
-
```ruby
|
141
|
-
# load the gem
|
142
|
-
require 'dock_genius_api_ruby_client'
|
143
|
-
|
144
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
145
|
-
|
146
|
-
opts = {
|
147
|
-
options: "options_example" # String |
|
148
|
-
}
|
149
|
-
|
150
|
-
begin
|
151
|
-
#Create a change stream.
|
152
|
-
result = api_instance.marina_create_change_stream_get_marinas_change_stream(opts)
|
153
|
-
p result
|
154
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
155
|
-
puts "Exception when calling MarinaApi->marina_create_change_stream_get_marinas_change_stream: #{e}"
|
156
|
-
end
|
157
|
-
```
|
158
|
-
|
159
|
-
### Parameters
|
160
|
-
|
161
|
-
Name | Type | Description | Notes
|
162
|
-
------------- | ------------- | ------------- | -------------
|
163
|
-
**options** | **String**| | [optional]
|
164
|
-
|
165
|
-
### Return type
|
166
|
-
|
167
|
-
**File**
|
168
|
-
|
169
|
-
### Authorization
|
170
|
-
|
171
|
-
No authorization required
|
172
|
-
|
173
|
-
### HTTP request headers
|
174
|
-
|
175
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
176
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
# **marina_create_change_stream_post_marinas_change_stream**
|
181
|
-
> File marina_create_change_stream_post_marinas_change_stream(opts)
|
182
|
-
|
183
|
-
Create a change stream.
|
184
|
-
|
185
|
-
### Example
|
186
|
-
```ruby
|
187
|
-
# load the gem
|
188
|
-
require 'dock_genius_api_ruby_client'
|
189
|
-
|
190
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
191
|
-
|
192
|
-
opts = {
|
193
|
-
options: "options_example" # String |
|
194
|
-
}
|
195
|
-
|
196
|
-
begin
|
197
|
-
#Create a change stream.
|
198
|
-
result = api_instance.marina_create_change_stream_post_marinas_change_stream(opts)
|
199
|
-
p result
|
200
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
201
|
-
puts "Exception when calling MarinaApi->marina_create_change_stream_post_marinas_change_stream: #{e}"
|
202
|
-
end
|
203
|
-
```
|
204
|
-
|
205
|
-
### Parameters
|
206
|
-
|
207
|
-
Name | Type | Description | Notes
|
208
|
-
------------- | ------------- | ------------- | -------------
|
209
|
-
**options** | **String**| | [optional]
|
210
|
-
|
211
|
-
### Return type
|
212
|
-
|
213
|
-
**File**
|
214
|
-
|
215
|
-
### Authorization
|
216
|
-
|
217
|
-
No authorization required
|
218
|
-
|
219
|
-
### HTTP request headers
|
220
|
-
|
221
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
222
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
# **marina_delete_by_id**
|
227
|
-
> Object marina_delete_by_id(id)
|
228
|
-
|
229
|
-
Delete a model instance by {{id}} from the data source.
|
230
|
-
|
231
|
-
### Example
|
232
|
-
```ruby
|
233
|
-
# load the gem
|
234
|
-
require 'dock_genius_api_ruby_client'
|
235
|
-
|
236
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
237
|
-
|
238
|
-
id = "id_example" # String | Model id
|
239
|
-
|
240
|
-
|
241
|
-
begin
|
242
|
-
#Delete a model instance by {{id}} from the data source.
|
243
|
-
result = api_instance.marina_delete_by_id(id)
|
244
|
-
p result
|
245
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
246
|
-
puts "Exception when calling MarinaApi->marina_delete_by_id: #{e}"
|
247
|
-
end
|
248
|
-
```
|
249
|
-
|
250
|
-
### Parameters
|
251
|
-
|
252
|
-
Name | Type | Description | Notes
|
253
|
-
------------- | ------------- | ------------- | -------------
|
254
|
-
**id** | **String**| Model id |
|
255
|
-
|
256
|
-
### Return type
|
257
|
-
|
258
|
-
**Object**
|
259
|
-
|
260
|
-
### Authorization
|
261
|
-
|
262
|
-
No authorization required
|
263
|
-
|
264
|
-
### HTTP request headers
|
265
|
-
|
266
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
267
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
# **marina_exists_get_marinasid_exists**
|
272
|
-
> InlineResponse2002 marina_exists_get_marinasid_exists(id)
|
273
|
-
|
274
|
-
Check whether a model instance exists in the data source.
|
275
|
-
|
276
|
-
### Example
|
277
|
-
```ruby
|
278
|
-
# load the gem
|
279
|
-
require 'dock_genius_api_ruby_client'
|
280
|
-
|
281
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
282
|
-
|
283
|
-
id = "id_example" # String | Model id
|
284
|
-
|
285
|
-
|
286
|
-
begin
|
287
|
-
#Check whether a model instance exists in the data source.
|
288
|
-
result = api_instance.marina_exists_get_marinasid_exists(id)
|
289
|
-
p result
|
290
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
291
|
-
puts "Exception when calling MarinaApi->marina_exists_get_marinasid_exists: #{e}"
|
292
|
-
end
|
293
|
-
```
|
294
|
-
|
295
|
-
### Parameters
|
296
|
-
|
297
|
-
Name | Type | Description | Notes
|
298
|
-
------------- | ------------- | ------------- | -------------
|
299
|
-
**id** | **String**| Model id |
|
300
|
-
|
301
|
-
### Return type
|
302
|
-
|
303
|
-
[**InlineResponse2002**](InlineResponse2002.md)
|
304
|
-
|
305
|
-
### Authorization
|
306
|
-
|
307
|
-
No authorization required
|
308
|
-
|
309
|
-
### HTTP request headers
|
310
|
-
|
311
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
312
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
# **marina_exists_head_marinasid**
|
317
|
-
> InlineResponse2002 marina_exists_head_marinasid(id)
|
318
|
-
|
319
|
-
Check whether a model instance exists in the data source.
|
320
|
-
|
321
|
-
### Example
|
322
|
-
```ruby
|
323
|
-
# load the gem
|
324
|
-
require 'dock_genius_api_ruby_client'
|
325
|
-
|
326
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
327
|
-
|
328
|
-
id = "id_example" # String | Model id
|
329
|
-
|
330
|
-
|
331
|
-
begin
|
332
|
-
#Check whether a model instance exists in the data source.
|
333
|
-
result = api_instance.marina_exists_head_marinasid(id)
|
334
|
-
p result
|
335
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
336
|
-
puts "Exception when calling MarinaApi->marina_exists_head_marinasid: #{e}"
|
337
|
-
end
|
338
|
-
```
|
339
|
-
|
340
|
-
### Parameters
|
341
|
-
|
342
|
-
Name | Type | Description | Notes
|
343
|
-
------------- | ------------- | ------------- | -------------
|
344
|
-
**id** | **String**| Model id |
|
345
|
-
|
346
|
-
### Return type
|
347
|
-
|
348
|
-
[**InlineResponse2002**](InlineResponse2002.md)
|
349
|
-
|
350
|
-
### Authorization
|
351
|
-
|
352
|
-
No authorization required
|
353
|
-
|
354
|
-
### HTTP request headers
|
355
|
-
|
356
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
357
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
# **marina_find**
|
362
|
-
> Array<Marina> marina_find(opts)
|
363
|
-
|
364
|
-
Find all instances of the model matched by filter from the data source.
|
365
|
-
|
366
|
-
### Example
|
367
|
-
```ruby
|
368
|
-
# load the gem
|
369
|
-
require 'dock_genius_api_ruby_client'
|
370
|
-
|
371
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
372
|
-
|
373
|
-
opts = {
|
374
|
-
filter: "filter_example" # String | Filter defining fields, where, include, order, offset, and limit
|
375
|
-
}
|
376
|
-
|
377
|
-
begin
|
378
|
-
#Find all instances of the model matched by filter from the data source.
|
379
|
-
result = api_instance.marina_find(opts)
|
380
|
-
p result
|
381
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
382
|
-
puts "Exception when calling MarinaApi->marina_find: #{e}"
|
383
|
-
end
|
384
|
-
```
|
385
|
-
|
386
|
-
### Parameters
|
387
|
-
|
388
|
-
Name | Type | Description | Notes
|
389
|
-
------------- | ------------- | ------------- | -------------
|
390
|
-
**filter** | **String**| Filter defining fields, where, include, order, offset, and limit | [optional]
|
391
|
-
|
392
|
-
### Return type
|
393
|
-
|
394
|
-
[**Array<Marina>**](Marina.md)
|
395
|
-
|
396
|
-
### Authorization
|
397
|
-
|
398
|
-
No authorization required
|
399
|
-
|
400
|
-
### HTTP request headers
|
401
|
-
|
402
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
403
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
# **marina_find_by_id**
|
408
|
-
> Marina marina_find_by_id(id, opts)
|
409
|
-
|
410
|
-
Find a model instance by {{id}} from the data source.
|
411
|
-
|
412
|
-
### Example
|
413
|
-
```ruby
|
414
|
-
# load the gem
|
415
|
-
require 'dock_genius_api_ruby_client'
|
416
|
-
|
417
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
418
|
-
|
419
|
-
id = "id_example" # String | Model id
|
420
|
-
|
421
|
-
opts = {
|
422
|
-
filter: "filter_example" # String | Filter defining fields and include
|
423
|
-
}
|
424
|
-
|
425
|
-
begin
|
426
|
-
#Find a model instance by {{id}} from the data source.
|
427
|
-
result = api_instance.marina_find_by_id(id, opts)
|
428
|
-
p result
|
429
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
430
|
-
puts "Exception when calling MarinaApi->marina_find_by_id: #{e}"
|
431
|
-
end
|
432
|
-
```
|
433
|
-
|
434
|
-
### Parameters
|
435
|
-
|
436
|
-
Name | Type | Description | Notes
|
437
|
-
------------- | ------------- | ------------- | -------------
|
438
|
-
**id** | **String**| Model id |
|
439
|
-
**filter** | **String**| Filter defining fields and include | [optional]
|
440
|
-
|
441
|
-
### Return type
|
442
|
-
|
443
|
-
[**Marina**](Marina.md)
|
444
|
-
|
445
|
-
### Authorization
|
446
|
-
|
447
|
-
No authorization required
|
448
|
-
|
449
|
-
### HTTP request headers
|
450
|
-
|
451
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
452
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
# **marina_find_one**
|
457
|
-
> Marina marina_find_one(opts)
|
458
|
-
|
459
|
-
Find first instance of the model matched by filter from the data source.
|
460
|
-
|
461
|
-
### Example
|
462
|
-
```ruby
|
463
|
-
# load the gem
|
464
|
-
require 'dock_genius_api_ruby_client'
|
465
|
-
|
466
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
467
|
-
|
468
|
-
opts = {
|
469
|
-
filter: "filter_example" # String | Filter defining fields, where, include, order, offset, and limit
|
470
|
-
}
|
471
|
-
|
472
|
-
begin
|
473
|
-
#Find first instance of the model matched by filter from the data source.
|
474
|
-
result = api_instance.marina_find_one(opts)
|
475
|
-
p result
|
476
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
477
|
-
puts "Exception when calling MarinaApi->marina_find_one: #{e}"
|
478
|
-
end
|
479
|
-
```
|
480
|
-
|
481
|
-
### Parameters
|
482
|
-
|
483
|
-
Name | Type | Description | Notes
|
484
|
-
------------- | ------------- | ------------- | -------------
|
485
|
-
**filter** | **String**| Filter defining fields, where, include, order, offset, and limit | [optional]
|
486
|
-
|
487
|
-
### Return type
|
488
|
-
|
489
|
-
[**Marina**](Marina.md)
|
490
|
-
|
491
|
-
### Authorization
|
492
|
-
|
493
|
-
No authorization required
|
494
|
-
|
495
|
-
### HTTP request headers
|
496
|
-
|
497
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
498
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
# **marina_prototype_count_docks**
|
503
|
-
> InlineResponse200 marina_prototype_count_docks(id, opts)
|
504
|
-
|
505
|
-
Counts docks of Marina.
|
506
|
-
|
507
|
-
### Example
|
508
|
-
```ruby
|
509
|
-
# load the gem
|
510
|
-
require 'dock_genius_api_ruby_client'
|
511
|
-
|
512
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
513
|
-
|
514
|
-
id = "id_example" # String | PersistedModel id
|
515
|
-
|
516
|
-
opts = {
|
517
|
-
where: "where_example" # String | Criteria to match model instances
|
518
|
-
}
|
519
|
-
|
520
|
-
begin
|
521
|
-
#Counts docks of Marina.
|
522
|
-
result = api_instance.marina_prototype_count_docks(id, opts)
|
523
|
-
p result
|
524
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
525
|
-
puts "Exception when calling MarinaApi->marina_prototype_count_docks: #{e}"
|
526
|
-
end
|
527
|
-
```
|
528
|
-
|
529
|
-
### Parameters
|
530
|
-
|
531
|
-
Name | Type | Description | Notes
|
532
|
-
------------- | ------------- | ------------- | -------------
|
533
|
-
**id** | **String**| PersistedModel id |
|
534
|
-
**where** | **String**| Criteria to match model instances | [optional]
|
535
|
-
|
536
|
-
### Return type
|
537
|
-
|
538
|
-
[**InlineResponse200**](InlineResponse200.md)
|
539
|
-
|
540
|
-
### Authorization
|
541
|
-
|
542
|
-
No authorization required
|
543
|
-
|
544
|
-
### HTTP request headers
|
545
|
-
|
546
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
547
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
# **marina_prototype_create_address**
|
552
|
-
> Address marina_prototype_create_address(id, opts)
|
553
|
-
|
554
|
-
Creates a new instance in address of this model.
|
555
|
-
|
556
|
-
### Example
|
557
|
-
```ruby
|
558
|
-
# load the gem
|
559
|
-
require 'dock_genius_api_ruby_client'
|
560
|
-
|
561
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
562
|
-
|
563
|
-
id = "id_example" # String | PersistedModel id
|
564
|
-
|
565
|
-
opts = {
|
566
|
-
data: DockGeniusApiRubyClient::Address.new # Address |
|
567
|
-
}
|
568
|
-
|
569
|
-
begin
|
570
|
-
#Creates a new instance in address of this model.
|
571
|
-
result = api_instance.marina_prototype_create_address(id, opts)
|
572
|
-
p result
|
573
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
574
|
-
puts "Exception when calling MarinaApi->marina_prototype_create_address: #{e}"
|
575
|
-
end
|
576
|
-
```
|
577
|
-
|
578
|
-
### Parameters
|
579
|
-
|
580
|
-
Name | Type | Description | Notes
|
581
|
-
------------- | ------------- | ------------- | -------------
|
582
|
-
**id** | **String**| PersistedModel id |
|
583
|
-
**data** | [**Address**](Address.md)| | [optional]
|
584
|
-
|
585
|
-
### Return type
|
586
|
-
|
587
|
-
[**Address**](Address.md)
|
588
|
-
|
589
|
-
### Authorization
|
590
|
-
|
591
|
-
No authorization required
|
592
|
-
|
593
|
-
### HTTP request headers
|
594
|
-
|
595
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
596
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
# **marina_prototype_create_docks**
|
601
|
-
> Dock marina_prototype_create_docks(id, opts)
|
602
|
-
|
603
|
-
Creates a new instance in docks of this model.
|
604
|
-
|
605
|
-
### Example
|
606
|
-
```ruby
|
607
|
-
# load the gem
|
608
|
-
require 'dock_genius_api_ruby_client'
|
609
|
-
|
610
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
611
|
-
|
612
|
-
id = "id_example" # String | PersistedModel id
|
613
|
-
|
614
|
-
opts = {
|
615
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock |
|
616
|
-
}
|
617
|
-
|
618
|
-
begin
|
619
|
-
#Creates a new instance in docks of this model.
|
620
|
-
result = api_instance.marina_prototype_create_docks(id, opts)
|
621
|
-
p result
|
622
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
623
|
-
puts "Exception when calling MarinaApi->marina_prototype_create_docks: #{e}"
|
624
|
-
end
|
625
|
-
```
|
626
|
-
|
627
|
-
### Parameters
|
628
|
-
|
629
|
-
Name | Type | Description | Notes
|
630
|
-
------------- | ------------- | ------------- | -------------
|
631
|
-
**id** | **String**| PersistedModel id |
|
632
|
-
**data** | [**Dock**](Dock.md)| | [optional]
|
633
|
-
|
634
|
-
### Return type
|
635
|
-
|
636
|
-
[**Dock**](Dock.md)
|
637
|
-
|
638
|
-
### Authorization
|
639
|
-
|
640
|
-
No authorization required
|
641
|
-
|
642
|
-
### HTTP request headers
|
643
|
-
|
644
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
645
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
# **marina_prototype_create_listing_agent**
|
650
|
-
> ListingAgent marina_prototype_create_listing_agent(id, opts)
|
651
|
-
|
652
|
-
Creates a new instance in listingAgent of this model.
|
653
|
-
|
654
|
-
### Example
|
655
|
-
```ruby
|
656
|
-
# load the gem
|
657
|
-
require 'dock_genius_api_ruby_client'
|
658
|
-
|
659
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
660
|
-
|
661
|
-
id = "id_example" # String | PersistedModel id
|
662
|
-
|
663
|
-
opts = {
|
664
|
-
data: DockGeniusApiRubyClient::ListingAgent.new # ListingAgent |
|
665
|
-
}
|
666
|
-
|
667
|
-
begin
|
668
|
-
#Creates a new instance in listingAgent of this model.
|
669
|
-
result = api_instance.marina_prototype_create_listing_agent(id, opts)
|
670
|
-
p result
|
671
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
672
|
-
puts "Exception when calling MarinaApi->marina_prototype_create_listing_agent: #{e}"
|
673
|
-
end
|
674
|
-
```
|
675
|
-
|
676
|
-
### Parameters
|
677
|
-
|
678
|
-
Name | Type | Description | Notes
|
679
|
-
------------- | ------------- | ------------- | -------------
|
680
|
-
**id** | **String**| PersistedModel id |
|
681
|
-
**data** | [**ListingAgent**](ListingAgent.md)| | [optional]
|
682
|
-
|
683
|
-
### Return type
|
684
|
-
|
685
|
-
[**ListingAgent**](ListingAgent.md)
|
686
|
-
|
687
|
-
### Authorization
|
688
|
-
|
689
|
-
No authorization required
|
690
|
-
|
691
|
-
### HTTP request headers
|
692
|
-
|
693
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
694
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
# **marina_prototype_delete_docks**
|
699
|
-
> marina_prototype_delete_docks(id)
|
700
|
-
|
701
|
-
Deletes all docks of this model.
|
702
|
-
|
703
|
-
### Example
|
704
|
-
```ruby
|
705
|
-
# load the gem
|
706
|
-
require 'dock_genius_api_ruby_client'
|
707
|
-
|
708
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
709
|
-
|
710
|
-
id = "id_example" # String | PersistedModel id
|
711
|
-
|
712
|
-
|
713
|
-
begin
|
714
|
-
#Deletes all docks of this model.
|
715
|
-
api_instance.marina_prototype_delete_docks(id)
|
716
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
717
|
-
puts "Exception when calling MarinaApi->marina_prototype_delete_docks: #{e}"
|
718
|
-
end
|
719
|
-
```
|
720
|
-
|
721
|
-
### Parameters
|
722
|
-
|
723
|
-
Name | Type | Description | Notes
|
724
|
-
------------- | ------------- | ------------- | -------------
|
725
|
-
**id** | **String**| PersistedModel id |
|
726
|
-
|
727
|
-
### Return type
|
728
|
-
|
729
|
-
nil (empty response body)
|
730
|
-
|
731
|
-
### Authorization
|
732
|
-
|
733
|
-
No authorization required
|
734
|
-
|
735
|
-
### HTTP request headers
|
736
|
-
|
737
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
738
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
# **marina_prototype_destroy_address**
|
743
|
-
> marina_prototype_destroy_address(id)
|
744
|
-
|
745
|
-
Deletes address of this model.
|
746
|
-
|
747
|
-
### Example
|
748
|
-
```ruby
|
749
|
-
# load the gem
|
750
|
-
require 'dock_genius_api_ruby_client'
|
751
|
-
|
752
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
753
|
-
|
754
|
-
id = "id_example" # String | PersistedModel id
|
755
|
-
|
756
|
-
|
757
|
-
begin
|
758
|
-
#Deletes address of this model.
|
759
|
-
api_instance.marina_prototype_destroy_address(id)
|
760
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
761
|
-
puts "Exception when calling MarinaApi->marina_prototype_destroy_address: #{e}"
|
762
|
-
end
|
763
|
-
```
|
764
|
-
|
765
|
-
### Parameters
|
766
|
-
|
767
|
-
Name | Type | Description | Notes
|
768
|
-
------------- | ------------- | ------------- | -------------
|
769
|
-
**id** | **String**| PersistedModel id |
|
770
|
-
|
771
|
-
### Return type
|
772
|
-
|
773
|
-
nil (empty response body)
|
774
|
-
|
775
|
-
### Authorization
|
776
|
-
|
777
|
-
No authorization required
|
778
|
-
|
779
|
-
### HTTP request headers
|
780
|
-
|
781
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
782
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
# **marina_prototype_destroy_by_id_docks**
|
787
|
-
> marina_prototype_destroy_by_id_docks(fk, id)
|
788
|
-
|
789
|
-
Delete a related item by id for docks.
|
790
|
-
|
791
|
-
### Example
|
792
|
-
```ruby
|
793
|
-
# load the gem
|
794
|
-
require 'dock_genius_api_ruby_client'
|
795
|
-
|
796
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
797
|
-
|
798
|
-
fk = "fk_example" # String | Foreign key for docks
|
799
|
-
|
800
|
-
id = "id_example" # String | PersistedModel id
|
801
|
-
|
802
|
-
|
803
|
-
begin
|
804
|
-
#Delete a related item by id for docks.
|
805
|
-
api_instance.marina_prototype_destroy_by_id_docks(fk, id)
|
806
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
807
|
-
puts "Exception when calling MarinaApi->marina_prototype_destroy_by_id_docks: #{e}"
|
808
|
-
end
|
809
|
-
```
|
810
|
-
|
811
|
-
### Parameters
|
812
|
-
|
813
|
-
Name | Type | Description | Notes
|
814
|
-
------------- | ------------- | ------------- | -------------
|
815
|
-
**fk** | **String**| Foreign key for docks |
|
816
|
-
**id** | **String**| PersistedModel id |
|
817
|
-
|
818
|
-
### Return type
|
819
|
-
|
820
|
-
nil (empty response body)
|
821
|
-
|
822
|
-
### Authorization
|
823
|
-
|
824
|
-
No authorization required
|
825
|
-
|
826
|
-
### HTTP request headers
|
827
|
-
|
828
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
829
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
# **marina_prototype_destroy_listing_agent**
|
834
|
-
> marina_prototype_destroy_listing_agent(id)
|
835
|
-
|
836
|
-
Deletes listingAgent of this model.
|
837
|
-
|
838
|
-
### Example
|
839
|
-
```ruby
|
840
|
-
# load the gem
|
841
|
-
require 'dock_genius_api_ruby_client'
|
842
|
-
|
843
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
844
|
-
|
845
|
-
id = "id_example" # String | PersistedModel id
|
846
|
-
|
847
|
-
|
848
|
-
begin
|
849
|
-
#Deletes listingAgent of this model.
|
850
|
-
api_instance.marina_prototype_destroy_listing_agent(id)
|
851
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
852
|
-
puts "Exception when calling MarinaApi->marina_prototype_destroy_listing_agent: #{e}"
|
853
|
-
end
|
854
|
-
```
|
855
|
-
|
856
|
-
### Parameters
|
857
|
-
|
858
|
-
Name | Type | Description | Notes
|
859
|
-
------------- | ------------- | ------------- | -------------
|
860
|
-
**id** | **String**| PersistedModel id |
|
861
|
-
|
862
|
-
### Return type
|
863
|
-
|
864
|
-
nil (empty response body)
|
865
|
-
|
866
|
-
### Authorization
|
867
|
-
|
868
|
-
No authorization required
|
869
|
-
|
870
|
-
### HTTP request headers
|
871
|
-
|
872
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
873
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
874
|
-
|
875
|
-
|
876
|
-
|
877
|
-
# **marina_prototype_find_by_id_docks**
|
878
|
-
> Dock marina_prototype_find_by_id_docks(fk, id)
|
879
|
-
|
880
|
-
Find a related item by id for docks.
|
881
|
-
|
882
|
-
### Example
|
883
|
-
```ruby
|
884
|
-
# load the gem
|
885
|
-
require 'dock_genius_api_ruby_client'
|
886
|
-
|
887
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
888
|
-
|
889
|
-
fk = "fk_example" # String | Foreign key for docks
|
890
|
-
|
891
|
-
id = "id_example" # String | PersistedModel id
|
892
|
-
|
893
|
-
|
894
|
-
begin
|
895
|
-
#Find a related item by id for docks.
|
896
|
-
result = api_instance.marina_prototype_find_by_id_docks(fk, id)
|
897
|
-
p result
|
898
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
899
|
-
puts "Exception when calling MarinaApi->marina_prototype_find_by_id_docks: #{e}"
|
900
|
-
end
|
901
|
-
```
|
902
|
-
|
903
|
-
### Parameters
|
904
|
-
|
905
|
-
Name | Type | Description | Notes
|
906
|
-
------------- | ------------- | ------------- | -------------
|
907
|
-
**fk** | **String**| Foreign key for docks |
|
908
|
-
**id** | **String**| PersistedModel id |
|
909
|
-
|
910
|
-
### Return type
|
911
|
-
|
912
|
-
[**Dock**](Dock.md)
|
913
|
-
|
914
|
-
### Authorization
|
915
|
-
|
916
|
-
No authorization required
|
917
|
-
|
918
|
-
### HTTP request headers
|
919
|
-
|
920
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
921
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
922
|
-
|
923
|
-
|
924
|
-
|
925
|
-
# **marina_prototype_get_address**
|
926
|
-
> Address marina_prototype_get_address(id, opts)
|
927
|
-
|
928
|
-
Fetches hasOne relation address.
|
929
|
-
|
930
|
-
### Example
|
931
|
-
```ruby
|
932
|
-
# load the gem
|
933
|
-
require 'dock_genius_api_ruby_client'
|
934
|
-
|
935
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
936
|
-
|
937
|
-
id = "id_example" # String | PersistedModel id
|
938
|
-
|
939
|
-
opts = {
|
940
|
-
refresh: true # BOOLEAN |
|
941
|
-
}
|
942
|
-
|
943
|
-
begin
|
944
|
-
#Fetches hasOne relation address.
|
945
|
-
result = api_instance.marina_prototype_get_address(id, opts)
|
946
|
-
p result
|
947
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
948
|
-
puts "Exception when calling MarinaApi->marina_prototype_get_address: #{e}"
|
949
|
-
end
|
950
|
-
```
|
951
|
-
|
952
|
-
### Parameters
|
953
|
-
|
954
|
-
Name | Type | Description | Notes
|
955
|
-
------------- | ------------- | ------------- | -------------
|
956
|
-
**id** | **String**| PersistedModel id |
|
957
|
-
**refresh** | **BOOLEAN**| | [optional]
|
958
|
-
|
959
|
-
### Return type
|
960
|
-
|
961
|
-
[**Address**](Address.md)
|
962
|
-
|
963
|
-
### Authorization
|
964
|
-
|
965
|
-
No authorization required
|
966
|
-
|
967
|
-
### HTTP request headers
|
968
|
-
|
969
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
970
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
971
|
-
|
972
|
-
|
973
|
-
|
974
|
-
# **marina_prototype_get_docks**
|
975
|
-
> Array<Dock> marina_prototype_get_docks(id, opts)
|
976
|
-
|
977
|
-
Queries docks of Marina.
|
978
|
-
|
979
|
-
### Example
|
980
|
-
```ruby
|
981
|
-
# load the gem
|
982
|
-
require 'dock_genius_api_ruby_client'
|
983
|
-
|
984
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
985
|
-
|
986
|
-
id = "id_example" # String | PersistedModel id
|
987
|
-
|
988
|
-
opts = {
|
989
|
-
filter: "filter_example" # String |
|
990
|
-
}
|
991
|
-
|
992
|
-
begin
|
993
|
-
#Queries docks of Marina.
|
994
|
-
result = api_instance.marina_prototype_get_docks(id, opts)
|
995
|
-
p result
|
996
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
997
|
-
puts "Exception when calling MarinaApi->marina_prototype_get_docks: #{e}"
|
998
|
-
end
|
999
|
-
```
|
1000
|
-
|
1001
|
-
### Parameters
|
1002
|
-
|
1003
|
-
Name | Type | Description | Notes
|
1004
|
-
------------- | ------------- | ------------- | -------------
|
1005
|
-
**id** | **String**| PersistedModel id |
|
1006
|
-
**filter** | **String**| | [optional]
|
1007
|
-
|
1008
|
-
### Return type
|
1009
|
-
|
1010
|
-
[**Array<Dock>**](Dock.md)
|
1011
|
-
|
1012
|
-
### Authorization
|
1013
|
-
|
1014
|
-
No authorization required
|
1015
|
-
|
1016
|
-
### HTTP request headers
|
1017
|
-
|
1018
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1019
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
# **marina_prototype_get_listing_agent**
|
1024
|
-
> ListingAgent marina_prototype_get_listing_agent(id, opts)
|
1025
|
-
|
1026
|
-
Fetches hasOne relation listingAgent.
|
1027
|
-
|
1028
|
-
### Example
|
1029
|
-
```ruby
|
1030
|
-
# load the gem
|
1031
|
-
require 'dock_genius_api_ruby_client'
|
1032
|
-
|
1033
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1034
|
-
|
1035
|
-
id = "id_example" # String | PersistedModel id
|
1036
|
-
|
1037
|
-
opts = {
|
1038
|
-
refresh: true # BOOLEAN |
|
1039
|
-
}
|
1040
|
-
|
1041
|
-
begin
|
1042
|
-
#Fetches hasOne relation listingAgent.
|
1043
|
-
result = api_instance.marina_prototype_get_listing_agent(id, opts)
|
1044
|
-
p result
|
1045
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1046
|
-
puts "Exception when calling MarinaApi->marina_prototype_get_listing_agent: #{e}"
|
1047
|
-
end
|
1048
|
-
```
|
1049
|
-
|
1050
|
-
### Parameters
|
1051
|
-
|
1052
|
-
Name | Type | Description | Notes
|
1053
|
-
------------- | ------------- | ------------- | -------------
|
1054
|
-
**id** | **String**| PersistedModel id |
|
1055
|
-
**refresh** | **BOOLEAN**| | [optional]
|
1056
|
-
|
1057
|
-
### Return type
|
1058
|
-
|
1059
|
-
[**ListingAgent**](ListingAgent.md)
|
1060
|
-
|
1061
|
-
### Authorization
|
1062
|
-
|
1063
|
-
No authorization required
|
1064
|
-
|
1065
|
-
### HTTP request headers
|
1066
|
-
|
1067
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1068
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1069
|
-
|
1070
|
-
|
1071
|
-
|
1072
|
-
# **marina_prototype_update_address**
|
1073
|
-
> Address marina_prototype_update_address(id, opts)
|
1074
|
-
|
1075
|
-
Update address of this model.
|
1076
|
-
|
1077
|
-
### Example
|
1078
|
-
```ruby
|
1079
|
-
# load the gem
|
1080
|
-
require 'dock_genius_api_ruby_client'
|
1081
|
-
|
1082
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1083
|
-
|
1084
|
-
id = "id_example" # String | PersistedModel id
|
1085
|
-
|
1086
|
-
opts = {
|
1087
|
-
data: DockGeniusApiRubyClient::Address.new # Address |
|
1088
|
-
}
|
1089
|
-
|
1090
|
-
begin
|
1091
|
-
#Update address of this model.
|
1092
|
-
result = api_instance.marina_prototype_update_address(id, opts)
|
1093
|
-
p result
|
1094
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1095
|
-
puts "Exception when calling MarinaApi->marina_prototype_update_address: #{e}"
|
1096
|
-
end
|
1097
|
-
```
|
1098
|
-
|
1099
|
-
### Parameters
|
1100
|
-
|
1101
|
-
Name | Type | Description | Notes
|
1102
|
-
------------- | ------------- | ------------- | -------------
|
1103
|
-
**id** | **String**| PersistedModel id |
|
1104
|
-
**data** | [**Address**](Address.md)| | [optional]
|
1105
|
-
|
1106
|
-
### Return type
|
1107
|
-
|
1108
|
-
[**Address**](Address.md)
|
1109
|
-
|
1110
|
-
### Authorization
|
1111
|
-
|
1112
|
-
No authorization required
|
1113
|
-
|
1114
|
-
### HTTP request headers
|
1115
|
-
|
1116
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1117
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1118
|
-
|
1119
|
-
|
1120
|
-
|
1121
|
-
# **marina_prototype_update_attributes_patch_marinasid**
|
1122
|
-
> Marina marina_prototype_update_attributes_patch_marinasid(id, opts)
|
1123
|
-
|
1124
|
-
Patch attributes for a model instance and persist it into the data source.
|
1125
|
-
|
1126
|
-
### Example
|
1127
|
-
```ruby
|
1128
|
-
# load the gem
|
1129
|
-
require 'dock_genius_api_ruby_client'
|
1130
|
-
|
1131
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1132
|
-
|
1133
|
-
id = "id_example" # String | PersistedModel id
|
1134
|
-
|
1135
|
-
opts = {
|
1136
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | An object of model property name/value pairs
|
1137
|
-
}
|
1138
|
-
|
1139
|
-
begin
|
1140
|
-
#Patch attributes for a model instance and persist it into the data source.
|
1141
|
-
result = api_instance.marina_prototype_update_attributes_patch_marinasid(id, opts)
|
1142
|
-
p result
|
1143
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1144
|
-
puts "Exception when calling MarinaApi->marina_prototype_update_attributes_patch_marinasid: #{e}"
|
1145
|
-
end
|
1146
|
-
```
|
1147
|
-
|
1148
|
-
### Parameters
|
1149
|
-
|
1150
|
-
Name | Type | Description | Notes
|
1151
|
-
------------- | ------------- | ------------- | -------------
|
1152
|
-
**id** | **String**| PersistedModel id |
|
1153
|
-
**data** | [**Marina**](Marina.md)| An object of model property name/value pairs | [optional]
|
1154
|
-
|
1155
|
-
### Return type
|
1156
|
-
|
1157
|
-
[**Marina**](Marina.md)
|
1158
|
-
|
1159
|
-
### Authorization
|
1160
|
-
|
1161
|
-
No authorization required
|
1162
|
-
|
1163
|
-
### HTTP request headers
|
1164
|
-
|
1165
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1166
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1167
|
-
|
1168
|
-
|
1169
|
-
|
1170
|
-
# **marina_prototype_update_attributes_put_marinasid**
|
1171
|
-
> Marina marina_prototype_update_attributes_put_marinasid(id, opts)
|
1172
|
-
|
1173
|
-
Patch attributes for a model instance and persist it into the data source.
|
1174
|
-
|
1175
|
-
### Example
|
1176
|
-
```ruby
|
1177
|
-
# load the gem
|
1178
|
-
require 'dock_genius_api_ruby_client'
|
1179
|
-
|
1180
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1181
|
-
|
1182
|
-
id = "id_example" # String | PersistedModel id
|
1183
|
-
|
1184
|
-
opts = {
|
1185
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | An object of model property name/value pairs
|
1186
|
-
}
|
1187
|
-
|
1188
|
-
begin
|
1189
|
-
#Patch attributes for a model instance and persist it into the data source.
|
1190
|
-
result = api_instance.marina_prototype_update_attributes_put_marinasid(id, opts)
|
1191
|
-
p result
|
1192
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1193
|
-
puts "Exception when calling MarinaApi->marina_prototype_update_attributes_put_marinasid: #{e}"
|
1194
|
-
end
|
1195
|
-
```
|
1196
|
-
|
1197
|
-
### Parameters
|
1198
|
-
|
1199
|
-
Name | Type | Description | Notes
|
1200
|
-
------------- | ------------- | ------------- | -------------
|
1201
|
-
**id** | **String**| PersistedModel id |
|
1202
|
-
**data** | [**Marina**](Marina.md)| An object of model property name/value pairs | [optional]
|
1203
|
-
|
1204
|
-
### Return type
|
1205
|
-
|
1206
|
-
[**Marina**](Marina.md)
|
1207
|
-
|
1208
|
-
### Authorization
|
1209
|
-
|
1210
|
-
No authorization required
|
1211
|
-
|
1212
|
-
### HTTP request headers
|
1213
|
-
|
1214
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1215
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1216
|
-
|
1217
|
-
|
1218
|
-
|
1219
|
-
# **marina_prototype_update_by_id_docks**
|
1220
|
-
> Dock marina_prototype_update_by_id_docks(fk, id, opts)
|
1221
|
-
|
1222
|
-
Update a related item by id for docks.
|
1223
|
-
|
1224
|
-
### Example
|
1225
|
-
```ruby
|
1226
|
-
# load the gem
|
1227
|
-
require 'dock_genius_api_ruby_client'
|
1228
|
-
|
1229
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1230
|
-
|
1231
|
-
fk = "fk_example" # String | Foreign key for docks
|
1232
|
-
|
1233
|
-
id = "id_example" # String | PersistedModel id
|
1234
|
-
|
1235
|
-
opts = {
|
1236
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock |
|
1237
|
-
}
|
1238
|
-
|
1239
|
-
begin
|
1240
|
-
#Update a related item by id for docks.
|
1241
|
-
result = api_instance.marina_prototype_update_by_id_docks(fk, id, opts)
|
1242
|
-
p result
|
1243
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1244
|
-
puts "Exception when calling MarinaApi->marina_prototype_update_by_id_docks: #{e}"
|
1245
|
-
end
|
1246
|
-
```
|
1247
|
-
|
1248
|
-
### Parameters
|
1249
|
-
|
1250
|
-
Name | Type | Description | Notes
|
1251
|
-
------------- | ------------- | ------------- | -------------
|
1252
|
-
**fk** | **String**| Foreign key for docks |
|
1253
|
-
**id** | **String**| PersistedModel id |
|
1254
|
-
**data** | [**Dock**](Dock.md)| | [optional]
|
1255
|
-
|
1256
|
-
### Return type
|
1257
|
-
|
1258
|
-
[**Dock**](Dock.md)
|
1259
|
-
|
1260
|
-
### Authorization
|
1261
|
-
|
1262
|
-
No authorization required
|
1263
|
-
|
1264
|
-
### HTTP request headers
|
1265
|
-
|
1266
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1267
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1268
|
-
|
1269
|
-
|
1270
|
-
|
1271
|
-
# **marina_prototype_update_listing_agent**
|
1272
|
-
> ListingAgent marina_prototype_update_listing_agent(id, opts)
|
1273
|
-
|
1274
|
-
Update listingAgent of this model.
|
1275
|
-
|
1276
|
-
### Example
|
1277
|
-
```ruby
|
1278
|
-
# load the gem
|
1279
|
-
require 'dock_genius_api_ruby_client'
|
1280
|
-
|
1281
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1282
|
-
|
1283
|
-
id = "id_example" # String | PersistedModel id
|
1284
|
-
|
1285
|
-
opts = {
|
1286
|
-
data: DockGeniusApiRubyClient::ListingAgent.new # ListingAgent |
|
1287
|
-
}
|
1288
|
-
|
1289
|
-
begin
|
1290
|
-
#Update listingAgent of this model.
|
1291
|
-
result = api_instance.marina_prototype_update_listing_agent(id, opts)
|
1292
|
-
p result
|
1293
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1294
|
-
puts "Exception when calling MarinaApi->marina_prototype_update_listing_agent: #{e}"
|
1295
|
-
end
|
1296
|
-
```
|
1297
|
-
|
1298
|
-
### Parameters
|
1299
|
-
|
1300
|
-
Name | Type | Description | Notes
|
1301
|
-
------------- | ------------- | ------------- | -------------
|
1302
|
-
**id** | **String**| PersistedModel id |
|
1303
|
-
**data** | [**ListingAgent**](ListingAgent.md)| | [optional]
|
1304
|
-
|
1305
|
-
### Return type
|
1306
|
-
|
1307
|
-
[**ListingAgent**](ListingAgent.md)
|
1308
|
-
|
1309
|
-
### Authorization
|
1310
|
-
|
1311
|
-
No authorization required
|
1312
|
-
|
1313
|
-
### HTTP request headers
|
1314
|
-
|
1315
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1316
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1317
|
-
|
1318
|
-
|
1319
|
-
|
1320
|
-
# **marina_replace_by_id**
|
1321
|
-
> Marina marina_replace_by_id(id, opts)
|
1322
|
-
|
1323
|
-
Replace attributes for a model instance and persist it into the data source.
|
1324
|
-
|
1325
|
-
### Example
|
1326
|
-
```ruby
|
1327
|
-
# load the gem
|
1328
|
-
require 'dock_genius_api_ruby_client'
|
1329
|
-
|
1330
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1331
|
-
|
1332
|
-
id = "id_example" # String | Model id
|
1333
|
-
|
1334
|
-
opts = {
|
1335
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | Model instance data
|
1336
|
-
}
|
1337
|
-
|
1338
|
-
begin
|
1339
|
-
#Replace attributes for a model instance and persist it into the data source.
|
1340
|
-
result = api_instance.marina_replace_by_id(id, opts)
|
1341
|
-
p result
|
1342
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1343
|
-
puts "Exception when calling MarinaApi->marina_replace_by_id: #{e}"
|
1344
|
-
end
|
1345
|
-
```
|
1346
|
-
|
1347
|
-
### Parameters
|
1348
|
-
|
1349
|
-
Name | Type | Description | Notes
|
1350
|
-
------------- | ------------- | ------------- | -------------
|
1351
|
-
**id** | **String**| Model id |
|
1352
|
-
**data** | [**Marina**](Marina.md)| Model instance data | [optional]
|
1353
|
-
|
1354
|
-
### Return type
|
1355
|
-
|
1356
|
-
[**Marina**](Marina.md)
|
1357
|
-
|
1358
|
-
### Authorization
|
1359
|
-
|
1360
|
-
No authorization required
|
1361
|
-
|
1362
|
-
### HTTP request headers
|
1363
|
-
|
1364
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1365
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1366
|
-
|
1367
|
-
|
1368
|
-
|
1369
|
-
# **marina_replace_or_create**
|
1370
|
-
> Marina marina_replace_or_create(opts)
|
1371
|
-
|
1372
|
-
Replace an existing model instance or insert a new one into the data source.
|
1373
|
-
|
1374
|
-
### Example
|
1375
|
-
```ruby
|
1376
|
-
# load the gem
|
1377
|
-
require 'dock_genius_api_ruby_client'
|
1378
|
-
|
1379
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1380
|
-
|
1381
|
-
opts = {
|
1382
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | Model instance data
|
1383
|
-
}
|
1384
|
-
|
1385
|
-
begin
|
1386
|
-
#Replace an existing model instance or insert a new one into the data source.
|
1387
|
-
result = api_instance.marina_replace_or_create(opts)
|
1388
|
-
p result
|
1389
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1390
|
-
puts "Exception when calling MarinaApi->marina_replace_or_create: #{e}"
|
1391
|
-
end
|
1392
|
-
```
|
1393
|
-
|
1394
|
-
### Parameters
|
1395
|
-
|
1396
|
-
Name | Type | Description | Notes
|
1397
|
-
------------- | ------------- | ------------- | -------------
|
1398
|
-
**data** | [**Marina**](Marina.md)| Model instance data | [optional]
|
1399
|
-
|
1400
|
-
### Return type
|
1401
|
-
|
1402
|
-
[**Marina**](Marina.md)
|
1403
|
-
|
1404
|
-
### Authorization
|
1405
|
-
|
1406
|
-
No authorization required
|
1407
|
-
|
1408
|
-
### HTTP request headers
|
1409
|
-
|
1410
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1411
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1412
|
-
|
1413
|
-
|
1414
|
-
|
1415
|
-
# **marina_update_all**
|
1416
|
-
> InlineResponse2001 marina_update_all(opts)
|
1417
|
-
|
1418
|
-
Update instances of the model matched by {{where}} from the data source.
|
1419
|
-
|
1420
|
-
### Example
|
1421
|
-
```ruby
|
1422
|
-
# load the gem
|
1423
|
-
require 'dock_genius_api_ruby_client'
|
1424
|
-
|
1425
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1426
|
-
|
1427
|
-
opts = {
|
1428
|
-
where: "where_example", # String | Criteria to match model instances
|
1429
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | An object of model property name/value pairs
|
1430
|
-
}
|
1431
|
-
|
1432
|
-
begin
|
1433
|
-
#Update instances of the model matched by {{where}} from the data source.
|
1434
|
-
result = api_instance.marina_update_all(opts)
|
1435
|
-
p result
|
1436
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1437
|
-
puts "Exception when calling MarinaApi->marina_update_all: #{e}"
|
1438
|
-
end
|
1439
|
-
```
|
1440
|
-
|
1441
|
-
### Parameters
|
1442
|
-
|
1443
|
-
Name | Type | Description | Notes
|
1444
|
-
------------- | ------------- | ------------- | -------------
|
1445
|
-
**where** | **String**| Criteria to match model instances | [optional]
|
1446
|
-
**data** | [**Marina**](Marina.md)| An object of model property name/value pairs | [optional]
|
1447
|
-
|
1448
|
-
### Return type
|
1449
|
-
|
1450
|
-
[**InlineResponse2001**](InlineResponse2001.md)
|
1451
|
-
|
1452
|
-
### Authorization
|
1453
|
-
|
1454
|
-
No authorization required
|
1455
|
-
|
1456
|
-
### HTTP request headers
|
1457
|
-
|
1458
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1459
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1460
|
-
|
1461
|
-
|
1462
|
-
|
1463
|
-
# **marina_upsert_patch_marinas**
|
1464
|
-
> Marina marina_upsert_patch_marinas(opts)
|
1465
|
-
|
1466
|
-
Patch an existing model instance or insert a new one into the data source.
|
1467
|
-
|
1468
|
-
### Example
|
1469
|
-
```ruby
|
1470
|
-
# load the gem
|
1471
|
-
require 'dock_genius_api_ruby_client'
|
1472
|
-
|
1473
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1474
|
-
|
1475
|
-
opts = {
|
1476
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | Model instance data
|
1477
|
-
}
|
1478
|
-
|
1479
|
-
begin
|
1480
|
-
#Patch an existing model instance or insert a new one into the data source.
|
1481
|
-
result = api_instance.marina_upsert_patch_marinas(opts)
|
1482
|
-
p result
|
1483
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1484
|
-
puts "Exception when calling MarinaApi->marina_upsert_patch_marinas: #{e}"
|
1485
|
-
end
|
1486
|
-
```
|
1487
|
-
|
1488
|
-
### Parameters
|
1489
|
-
|
1490
|
-
Name | Type | Description | Notes
|
1491
|
-
------------- | ------------- | ------------- | -------------
|
1492
|
-
**data** | [**Marina**](Marina.md)| Model instance data | [optional]
|
1493
|
-
|
1494
|
-
### Return type
|
1495
|
-
|
1496
|
-
[**Marina**](Marina.md)
|
1497
|
-
|
1498
|
-
### Authorization
|
1499
|
-
|
1500
|
-
No authorization required
|
1501
|
-
|
1502
|
-
### HTTP request headers
|
1503
|
-
|
1504
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1505
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1506
|
-
|
1507
|
-
|
1508
|
-
|
1509
|
-
# **marina_upsert_put_marinas**
|
1510
|
-
> Marina marina_upsert_put_marinas(opts)
|
1511
|
-
|
1512
|
-
Patch an existing model instance or insert a new one into the data source.
|
1513
|
-
|
1514
|
-
### Example
|
1515
|
-
```ruby
|
1516
|
-
# load the gem
|
1517
|
-
require 'dock_genius_api_ruby_client'
|
1518
|
-
|
1519
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1520
|
-
|
1521
|
-
opts = {
|
1522
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | Model instance data
|
1523
|
-
}
|
1524
|
-
|
1525
|
-
begin
|
1526
|
-
#Patch an existing model instance or insert a new one into the data source.
|
1527
|
-
result = api_instance.marina_upsert_put_marinas(opts)
|
1528
|
-
p result
|
1529
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1530
|
-
puts "Exception when calling MarinaApi->marina_upsert_put_marinas: #{e}"
|
1531
|
-
end
|
1532
|
-
```
|
1533
|
-
|
1534
|
-
### Parameters
|
1535
|
-
|
1536
|
-
Name | Type | Description | Notes
|
1537
|
-
------------- | ------------- | ------------- | -------------
|
1538
|
-
**data** | [**Marina**](Marina.md)| Model instance data | [optional]
|
1539
|
-
|
1540
|
-
### Return type
|
1541
|
-
|
1542
|
-
[**Marina**](Marina.md)
|
1543
|
-
|
1544
|
-
### Authorization
|
1545
|
-
|
1546
|
-
No authorization required
|
1547
|
-
|
1548
|
-
### HTTP request headers
|
1549
|
-
|
1550
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1551
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1552
|
-
|
1553
|
-
|
1554
|
-
|
1555
|
-
# **marina_upsert_with_where**
|
1556
|
-
> Marina marina_upsert_with_where(opts)
|
1557
|
-
|
1558
|
-
Update an existing model instance or insert a new one into the data source based on the where criteria.
|
1559
|
-
|
1560
|
-
### Example
|
1561
|
-
```ruby
|
1562
|
-
# load the gem
|
1563
|
-
require 'dock_genius_api_ruby_client'
|
1564
|
-
|
1565
|
-
api_instance = DockGeniusApiRubyClient::MarinaApi.new
|
1566
|
-
|
1567
|
-
opts = {
|
1568
|
-
where: "where_example", # String | Criteria to match model instances
|
1569
|
-
data: DockGeniusApiRubyClient::Marina.new # Marina | An object of model property name/value pairs
|
1570
|
-
}
|
1571
|
-
|
1572
|
-
begin
|
1573
|
-
#Update an existing model instance or insert a new one into the data source based on the where criteria.
|
1574
|
-
result = api_instance.marina_upsert_with_where(opts)
|
1575
|
-
p result
|
1576
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1577
|
-
puts "Exception when calling MarinaApi->marina_upsert_with_where: #{e}"
|
1578
|
-
end
|
1579
|
-
```
|
1580
|
-
|
1581
|
-
### Parameters
|
1582
|
-
|
1583
|
-
Name | Type | Description | Notes
|
1584
|
-
------------- | ------------- | ------------- | -------------
|
1585
|
-
**where** | **String**| Criteria to match model instances | [optional]
|
1586
|
-
**data** | [**Marina**](Marina.md)| An object of model property name/value pairs | [optional]
|
1587
|
-
|
1588
|
-
### Return type
|
1589
|
-
|
1590
|
-
[**Marina**](Marina.md)
|
1591
|
-
|
1592
|
-
### Authorization
|
1593
|
-
|
1594
|
-
No authorization required
|
1595
|
-
|
1596
|
-
### HTTP request headers
|
1597
|
-
|
1598
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1599
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1600
|
-
|
1601
|
-
|
1602
|
-
|