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.
Files changed (62) hide show
  1. checksums.yaml +4 -4
  2. data/config.json +10 -0
  3. data/dg-api-gem +1 -0
  4. data/swagger.yml +3075 -0
  5. metadata +170 -78
  6. data/LICENSE +0 -201
  7. data/README.md +0 -200
  8. data/dock_genius_api_ruby_client.gemspec +0 -55
  9. data/docs/AccessToken.md +0 -11
  10. data/docs/Address.md +0 -16
  11. data/docs/Customer.md +0 -22
  12. data/docs/CustomerApi.md +0 -1938
  13. data/docs/Dock.md +0 -20
  14. data/docs/DockApi.md +0 -1112
  15. data/docs/EmailAddress.md +0 -9
  16. data/docs/GeoPoint.md +0 -9
  17. data/docs/InlineResponse200.md +0 -8
  18. data/docs/InlineResponse2001.md +0 -8
  19. data/docs/InlineResponse2002.md +0 -8
  20. data/docs/ListingAgent.md +0 -12
  21. data/docs/Marina.md +0 -15
  22. data/docs/MarinaApi.md +0 -1602
  23. data/docs/Phone.md +0 -9
  24. data/git_push.sh +0 -67
  25. data/lib/dock_genius_api_ruby_client.rb +0 -65
  26. data/lib/dock_genius_api_ruby_client/api/customer_api.rb +0 -2363
  27. data/lib/dock_genius_api_ruby_client/api/dock_api.rb +0 -1352
  28. data/lib/dock_genius_api_ruby_client/api/marina_api.rb +0 -1945
  29. data/lib/dock_genius_api_ruby_client/api_client.rb +0 -378
  30. data/lib/dock_genius_api_ruby_client/api_error.rb +0 -47
  31. data/lib/dock_genius_api_ruby_client/configuration.rb +0 -207
  32. data/lib/dock_genius_api_ruby_client/models/access_token.rb +0 -230
  33. data/lib/dock_genius_api_ruby_client/models/address.rb +0 -281
  34. data/lib/dock_genius_api_ruby_client/models/customer.rb +0 -330
  35. data/lib/dock_genius_api_ruby_client/models/dock.rb +0 -327
  36. data/lib/dock_genius_api_ruby_client/models/email_address.rb +0 -208
  37. data/lib/dock_genius_api_ruby_client/models/geo_point.rb +0 -208
  38. data/lib/dock_genius_api_ruby_client/models/inline_response_200.rb +0 -199
  39. data/lib/dock_genius_api_ruby_client/models/inline_response_200_1.rb +0 -200
  40. data/lib/dock_genius_api_ruby_client/models/inline_response_200_2.rb +0 -199
  41. data/lib/dock_genius_api_ruby_client/models/listing_agent.rb +0 -239
  42. data/lib/dock_genius_api_ruby_client/models/marina.rb +0 -263
  43. data/lib/dock_genius_api_ruby_client/models/phone.rb +0 -209
  44. data/lib/dock_genius_api_ruby_client/version.rb +0 -26
  45. data/spec/api/customer_api_spec.rb +0 -551
  46. data/spec/api/dock_api_spec.rb +0 -332
  47. data/spec/api/marina_api_spec.rb +0 -461
  48. data/spec/api_client_spec.rb +0 -237
  49. data/spec/configuration_spec.rb +0 -53
  50. data/spec/models/access_token_spec.rb +0 -71
  51. data/spec/models/address_spec.rb +0 -101
  52. data/spec/models/customer_spec.rb +0 -137
  53. data/spec/models/dock_spec.rb +0 -125
  54. data/spec/models/email_address_spec.rb +0 -59
  55. data/spec/models/geo_point_spec.rb +0 -59
  56. data/spec/models/inline_response_200_1_spec.rb +0 -53
  57. data/spec/models/inline_response_200_2_spec.rb +0 -53
  58. data/spec/models/inline_response_200_spec.rb +0 -53
  59. data/spec/models/listing_agent_spec.rb +0 -77
  60. data/spec/models/marina_spec.rb +0 -95
  61. data/spec/models/phone_spec.rb +0 -59
  62. data/spec/spec_helper.rb +0 -122
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 237598f38727310aedde47de4d0f170951c2e4fe
4
- data.tar.gz: 8811b2dbcc8ead0b410433ac3e3c59a2cd663cc7
3
+ metadata.gz: 57eca49e500dc463ad162201daaf9fdaced7285e
4
+ data.tar.gz: ea9b603649b1051e79bf1fa5c74b2f2c401dc285
5
5
  SHA512:
