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/Dock.md
DELETED
@@ -1,20 +0,0 @@
|
|
1
|
-
# DockGeniusApiRubyClient::Dock
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**id** | **Float** | | [optional]
|
7
|
-
**common_name** | **String** | The name given to the dock (usually by a marina with many docks). | [default to ""]
|
8
|
-
**image_url** | **String** | The URL to the image that shows this dock | [optional]
|
9
|
-
**location** | [**GeoPoint**](GeoPoint.md) | The coordinates of this dock. If a boundary GeoJSON is provided, this attribute may be overridden at creation or update |
|
10
|
-
**boundary_geo_json** | **String** | A GeoJSON fragment representing the boundary of the slip. If this attribute is provided at creation or update it overrides the location | [optional]
|
11
|
-
**is_slip** | **BOOLEAN** | Indicates if it is a slip (true) or a dock (false) | [default to false]
|
12
|
-
**for_rent** | **BOOLEAN** | Indicates if it is listed for rent | [default to false]
|
13
|
-
**for_sale** | **BOOLEAN** | Indicates if it is listed for sale | [default to false]
|
14
|
-
**source** | **String** | | [optional]
|
15
|
-
**created** | **Date** | | [optional]
|
16
|
-
**last_updated** | **Date** | | [optional]
|
17
|
-
**marina_id** | **Float** | | [optional]
|
18
|
-
**_listing_agent** | [**ListingAgent**](ListingAgent.md) | | [optional]
|
19
|
-
|
20
|
-
|
data/docs/DockApi.md
DELETED
@@ -1,1112 +0,0 @@
|
|
1
|
-
# DockGeniusApiRubyClient::DockApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://localhost/api*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**dock_count**](DockApi.md#dock_count) | **GET** /Docks/count | Count instances of the model matched by where from the data source.
|
8
|
-
[**dock_create**](DockApi.md#dock_create) | **POST** /Docks | Create a new instance of the model and persist it into the data source.
|
9
|
-
[**dock_create_change_stream_get_docks_change_stream**](DockApi.md#dock_create_change_stream_get_docks_change_stream) | **GET** /Docks/change-stream | Create a change stream.
|
10
|
-
[**dock_create_change_stream_post_docks_change_stream**](DockApi.md#dock_create_change_stream_post_docks_change_stream) | **POST** /Docks/change-stream | Create a change stream.
|
11
|
-
[**dock_delete_by_id**](DockApi.md#dock_delete_by_id) | **DELETE** /Docks/{id} | Delete a model instance by {{id}} from the data source.
|
12
|
-
[**dock_exists_get_docksid_exists**](DockApi.md#dock_exists_get_docksid_exists) | **GET** /Docks/{id}/exists | Check whether a model instance exists in the data source.
|
13
|
-
[**dock_exists_head_docksid**](DockApi.md#dock_exists_head_docksid) | **HEAD** /Docks/{id} | Check whether a model instance exists in the data source.
|
14
|
-
[**dock_find**](DockApi.md#dock_find) | **GET** /Docks | Find all instances of the model matched by filter from the data source.
|
15
|
-
[**dock_find_by_id**](DockApi.md#dock_find_by_id) | **GET** /Docks/{id} | Find a model instance by {{id}} from the data source.
|
16
|
-
[**dock_find_one**](DockApi.md#dock_find_one) | **GET** /Docks/findOne | Find first instance of the model matched by filter from the data source.
|
17
|
-
[**dock_prototype_create_listing_agent**](DockApi.md#dock_prototype_create_listing_agent) | **POST** /Docks/{id}/listingAgent | Creates a new instance in listingAgent of this model.
|
18
|
-
[**dock_prototype_destroy_listing_agent**](DockApi.md#dock_prototype_destroy_listing_agent) | **DELETE** /Docks/{id}/listingAgent | Deletes listingAgent of this model.
|
19
|
-
[**dock_prototype_get_listing_agent**](DockApi.md#dock_prototype_get_listing_agent) | **GET** /Docks/{id}/listingAgent | Fetches hasOne relation listingAgent.
|
20
|
-
[**dock_prototype_get_marina**](DockApi.md#dock_prototype_get_marina) | **GET** /Docks/{id}/marina | Fetches belongsTo relation marina.
|
21
|
-
[**dock_prototype_update_attributes_patch_docksid**](DockApi.md#dock_prototype_update_attributes_patch_docksid) | **PATCH** /Docks/{id} | Patch attributes for a model instance and persist it into the data source.
|
22
|
-
[**dock_prototype_update_attributes_put_docksid**](DockApi.md#dock_prototype_update_attributes_put_docksid) | **PUT** /Docks/{id} | Patch attributes for a model instance and persist it into the data source.
|
23
|
-
[**dock_prototype_update_listing_agent**](DockApi.md#dock_prototype_update_listing_agent) | **PUT** /Docks/{id}/listingAgent | Update listingAgent of this model.
|
24
|
-
[**dock_replace_by_id**](DockApi.md#dock_replace_by_id) | **POST** /Docks/{id}/replace | Replace attributes for a model instance and persist it into the data source.
|
25
|
-
[**dock_replace_or_create**](DockApi.md#dock_replace_or_create) | **POST** /Docks/replaceOrCreate | Replace an existing model instance or insert a new one into the data source.
|
26
|
-
[**dock_update_all**](DockApi.md#dock_update_all) | **POST** /Docks/update | Update instances of the model matched by {{where}} from the data source.
|
27
|
-
[**dock_upsert_patch_docks**](DockApi.md#dock_upsert_patch_docks) | **PATCH** /Docks | Patch an existing model instance or insert a new one into the data source.
|
28
|
-
[**dock_upsert_put_docks**](DockApi.md#dock_upsert_put_docks) | **PUT** /Docks | Patch an existing model instance or insert a new one into the data source.
|
29
|
-
[**dock_upsert_with_where**](DockApi.md#dock_upsert_with_where) | **POST** /Docks/upsertWithWhere | Update an existing model instance or insert a new one into the data source based on the where criteria.
|
30
|
-
|
31
|
-
|
32
|
-
# **dock_count**
|
33
|
-
> InlineResponse200 dock_count(opts)
|
34
|
-
|
35
|
-
Count instances of the model matched by where from the data source.
|
36
|
-
|
37
|
-
### Example
|
38
|
-
```ruby
|
39
|
-
# load the gem
|
40
|
-
require 'dock_genius_api_ruby_client'
|
41
|
-
|
42
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
43
|
-
|
44
|
-
opts = {
|
45
|
-
where: "where_example" # String | Criteria to match model instances
|
46
|
-
}
|
47
|
-
|
48
|
-
begin
|
49
|
-
#Count instances of the model matched by where from the data source.
|
50
|
-
result = api_instance.dock_count(opts)
|
51
|
-
p result
|
52
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
53
|
-
puts "Exception when calling DockApi->dock_count: #{e}"
|
54
|
-
end
|
55
|
-
```
|
56
|
-
|
57
|
-
### Parameters
|
58
|
-
|
59
|
-
Name | Type | Description | Notes
|
60
|
-
------------- | ------------- | ------------- | -------------
|
61
|
-
**where** | **String**| Criteria to match model instances | [optional]
|
62
|
-
|
63
|
-
### Return type
|
64
|
-
|
65
|
-
[**InlineResponse200**](InlineResponse200.md)
|
66
|
-
|
67
|
-
### Authorization
|
68
|
-
|
69
|
-
No authorization required
|
70
|
-
|
71
|
-
### HTTP request headers
|
72
|
-
|
73
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
74
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
# **dock_create**
|
79
|
-
> Dock dock_create(opts)
|
80
|
-
|
81
|
-
Create a new instance of the model and persist it into the data source.
|
82
|
-
|
83
|
-
### Example
|
84
|
-
```ruby
|
85
|
-
# load the gem
|
86
|
-
require 'dock_genius_api_ruby_client'
|
87
|
-
|
88
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
89
|
-
|
90
|
-
opts = {
|
91
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | Model instance data
|
92
|
-
}
|
93
|
-
|
94
|
-
begin
|
95
|
-
#Create a new instance of the model and persist it into the data source.
|
96
|
-
result = api_instance.dock_create(opts)
|
97
|
-
p result
|
98
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
99
|
-
puts "Exception when calling DockApi->dock_create: #{e}"
|
100
|
-
end
|
101
|
-
```
|
102
|
-
|
103
|
-
### Parameters
|
104
|
-
|
105
|
-
Name | Type | Description | Notes
|
106
|
-
------------- | ------------- | ------------- | -------------
|
107
|
-
**data** | [**Dock**](Dock.md)| Model instance data | [optional]
|
108
|
-
|
109
|
-
### Return type
|
110
|
-
|
111
|
-
[**Dock**](Dock.md)
|
112
|
-
|
113
|
-
### Authorization
|
114
|
-
|
115
|
-
No authorization required
|
116
|
-
|
117
|
-
### HTTP request headers
|
118
|
-
|
119
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
120
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
# **dock_create_change_stream_get_docks_change_stream**
|
125
|
-
> File dock_create_change_stream_get_docks_change_stream(opts)
|
126
|
-
|
127
|
-
Create a change stream.
|
128
|
-
|
129
|
-
### Example
|
130
|
-
```ruby
|
131
|
-
# load the gem
|
132
|
-
require 'dock_genius_api_ruby_client'
|
133
|
-
|
134
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
135
|
-
|
136
|
-
opts = {
|
137
|
-
options: "options_example" # String |
|
138
|
-
}
|
139
|
-
|
140
|
-
begin
|
141
|
-
#Create a change stream.
|
142
|
-
result = api_instance.dock_create_change_stream_get_docks_change_stream(opts)
|
143
|
-
p result
|
144
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
145
|
-
puts "Exception when calling DockApi->dock_create_change_stream_get_docks_change_stream: #{e}"
|
146
|
-
end
|
147
|
-
```
|
148
|
-
|
149
|
-
### Parameters
|
150
|
-
|
151
|
-
Name | Type | Description | Notes
|
152
|
-
------------- | ------------- | ------------- | -------------
|
153
|
-
**options** | **String**| | [optional]
|
154
|
-
|
155
|
-
### Return type
|
156
|
-
|
157
|
-
**File**
|
158
|
-
|
159
|
-
### Authorization
|
160
|
-
|
161
|
-
No authorization required
|
162
|
-
|
163
|
-
### HTTP request headers
|
164
|
-
|
165
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
166
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
# **dock_create_change_stream_post_docks_change_stream**
|
171
|
-
> File dock_create_change_stream_post_docks_change_stream(opts)
|
172
|
-
|
173
|
-
Create a change stream.
|
174
|
-
|
175
|
-
### Example
|
176
|
-
```ruby
|
177
|
-
# load the gem
|
178
|
-
require 'dock_genius_api_ruby_client'
|
179
|
-
|
180
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
181
|
-
|
182
|
-
opts = {
|
183
|
-
options: "options_example" # String |
|
184
|
-
}
|
185
|
-
|
186
|
-
begin
|
187
|
-
#Create a change stream.
|
188
|
-
result = api_instance.dock_create_change_stream_post_docks_change_stream(opts)
|
189
|
-
p result
|
190
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
191
|
-
puts "Exception when calling DockApi->dock_create_change_stream_post_docks_change_stream: #{e}"
|
192
|
-
end
|
193
|
-
```
|
194
|
-
|
195
|
-
### Parameters
|
196
|
-
|
197
|
-
Name | Type | Description | Notes
|
198
|
-
------------- | ------------- | ------------- | -------------
|
199
|
-
**options** | **String**| | [optional]
|
200
|
-
|
201
|
-
### Return type
|
202
|
-
|
203
|
-
**File**
|
204
|
-
|
205
|
-
### Authorization
|
206
|
-
|
207
|
-
No authorization required
|
208
|
-
|
209
|
-
### HTTP request headers
|
210
|
-
|
211
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
212
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
# **dock_delete_by_id**
|
217
|
-
> Object dock_delete_by_id(id)
|
218
|
-
|
219
|
-
Delete a model instance by {{id}} from the data source.
|
220
|
-
|
221
|
-
### Example
|
222
|
-
```ruby
|
223
|
-
# load the gem
|
224
|
-
require 'dock_genius_api_ruby_client'
|
225
|
-
|
226
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
227
|
-
|
228
|
-
id = "id_example" # String | Model id
|
229
|
-
|
230
|
-
|
231
|
-
begin
|
232
|
-
#Delete a model instance by {{id}} from the data source.
|
233
|
-
result = api_instance.dock_delete_by_id(id)
|
234
|
-
p result
|
235
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
236
|
-
puts "Exception when calling DockApi->dock_delete_by_id: #{e}"
|
237
|
-
end
|
238
|
-
```
|
239
|
-
|
240
|
-
### Parameters
|
241
|
-
|
242
|
-
Name | Type | Description | Notes
|
243
|
-
------------- | ------------- | ------------- | -------------
|
244
|
-
**id** | **String**| Model id |
|
245
|
-
|
246
|
-
### Return type
|
247
|
-
|
248
|
-
**Object**
|
249
|
-
|
250
|
-
### Authorization
|
251
|
-
|
252
|
-
No authorization required
|
253
|
-
|
254
|
-
### HTTP request headers
|
255
|
-
|
256
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
257
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
# **dock_exists_get_docksid_exists**
|
262
|
-
> InlineResponse2002 dock_exists_get_docksid_exists(id)
|
263
|
-
|
264
|
-
Check whether a model instance exists in the data source.
|
265
|
-
|
266
|
-
### Example
|
267
|
-
```ruby
|
268
|
-
# load the gem
|
269
|
-
require 'dock_genius_api_ruby_client'
|
270
|
-
|
271
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
272
|
-
|
273
|
-
id = "id_example" # String | Model id
|
274
|
-
|
275
|
-
|
276
|
-
begin
|
277
|
-
#Check whether a model instance exists in the data source.
|
278
|
-
result = api_instance.dock_exists_get_docksid_exists(id)
|
279
|
-
p result
|
280
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
281
|
-
puts "Exception when calling DockApi->dock_exists_get_docksid_exists: #{e}"
|
282
|
-
end
|
283
|
-
```
|
284
|
-
|
285
|
-
### Parameters
|
286
|
-
|
287
|
-
Name | Type | Description | Notes
|
288
|
-
------------- | ------------- | ------------- | -------------
|
289
|
-
**id** | **String**| Model id |
|
290
|
-
|
291
|
-
### Return type
|
292
|
-
|
293
|
-
[**InlineResponse2002**](InlineResponse2002.md)
|
294
|
-
|
295
|
-
### Authorization
|
296
|
-
|
297
|
-
No authorization required
|
298
|
-
|
299
|
-
### HTTP request headers
|
300
|
-
|
301
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
302
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
# **dock_exists_head_docksid**
|
307
|
-
> InlineResponse2002 dock_exists_head_docksid(id)
|
308
|
-
|
309
|
-
Check whether a model instance exists in the data source.
|
310
|
-
|
311
|
-
### Example
|
312
|
-
```ruby
|
313
|
-
# load the gem
|
314
|
-
require 'dock_genius_api_ruby_client'
|
315
|
-
|
316
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
317
|
-
|
318
|
-
id = "id_example" # String | Model id
|
319
|
-
|
320
|
-
|
321
|
-
begin
|
322
|
-
#Check whether a model instance exists in the data source.
|
323
|
-
result = api_instance.dock_exists_head_docksid(id)
|
324
|
-
p result
|
325
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
326
|
-
puts "Exception when calling DockApi->dock_exists_head_docksid: #{e}"
|
327
|
-
end
|
328
|
-
```
|
329
|
-
|
330
|
-
### Parameters
|
331
|
-
|
332
|
-
Name | Type | Description | Notes
|
333
|
-
------------- | ------------- | ------------- | -------------
|
334
|
-
**id** | **String**| Model id |
|
335
|
-
|
336
|
-
### Return type
|
337
|
-
|
338
|
-
[**InlineResponse2002**](InlineResponse2002.md)
|
339
|
-
|
340
|
-
### Authorization
|
341
|
-
|
342
|
-
No authorization required
|
343
|
-
|
344
|
-
### HTTP request headers
|
345
|
-
|
346
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
347
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
# **dock_find**
|
352
|
-
> Array<Dock> dock_find(opts)
|
353
|
-
|
354
|
-
Find all instances of the model matched by filter from the data source.
|
355
|
-
|
356
|
-
### Example
|
357
|
-
```ruby
|
358
|
-
# load the gem
|
359
|
-
require 'dock_genius_api_ruby_client'
|
360
|
-
|
361
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
362
|
-
|
363
|
-
opts = {
|
364
|
-
filter: "filter_example" # String | Filter defining fields, where, include, order, offset, and limit
|
365
|
-
}
|
366
|
-
|
367
|
-
begin
|
368
|
-
#Find all instances of the model matched by filter from the data source.
|
369
|
-
result = api_instance.dock_find(opts)
|
370
|
-
p result
|
371
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
372
|
-
puts "Exception when calling DockApi->dock_find: #{e}"
|
373
|
-
end
|
374
|
-
```
|
375
|
-
|
376
|
-
### Parameters
|
377
|
-
|
378
|
-
Name | Type | Description | Notes
|
379
|
-
------------- | ------------- | ------------- | -------------
|
380
|
-
**filter** | **String**| Filter defining fields, where, include, order, offset, and limit | [optional]
|
381
|
-
|
382
|
-
### Return type
|
383
|
-
|
384
|
-
[**Array<Dock>**](Dock.md)
|
385
|
-
|
386
|
-
### Authorization
|
387
|
-
|
388
|
-
No authorization required
|
389
|
-
|
390
|
-
### HTTP request headers
|
391
|
-
|
392
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
393
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
# **dock_find_by_id**
|
398
|
-
> Dock dock_find_by_id(id, opts)
|
399
|
-
|
400
|
-
Find a model instance by {{id}} from the data source.
|
401
|
-
|
402
|
-
### Example
|
403
|
-
```ruby
|
404
|
-
# load the gem
|
405
|
-
require 'dock_genius_api_ruby_client'
|
406
|
-
|
407
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
408
|
-
|
409
|
-
id = "id_example" # String | Model id
|
410
|
-
|
411
|
-
opts = {
|
412
|
-
filter: "filter_example" # String | Filter defining fields and include
|
413
|
-
}
|
414
|
-
|
415
|
-
begin
|
416
|
-
#Find a model instance by {{id}} from the data source.
|
417
|
-
result = api_instance.dock_find_by_id(id, opts)
|
418
|
-
p result
|
419
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
420
|
-
puts "Exception when calling DockApi->dock_find_by_id: #{e}"
|
421
|
-
end
|
422
|
-
```
|
423
|
-
|
424
|
-
### Parameters
|
425
|
-
|
426
|
-
Name | Type | Description | Notes
|
427
|
-
------------- | ------------- | ------------- | -------------
|
428
|
-
**id** | **String**| Model id |
|
429
|
-
**filter** | **String**| Filter defining fields and include | [optional]
|
430
|
-
|
431
|
-
### Return type
|
432
|
-
|
433
|
-
[**Dock**](Dock.md)
|
434
|
-
|
435
|
-
### Authorization
|
436
|
-
|
437
|
-
No authorization required
|
438
|
-
|
439
|
-
### HTTP request headers
|
440
|
-
|
441
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
442
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
# **dock_find_one**
|
447
|
-
> Dock dock_find_one(opts)
|
448
|
-
|
449
|
-
Find first instance of the model matched by filter from the data source.
|
450
|
-
|
451
|
-
### Example
|
452
|
-
```ruby
|
453
|
-
# load the gem
|
454
|
-
require 'dock_genius_api_ruby_client'
|
455
|
-
|
456
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
457
|
-
|
458
|
-
opts = {
|
459
|
-
filter: "filter_example" # String | Filter defining fields, where, include, order, offset, and limit
|
460
|
-
}
|
461
|
-
|
462
|
-
begin
|
463
|
-
#Find first instance of the model matched by filter from the data source.
|
464
|
-
result = api_instance.dock_find_one(opts)
|
465
|
-
p result
|
466
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
467
|
-
puts "Exception when calling DockApi->dock_find_one: #{e}"
|
468
|
-
end
|
469
|
-
```
|
470
|
-
|
471
|
-
### Parameters
|
472
|
-
|
473
|
-
Name | Type | Description | Notes
|
474
|
-
------------- | ------------- | ------------- | -------------
|
475
|
-
**filter** | **String**| Filter defining fields, where, include, order, offset, and limit | [optional]
|
476
|
-
|
477
|
-
### Return type
|
478
|
-
|
479
|
-
[**Dock**](Dock.md)
|
480
|
-
|
481
|
-
### Authorization
|
482
|
-
|
483
|
-
No authorization required
|
484
|
-
|
485
|
-
### HTTP request headers
|
486
|
-
|
487
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
488
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
# **dock_prototype_create_listing_agent**
|
493
|
-
> ListingAgent dock_prototype_create_listing_agent(id, opts)
|
494
|
-
|
495
|
-
Creates a new instance in listingAgent of this model.
|
496
|
-
|
497
|
-
### Example
|
498
|
-
```ruby
|
499
|
-
# load the gem
|
500
|
-
require 'dock_genius_api_ruby_client'
|
501
|
-
|
502
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
503
|
-
|
504
|
-
id = "id_example" # String | PersistedModel id
|
505
|
-
|
506
|
-
opts = {
|
507
|
-
data: DockGeniusApiRubyClient::ListingAgent.new # ListingAgent |
|
508
|
-
}
|
509
|
-
|
510
|
-
begin
|
511
|
-
#Creates a new instance in listingAgent of this model.
|
512
|
-
result = api_instance.dock_prototype_create_listing_agent(id, opts)
|
513
|
-
p result
|
514
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
515
|
-
puts "Exception when calling DockApi->dock_prototype_create_listing_agent: #{e}"
|
516
|
-
end
|
517
|
-
```
|
518
|
-
|
519
|
-
### Parameters
|
520
|
-
|
521
|
-
Name | Type | Description | Notes
|
522
|
-
------------- | ------------- | ------------- | -------------
|
523
|
-
**id** | **String**| PersistedModel id |
|
524
|
-
**data** | [**ListingAgent**](ListingAgent.md)| | [optional]
|
525
|
-
|
526
|
-
### Return type
|
527
|
-
|
528
|
-
[**ListingAgent**](ListingAgent.md)
|
529
|
-
|
530
|
-
### Authorization
|
531
|
-
|
532
|
-
No authorization required
|
533
|
-
|
534
|
-
### HTTP request headers
|
535
|
-
|
536
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
537
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
# **dock_prototype_destroy_listing_agent**
|
542
|
-
> dock_prototype_destroy_listing_agent(id)
|
543
|
-
|
544
|
-
Deletes listingAgent of this model.
|
545
|
-
|
546
|
-
### Example
|
547
|
-
```ruby
|
548
|
-
# load the gem
|
549
|
-
require 'dock_genius_api_ruby_client'
|
550
|
-
|
551
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
552
|
-
|
553
|
-
id = "id_example" # String | PersistedModel id
|
554
|
-
|
555
|
-
|
556
|
-
begin
|
557
|
-
#Deletes listingAgent of this model.
|
558
|
-
api_instance.dock_prototype_destroy_listing_agent(id)
|
559
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
560
|
-
puts "Exception when calling DockApi->dock_prototype_destroy_listing_agent: #{e}"
|
561
|
-
end
|
562
|
-
```
|
563
|
-
|
564
|
-
### Parameters
|
565
|
-
|
566
|
-
Name | Type | Description | Notes
|
567
|
-
------------- | ------------- | ------------- | -------------
|
568
|
-
**id** | **String**| PersistedModel id |
|
569
|
-
|
570
|
-
### Return type
|
571
|
-
|
572
|
-
nil (empty response body)
|
573
|
-
|
574
|
-
### Authorization
|
575
|
-
|
576
|
-
No authorization required
|
577
|
-
|
578
|
-
### HTTP request headers
|
579
|
-
|
580
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
581
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
# **dock_prototype_get_listing_agent**
|
586
|
-
> ListingAgent dock_prototype_get_listing_agent(id, opts)
|
587
|
-
|
588
|
-
Fetches hasOne relation listingAgent.
|
589
|
-
|
590
|
-
### Example
|
591
|
-
```ruby
|
592
|
-
# load the gem
|
593
|
-
require 'dock_genius_api_ruby_client'
|
594
|
-
|
595
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
596
|
-
|
597
|
-
id = "id_example" # String | PersistedModel id
|
598
|
-
|
599
|
-
opts = {
|
600
|
-
refresh: true # BOOLEAN |
|
601
|
-
}
|
602
|
-
|
603
|
-
begin
|
604
|
-
#Fetches hasOne relation listingAgent.
|
605
|
-
result = api_instance.dock_prototype_get_listing_agent(id, opts)
|
606
|
-
p result
|
607
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
608
|
-
puts "Exception when calling DockApi->dock_prototype_get_listing_agent: #{e}"
|
609
|
-
end
|
610
|
-
```
|
611
|
-
|
612
|
-
### Parameters
|
613
|
-
|
614
|
-
Name | Type | Description | Notes
|
615
|
-
------------- | ------------- | ------------- | -------------
|
616
|
-
**id** | **String**| PersistedModel id |
|
617
|
-
**refresh** | **BOOLEAN**| | [optional]
|
618
|
-
|
619
|
-
### Return type
|
620
|
-
|
621
|
-
[**ListingAgent**](ListingAgent.md)
|
622
|
-
|
623
|
-
### Authorization
|
624
|
-
|
625
|
-
No authorization required
|
626
|
-
|
627
|
-
### HTTP request headers
|
628
|
-
|
629
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
630
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
# **dock_prototype_get_marina**
|
635
|
-
> Marina dock_prototype_get_marina(id, opts)
|
636
|
-
|
637
|
-
Fetches belongsTo relation marina.
|
638
|
-
|
639
|
-
### Example
|
640
|
-
```ruby
|
641
|
-
# load the gem
|
642
|
-
require 'dock_genius_api_ruby_client'
|
643
|
-
|
644
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
645
|
-
|
646
|
-
id = "id_example" # String | PersistedModel id
|
647
|
-
|
648
|
-
opts = {
|
649
|
-
refresh: true # BOOLEAN |
|
650
|
-
}
|
651
|
-
|
652
|
-
begin
|
653
|
-
#Fetches belongsTo relation marina.
|
654
|
-
result = api_instance.dock_prototype_get_marina(id, opts)
|
655
|
-
p result
|
656
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
657
|
-
puts "Exception when calling DockApi->dock_prototype_get_marina: #{e}"
|
658
|
-
end
|
659
|
-
```
|
660
|
-
|
661
|
-
### Parameters
|
662
|
-
|
663
|
-
Name | Type | Description | Notes
|
664
|
-
------------- | ------------- | ------------- | -------------
|
665
|
-
**id** | **String**| PersistedModel id |
|
666
|
-
**refresh** | **BOOLEAN**| | [optional]
|
667
|
-
|
668
|
-
### Return type
|
669
|
-
|
670
|
-
[**Marina**](Marina.md)
|
671
|
-
|
672
|
-
### Authorization
|
673
|
-
|
674
|
-
No authorization required
|
675
|
-
|
676
|
-
### HTTP request headers
|
677
|
-
|
678
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
679
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
# **dock_prototype_update_attributes_patch_docksid**
|
684
|
-
> Dock dock_prototype_update_attributes_patch_docksid(id, opts)
|
685
|
-
|
686
|
-
Patch attributes for a model instance and persist it into the data source.
|
687
|
-
|
688
|
-
### Example
|
689
|
-
```ruby
|
690
|
-
# load the gem
|
691
|
-
require 'dock_genius_api_ruby_client'
|
692
|
-
|
693
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
694
|
-
|
695
|
-
id = "id_example" # String | PersistedModel id
|
696
|
-
|
697
|
-
opts = {
|
698
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | An object of model property name/value pairs
|
699
|
-
}
|
700
|
-
|
701
|
-
begin
|
702
|
-
#Patch attributes for a model instance and persist it into the data source.
|
703
|
-
result = api_instance.dock_prototype_update_attributes_patch_docksid(id, opts)
|
704
|
-
p result
|
705
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
706
|
-
puts "Exception when calling DockApi->dock_prototype_update_attributes_patch_docksid: #{e}"
|
707
|
-
end
|
708
|
-
```
|
709
|
-
|
710
|
-
### Parameters
|
711
|
-
|
712
|
-
Name | Type | Description | Notes
|
713
|
-
------------- | ------------- | ------------- | -------------
|
714
|
-
**id** | **String**| PersistedModel id |
|
715
|
-
**data** | [**Dock**](Dock.md)| An object of model property name/value pairs | [optional]
|
716
|
-
|
717
|
-
### Return type
|
718
|
-
|
719
|
-
[**Dock**](Dock.md)
|
720
|
-
|
721
|
-
### Authorization
|
722
|
-
|
723
|
-
No authorization required
|
724
|
-
|
725
|
-
### HTTP request headers
|
726
|
-
|
727
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
728
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
# **dock_prototype_update_attributes_put_docksid**
|
733
|
-
> Dock dock_prototype_update_attributes_put_docksid(id, opts)
|
734
|
-
|
735
|
-
Patch attributes for a model instance and persist it into the data source.
|
736
|
-
|
737
|
-
### Example
|
738
|
-
```ruby
|
739
|
-
# load the gem
|
740
|
-
require 'dock_genius_api_ruby_client'
|
741
|
-
|
742
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
743
|
-
|
744
|
-
id = "id_example" # String | PersistedModel id
|
745
|
-
|
746
|
-
opts = {
|
747
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | An object of model property name/value pairs
|
748
|
-
}
|
749
|
-
|
750
|
-
begin
|
751
|
-
#Patch attributes for a model instance and persist it into the data source.
|
752
|
-
result = api_instance.dock_prototype_update_attributes_put_docksid(id, opts)
|
753
|
-
p result
|
754
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
755
|
-
puts "Exception when calling DockApi->dock_prototype_update_attributes_put_docksid: #{e}"
|
756
|
-
end
|
757
|
-
```
|
758
|
-
|
759
|
-
### Parameters
|
760
|
-
|
761
|
-
Name | Type | Description | Notes
|
762
|
-
------------- | ------------- | ------------- | -------------
|
763
|
-
**id** | **String**| PersistedModel id |
|
764
|
-
**data** | [**Dock**](Dock.md)| An object of model property name/value pairs | [optional]
|
765
|
-
|
766
|
-
### Return type
|
767
|
-
|
768
|
-
[**Dock**](Dock.md)
|
769
|
-
|
770
|
-
### Authorization
|
771
|
-
|
772
|
-
No authorization required
|
773
|
-
|
774
|
-
### HTTP request headers
|
775
|
-
|
776
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
777
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
778
|
-
|
779
|
-
|
780
|
-
|
781
|
-
# **dock_prototype_update_listing_agent**
|
782
|
-
> ListingAgent dock_prototype_update_listing_agent(id, opts)
|
783
|
-
|
784
|
-
Update listingAgent of this model.
|
785
|
-
|
786
|
-
### Example
|
787
|
-
```ruby
|
788
|
-
# load the gem
|
789
|
-
require 'dock_genius_api_ruby_client'
|
790
|
-
|
791
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
792
|
-
|
793
|
-
id = "id_example" # String | PersistedModel id
|
794
|
-
|
795
|
-
opts = {
|
796
|
-
data: DockGeniusApiRubyClient::ListingAgent.new # ListingAgent |
|
797
|
-
}
|
798
|
-
|
799
|
-
begin
|
800
|
-
#Update listingAgent of this model.
|
801
|
-
result = api_instance.dock_prototype_update_listing_agent(id, opts)
|
802
|
-
p result
|
803
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
804
|
-
puts "Exception when calling DockApi->dock_prototype_update_listing_agent: #{e}"
|
805
|
-
end
|
806
|
-
```
|
807
|
-
|
808
|
-
### Parameters
|
809
|
-
|
810
|
-
Name | Type | Description | Notes
|
811
|
-
------------- | ------------- | ------------- | -------------
|
812
|
-
**id** | **String**| PersistedModel id |
|
813
|
-
**data** | [**ListingAgent**](ListingAgent.md)| | [optional]
|
814
|
-
|
815
|
-
### Return type
|
816
|
-
|
817
|
-
[**ListingAgent**](ListingAgent.md)
|
818
|
-
|
819
|
-
### Authorization
|
820
|
-
|
821
|
-
No authorization required
|
822
|
-
|
823
|
-
### HTTP request headers
|
824
|
-
|
825
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
826
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
# **dock_replace_by_id**
|
831
|
-
> Dock dock_replace_by_id(id, opts)
|
832
|
-
|
833
|
-
Replace attributes for a model instance and persist it into the data source.
|
834
|
-
|
835
|
-
### Example
|
836
|
-
```ruby
|
837
|
-
# load the gem
|
838
|
-
require 'dock_genius_api_ruby_client'
|
839
|
-
|
840
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
841
|
-
|
842
|
-
id = "id_example" # String | Model id
|
843
|
-
|
844
|
-
opts = {
|
845
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | Model instance data
|
846
|
-
}
|
847
|
-
|
848
|
-
begin
|
849
|
-
#Replace attributes for a model instance and persist it into the data source.
|
850
|
-
result = api_instance.dock_replace_by_id(id, opts)
|
851
|
-
p result
|
852
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
853
|
-
puts "Exception when calling DockApi->dock_replace_by_id: #{e}"
|
854
|
-
end
|
855
|
-
```
|
856
|
-
|
857
|
-
### Parameters
|
858
|
-
|
859
|
-
Name | Type | Description | Notes
|
860
|
-
------------- | ------------- | ------------- | -------------
|
861
|
-
**id** | **String**| Model id |
|
862
|
-
**data** | [**Dock**](Dock.md)| Model instance data | [optional]
|
863
|
-
|
864
|
-
### Return type
|
865
|
-
|
866
|
-
[**Dock**](Dock.md)
|
867
|
-
|
868
|
-
### Authorization
|
869
|
-
|
870
|
-
No authorization required
|
871
|
-
|
872
|
-
### HTTP request headers
|
873
|
-
|
874
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
875
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
876
|
-
|
877
|
-
|
878
|
-
|
879
|
-
# **dock_replace_or_create**
|
880
|
-
> Dock dock_replace_or_create(opts)
|
881
|
-
|
882
|
-
Replace an existing model instance or insert a new one into the data source.
|
883
|
-
|
884
|
-
### Example
|
885
|
-
```ruby
|
886
|
-
# load the gem
|
887
|
-
require 'dock_genius_api_ruby_client'
|
888
|
-
|
889
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
890
|
-
|
891
|
-
opts = {
|
892
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | Model instance data
|
893
|
-
}
|
894
|
-
|
895
|
-
begin
|
896
|
-
#Replace an existing model instance or insert a new one into the data source.
|
897
|
-
result = api_instance.dock_replace_or_create(opts)
|
898
|
-
p result
|
899
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
900
|
-
puts "Exception when calling DockApi->dock_replace_or_create: #{e}"
|
901
|
-
end
|
902
|
-
```
|
903
|
-
|
904
|
-
### Parameters
|
905
|
-
|
906
|
-
Name | Type | Description | Notes
|
907
|
-
------------- | ------------- | ------------- | -------------
|
908
|
-
**data** | [**Dock**](Dock.md)| Model instance data | [optional]
|
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
|
-
# **dock_update_all**
|
926
|
-
> InlineResponse2001 dock_update_all(opts)
|
927
|
-
|
928
|
-
Update instances of the model matched by {{where}} from the data source.
|
929
|
-
|
930
|
-
### Example
|
931
|
-
```ruby
|
932
|
-
# load the gem
|
933
|
-
require 'dock_genius_api_ruby_client'
|
934
|
-
|
935
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
936
|
-
|
937
|
-
opts = {
|
938
|
-
where: "where_example", # String | Criteria to match model instances
|
939
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | An object of model property name/value pairs
|
940
|
-
}
|
941
|
-
|
942
|
-
begin
|
943
|
-
#Update instances of the model matched by {{where}} from the data source.
|
944
|
-
result = api_instance.dock_update_all(opts)
|
945
|
-
p result
|
946
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
947
|
-
puts "Exception when calling DockApi->dock_update_all: #{e}"
|
948
|
-
end
|
949
|
-
```
|
950
|
-
|
951
|
-
### Parameters
|
952
|
-
|
953
|
-
Name | Type | Description | Notes
|
954
|
-
------------- | ------------- | ------------- | -------------
|
955
|
-
**where** | **String**| Criteria to match model instances | [optional]
|
956
|
-
**data** | [**Dock**](Dock.md)| An object of model property name/value pairs | [optional]
|
957
|
-
|
958
|
-
### Return type
|
959
|
-
|
960
|
-
[**InlineResponse2001**](InlineResponse2001.md)
|
961
|
-
|
962
|
-
### Authorization
|
963
|
-
|
964
|
-
No authorization required
|
965
|
-
|
966
|
-
### HTTP request headers
|
967
|
-
|
968
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
969
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
970
|
-
|
971
|
-
|
972
|
-
|
973
|
-
# **dock_upsert_patch_docks**
|
974
|
-
> Dock dock_upsert_patch_docks(opts)
|
975
|
-
|
976
|
-
Patch an existing model instance or insert a new one into the data source.
|
977
|
-
|
978
|
-
### Example
|
979
|
-
```ruby
|
980
|
-
# load the gem
|
981
|
-
require 'dock_genius_api_ruby_client'
|
982
|
-
|
983
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
984
|
-
|
985
|
-
opts = {
|
986
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | Model instance data
|
987
|
-
}
|
988
|
-
|
989
|
-
begin
|
990
|
-
#Patch an existing model instance or insert a new one into the data source.
|
991
|
-
result = api_instance.dock_upsert_patch_docks(opts)
|
992
|
-
p result
|
993
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
994
|
-
puts "Exception when calling DockApi->dock_upsert_patch_docks: #{e}"
|
995
|
-
end
|
996
|
-
```
|
997
|
-
|
998
|
-
### Parameters
|
999
|
-
|
1000
|
-
Name | Type | Description | Notes
|
1001
|
-
------------- | ------------- | ------------- | -------------
|
1002
|
-
**data** | [**Dock**](Dock.md)| Model instance data | [optional]
|
1003
|
-
|
1004
|
-
### Return type
|
1005
|
-
|
1006
|
-
[**Dock**](Dock.md)
|
1007
|
-
|
1008
|
-
### Authorization
|
1009
|
-
|
1010
|
-
No authorization required
|
1011
|
-
|
1012
|
-
### HTTP request headers
|
1013
|
-
|
1014
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1015
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
# **dock_upsert_put_docks**
|
1020
|
-
> Dock dock_upsert_put_docks(opts)
|
1021
|
-
|
1022
|
-
Patch an existing model instance or insert a new one into the data source.
|
1023
|
-
|
1024
|
-
### Example
|
1025
|
-
```ruby
|
1026
|
-
# load the gem
|
1027
|
-
require 'dock_genius_api_ruby_client'
|
1028
|
-
|
1029
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
1030
|
-
|
1031
|
-
opts = {
|
1032
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | Model instance data
|
1033
|
-
}
|
1034
|
-
|
1035
|
-
begin
|
1036
|
-
#Patch an existing model instance or insert a new one into the data source.
|
1037
|
-
result = api_instance.dock_upsert_put_docks(opts)
|
1038
|
-
p result
|
1039
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1040
|
-
puts "Exception when calling DockApi->dock_upsert_put_docks: #{e}"
|
1041
|
-
end
|
1042
|
-
```
|
1043
|
-
|
1044
|
-
### Parameters
|
1045
|
-
|
1046
|
-
Name | Type | Description | Notes
|
1047
|
-
------------- | ------------- | ------------- | -------------
|
1048
|
-
**data** | [**Dock**](Dock.md)| Model instance data | [optional]
|
1049
|
-
|
1050
|
-
### Return type
|
1051
|
-
|
1052
|
-
[**Dock**](Dock.md)
|
1053
|
-
|
1054
|
-
### Authorization
|
1055
|
-
|
1056
|
-
No authorization required
|
1057
|
-
|
1058
|
-
### HTTP request headers
|
1059
|
-
|
1060
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1061
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1062
|
-
|
1063
|
-
|
1064
|
-
|
1065
|
-
# **dock_upsert_with_where**
|
1066
|
-
> Dock dock_upsert_with_where(opts)
|
1067
|
-
|
1068
|
-
Update an existing model instance or insert a new one into the data source based on the where criteria.
|
1069
|
-
|
1070
|
-
### Example
|
1071
|
-
```ruby
|
1072
|
-
# load the gem
|
1073
|
-
require 'dock_genius_api_ruby_client'
|
1074
|
-
|
1075
|
-
api_instance = DockGeniusApiRubyClient::DockApi.new
|
1076
|
-
|
1077
|
-
opts = {
|
1078
|
-
where: "where_example", # String | Criteria to match model instances
|
1079
|
-
data: DockGeniusApiRubyClient::Dock.new # Dock | An object of model property name/value pairs
|
1080
|
-
}
|
1081
|
-
|
1082
|
-
begin
|
1083
|
-
#Update an existing model instance or insert a new one into the data source based on the where criteria.
|
1084
|
-
result = api_instance.dock_upsert_with_where(opts)
|
1085
|
-
p result
|
1086
|
-
rescue DockGeniusApiRubyClient::ApiError => e
|
1087
|
-
puts "Exception when calling DockApi->dock_upsert_with_where: #{e}"
|
1088
|
-
end
|
1089
|
-
```
|
1090
|
-
|
1091
|
-
### Parameters
|
1092
|
-
|
1093
|
-
Name | Type | Description | Notes
|
1094
|
-
------------- | ------------- | ------------- | -------------
|
1095
|
-
**where** | **String**| Criteria to match model instances | [optional]
|
1096
|
-
**data** | [**Dock**](Dock.md)| An object of model property name/value pairs | [optional]
|
1097
|
-
|
1098
|
-
### Return type
|
1099
|
-
|
1100
|
-
[**Dock**](Dock.md)
|
1101
|
-
|
1102
|
-
### Authorization
|
1103
|
-
|
1104
|
-
No authorization required
|
1105
|
-
|
1106
|
-
### HTTP request headers
|
1107
|
-
|
1108
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
|
1109
|
-
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
|
1110
|
-
|
1111
|
-
|
1112
|
-
|