6
- metadata.gz: 721ba425029cd1ae51589c3760815a0e9e677ecdee0baba77ce24adde590752447cb4a9a8232737c159932571e09fa74da63f452826f49934065cfd6d51fbbb9
7
- data.tar.gz: a92c6e17363319df921c37f743f2673b138f90a5a5eebd4d188fe611d099f6ddd5f1ee7366e9530657a95de1670b1e23a3ccd3c8edcdf05a63b7a8f18d55a678
6
+ metadata.gz: d7e48c3a34246e814d7ece207c05d21032aa1001f822b2f8d708d1ee812894da9a8aeaba301796090b8cd5601e14d2a55022c7e3699e1763ca782b644655ad2f
7
+ data.tar.gz: 77e40ae88c92339fbc448531457f64710a324a4d8897b6545cc6e94b9464e00cbe2101b681b9810245172f09dddaf6f88382376d2a467bea0c873ab390c7fc6d
@@ -0,0 +1,10 @@
1
+ {
2
+ "gemName" : "dock_genius_api_ruby_client",
3
+ "moduleName" : "DockGeniusApiRubyClient",
4
+ "gemAuthor" : "The DockGenius Engineering Team",
5
+ "gemAuthorEmail" : "hi@dockgenius.com",
6
+ "gemLicense" : "Nonstandard",
7
+ "gemVersion" : "0.1.2-ge30447",
8
+ "gemSummary" : "A ruby gem for the DockGenius API",
9
+ "gemDescription" : "Use this gem to access the DockGenius API using Ruby"
10
+ }
@@ -0,0 +1 @@
1
+ Subproject commit 453cc136420e8bf8c26ad9a87676e684d011ff8f-dirty
@@ -0,0 +1,3075 @@
1
+ swagger: '2.0'
2
+ info:
3
+ version: 0.1.0
4
+ title: DockGenius API
5
+ appDescription: API for the DockGenius platform https://dockgenius.com
6
+ termsOfService: https://dockgenius.com/terms/
7
+ contact:
8
+ name: DockGenius Support
9
+ url: https://dockgenius.com/support
10
+ email: hi@dockgenius.com
11
+ basePath: /api
12
+ paths:
13
+ '/Customers/{id}/accessTokens/{fk}':
14
+ get:
15
+ tags:
16
+ - Customer
17
+ summary: Find a related item by id for accessTokens.
18
+ operationId: Customer.prototype.__findById__accessTokens
19
+ parameters:
20
+ - name: fk
21
+ in: path
22
+ description: Foreign key for accessTokens
23
+ required: true
24
+ type: string
25
+ format: JSON
26
+ - name: id
27
+ in: path
28
+ description: User id
29
+ required: true
30
+ type: string
31
+ format: JSON
32
+ responses:
33
+ '200':
34
+ description: Request was successful
35
+ schema:
36
+ $ref: '#/definitions/AccessToken'
37
+ deprecated: false
38
+ delete:
39
+ tags:
40
+ - Customer
41
+ summary: Delete a related item by id for accessTokens.
42
+ operationId: Customer.prototype.__destroyById__accessTokens
43
+ parameters:
44
+ - name: fk
45
+ in: path
46
+ description: Foreign key for accessTokens
47
+ required: true
48
+ type: string
49
+ format: JSON
50
+ - name: id
51
+ in: path
52
+ description: User id
53
+ required: true
54
+ type: string
55
+ format: JSON
56
+ responses:
57
+ '204':
58
+ description: Request was successful
59
+ deprecated: false
60
+ put:
61
+ tags:
62
+ - Customer
63
+ summary: Update a related item by id for accessTokens.
64
+ operationId: Customer.prototype.__updateById__accessTokens
65
+ parameters:
66
+ - name: fk
67
+ in: path
68
+ description: Foreign key for accessTokens
69
+ required: true
70
+ type: string
71
+ format: JSON
72
+ - name: data
73
+ in: body
74
+ required: false
75
+ schema:
76
+ $ref: '#/definitions/AccessToken'
77
+ - name: id
78
+ in: path
79
+ description: User id
80
+ required: true
81
+ type: string
82
+ format: JSON
83
+ responses:
84
+ '200':
85
+ description: Request was successful
86
+ schema:
87
+ $ref: '#/definitions/AccessToken'
88
+ deprecated: false
89
+ '/Customers/{id}/address':
90
+ get:
91
+ tags:
92
+ - Customer
93
+ summary: Fetches hasOne relation address.
94
+ operationId: Customer.prototype.__get__address
95
+ parameters:
96
+ - name: refresh
97
+ in: query
98
+ required: false
99
+ type: boolean
100
+ - name: id
101
+ in: path
102
+ description: User id
103
+ required: true
104
+ type: string
105
+ format: JSON
106
+ responses:
107
+ '200':
108
+ description: Request was successful
109
+ schema:
110
+ $ref: '#/definitions/Address'
111
+ deprecated: false
112
+ post:
113
+ tags:
114
+ - Customer
115
+ summary: Creates a new instance in address of this model.
116
+ operationId: Customer.prototype.__create__address
117
+ parameters:
118
+ - name: data
119
+ in: body
120
+ required: false
121
+ schema:
122
+ $ref: '#/definitions/Address'
123
+ - name: id
124
+ in: path
125
+ description: User id
126
+ required: true
127
+ type: string
128
+ format: JSON
129
+ responses:
130
+ '200':
131
+ description: Request was successful
132
+ schema:
133
+ $ref: '#/definitions/Address'
134
+ deprecated: false
135
+ put:
136
+ tags:
137
+ - Customer
138
+ summary: Update address of this model.
139
+ operationId: Customer.prototype.__update__address
140
+ parameters:
141
+ - name: data
142
+ in: body
143
+ required: false
144
+ schema:
145
+ $ref: '#/definitions/Address'
146
+ - name: id
147
+ in: path
148
+ description: User id
149
+ required: true
150
+ type: string
151
+ format: JSON
152
+ responses:
153
+ '200':
154
+ description: Request was successful
155
+ schema:
156
+ $ref: '#/definitions/Address'
157
+ deprecated: false
158
+ delete:
159
+ tags:
160
+ - Customer
161
+ summary: Deletes address of this model.
162
+ operationId: Customer.prototype.__destroy__address
163
+ parameters:
164
+ - name: id
165
+ in: path
166
+ description: User id
167
+ required: true
168
+ type: string
169
+ format: JSON
170
+ responses:
171
+ '204':
172
+ description: Request was successful
173
+ deprecated: false
174
+ '/Customers/{id}/emails/{fk}':
175
+ get:
176
+ tags:
177
+ - Customer
178
+ summary: Find a related item by id for emails.
179
+ operationId: Customer.prototype.__findById__emails
180
+ parameters:
181
+ - name: fk
182
+ in: path
183
+ description: Foreign key for emails
184
+ required: true
185
+ type: string
186
+ format: JSON
187
+ - name: id
188
+ in: path
189
+ description: User id
190
+ required: true
191
+ type: string
192
+ format: JSON
193
+ responses:
194
+ '200':
195
+ description: Request was successful
196
+ schema:
197
+ $ref: '#/definitions/EmailAddress'
198
+ deprecated: false
199
+ delete:
200
+ tags:
201
+ - Customer
202
+ summary: Delete a related item by id for emails.
203
+ operationId: Customer.prototype.__destroyById__emails
204
+ parameters:
205
+ - name: fk
206
+ in: path
207
+ description: Foreign key for emails
208
+ required: true
209
+ type: string
210
+ format: JSON
211
+ - name: id
212
+ in: path
213
+ description: User id
214
+ required: true
215
+ type: string
216
+ format: JSON
217
+ responses:
218
+ '204':
219
+ description: Request was successful
220
+ deprecated: false
221
+ put:
222
+ tags:
223
+ - Customer
224
+ summary: Update a related item by id for emails.
225
+ operationId: Customer.prototype.__updateById__emails
226
+ parameters:
227
+ - name: fk
228
+ in: path
229
+ description: Foreign key for emails
230
+ required: true
231
+ type: string
232
+ format: JSON
233
+ - name: data
234
+ in: body
235
+ required: false
236
+ schema:
237
+ $ref: '#/definitions/EmailAddress'
238
+ - name: id
239
+ in: path
240
+ description: User id
241
+ required: true
242
+ type: string
243
+ format: JSON
244
+ responses:
245
+ '200':
246
+ description: Request was successful
247
+ schema:
248
+ $ref: '#/definitions/EmailAddress'
249
+ deprecated: false
250
+ '/Customers/{id}/accessTokens':
251
+ get:
252
+ tags:
253
+ - Customer
254
+ summary: Queries accessTokens of Customer.
255
+ operationId: Customer.prototype.__get__accessTokens
256
+ parameters:
257
+ - name: filter
258
+ in: query
259
+ required: false
260
+ type: string
261
+ format: JSON
262
+ - name: id
263
+ in: path
264
+ description: User id
265
+ required: true
266
+ type: string
267
+ format: JSON
268
+ responses:
269
+ '200':
270
+ description: Request was successful
271
+ schema:
272
+ type: array
273
+ items:
274
+ $ref: '#/definitions/AccessToken'
275
+ deprecated: false
276
+ post:
277
+ tags:
278
+ - Customer
279
+ summary: Creates a new instance in accessTokens of this model.
280
+ operationId: Customer.prototype.__create__accessTokens
281
+ parameters:
282
+ - name: data
283
+ in: body
284
+ required: false
285
+ schema:
286
+ $ref: '#/definitions/AccessToken'
287
+ - name: id
288
+ in: path
289
+ description: User id
290
+ required: true
291
+ type: string
292
+ format: JSON
293
+ responses:
294
+ '200':
295
+ description: Request was successful
296
+ schema:
297
+ $ref: '#/definitions/AccessToken'
298
+ deprecated: false
299
+ delete:
300
+ tags:
301
+ - Customer
302
+ summary: Deletes all accessTokens of this model.
303
+ operationId: Customer.prototype.__delete__accessTokens
304
+ parameters:
305
+ - name: id
306
+ in: path
307
+ description: User id
308
+ required: true
309
+ type: string
310
+ format: JSON
311
+ responses:
312
+ '204':
313
+ description: Request was successful
314
+ deprecated: false
315
+ '/Customers/{id}/accessTokens/count':
316
+ get:
317
+ tags:
318
+ - Customer
319
+ summary: Counts accessTokens of Customer.
320
+ operationId: Customer.prototype.__count__accessTokens
321
+ parameters:
322
+ - name: where
323
+ in: query
324
+ description: Criteria to match model instances
325
+ required: false
326
+ type: string
327
+ format: JSON
328
+ - name: id
329
+ in: path
330
+ description: User id
331
+ required: true
332
+ type: string
333
+ format: JSON
334
+ responses:
335
+ '200':
336
+ description: Request was successful
337
+ schema:
338
+ type: object
339
+ properties:
340
+ count:
341
+ type: number
342
+ format: double
343
+ deprecated: false
344
+ '/Customers/{id}/emails':
345
+ get:
346
+ tags:
347
+ - Customer
348
+ summary: Queries emails of Customer.
349
+ operationId: Customer.prototype.__get__emails
350
+ parameters:
351
+ - name: filter
352
+ in: query
353
+ required: false
354
+ type: string
355
+ format: JSON
356
+ - name: id
357
+ in: path
358
+ description: User id
359
+ required: true
360
+ type: string
361
+ format: JSON
362
+ responses:
363
+ '200':
364
+ description: Request was successful
365
+ schema:
366
+ type: array
367
+ items:
368
+ $ref: '#/definitions/EmailAddress'
369
+ deprecated: false
370
+ post:
371
+ tags:
372
+ - Customer
373
+ summary: Creates a new instance in emails of this model.
374
+ operationId: Customer.prototype.__create__emails
375
+ parameters:
376
+ - name: data
377
+ in: body
378
+ required: false
379
+ schema:
380
+ $ref: '#/definitions/EmailAddress'
381
+ - name: id
382
+ in: path
383
+ description: User id
384
+ required: true
385
+ type: string
386
+ format: JSON
387
+ responses:
388
+ '200':
389
+ description: Request was successful
390
+ schema:
391
+ $ref: '#/definitions/EmailAddress'
392
+ deprecated: false
393
+ delete:
394
+ tags:
395
+ - Customer
396
+ summary: Deletes all emails of this model.
397
+ operationId: Customer.prototype.__delete__emails
398
+ parameters:
399
+ - name: id
400
+ in: path
401
+ description: User id
402
+ required: true
403
+ type: string
404
+ format: JSON
405
+ responses:
406
+ '204':
407
+ description: Request was successful
408
+ deprecated: false
409
+ '/Customers/{id}/emails/count':
410
+ get:
411
+ tags:
412
+ - Customer
413
+ summary: Counts emails of Customer.
414
+ operationId: Customer.prototype.__count__emails
415
+ parameters:
416
+ - name: where
417
+ in: query
418
+ description: Criteria to match model instances
419
+ required: false
420
+ type: string
421
+ format: JSON
422
+ - name: id
423
+ in: path
424
+ description: User id
425
+ required: true
426
+ type: string
427
+ format: JSON
428
+ responses:
429
+ '200':
430
+ description: Request was successful
431
+ schema:
432
+ type: object
433
+ properties:
434
+ count:
435
+ type: number
436
+ format: double
437
+ deprecated: false
438
+ /Customers:
439
+ post:
440
+ tags:
441
+ - Customer
442
+ summary: Create a new instance of the model and persist it into the data source.
443
+ operationId: Customer.create
444
+ parameters:
445
+ - name: data
446
+ in: body
447
+ description: Model instance data
448
+ required: false
449
+ schema:
450
+ description: Model instance data
451
+ $ref: '#/definitions/Customer'
452
+ responses:
453
+ '200':
454
+ description: Request was successful
455
+ schema:
456
+ $ref: '#/definitions/Customer'
457
+ deprecated: false
458
+ put:
459
+ tags:
460
+ - Customer
461
+ summary: >-
462
+ Patch an existing model instance or insert a new one into the data
463
+ source.
464
+ operationId: Customer.upsert__put_Customers
465
+ parameters:
466
+ - name: data
467
+ in: body
468
+ description: Model instance data
469
+ required: false
470
+ schema:
471
+ description: Model instance data
472
+ $ref: '#/definitions/Customer'
473
+ responses:
474
+ '200':
475
+ description: Request was successful
476
+ schema:
477
+ $ref: '#/definitions/Customer'
478
+ deprecated: false
479
+ patch:
480
+ tags:
481
+ - Customer
482
+ summary: >-
483
+ Patch an existing model instance or insert a new one into the data
484
+ source.
485
+ operationId: Customer.upsert__patch_Customers
486
+ parameters:
487
+ - name: data
488
+ in: body
489
+ description: Model instance data
490
+ required: false
491
+ schema:
492
+ description: Model instance data
493
+ $ref: '#/definitions/Customer'
494
+ responses:
495
+ '200':
496
+ description: Request was successful
497
+ schema:
498
+ $ref: '#/definitions/Customer'
499
+ deprecated: false
500
+ get:
501
+ tags:
502
+ - Customer
503
+ summary: Find all instances of the model matched by filter from the data source.
504
+ operationId: Customer.find
505
+ parameters:
506
+ - name: filter
507
+ in: query
508
+ description: 'Filter defining fields, where, include, order, offset, and limit'
509
+ required: false
510
+ type: string
511
+ format: JSON
512
+ responses:
513
+ '200':
514
+ description: Request was successful
515
+ schema:
516
+ type: array
517
+ items:
518
+ $ref: '#/definitions/Customer'
519
+ deprecated: false
520
+ /Customers/replaceOrCreate:
521
+ post:
522
+ tags:
523
+ - Customer
524
+ summary: >-
525
+ Replace an existing model instance or insert a new one into the data
526
+ source.
527
+ operationId: Customer.replaceOrCreate
528
+ parameters:
529
+ - name: data
530
+ in: body
531
+ description: Model instance data
532
+ required: false
533
+ schema:
534
+ description: Model instance data
535
+ $ref: '#/definitions/Customer'
536
+ responses:
537
+ '200':
538
+ description: Request was successful
539
+ schema:
540
+ $ref: '#/definitions/Customer'
541
+ deprecated: false
542
+ /Customers/upsertWithWhere:
543
+ post:
544
+ tags:
545
+ - Customer
546
+ summary: >-
547
+ Update an existing model instance or insert a new one into the data
548
+ source based on the where criteria.
549
+ operationId: Customer.upsertWithWhere
550
+ parameters:
551
+ - name: where
552
+ in: query
553
+ description: Criteria to match model instances
554
+ required: false
555
+ type: string
556
+ format: JSON
557
+ - name: data
558
+ in: body
559
+ description: An object of model property name/value pairs
560
+ required: false
561
+ schema:
562
+ description: An object of model property name/value pairs
563
+ $ref: '#/definitions/Customer'
564
+ responses:
565
+ '200':
566
+ description: Request was successful
567
+ schema:
568
+ $ref: '#/definitions/Customer'
569
+ deprecated: false
570
+ '/Customers/{id}/exists':
571
+ get:
572
+ tags:
573
+ - Customer
574
+ summary: Check whether a model instance exists in the data source.
575
+ operationId: 'Customer.exists__get_Customers_{id}_exists'
576
+ parameters:
577
+ - name: id
578
+ in: path
579
+ description: Model id
580
+ required: true
581
+ type: string
582
+ format: JSON
583
+ responses:
584
+ '200':
585
+ description: Request was successful
586
+ schema:
587
+ type: object
588
+ properties:
589
+ exists:
590
+ type: boolean
591
+ deprecated: false
592
+ '/Customers/{id}':
593
+ head:
594
+ tags:
595
+ - Customer
596
+ summary: Check whether a model instance exists in the data source.
597
+ operationId: 'Customer.exists__head_Customers_{id}'
598
+ parameters:
599
+ - name: id
600
+ in: path
601
+ description: Model id
602
+ required: true
603
+ type: string
604
+ format: JSON
605
+ responses:
606
+ '200':
607
+ description: Request was successful
608
+ schema:
609
+ type: object
610
+ properties:
611
+ exists:
612
+ type: boolean
613
+ deprecated: false
614
+ get:
615
+ tags:
616
+ - Customer
617
+ summary: 'Find a model instance by {{id}} from the data source.'
618
+ operationId: Customer.findById
619
+ parameters:
620
+ - name: id
621
+ in: path
622
+ description: Model id
623
+ required: true
624
+ type: string
625
+ format: JSON
626
+ - name: filter
627
+ in: query
628
+ description: Filter defining fields and include
629
+ required: false
630
+ type: string
631
+ format: JSON
632
+ responses:
633
+ '200':
634
+ description: Request was successful
635
+ schema:
636
+ $ref: '#/definitions/Customer'
637
+ deprecated: false
638
+ delete:
639
+ tags:
640
+ - Customer
641
+ summary: 'Delete a model instance by {{id}} from the data source.'
642
+ operationId: Customer.deleteById
643
+ parameters:
644
+ - name: id
645
+ in: path
646
+ description: Model id
647
+ required: true
648
+ type: string
649
+ format: JSON
650
+ responses:
651
+ '200':
652
+ description: Request was successful
653
+ schema:
654
+ type: object
655
+ deprecated: false
656
+ put:
657
+ tags:
658
+ - Customer
659
+ summary: >-
660
+ Patch attributes for a model instance and persist it into the data
661
+ source.
662
+ operationId: 'Customer.prototype.updateAttributes__put_Customers_{id}'
663
+ parameters:
664
+ - name: data
665
+ in: body
666
+ description: An object of model property name/value pairs
667
+ required: false
668
+ schema:
669
+ description: An object of model property name/value pairs
670
+ $ref: '#/definitions/Customer'
671
+ - name: id
672
+ in: path
673
+ description: User id
674
+ required: true
675
+ type: string
676
+ format: JSON
677
+ responses:
678
+ '200':
679
+ description: Request was successful
680
+ schema:
681
+ $ref: '#/definitions/Customer'
682
+ deprecated: false
683
+ patch:
684
+ tags:
685
+ - Customer
686
+ summary: >-
687
+ Patch attributes for a model instance and persist it into the data
688
+ source.
689
+ operationId: 'Customer.prototype.updateAttributes__patch_Customers_{id}'
690
+ parameters:
691
+ - name: data
692
+ in: body
693
+ description: An object of model property name/value pairs
694
+ required: false
695
+ schema:
696
+ description: An object of model property name/value pairs
697
+ $ref: '#/definitions/Customer'
698
+ - name: id
699
+ in: path
700
+ description: User id
701
+ required: true
702
+ type: string
703
+ format: JSON
704
+ responses:
705
+ '200':
706
+ description: Request was successful
707
+ schema:
708
+ $ref: '#/definitions/Customer'
709
+ deprecated: false
710
+ '/Customers/{id}/replace':
711
+ post:
712
+ tags:
713
+ - Customer
714
+ summary: >-
715
+ Replace attributes for a model instance and persist it into the data
716
+ source.
717
+ operationId: Customer.replaceById
718
+ parameters:
719
+ - name: id
720
+ in: path
721
+ description: Model id
722
+ required: true
723
+ type: string
724
+ format: JSON
725
+ - name: data
726
+ in: body
727
+ description: Model instance data
728
+ required: false
729
+ schema:
730
+ description: Model instance data
731
+ $ref: '#/definitions/Customer'
732
+ responses:
733
+ '200':
734
+ description: Request was successful
735
+ schema:
736
+ $ref: '#/definitions/Customer'
737
+ deprecated: false
738
+ /Customers/findOne:
739
+ get:
740
+ tags:
741
+ - Customer
742
+ summary: Find first instance of the model matched by filter from the data source.
743
+ operationId: Customer.findOne
744
+ parameters:
745
+ - name: filter
746
+ in: query
747
+ description: 'Filter defining fields, where, include, order, offset, and limit'
748
+ required: false
749
+ type: string
750
+ format: JSON
751
+ responses:
752
+ '200':
753
+ description: Request was successful
754
+ schema:
755
+ $ref: '#/definitions/Customer'
756
+ deprecated: false
757
+ /Customers/update:
758
+ post:
759
+ tags:
760
+ - Customer
761
+ summary: 'Update instances of the model matched by {{where}} from the data source.'
762
+ operationId: Customer.updateAll
763
+ parameters:
764
+ - name: where
765
+ in: query
766
+ description: Criteria to match model instances
767
+ required: false
768
+ type: string
769
+ format: JSON
770
+ - name: data
771
+ in: body
772
+ description: An object of model property name/value pairs
773
+ required: false
774
+ schema:
775
+ description: An object of model property name/value pairs
776
+ $ref: '#/definitions/Customer'
777
+ responses:
778
+ '200':
779
+ description: Request was successful
780
+ schema:
781
+ description: Information related to the outcome of the operation
782
+ type: object
783
+ properties:
784
+ count:
785
+ description: The number of instances updated
786
+ type: number
787
+ format: double
788
+ deprecated: false
789
+ /Customers/count:
790
+ get:
791
+ tags:
792
+ - Customer
793
+ summary: Count instances of the model matched by where from the data source.
794
+ operationId: Customer.count
795
+ parameters:
796
+ - name: where
797
+ in: query
798
+ description: Criteria to match model instances
799
+ required: false
800
+ type: string
801
+ format: JSON
802
+ responses:
803
+ '200':
804
+ description: Request was successful
805
+ schema:
806
+ type: object
807
+ properties:
808
+ count:
809
+ type: number
810
+ format: double
811
+ deprecated: false
812
+ /Customers/change-stream:
813
+ post:
814
+ tags:
815
+ - Customer
816
+ summary: Create a change stream.
817
+ operationId: Customer.createChangeStream__post_Customers_change-stream
818
+ parameters:
819
+ - name: options
820
+ in: formData
821
+ required: false
822
+ type: string
823
+ format: JSON
824
+ responses:
825
+ '200':
826
+ description: Request was successful
827
+ schema:
828
+ type: file
829
+ deprecated: false
830
+ get:
831
+ tags:
832
+ - Customer
833
+ summary: Create a change stream.
834
+ operationId: Customer.createChangeStream__get_Customers_change-stream
835
+ parameters:
836
+ - name: options
837
+ in: query
838
+ required: false
839
+ type: string
840
+ format: JSON
841
+ responses:
842
+ '200':
843
+ description: Request was successful
844
+ schema:
845
+ type: file
846
+ deprecated: false
847
+ /Customers/login:
848
+ post:
849
+ tags:
850
+ - Customer
851
+ summary: Login a user with username/email and password.
852
+ operationId: Customer.login
853
+ parameters:
854
+ - name: credentials
855
+ in: body
856
+ required: true
857
+ schema:
858
+ type: object
859
+ - name: include
860
+ in: query
861
+ description: >-
862
+ Related objects to include in the response. See the description of
863
+ return value for more details.
864
+ required: false
865
+ type: string
866
+ format: JSON
867
+ responses:
868
+ '200':
869
+ description: Request was successful
870
+ schema:
871
+ description: >+
872
+ The response body contains properties of the AccessToken created
873
+ on login.
874
+
875
+ Depending on the value of `include` parameter, the body may
876
+ contain additional properties:
877
+
878
+ - `user` - `U+007BUserU+007D` - Data of the currently logged in user. (`include=user`)
879
+
880
+ type: object
881
+ deprecated: false
882
+ /Customers/logout:
883
+ post:
884
+ tags:
885
+ - Customer
886
+ summary: Logout a user with access token.
887
+ operationId: Customer.logout
888
+ parameters: []
889
+ responses:
890
+ '204':
891
+ description: Request was successful
892
+ deprecated: false
893
+ /Customers/confirm:
894
+ get:
895
+ tags:
896
+ - Customer
897
+ summary: Confirm a user registration with email verification token.
898
+ operationId: Customer.confirm
899
+ parameters:
900
+ - name: uid
901
+ in: query
902
+ required: true
903
+ type: string
904
+ - name: token
905
+ in: query
906
+ required: true
907
+ type: string
908
+ - name: redirect
909
+ in: query
910
+ required: false
911
+ type: string
912
+ responses:
913
+ '204':
914
+ description: Request was successful
915
+ deprecated: false
916
+ /Customers/reset:
917
+ post:
918
+ tags:
919
+ - Customer
920
+ summary: Reset password for a user with email.
921
+ operationId: Customer.resetPassword
922
+ parameters:
923
+ - name: options
924
+ in: body
925
+ required: true
926
+ schema:
927
+ type: object
928
+ responses:
929
+ '204':
930
+ description: Request was successful
931
+ deprecated: false
932
+ '/Marinas/{id}/docks/{fk}':
933
+ get:
934
+ tags:
935
+ - Marina
936
+ summary: Find a related item by id for docks.
937
+ operationId: Marina.prototype.__findById__docks
938
+ parameters:
939
+ - name: fk
940
+ in: path
941
+ description: Foreign key for docks
942
+ required: true
943
+ type: string
944
+ format: JSON
945
+ - name: id
946
+ in: path
947
+ description: PersistedModel id
948
+ required: true
949
+ type: string
950
+ format: JSON
951
+ responses:
952
+ '200':
953
+ description: Request was successful
954
+ schema:
955
+ $ref: '#/definitions/Dock'
956
+ deprecated: false
957
+ delete:
958
+ tags:
959
+ - Marina
960
+ summary: Delete a related item by id for docks.
961
+ operationId: Marina.prototype.__destroyById__docks
962
+ parameters:
963
+ - name: fk
964
+ in: path
965
+ description: Foreign key for docks
966
+ required: true
967
+ type: string
968
+ format: JSON
969
+ - name: id
970
+ in: path
971
+ description: PersistedModel id
972
+ required: true
973
+ type: string
974
+ format: JSON
975
+ responses:
976
+ '204':
977
+ description: Request was successful
978
+ deprecated: false
979
+ put:
980
+ tags:
981
+ - Marina
982
+ summary: Update a related item by id for docks.
983
+ operationId: Marina.prototype.__updateById__docks
984
+ parameters:
985
+ - name: fk
986
+ in: path
987
+ description: Foreign key for docks
988
+ required: true
989
+ type: string
990
+ format: JSON
991
+ - name: data
992
+ in: body
993
+ required: false
994
+ schema:
995
+ $ref: '#/definitions/Dock'
996
+ - name: id
997
+ in: path
998
+ description: PersistedModel id
999
+ required: true
1000
+ type: string
1001
+ format: JSON
1002
+ responses:
1003
+ '200':
1004
+ description: Request was successful
1005
+ schema:
1006
+ $ref: '#/definitions/Dock'
1007
+ deprecated: false
1008
+ '/Marinas/{id}/address':
1009
+ get:
1010
+ tags:
1011
+ - Marina
1012
+ summary: Fetches hasOne relation address.
1013
+ operationId: Marina.prototype.__get__address
1014
+ parameters:
1015
+ - name: refresh
1016
+ in: query
1017
+ required: false
1018
+ type: boolean
1019
+ - name: id
1020
+ in: path
1021
+ description: PersistedModel id
1022
+ required: true
1023
+ type: string
1024
+ format: JSON
1025
+ responses:
1026
+ '200':
1027
+ description: Request was successful
1028
+ schema:
1029
+ $ref: '#/definitions/Address'
1030
+ deprecated: false
1031
+ post:
1032
+ tags:
1033
+ - Marina
1034
+ summary: Creates a new instance in address of this model.
1035
+ operationId: Marina.prototype.__create__address
1036
+ parameters:
1037
+ - name: data
1038
+ in: body
1039
+ required: false
1040
+ schema:
1041
+ $ref: '#/definitions/Address'
1042
+ - name: id
1043
+ in: path
1044
+ description: PersistedModel id
1045
+ required: true
1046
+ type: string
1047
+ format: JSON
1048
+ responses:
1049
+ '200':
1050
+ description: Request was successful
1051
+ schema:
1052
+ $ref: '#/definitions/Address'
1053
+ deprecated: false
1054
+ put:
1055
+ tags:
1056
+ - Marina
1057
+ summary: Update address of this model.
1058
+ operationId: Marina.prototype.__update__address
1059
+ parameters:
1060
+ - name: data
1061
+ in: body
1062
+ required: false
1063
+ schema:
1064
+ $ref: '#/definitions/Address'
1065
+ - name: id
1066
+ in: path
1067
+ description: PersistedModel id
1068
+ required: true
1069
+ type: string
1070
+ format: JSON
1071
+ responses:
1072
+ '200':
1073
+ description: Request was successful
1074
+ schema:
1075
+ $ref: '#/definitions/Address'
1076
+ deprecated: false
1077
+ delete:
1078
+ tags:
1079
+ - Marina
1080
+ summary: Deletes address of this model.
1081
+ operationId: Marina.prototype.__destroy__address
1082
+ parameters:
1083
+ - name: id
1084
+ in: path
1085
+ description: PersistedModel id
1086
+ required: true
1087
+ type: string
1088
+ format: JSON
1089
+ responses:
1090
+ '204':
1091
+ description: Request was successful
1092
+ deprecated: false
1093
+ '/Marinas/{id}/listingAgent':
1094
+ get:
1095
+ tags:
1096
+ - Marina
1097
+ summary: Fetches hasOne relation listingAgent.
1098
+ operationId: Marina.prototype.__get__listingAgent
1099
+ parameters:
1100
+ - name: refresh
1101
+ in: query
1102
+ required: false
1103
+ type: boolean
1104
+ - name: id
1105
+ in: path
1106
+ description: PersistedModel id
1107
+ required: true
1108
+ type: string
1109
+ format: JSON
1110
+ responses:
1111
+ '200':
1112
+ description: Request was successful
1113
+ schema:
1114
+ $ref: '#/definitions/ListingAgent'
1115
+ deprecated: false
1116
+ post:
1117
+ tags:
1118
+ - Marina
1119
+ summary: Creates a new instance in listingAgent of this model.
1120
+ operationId: Marina.prototype.__create__listingAgent
1121
+ parameters:
1122
+ - name: data
1123
+ in: body
1124
+ required: false
1125
+ schema:
1126
+ $ref: '#/definitions/ListingAgent'
1127
+ - name: id
1128
+ in: path
1129
+ description: PersistedModel id
1130
+ required: true
1131
+ type: string
1132
+ format: JSON
1133
+ responses:
1134
+ '200':
1135
+ description: Request was successful
1136
+ schema:
1137
+ $ref: '#/definitions/ListingAgent'
1138
+ deprecated: false
1139
+ put:
1140
+ tags:
1141
+ - Marina
1142
+ summary: Update listingAgent of this model.
1143
+ operationId: Marina.prototype.__update__listingAgent
1144
+ parameters:
1145
+ - name: data
1146
+ in: body
1147
+ required: false
1148
+ schema:
1149
+ $ref: '#/definitions/ListingAgent'
1150
+ - name: id
1151
+ in: path
1152
+ description: PersistedModel id
1153
+ required: true
1154
+ type: string
1155
+ format: JSON
1156
+ responses:
1157
+ '200':
1158
+ description: Request was successful
1159
+ schema:
1160
+ $ref: '#/definitions/ListingAgent'
1161
+ deprecated: false
1162
+ delete:
1163
+ tags:
1164
+ - Marina
1165
+ summary: Deletes listingAgent of this model.
1166
+ operationId: Marina.prototype.__destroy__listingAgent
1167
+ parameters:
1168
+ - name: id
1169
+ in: path
1170
+ description: PersistedModel id
1171
+ required: true
1172
+ type: string
1173
+ format: JSON
1174
+ responses:
1175
+ '204':
1176
+ description: Request was successful
1177
+ deprecated: false
1178
+ '/Marinas/{id}/docks':
1179
+ get:
1180
+ tags:
1181
+ - Marina
1182
+ summary: Queries docks of Marina.
1183
+ operationId: Marina.prototype.__get__docks
1184
+ parameters:
1185
+ - name: filter
1186
+ in: query
1187
+ required: false
1188
+ type: string
1189
+ format: JSON
1190
+ - name: id
1191
+ in: path
1192
+ description: PersistedModel id
1193
+ required: true
1194
+ type: string
1195
+ format: JSON
1196
+ responses:
1197
+ '200':
1198
+ description: Request was successful
1199
+ schema:
1200
+ type: array
1201
+ items:
1202
+ $ref: '#/definitions/Dock'
1203
+ deprecated: false
1204
+ post:
1205
+ tags:
1206
+ - Marina
1207
+ summary: Creates a new instance in docks of this model.
1208
+ operationId: Marina.prototype.__create__docks
1209
+ parameters:
1210
+ - name: data
1211
+ in: body
1212
+ required: false
1213
+ schema:
1214
+ $ref: '#/definitions/Dock'
1215
+ - name: id
1216
+ in: path
1217
+ description: PersistedModel id
1218
+ required: true
1219
+ type: string
1220
+ format: JSON
1221
+ responses:
1222
+ '200':
1223
+ description: Request was successful
1224
+ schema:
1225
+ $ref: '#/definitions/Dock'
1226
+ deprecated: false
1227
+ delete:
1228
+ tags:
1229
+ - Marina
1230
+ summary: Deletes all docks of this model.
1231
+ operationId: Marina.prototype.__delete__docks
1232
+ parameters:
1233
+ - name: id
1234
+ in: path
1235
+ description: PersistedModel id
1236
+ required: true
1237
+ type: string
1238
+ format: JSON
1239
+ responses:
1240
+ '204':
1241
+ description: Request was successful
1242
+ deprecated: false
1243
+ '/Marinas/{id}/docks/count':
1244
+ get:
1245
+ tags:
1246
+ - Marina
1247
+ summary: Counts docks of Marina.
1248
+ operationId: Marina.prototype.__count__docks
1249
+ parameters:
1250
+ - name: where
1251
+ in: query
1252
+ description: Criteria to match model instances
1253
+ required: false
1254
+ type: string
1255
+ format: JSON
1256
+ - name: id
1257
+ in: path
1258
+ description: PersistedModel id
1259
+ required: true
1260
+ type: string
1261
+ format: JSON
1262
+ responses:
1263
+ '200':
1264
+ description: Request was successful
1265
+ schema:
1266
+ type: object
1267
+ properties:
1268
+ count:
1269
+ type: number
1270
+ format: double
1271
+ deprecated: false
1272
+ /Marinas:
1273
+ post:
1274
+ tags:
1275
+ - Marina
1276
+ summary: Create a new instance of the model and persist it into the data source.
1277
+ operationId: Marina.create
1278
+ parameters:
1279
+ - name: data
1280
+ in: body
1281
+ description: Model instance data
1282
+ required: false
1283
+ schema:
1284
+ description: Model instance data
1285
+ $ref: '#/definitions/Marina'
1286
+ responses:
1287
+ '200':
1288
+ description: Request was successful
1289
+ schema:
1290
+ $ref: '#/definitions/Marina'
1291
+ deprecated: false
1292
+ put:
1293
+ tags:
1294
+ - Marina
1295
+ summary: >-
1296
+ Patch an existing model instance or insert a new one into the data
1297
+ source.
1298
+ operationId: Marina.upsert__put_Marinas
1299
+ parameters:
1300
+ - name: data
1301
+ in: body
1302
+ description: Model instance data
1303
+ required: false
1304
+ schema:
1305
+ description: Model instance data
1306
+ $ref: '#/definitions/Marina'
1307
+ responses:
1308
+ '200':
1309
+ description: Request was successful
1310
+ schema:
1311
+ $ref: '#/definitions/Marina'
1312
+ deprecated: false
1313
+ patch:
1314
+ tags:
1315
+ - Marina
1316
+ summary: >-
1317
+ Patch an existing model instance or insert a new one into the data
1318
+ source.
1319
+ operationId: Marina.upsert__patch_Marinas
1320
+ parameters:
1321
+ - name: data
1322
+ in: body
1323
+ description: Model instance data
1324
+ required: false
1325
+ schema:
1326
+ description: Model instance data
1327
+ $ref: '#/definitions/Marina'
1328
+ responses:
1329
+ '200':
1330
+ description: Request was successful
1331
+ schema:
1332
+ $ref: '#/definitions/Marina'
1333
+ deprecated: false
1334
+ get:
1335
+ tags:
1336
+ - Marina
1337
+ summary: Find all instances of the model matched by filter from the data source.
1338
+ operationId: Marina.find
1339
+ parameters:
1340
+ - name: filter
1341
+ in: query
1342
+ description: 'Filter defining fields, where, include, order, offset, and limit'
1343
+ required: false
1344
+ type: string
1345
+ format: JSON
1346
+ responses:
1347
+ '200':
1348
+ description: Request was successful
1349
+ schema:
1350
+ type: array
1351
+ items:
1352
+ $ref: '#/definitions/Marina'
1353
+ deprecated: false
1354
+ /Marinas/replaceOrCreate:
1355
+ post:
1356
+ tags:
1357
+ - Marina
1358
+ summary: >-
1359
+ Replace an existing model instance or insert a new one into the data
1360
+ source.
1361
+ operationId: Marina.replaceOrCreate
1362
+ parameters:
1363
+ - name: data
1364
+ in: body
1365
+ description: Model instance data
1366
+ required: false
1367
+ schema:
1368
+ description: Model instance data
1369
+ $ref: '#/definitions/Marina'
1370
+ responses:
1371
+ '200':
1372
+ description: Request was successful
1373
+ schema:
1374
+ $ref: '#/definitions/Marina'
1375
+ deprecated: false
1376
+ /Marinas/upsertWithWhere:
1377
+ post:
1378
+ tags:
1379
+ - Marina
1380
+ summary: >-
1381
+ Update an existing model instance or insert a new one into the data
1382
+ source based on the where criteria.
1383
+ operationId: Marina.upsertWithWhere
1384
+ parameters:
1385
+ - name: where
1386
+ in: query
1387
+ description: Criteria to match model instances
1388
+ required: false
1389
+ type: string
1390
+ format: JSON
1391
+ - name: data
1392
+ in: body
1393
+ description: An object of model property name/value pairs
1394
+ required: false
1395
+ schema:
1396
+ description: An object of model property name/value pairs
1397
+ $ref: '#/definitions/Marina'
1398
+ responses:
1399
+ '200':
1400
+ description: Request was successful
1401
+ schema:
1402
+ $ref: '#/definitions/Marina'
1403
+ deprecated: false
1404
+ '/Marinas/{id}/exists':
1405
+ get:
1406
+ tags:
1407
+ - Marina
1408
+ summary: Check whether a model instance exists in the data source.
1409
+ operationId: 'Marina.exists__get_Marinas_{id}_exists'
1410
+ parameters:
1411
+ - name: id
1412
+ in: path
1413
+ description: Model id
1414
+ required: true
1415
+ type: string
1416
+ format: JSON
1417
+ responses:
1418
+ '200':
1419
+ description: Request was successful
1420
+ schema:
1421
+ type: object
1422
+ properties:
1423
+ exists:
1424
+ type: boolean
1425
+ deprecated: false
1426
+ '/Marinas/{id}':
1427
+ head:
1428
+ tags:
1429
+ - Marina
1430
+ summary: Check whether a model instance exists in the data source.
1431
+ operationId: 'Marina.exists__head_Marinas_{id}'
1432
+ parameters:
1433
+ - name: id
1434
+ in: path
1435
+ description: Model id
1436
+ required: true
1437
+ type: string
1438
+ format: JSON
1439
+ responses:
1440
+ '200':
1441
+ description: Request was successful
1442
+ schema:
1443
+ type: object
1444
+ properties:
1445
+ exists:
1446
+ type: boolean
1447
+ deprecated: false
1448
+ get:
1449
+ tags:
1450
+ - Marina
1451
+ summary: 'Find a model instance by {{id}} from the data source.'
1452
+ operationId: Marina.findById
1453
+ parameters:
1454
+ - name: id
1455
+ in: path
1456
+ description: Model id
1457
+ required: true
1458
+ type: string
1459
+ format: JSON
1460
+ - name: filter
1461
+ in: query
1462
+ description: Filter defining fields and include
1463
+ required: false
1464
+ type: string
1465
+ format: JSON
1466
+ responses:
1467
+ '200':
1468
+ description: Request was successful
1469
+ schema:
1470
+ $ref: '#/definitions/Marina'
1471
+ deprecated: false
1472
+ delete:
1473
+ tags:
1474
+ - Marina
1475
+ summary: 'Delete a model instance by {{id}} from the data source.'
1476
+ operationId: Marina.deleteById
1477
+ parameters:
1478
+ - name: id
1479
+ in: path
1480
+ description: Model id
1481
+ required: true
1482
+ type: string
1483
+ format: JSON
1484
+ responses:
1485
+ '200':
1486
+ description: Request was successful
1487
+ schema:
1488
+ type: object
1489
+ deprecated: false
1490
+ put:
1491
+ tags:
1492
+ - Marina
1493
+ summary: >-
1494
+ Patch attributes for a model instance and persist it into the data
1495
+ source.
1496
+ operationId: 'Marina.prototype.updateAttributes__put_Marinas_{id}'
1497
+ parameters:
1498
+ - name: data
1499
+ in: body
1500
+ description: An object of model property name/value pairs
1501
+ required: false
1502
+ schema:
1503
+ description: An object of model property name/value pairs
1504
+ $ref: '#/definitions/Marina'
1505
+ - name: id
1506
+ in: path
1507
+ description: PersistedModel id
1508
+ required: true
1509
+ type: string
1510
+ format: JSON
1511
+ responses:
1512
+ '200':
1513
+ description: Request was successful
1514
+ schema:
1515
+ $ref: '#/definitions/Marina'
1516
+ deprecated: false
1517
+ patch:
1518
+ tags:
1519
+ - Marina
1520
+ summary: >-
1521
+ Patch attributes for a model instance and persist it into the data
1522
+ source.
1523
+ operationId: 'Marina.prototype.updateAttributes__patch_Marinas_{id}'
1524
+ parameters:
1525
+ - name: data
1526
+ in: body
1527
+ description: An object of model property name/value pairs
1528
+ required: false
1529
+ schema:
1530
+ description: An object of model property name/value pairs
1531
+ $ref: '#/definitions/Marina'
1532
+ - name: id
1533
+ in: path
1534
+ description: PersistedModel id
1535
+ required: true
1536
+ type: string
1537
+ format: JSON
1538
+ responses:
1539
+ '200':
1540
+ description: Request was successful
1541
+ schema:
1542
+ $ref: '#/definitions/Marina'
1543
+ deprecated: false
1544
+ '/Marinas/{id}/replace':
1545
+ post:
1546
+ tags:
1547
+ - Marina
1548
+ summary: >-
1549
+ Replace attributes for a model instance and persist it into the data
1550
+ source.
1551
+ operationId: Marina.replaceById
1552
+ parameters:
1553
+ - name: id
1554
+ in: path
1555
+ description: Model id
1556
+ required: true
1557
+ type: string
1558
+ format: JSON
1559
+ - name: data
1560
+ in: body
1561
+ description: Model instance data
1562
+ required: false
1563
+ schema:
1564
+ description: Model instance data
1565
+ $ref: '#/definitions/Marina'
1566
+ responses:
1567
+ '200':
1568
+ description: Request was successful
1569
+ schema:
1570
+ $ref: '#/definitions/Marina'
1571
+ deprecated: false
1572
+ /Marinas/findOne:
1573
+ get:
1574
+ tags:
1575
+ - Marina
1576
+ summary: Find first instance of the model matched by filter from the data source.
1577
+ operationId: Marina.findOne
1578
+ parameters:
1579
+ - name: filter
1580
+ in: query
1581
+ description: 'Filter defining fields, where, include, order, offset, and limit'
1582
+ required: false
1583
+ type: string
1584
+ format: JSON
1585
+ responses:
1586
+ '200':
1587
+ description: Request was successful
1588
+ schema:
1589
+ $ref: '#/definitions/Marina'
1590
+ deprecated: false
1591
+ /Marinas/update:
1592
+ post:
1593
+ tags:
1594
+ - Marina
1595
+ summary: 'Update instances of the model matched by {{where}} from the data source.'
1596
+ operationId: Marina.updateAll
1597
+ parameters:
1598
+ - name: where
1599
+ in: query
1600
+ description: Criteria to match model instances
1601
+ required: false
1602
+ type: string
1603
+ format: JSON
1604
+ - name: data
1605
+ in: body
1606
+ description: An object of model property name/value pairs
1607
+ required: false
1608
+ schema:
1609
+ description: An object of model property name/value pairs
1610
+ $ref: '#/definitions/Marina'
1611
+ responses:
1612
+ '200':
1613
+ description: Request was successful
1614
+ schema:
1615
+ description: Information related to the outcome of the operation
1616
+ type: object
1617
+ properties:
1618
+ count:
1619
+ description: The number of instances updated
1620
+ type: number
1621
+ format: double
1622
+ deprecated: false
1623
+ /Marinas/count:
1624
+ get:
1625
+ tags:
1626
+ - Marina
1627
+ summary: Count instances of the model matched by where from the data source.
1628
+ operationId: Marina.count
1629
+ parameters:
1630
+ - name: where
1631
+ in: query
1632
+ description: Criteria to match model instances
1633
+ required: false
1634
+ type: string
1635
+ format: JSON
1636
+ responses:
1637
+ '200':
1638
+ description: Request was successful
1639
+ schema:
1640
+ type: object
1641
+ properties:
1642
+ count:
1643
+ type: number
1644
+ format: double
1645
+ deprecated: false
1646
+ /Marinas/change-stream:
1647
+ post:
1648
+ tags:
1649
+ - Marina
1650
+ summary: Create a change stream.
1651
+ operationId: Marina.createChangeStream__post_Marinas_change-stream
1652
+ parameters:
1653
+ - name: options
1654
+ in: formData
1655
+ required: false
1656
+ type: string
1657
+ format: JSON
1658
+ responses:
1659
+ '200':
1660
+ description: Request was successful
1661
+ schema:
1662
+ type: file
1663
+ deprecated: false
1664
+ get:
1665
+ tags:
1666
+ - Marina
1667
+ summary: Create a change stream.
1668
+ operationId: Marina.createChangeStream__get_Marinas_change-stream
1669
+ parameters:
1670
+ - name: options
1671
+ in: query
1672
+ required: false
1673
+ type: string
1674
+ format: JSON
1675
+ responses:
1676
+ '200':
1677
+ description: Request was successful
1678
+ schema:
1679
+ type: file
1680
+ deprecated: false
1681
+ '/Docks/{id}/marina':
1682
+ get:
1683
+ tags:
1684
+ - Dock
1685
+ summary: Fetches belongsTo relation marina.
1686
+ operationId: Dock.prototype.__get__marina
1687
+ parameters:
1688
+ - name: refresh
1689
+ in: query
1690
+ required: false
1691
+ type: boolean
1692
+ - name: id
1693
+ in: path
1694
+ description: PersistedModel id
1695
+ required: true
1696
+ type: string
1697
+ format: JSON
1698
+ responses:
1699
+ '200':
1700
+ description: Request was successful
1701
+ schema:
1702
+ $ref: '#/definitions/Marina'
1703
+ deprecated: false
1704
+ '/Docks/{id}/listingAgent':
1705
+ get:
1706
+ tags:
1707
+ - Dock
1708
+ summary: Fetches hasOne relation listingAgent.
1709
+ operationId: Dock.prototype.__get__listingAgent
1710
+ parameters:
1711
+ - name: refresh
1712
+ in: query
1713
+ required: false
1714
+ type: boolean
1715
+ - name: id
1716
+ in: path
1717
+ description: PersistedModel id
1718
+ required: true
1719
+ type: string
1720
+ format: JSON
1721
+ responses:
1722
+ '200':
1723
+ description: Request was successful
1724
+ schema:
1725
+ $ref: '#/definitions/ListingAgent'
1726
+ deprecated: false
1727
+ post:
1728
+ tags:
1729
+ - Dock
1730
+ summary: Creates a new instance in listingAgent of this model.
1731
+ operationId: Dock.prototype.__create__listingAgent
1732
+ parameters:
1733
+ - name: data
1734
+ in: body
1735
+ required: false
1736
+ schema:
1737
+ $ref: '#/definitions/ListingAgent'
1738
+ - name: id
1739
+ in: path
1740
+ description: PersistedModel id
1741
+ required: true
1742
+ type: string
1743
+ format: JSON
1744
+ responses:
1745
+ '200':
1746
+ description: Request was successful
1747
+ schema:
1748
+ $ref: '#/definitions/ListingAgent'
1749
+ deprecated: false
1750
+ put:
1751
+ tags:
1752
+ - Dock
1753
+ summary: Update listingAgent of this model.
1754
+ operationId: Dock.prototype.__update__listingAgent
1755
+ parameters:
1756
+ - name: data
1757
+ in: body
1758
+ required: false
1759
+ schema:
1760
+ $ref: '#/definitions/ListingAgent'
1761
+ - name: id
1762
+ in: path
1763
+ description: PersistedModel id
1764
+ required: true
1765
+ type: string
1766
+ format: JSON
1767
+ responses:
1768
+ '200':
1769
+ description: Request was successful
1770
+ schema:
1771
+ $ref: '#/definitions/ListingAgent'
1772
+ deprecated: false
1773
+ delete:
1774
+ tags:
1775
+ - Dock
1776
+ summary: Deletes listingAgent of this model.
1777
+ operationId: Dock.prototype.__destroy__listingAgent
1778
+ parameters:
1779
+ - name: id
1780
+ in: path
1781
+ description: PersistedModel id
1782
+ required: true
1783
+ type: string
1784
+ format: JSON
1785
+ responses:
1786
+ '204':
1787
+ description: Request was successful
1788
+ deprecated: false
1789
+ '/Docks/{id}/parameterAssignments/{fk}':
1790
+ get:
1791
+ tags:
1792
+ - Dock
1793
+ summary: Find a related item by id for parameterAssignments.
1794
+ operationId: Dock.prototype.__findById__parameterAssignments
1795
+ parameters:
1796
+ - name: fk
1797
+ in: path
1798
+ description: Foreign key for parameterAssignments
1799
+ required: true
1800
+ type: string
1801
+ format: JSON
1802
+ - name: id
1803
+ in: path
1804
+ description: PersistedModel id
1805
+ required: true
1806
+ type: string
1807
+ format: JSON
1808
+ responses:
1809
+ '200':
1810
+ description: Request was successful
1811
+ schema:
1812
+ $ref: '#/definitions/ParameterAssignment'
1813
+ deprecated: false
1814
+ delete:
1815
+ tags:
1816
+ - Dock
1817
+ summary: Delete a related item by id for parameterAssignments.
1818
+ operationId: Dock.prototype.__destroyById__parameterAssignments
1819
+ parameters:
1820
+ - name: fk
1821
+ in: path
1822
+ description: Foreign key for parameterAssignments
1823
+ required: true
1824
+ type: string
1825
+ format: JSON
1826
+ - name: id
1827
+ in: path
1828
+ description: PersistedModel id
1829
+ required: true
1830
+ type: string
1831
+ format: JSON
1832
+ responses:
1833
+ '204':
1834
+ description: Request was successful
1835
+ deprecated: false
1836
+ put:
1837
+ tags:
1838
+ - Dock
1839
+ summary: Update a related item by id for parameterAssignments.
1840
+ operationId: Dock.prototype.__updateById__parameterAssignments
1841
+ parameters:
1842
+ - name: fk
1843
+ in: path
1844
+ description: Foreign key for parameterAssignments
1845
+ required: true
1846
+ type: string
1847
+ format: JSON
1848
+ - name: data
1849
+ in: body
1850
+ required: false
1851
+ schema:
1852
+ $ref: '#/definitions/ParameterAssignment'
1853
+ - name: id
1854
+ in: path
1855
+ description: PersistedModel id
1856
+ required: true
1857
+ type: string
1858
+ format: JSON
1859
+ responses:
1860
+ '200':
1861
+ description: Request was successful
1862
+ schema:
1863
+ $ref: '#/definitions/ParameterAssignment'
1864
+ deprecated: false
1865
+ '/Docks/{id}/parameterAssignments':
1866
+ get:
1867
+ tags:
1868
+ - Dock
1869
+ summary: Queries parameterAssignments of Dock.
1870
+ operationId: Dock.prototype.__get__parameterAssignments
1871
+ parameters:
1872
+ - name: filter
1873
+ in: query
1874
+ required: false
1875
+ type: string
1876
+ format: JSON
1877
+ - name: id
1878
+ in: path
1879
+ description: PersistedModel id
1880
+ required: true
1881
+ type: string
1882
+ format: JSON
1883
+ responses:
1884
+ '200':
1885
+ description: Request was successful
1886
+ schema:
1887
+ type: array
1888
+ items:
1889
+ $ref: '#/definitions/ParameterAssignment'
1890
+ deprecated: false
1891
+ post:
1892
+ tags:
1893
+ - Dock
1894
+ summary: Creates a new instance in parameterAssignments of this model.
1895
+ operationId: Dock.prototype.__create__parameterAssignments
1896
+ parameters:
1897
+ - name: data
1898
+ in: body
1899
+ required: false
1900
+ schema:
1901
+ $ref: '#/definitions/ParameterAssignment'
1902
+ - name: id
1903
+ in: path
1904
+ description: PersistedModel id
1905
+ required: true
1906
+ type: string
1907
+ format: JSON
1908
+ responses:
1909
+ '200':
1910
+ description: Request was successful
1911
+ schema:
1912
+ $ref: '#/definitions/ParameterAssignment'
1913
+ deprecated: false
1914
+ delete:
1915
+ tags:
1916
+ - Dock
1917
+ summary: Deletes all parameterAssignments of this model.
1918
+ operationId: Dock.prototype.__delete__parameterAssignments
1919
+ parameters:
1920
+ - name: id
1921
+ in: path
1922
+ description: PersistedModel id
1923
+ required: true
1924
+ type: string
1925
+ format: JSON
1926
+ responses:
1927
+ '204':
1928
+ description: Request was successful
1929
+ deprecated: false
1930
+ '/Docks/{id}/parameterAssignments/count':
1931
+ get:
1932
+ tags:
1933
+ - Dock
1934
+ summary: Counts parameterAssignments of Dock.
1935
+ operationId: Dock.prototype.__count__parameterAssignments
1936
+ parameters:
1937
+ - name: where
1938
+ in: query
1939
+ description: Criteria to match model instances
1940
+ required: false
1941
+ type: string
1942
+ format: JSON
1943
+ - name: id
1944
+ in: path
1945
+ description: PersistedModel id
1946
+ required: true
1947
+ type: string
1948
+ format: JSON
1949
+ responses:
1950
+ '200':
1951
+ description: Request was successful
1952
+ schema:
1953
+ type: object
1954
+ properties:
1955
+ count:
1956
+ type: number
1957
+ format: double
1958
+ deprecated: false
1959
+ /Docks:
1960
+ post:
1961
+ tags:
1962
+ - Dock
1963
+ summary: Create a new instance of the model and persist it into the data source.
1964
+ operationId: Dock.create
1965
+ parameters:
1966
+ - name: data
1967
+ in: body
1968
+ description: Model instance data
1969
+ required: false
1970
+ schema:
1971
+ description: Model instance data
1972
+ $ref: '#/definitions/Dock'
1973
+ responses:
1974
+ '200':
1975
+ description: Request was successful
1976
+ schema:
1977
+ $ref: '#/definitions/Dock'
1978
+ deprecated: false
1979
+ put:
1980
+ tags:
1981
+ - Dock
1982
+ summary: >-
1983
+ Patch an existing model instance or insert a new one into the data
1984
+ source.
1985
+ operationId: Dock.upsert__put_Docks
1986
+ parameters:
1987
+ - name: data
1988
+ in: body
1989
+ description: Model instance data
1990
+ required: false
1991
+ schema:
1992
+ description: Model instance data
1993
+ $ref: '#/definitions/Dock'
1994
+ responses:
1995
+ '200':
1996
+ description: Request was successful
1997
+ schema:
1998
+ $ref: '#/definitions/Dock'
1999
+ deprecated: false
2000
+ patch:
2001
+ tags:
2002
+ - Dock
2003
+ summary: >-
2004
+ Patch an existing model instance or insert a new one into the data
2005
+ source.
2006
+ operationId: Dock.upsert__patch_Docks
2007
+ parameters:
2008
+ - name: data
2009
+ in: body
2010
+ description: Model instance data
2011
+ required: false
2012
+ schema:
2013
+ description: Model instance data
2014
+ $ref: '#/definitions/Dock'
2015
+ responses:
2016
+ '200':
2017
+ description: Request was successful
2018
+ schema:
2019
+ $ref: '#/definitions/Dock'
2020
+ deprecated: false
2021
+ get:
2022
+ tags:
2023
+ - Dock
2024
+ summary: Find all instances of the model matched by filter from the data source.
2025
+ operationId: Dock.find
2026
+ parameters:
2027
+ - name: filter
2028
+ in: query
2029
+ description: 'Filter defining fields, where, include, order, offset, and limit'
2030
+ required: false
2031
+ type: string
2032
+ format: JSON
2033
+ responses:
2034
+ '200':
2035
+ description: Request was successful
2036
+ schema:
2037
+ type: array
2038
+ items:
2039
+ $ref: '#/definitions/Dock'
2040
+ deprecated: false
2041
+ /Docks/replaceOrCreate:
2042
+ post:
2043
+ tags:
2044
+ - Dock
2045
+ summary: >-
2046
+ Replace an existing model instance or insert a new one into the data
2047
+ source.
2048
+ operationId: Dock.replaceOrCreate
2049
+ parameters:
2050
+ - name: data
2051
+ in: body
2052
+ description: Model instance data
2053
+ required: false
2054
+ schema:
2055
+ description: Model instance data
2056
+ $ref: '#/definitions/Dock'
2057
+ responses:
2058
+ '200':
2059
+ description: Request was successful
2060
+ schema:
2061
+ $ref: '#/definitions/Dock'
2062
+ deprecated: false
2063
+ /Docks/upsertWithWhere:
2064
+ post:
2065
+ tags:
2066
+ - Dock
2067
+ summary: >-
2068
+ Update an existing model instance or insert a new one into the data
2069
+ source based on the where criteria.
2070
+ operationId: Dock.upsertWithWhere
2071
+ parameters:
2072
+ - name: where
2073
+ in: query
2074
+ description: Criteria to match model instances
2075
+ required: false
2076
+ type: string
2077
+ format: JSON
2078
+ - name: data
2079
+ in: body
2080
+ description: An object of model property name/value pairs
2081
+ required: false
2082
+ schema:
2083
+ description: An object of model property name/value pairs
2084
+ $ref: '#/definitions/Dock'
2085
+ responses:
2086
+ '200':
2087
+ description: Request was successful
2088
+ schema:
2089
+ $ref: '#/definitions/Dock'
2090
+ deprecated: false
2091
+ '/Docks/{id}/exists':
2092
+ get:
2093
+ tags:
2094
+ - Dock
2095
+ summary: Check whether a model instance exists in the data source.
2096
+ operationId: 'Dock.exists__get_Docks_{id}_exists'
2097
+ parameters:
2098
+ - name: id
2099
+ in: path
2100
+ description: Model id
2101
+ required: true
2102
+ type: string
2103
+ format: JSON
2104
+ responses:
2105
+ '200':
2106
+ description: Request was successful
2107
+ schema:
2108
+ type: object
2109
+ properties:
2110
+ exists:
2111
+ type: boolean
2112
+ deprecated: false
2113
+ '/Docks/{id}':
2114
+ head:
2115
+ tags:
2116
+ - Dock
2117
+ summary: Check whether a model instance exists in the data source.
2118
+ operationId: 'Dock.exists__head_Docks_{id}'
2119
+ parameters:
2120
+ - name: id
2121
+ in: path
2122
+ description: Model id
2123
+ required: true
2124
+ type: string
2125
+ format: JSON
2126
+ responses:
2127
+ '200':
2128
+ description: Request was successful
2129
+ schema:
2130
+ type: object
2131
+ properties:
2132
+ exists:
2133
+ type: boolean
2134
+ deprecated: false
2135
+ get:
2136
+ tags:
2137
+ - Dock
2138
+ summary: 'Find a model instance by {{id}} from the data source.'
2139
+ operationId: Dock.findById
2140
+ parameters:
2141
+ - name: id
2142
+ in: path
2143
+ description: Model id
2144
+ required: true
2145
+ type: string
2146
+ format: JSON
2147
+ - name: filter
2148
+ in: query
2149
+ description: Filter defining fields and include
2150
+ required: false
2151
+ type: string
2152
+ format: JSON
2153
+ responses:
2154
+ '200':
2155
+ description: Request was successful
2156
+ schema:
2157
+ $ref: '#/definitions/Dock'
2158
+ deprecated: false
2159
+ delete:
2160
+ tags:
2161
+ - Dock
2162
+ summary: 'Delete a model instance by {{id}} from the data source.'
2163
+ operationId: Dock.deleteById
2164
+ parameters:
2165
+ - name: id
2166
+ in: path
2167
+ description: Model id
2168
+ required: true
2169
+ type: string
2170
+ format: JSON
2171
+ responses:
2172
+ '200':
2173
+ description: Request was successful
2174
+ schema:
2175
+ type: object
2176
+ deprecated: false
2177
+ put:
2178
+ tags:
2179
+ - Dock
2180
+ summary: >-
2181
+ Patch attributes for a model instance and persist it into the data
2182
+ source.
2183
+ operationId: 'Dock.prototype.updateAttributes__put_Docks_{id}'
2184
+ parameters:
2185
+ - name: data
2186
+ in: body
2187
+ description: An object of model property name/value pairs
2188
+ required: false
2189
+ schema:
2190
+ description: An object of model property name/value pairs
2191
+ $ref: '#/definitions/Dock'
2192
+ - name: id
2193
+ in: path
2194
+ description: PersistedModel id
2195
+ required: true
2196
+ type: string
2197
+ format: JSON
2198
+ responses:
2199
+ '200':
2200
+ description: Request was successful
2201
+ schema:
2202
+ $ref: '#/definitions/Dock'
2203
+ deprecated: false
2204
+ patch:
2205
+ tags:
2206
+ - Dock
2207
+ summary: >-
2208
+ Patch attributes for a model instance and persist it into the data
2209
+ source.
2210
+ operationId: 'Dock.prototype.updateAttributes__patch_Docks_{id}'
2211
+ parameters:
2212
+ - name: data
2213
+ in: body
2214
+ description: An object of model property name/value pairs
2215
+ required: false
2216
+ schema:
2217
+ description: An object of model property name/value pairs
2218
+ $ref: '#/definitions/Dock'
2219
+ - name: id
2220
+ in: path
2221
+ description: PersistedModel id
2222
+ required: true
2223
+ type: string
2224
+ format: JSON
2225
+ responses:
2226
+ '200':
2227
+ description: Request was successful
2228
+ schema:
2229
+ $ref: '#/definitions/Dock'
2230
+ deprecated: false
2231
+ '/Docks/{id}/replace':
2232
+ post:
2233
+ tags:
2234
+ - Dock
2235
+ summary: >-
2236
+ Replace attributes for a model instance and persist it into the data
2237
+ source.
2238
+ operationId: Dock.replaceById
2239
+ parameters:
2240
+ - name: id
2241
+ in: path
2242
+ description: Model id
2243
+ required: true
2244
+ type: string
2245
+ format: JSON
2246
+ - name: data
2247
+ in: body
2248
+ description: Model instance data
2249
+ required: false
2250
+ schema:
2251
+ description: Model instance data
2252
+ $ref: '#/definitions/Dock'
2253
+ responses:
2254
+ '200':
2255
+ description: Request was successful
2256
+ schema:
2257
+ $ref: '#/definitions/Dock'
2258
+ deprecated: false
2259
+ /Docks/findOne:
2260
+ get:
2261
+ tags:
2262
+ - Dock
2263
+ summary: Find first instance of the model matched by filter from the data source.
2264
+ operationId: Dock.findOne
2265
+ parameters:
2266
+ - name: filter
2267
+ in: query
2268
+ description: 'Filter defining fields, where, include, order, offset, and limit'
2269
+ required: false
2270
+ type: string
2271
+ format: JSON
2272
+ responses:
2273
+ '200':
2274
+ description: Request was successful
2275
+ schema:
2276
+ $ref: '#/definitions/Dock'
2277
+ deprecated: false
2278
+ /Docks/update:
2279
+ post:
2280
+ tags:
2281
+ - Dock
2282
+ summary: 'Update instances of the model matched by {{where}} from the data source.'
2283
+ operationId: Dock.updateAll
2284
+ parameters:
2285
+ - name: where
2286
+ in: query
2287
+ description: Criteria to match model instances
2288
+ required: false
2289
+ type: string
2290
+ format: JSON
2291
+ - name: data
2292
+ in: body
2293
+ description: An object of model property name/value pairs
2294
+ required: false
2295
+ schema:
2296
+ description: An object of model property name/value pairs
2297
+ $ref: '#/definitions/Dock'
2298
+ responses:
2299
+ '200':
2300
+ description: Request was successful
2301
+ schema:
2302
+ description: Information related to the outcome of the operation
2303
+ type: object
2304
+ properties:
2305
+ count:
2306
+ description: The number of instances updated
2307
+ type: number
2308
+ format: double
2309
+ deprecated: false
2310
+ /Docks/count:
2311
+ get:
2312
+ tags:
2313
+ - Dock
2314
+ summary: Count instances of the model matched by where from the data source.
2315
+ operationId: Dock.count
2316
+ parameters:
2317
+ - name: where
2318
+ in: query
2319
+ description: Criteria to match model instances
2320
+ required: false
2321
+ type: string
2322
+ format: JSON
2323
+ responses:
2324
+ '200':
2325
+ description: Request was successful
2326
+ schema:
2327
+ type: object
2328
+ properties:
2329
+ count:
2330
+ type: number
2331
+ format: double
2332
+ deprecated: false
2333
+ /Docks/change-stream:
2334
+ post:
2335
+ tags:
2336
+ - Dock
2337
+ summary: Create a change stream.
2338
+ operationId: Dock.createChangeStream__post_Docks_change-stream
2339
+ parameters:
2340
+ - name: options
2341
+ in: formData
2342
+ required: false
2343
+ type: string
2344
+ format: JSON
2345
+ responses:
2346
+ '200':
2347
+ description: Request was successful
2348
+ schema:
2349
+ type: file
2350
+ deprecated: false
2351
+ get:
2352
+ tags:
2353
+ - Dock
2354
+ summary: Create a change stream.
2355
+ operationId: Dock.createChangeStream__get_Docks_change-stream
2356
+ parameters:
2357
+ - name: options
2358
+ in: query
2359
+ required: false
2360
+ type: string
2361
+ format: JSON
2362
+ responses:
2363
+ '200':
2364
+ description: Request was successful
2365
+ schema:
2366
+ type: file
2367
+ deprecated: false
2368
+ /UnitsOfMeasurement/replaceOrCreate:
2369
+ post:
2370
+ tags:
2371
+ - UnitOfMeasurement
2372
+ summary: >-
2373
+ Replace an existing model instance or insert a new one into the data
2374
+ source.
2375
+ operationId: UnitOfMeasurement.replaceOrCreate
2376
+ parameters:
2377
+ - name: data
2378
+ in: body
2379
+ description: Model instance data
2380
+ required: false
2381
+ schema:
2382
+ description: Model instance data
2383
+ $ref: '#/definitions/UnitOfMeasurement'
2384
+ responses:
2385
+ '200':
2386
+ description: Request was successful
2387
+ schema:
2388
+ $ref: '#/definitions/UnitOfMeasurement'
2389
+ deprecated: false
2390
+ /UnitsOfMeasurement/upsertWithWhere:
2391
+ post:
2392
+ tags:
2393
+ - UnitOfMeasurement
2394
+ summary: >-
2395
+ Update an existing model instance or insert a new one into the data
2396
+ source based on the where criteria.
2397
+ operationId: UnitOfMeasurement.upsertWithWhere
2398
+ parameters:
2399
+ - name: where
2400
+ in: query
2401
+ description: Criteria to match model instances
2402
+ required: false
2403
+ type: string
2404
+ format: JSON
2405
+ - name: data
2406
+ in: body
2407
+ description: An object of model property name/value pairs
2408
+ required: false
2409
+ schema:
2410
+ description: An object of model property name/value pairs
2411
+ $ref: '#/definitions/UnitOfMeasurement'
2412
+ responses:
2413
+ '200':
2414
+ description: Request was successful
2415
+ schema:
2416
+ $ref: '#/definitions/UnitOfMeasurement'
2417
+ deprecated: false
2418
+ '/UnitsOfMeasurement/{id}/exists':
2419
+ get:
2420
+ tags:
2421
+ - UnitOfMeasurement
2422
+ summary: Check whether a model instance exists in the data source.
2423
+ operationId: 'UnitOfMeasurement.exists__get_UnitsOfMeasurement_{id}_exists'
2424
+ parameters:
2425
+ - name: id
2426
+ in: path
2427
+ description: Model id
2428
+ required: true
2429
+ type: string
2430
+ format: JSON
2431
+ responses:
2432
+ '200':
2433
+ description: Request was successful
2434
+ schema:
2435
+ type: object
2436
+ properties:
2437
+ exists:
2438
+ type: boolean
2439
+ deprecated: false
2440
+ '/UnitsOfMeasurement/{id}':
2441
+ head:
2442
+ tags:
2443
+ - UnitOfMeasurement
2444
+ summary: Check whether a model instance exists in the data source.
2445
+ operationId: 'UnitOfMeasurement.exists__head_UnitsOfMeasurement_{id}'
2446
+ parameters:
2447
+ - name: id
2448
+ in: path
2449
+ description: Model id
2450
+ required: true
2451
+ type: string
2452
+ format: JSON
2453
+ responses:
2454
+ '200':
2455
+ description: Request was successful
2456
+ schema:
2457
+ type: object
2458
+ properties:
2459
+ exists:
2460
+ type: boolean
2461
+ deprecated: false
2462
+ get:
2463
+ tags:
2464
+ - UnitOfMeasurement
2465
+ summary: 'Find a model instance by {{id}} from the data source.'
2466
+ operationId: UnitOfMeasurement.findById
2467
+ parameters:
2468
+ - name: id
2469
+ in: path
2470
+ description: Model id
2471
+ required: true
2472
+ type: string
2473
+ format: JSON
2474
+ - name: filter
2475
+ in: query
2476
+ description: Filter defining fields and include
2477
+ required: false
2478
+ type: string
2479
+ format: JSON
2480
+ responses:
2481
+ '200':
2482
+ description: Request was successful
2483
+ schema:
2484
+ $ref: '#/definitions/UnitOfMeasurement'
2485
+ deprecated: false
2486
+ '/UnitsOfMeasurement/{id}/replace':
2487
+ post:
2488
+ tags:
2489
+ - UnitOfMeasurement
2490
+ summary: >-
2491
+ Replace attributes for a model instance and persist it into the data
2492
+ source.
2493
+ operationId: UnitOfMeasurement.replaceById
2494
+ parameters:
2495
+ - name: id
2496
+ in: path
2497
+ description: Model id
2498
+ required: true
2499
+ type: string
2500
+ format: JSON
2501
+ - name: data
2502
+ in: body
2503
+ description: Model instance data
2504
+ required: false
2505
+ schema:
2506
+ description: Model instance data
2507
+ $ref: '#/definitions/UnitOfMeasurement'
2508
+ responses:
2509
+ '200':
2510
+ description: Request was successful
2511
+ schema:
2512
+ $ref: '#/definitions/UnitOfMeasurement'
2513
+ deprecated: false
2514
+ /UnitsOfMeasurement:
2515
+ get:
2516
+ tags:
2517
+ - UnitOfMeasurement
2518
+ summary: Find all instances of the model matched by filter from the data source.
2519
+ operationId: UnitOfMeasurement.find
2520
+ parameters:
2521
+ - name: filter
2522
+ in: query
2523
+ description: 'Filter defining fields, where, include, order, offset, and limit'
2524
+ required: false
2525
+ type: string
2526
+ format: JSON
2527
+ responses:
2528
+ '200':
2529
+ description: Request was successful
2530
+ schema:
2531
+ type: array
2532
+ items:
2533
+ $ref: '#/definitions/UnitOfMeasurement'
2534
+ deprecated: false
2535
+ /UnitsOfMeasurement/findOne:
2536
+ get:
2537
+ tags:
2538
+ - UnitOfMeasurement
2539
+ summary: Find first instance of the model matched by filter from the data source.
2540
+ operationId: UnitOfMeasurement.findOne
2541
+ parameters:
2542
+ - name: filter
2543
+ in: query
2544
+ description: 'Filter defining fields, where, include, order, offset, and limit'
2545
+ required: false
2546
+ type: string
2547
+ format: JSON
2548
+ responses:
2549
+ '200':
2550
+ description: Request was successful
2551
+ schema:
2552
+ $ref: '#/definitions/UnitOfMeasurement'
2553
+ deprecated: false
2554
+ /UnitsOfMeasurement/count:
2555
+ get:
2556
+ tags:
2557
+ - UnitOfMeasurement
2558
+ summary: Count instances of the model matched by where from the data source.
2559
+ operationId: UnitOfMeasurement.count
2560
+ parameters:
2561
+ - name: where
2562
+ in: query
2563
+ description: Criteria to match model instances
2564
+ required: false
2565
+ type: string
2566
+ format: JSON
2567
+ responses:
2568
+ '200':
2569
+ description: Request was successful
2570
+ schema:
2571
+ type: object
2572
+ properties:
2573
+ count:
2574
+ type: number
2575
+ format: double
2576
+ deprecated: false
2577
+ /Parameters/replaceOrCreate:
2578
+ post:
2579
+ tags:
2580
+ - Parameter
2581
+ summary: >-
2582
+ Replace an existing model instance or insert a new one into the data
2583
+ source.
2584
+ operationId: Parameter.replaceOrCreate
2585
+ parameters:
2586
+ - name: data
2587
+ in: body
2588
+ description: Model instance data
2589
+ required: false
2590
+ schema:
2591
+ description: Model instance data
2592
+ $ref: '#/definitions/Parameter'
2593
+ responses:
2594
+ '200':
2595
+ description: Request was successful
2596
+ schema:
2597
+ $ref: '#/definitions/Parameter'
2598
+ deprecated: false
2599
+ /Parameters/upsertWithWhere:
2600
+ post:
2601
+ tags:
2602
+ - Parameter
2603
+ summary: >-
2604
+ Update an existing model instance or insert a new one into the data
2605
+ source based on the where criteria.
2606
+ operationId: Parameter.upsertWithWhere
2607
+ parameters:
2608
+ - name: where
2609
+ in: query
2610
+ description: Criteria to match model instances
2611
+ required: false
2612
+ type: string
2613
+ format: JSON
2614
+ - name: data
2615
+ in: body
2616
+ description: An object of model property name/value pairs
2617
+ required: false
2618
+ schema:
2619
+ description: An object of model property name/value pairs
2620
+ $ref: '#/definitions/Parameter'
2621
+ responses:
2622
+ '200':
2623
+ description: Request was successful
2624
+ schema:
2625
+ $ref: '#/definitions/Parameter'
2626
+ deprecated: false
2627
+ '/Parameters/{id}/exists':
2628
+ get:
2629
+ tags:
2630
+ - Parameter
2631
+ summary: Check whether a model instance exists in the data source.
2632
+ operationId: 'Parameter.exists__get_Parameters_{id}_exists'
2633
+ parameters:
2634
+ - name: id
2635
+ in: path
2636
+ description: Model id
2637
+ required: true
2638
+ type: string
2639
+ format: JSON
2640
+ responses:
2641
+ '200':
2642
+ description: Request was successful
2643
+ schema:
2644
+ type: object
2645
+ properties:
2646
+ exists:
2647
+ type: boolean
2648
+ deprecated: false
2649
+ '/Parameters/{id}':
2650
+ head:
2651
+ tags:
2652
+ - Parameter
2653
+ summary: Check whether a model instance exists in the data source.
2654
+ operationId: 'Parameter.exists__head_Parameters_{id}'
2655
+ parameters:
2656
+ - name: id
2657
+ in: path
2658
+ description: Model id
2659
+ required: true
2660
+ type: string
2661
+ format: JSON
2662
+ responses:
2663
+ '200':
2664
+ description: Request was successful
2665
+ schema:
2666
+ type: object
2667
+ properties:
2668
+ exists:
2669
+ type: boolean
2670
+ deprecated: false
2671
+ get:
2672
+ tags:
2673
+ - Parameter
2674
+ summary: 'Find a model instance by {{id}} from the data source.'
2675
+ operationId: Parameter.findById
2676
+ parameters:
2677
+ - name: id
2678
+ in: path
2679
+ description: Model id
2680
+ required: true
2681
+ type: string
2682
+ format: JSON
2683
+ - name: filter
2684
+ in: query
2685
+ description: Filter defining fields and include
2686
+ required: false
2687
+ type: string
2688
+ format: JSON
2689
+ responses:
2690
+ '200':
2691
+ description: Request was successful
2692
+ schema:
2693
+ $ref: '#/definitions/Parameter'
2694
+ deprecated: false
2695
+ '/Parameters/{id}/replace':
2696
+ post:
2697
+ tags:
2698
+ - Parameter
2699
+ summary: >-
2700
+ Replace attributes for a model instance and persist it into the data
2701
+ source.
2702
+ operationId: Parameter.replaceById
2703
+ parameters:
2704
+ - name: id
2705
+ in: path
2706
+ description: Model id
2707
+ required: true
2708
+ type: string
2709
+ format: JSON
2710
+ - name: data
2711
+ in: body
2712
+ description: Model instance data
2713
+ required: false
2714
+ schema:
2715
+ description: Model instance data
2716
+ $ref: '#/definitions/Parameter'
2717
+ responses:
2718
+ '200':
2719
+ description: Request was successful
2720
+ schema:
2721
+ $ref: '#/definitions/Parameter'
2722
+ deprecated: false
2723
+ /Parameters:
2724
+ get:
2725
+ tags:
2726
+ - Parameter
2727
+ summary: Find all instances of the model matched by filter from the data source.
2728
+ operationId: Parameter.find
2729
+ parameters:
2730
+ - name: filter
2731
+ in: query
2732
+ description: 'Filter defining fields, where, include, order, offset, and limit'
2733
+ required: false
2734
+ type: string
2735
+ format: JSON
2736
+ responses:
2737
+ '200':
2738
+ description: Request was successful
2739
+ schema:
2740
+ type: array
2741
+ items:
2742
+ $ref: '#/definitions/Parameter'
2743
+ deprecated: false
2744
+ /Parameters/findOne:
2745
+ get:
2746
+ tags:
2747
+ - Parameter
2748
+ summary: Find first instance of the model matched by filter from the data source.
2749
+ operationId: Parameter.findOne
2750
+ parameters:
2751
+ - name: filter
2752
+ in: query
2753
+ description: 'Filter defining fields, where, include, order, offset, and limit'
2754
+ required: false
2755
+ type: string
2756
+ format: JSON
2757
+ responses:
2758
+ '200':
2759
+ description: Request was successful
2760
+ schema:
2761
+ $ref: '#/definitions/Parameter'
2762
+ deprecated: false
2763
+ /Parameters/count:
2764
+ get:
2765
+ tags:
2766
+ - Parameter
2767
+ summary: Count instances of the model matched by where from the data source.
2768
+ operationId: Parameter.count
2769
+ parameters:
2770
+ - name: where
2771
+ in: query
2772
+ description: Criteria to match model instances
2773
+ required: false
2774
+ type: string
2775
+ format: JSON
2776
+ responses:
2777
+ '200':
2778
+ description: Request was successful
2779
+ schema:
2780
+ type: object
2781
+ properties:
2782
+ count:
2783
+ type: number
2784
+ format: double
2785
+ deprecated: false
2786
+ tags:
2787
+ - name: Customer
2788
+ - name: Marina
2789
+ - name: Dock
2790
+ description: This class describes a physical dock or slip.
2791
+ - name: UnitOfMeasurement
2792
+ description: This class describes a unit of measurement.
2793
+ - name: Parameter
2794
+ description: A runtime-defined parameter that describes a dock or a marina.
2795
+ consumes:
2796
+ - application/json
2797
+ - application/x-www-form-urlencoded
2798
+ - application/xml
2799
+ - text/xml
2800
+ produces:
2801
+ - application/json
2802
+ - application/xml
2803
+ - text/xml
2804
+ - application/javascript
2805
+ - text/javascript
2806
+ definitions:
2807
+ x-any:
2808
+ properties: {}
2809
+ AccessToken:
2810
+ properties:
2811
+ id:
2812
+ type: string
2813
+ ttl:
2814
+ default: 1209600
2815
+ description: time to live in seconds (2 weeks by default)
2816
+ type: number
2817
+ format: double
2818
+ created:
2819
+ type: string
2820
+ format: date
2821
+ userId:
2822
+ type: number
2823
+ format: double
2824
+ required:
2825
+ - id
2826
+ additionalProperties: false
2827
+ Address:
2828
+ description: >-
2829
+ This class describes a physical address. Field names follow the xNAL
2830
+ standard.
2831
+ properties:
2832
+ country:
2833
+ default: US
2834
+ description: 'Country (always required, 2 character ISO code)'
2835
+ type: string
2836
+ administrative_area:
2837
+ description: State / Province / Region (ISO code when available)
2838
+ type: string
2839
+ sub_administrative_area:
2840
+ description: County / District (optional)
2841
+ type: string
2842
+ locality:
2843
+ description: City / Town
2844
+ type: string
2845
+ dependent_locality:
2846
+ description: Dependent locality (unused in the US)
2847
+ type: string
2848
+ postal_code:
2849
+ description: Postal code / ZIP Code
2850
+ type: string
2851
+ thoroughfare:
2852
+ description: Street address (including number in the US)
2853
+ type: string
2854
+ premise:
2855
+ description: 'Apartment, Suite, Box number, etc.'
2856
+ type: string
2857
+ id:
2858
+ type: string
2859
+ additionalProperties: false
2860
+ EmailAddress:
2861
+ properties:
2862
+ address:
2863
+ type: string
2864
+ id:
2865
+ type: string
2866
+ additionalProperties: false
2867
+ Customer:
2868
+ properties:
2869
+ firstName:
2870
+ type: string
2871
+ lastName:
2872
+ type: string
2873
+ imageURL:
2874
+ type: string
2875
+ realm:
2876
+ type: string
2877
+ username:
2878
+ type: string
2879
+ credentials:
2880
+ type: object
2881
+ challenges:
2882
+ type: object
2883
+ email:
2884
+ type: string
2885
+ emailVerified:
2886
+ type: boolean
2887
+ status:
2888
+ type: string
2889
+ created:
2890
+ type: string
2891
+ format: date
2892
+ lastUpdated:
2893
+ type: string
2894
+ format: date
2895
+ id:
2896
+ type: number
2897
+ format: double
2898
+ billingAddress:
2899
+ $ref: '#/definitions/Address'
2900
+ emailList:
2901
+ type: array
2902
+ items:
2903
+ $ref: '#/definitions/EmailAddress'
2904
+ required:
2905
+ - firstName
2906
+ - lastName
2907
+ - email
2908
+ additionalProperties: false
2909
+ Dock:
2910
+ description: This class describes a physical dock or slip.
2911
+ properties:
2912
+ id:
2913
+ type: number
2914
+ format: double
2915
+ commonName:
2916
+ default: ''
2917
+ description: The name given to the dock (usually by a marina with many docks).
2918
+ type: string
2919
+ imageURL:
2920
+ default: ''
2921
+ description: The URL to the image that shows this dock
2922
+ type: string
2923
+ location:
2924
+ description: >-
2925
+ The coordinates of this dock. If a boundary GeoJSON is provided, this
2926
+ attribute may be overridden at creation or update
2927
+ $ref: '#/definitions/GeoPoint'
2928
+ boundaryGeoJSON:
2929
+ default: ''
2930
+ description: >-
2931
+ A GeoJSON fragment representing the boundary of the slip. If this
2932
+ attribute is provided at creation or update it overrides the location
2933
+ type: string
2934
+ isSlip:
2935
+ default: false
2936
+ description: Indicates if it is a slip (true) or a dock (false)
2937
+ type: boolean
2938
+ forRent:
2939
+ default: false
2940
+ description: Indicates if it is listed for rent
2941
+ type: boolean
2942
+ forSale:
2943
+ default: false
2944
+ description: Indicates if it is listed for sale
2945
+ type: boolean
2946
+ source:
2947
+ description: An URI that tries to link this record to a source
2948
+ type: string
2949
+ created:
2950
+ type: string
2951
+ format: date
2952
+ lastUpdated:
2953
+ type: string
2954
+ format: date
2955
+ marinaId:
2956
+ type: number
2957
+ format: double
2958
+ _listingAgent:
2959
+ $ref: '#/definitions/ListingAgent'
2960
+ _parameterAssignments:
2961
+ type: array
2962
+ items:
2963
+ $ref: '#/definitions/ParameterAssignment'
2964
+ required:
2965
+ - commonName
2966
+ - location
2967
+ - isSlip
2968
+ - forRent
2969
+ - forSale
2970
+ additionalProperties: false
2971
+ ListingAgent:
2972
+ properties:
2973
+ name:
2974
+ description: The name of the listing agent.
2975
+ type: string
2976
+ crmId:
2977
+ description: An ID given by the CRM that links this person into the CRM.
2978
+ type: string
2979
+ id:
2980
+ type: string
2981
+ contactAddress:
2982
+ $ref: '#/definitions/Address'
2983
+ emailList:
2984
+ type: array
2985
+ items:
2986
+ $ref: '#/definitions/EmailAddress'
2987
+ phoneList:
2988
+ type: array
2989
+ items:
2990
+ $ref: '#/definitions/Phone'
2991
+ additionalProperties: false
2992
+ Marina:
2993
+ properties:
2994
+ name:
2995
+ type: string
2996
+ location:
2997
+ $ref: '#/definitions/GeoPoint'
2998
+ source:
2999
+ type: string
3000
+ created:
3001
+ type: string
3002
+ format: date
3003
+ lastUpdated:
3004
+ type: string
3005
+ format: date
3006
+ id:
3007
+ type: number
3008
+ format: double
3009
+ physicalAddress:
3010
+ $ref: '#/definitions/Address'
3011
+ _listingAgent:
3012
+ $ref: '#/definitions/ListingAgent'
3013
+ required:
3014
+ - location
3015
+ additionalProperties: false
3016
+ ParameterAssignment:
3017
+ description: This class describes a specific value assigned to a parameter.
3018
+ properties:
3019
+ value:
3020
+ type: number
3021
+ format: double
3022
+ id:
3023
+ type: string
3024
+ _parameter:
3025
+ $ref: '#/definitions/Parameter'
3026
+ required:
3027
+ - value
3028
+ additionalProperties: false
3029
+ UnitOfMeasurement:
3030
+ description: This class describes a unit of measurement.
3031
+ properties:
3032
+ domain:
3033
+ type: string
3034
+ id:
3035
+ type: string
3036
+ name:
3037
+ type: string
3038
+ required:
3039
+ - domain
3040
+ - id
3041
+ - name
3042
+ additionalProperties: false
3043
+ Parameter:
3044
+ description: A runtime-defined parameter that describes a dock or a marina.
3045
+ properties:
3046
+ id:
3047
+ type: string
3048
+ domain:
3049
+ type: string
3050
+ name:
3051
+ type: string
3052
+ allowed_values:
3053
+ type: array
3054
+ items:
3055
+ type: string
3056
+ required:
3057
+ - id
3058
+ - domain
3059
+ - name
3060
+ additionalProperties: false
3061
+ GeoPoint:
3062
+ properties:
3063
+ lat:
3064
+ type: number
3065
+ lng:
3066
+ type: number
3067
+ Phone:
3068
+ properties:
3069
+ number:
3070
+ type: string
3071
+ id:
3072
+ type: string
3073
+ required:
3074
+ - number
3075
+ additionalProperties: false