dock_genius_api_ruby_client 0.1.1.pre.g582ac6 → 0.1.2.pre.ge30447

Sign up to get free protection for your applications and to get access to all the features.
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
data/README.md DELETED
@@ -1,200 +0,0 @@
1
- # dock_genius_api_ruby_client
2
-
3
- DockGeniusApiRubyClient - the Ruby gem for the dockgenius-sl
4
-
5
- No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
6
-
7
- This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
-
9
- - API version: 0.1.0
10
- - Package version: 0.1.1-g582ac6
11
- - Build date: 2016-12-24T04:00:38.198-05:00
12
- - Build package: class io.swagger.codegen.languages.RubyClientCodegen
13
-
14
- ## Installation
15
-
16
- ### Build a gem
17
-
18
- To build the Ruby code into a gem:
19
-
20
- ```shell
21
- gem build dock_genius_api_ruby_client.gemspec
22
- ```
23
-
24
- Then either install the gem locally:
25
-
26
- ```shell
27
- gem install ./dock_genius_api_ruby_client-0.1.1-g582ac6.gem
28
- ```
29
- (for development, run `gem install --dev ./dock_genius_api_ruby_client-0.1.1-g582ac6.gem` to install the development dependencies)
30
-
31
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
-
33
- Finally add this to the Gemfile:
34
-
35
- gem 'dock_genius_api_ruby_client', '~> 0.1.1-g582ac6'
36
-
37
- ### Install from Git
38
-
39
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
40
-
41
- gem 'dock_genius_api_ruby_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
42
-
43
- ### Include the Ruby code directly
44
-
45
- Include the Ruby code directly using `-I` as follows:
46
-
47
- ```shell
48
- ruby -Ilib script.rb
49
- ```
50
-
51
- ## Getting Started
52
-
53
- Please follow the [installation](#installation) procedure and then run the following code:
54
- ```ruby
55
- # Load the gem
56
- require 'dock_genius_api_ruby_client'
57
-
58
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
59
-
60
- uid = "uid_example" # String |
61
-
62
- token = "token_example" # String |
63
-
64
- opts = {
65
- redirect: "redirect_example" # String |
66
- }
67
-
68
- begin
69
- #Confirm a user registration with email verification token.
70
- api_instance.customer_confirm(uid, token, opts)
71
- rescue DockGeniusApiRubyClient::ApiError => e
72
- puts "Exception when calling CustomerApi->customer_confirm: #{e}"
73
- end
74
-
75
- ```
76
-
77
- ## Documentation for API Endpoints
78
-
79
- All URIs are relative to *https://localhost/api*
80
-
81
- Class | Method | HTTP request | Description
82
- ------------ | ------------- | ------------- | -------------
83
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_confirm**](docs/CustomerApi.md#customer_confirm) | **GET** /Customers/confirm | Confirm a user registration with email verification token.
84
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_count**](docs/CustomerApi.md#customer_count) | **GET** /Customers/count | Count instances of the model matched by where from the data source.
85
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_create**](docs/CustomerApi.md#customer_create) | **POST** /Customers | Create a new instance of the model and persist it into the data source.
86
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_create_change_stream_get_customers_change_stream**](docs/CustomerApi.md#customer_create_change_stream_get_customers_change_stream) | **GET** /Customers/change-stream | Create a change stream.
87
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_create_change_stream_post_customers_change_stream**](docs/CustomerApi.md#customer_create_change_stream_post_customers_change_stream) | **POST** /Customers/change-stream | Create a change stream.
88
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_delete_by_id**](docs/CustomerApi.md#customer_delete_by_id) | **DELETE** /Customers/{id} | Delete a model instance by {{id}} from the data source.
89
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_exists_get_customersid_exists**](docs/CustomerApi.md#customer_exists_get_customersid_exists) | **GET** /Customers/{id}/exists | Check whether a model instance exists in the data source.
90
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_exists_head_customersid**](docs/CustomerApi.md#customer_exists_head_customersid) | **HEAD** /Customers/{id} | Check whether a model instance exists in the data source.
91
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_find**](docs/CustomerApi.md#customer_find) | **GET** /Customers | Find all instances of the model matched by filter from the data source.
92
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_find_by_id**](docs/CustomerApi.md#customer_find_by_id) | **GET** /Customers/{id} | Find a model instance by {{id}} from the data source.
93
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_find_one**](docs/CustomerApi.md#customer_find_one) | **GET** /Customers/findOne | Find first instance of the model matched by filter from the data source.
94
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_login**](docs/CustomerApi.md#customer_login) | **POST** /Customers/login | Login a user with username/email and password.
95
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_logout**](docs/CustomerApi.md#customer_logout) | **POST** /Customers/logout | Logout a user with access token.
96
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_count_access_tokens**](docs/CustomerApi.md#customer_prototype_count_access_tokens) | **GET** /Customers/{id}/accessTokens/count | Counts accessTokens of Customer.
97
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_count_emails**](docs/CustomerApi.md#customer_prototype_count_emails) | **GET** /Customers/{id}/emails/count | Counts emails of Customer.
98
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_create_access_tokens**](docs/CustomerApi.md#customer_prototype_create_access_tokens) | **POST** /Customers/{id}/accessTokens | Creates a new instance in accessTokens of this model.
99
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_create_address**](docs/CustomerApi.md#customer_prototype_create_address) | **POST** /Customers/{id}/address | Creates a new instance in address of this model.
100
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_create_emails**](docs/CustomerApi.md#customer_prototype_create_emails) | **POST** /Customers/{id}/emails | Creates a new instance in emails of this model.
101
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_delete_access_tokens**](docs/CustomerApi.md#customer_prototype_delete_access_tokens) | **DELETE** /Customers/{id}/accessTokens | Deletes all accessTokens of this model.
102
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_delete_emails**](docs/CustomerApi.md#customer_prototype_delete_emails) | **DELETE** /Customers/{id}/emails | Deletes all emails of this model.
103
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_destroy_address**](docs/CustomerApi.md#customer_prototype_destroy_address) | **DELETE** /Customers/{id}/address | Deletes address of this model.
104
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_destroy_by_id_access_tokens**](docs/CustomerApi.md#customer_prototype_destroy_by_id_access_tokens) | **DELETE** /Customers/{id}/accessTokens/{fk} | Delete a related item by id for accessTokens.
105
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_destroy_by_id_emails**](docs/CustomerApi.md#customer_prototype_destroy_by_id_emails) | **DELETE** /Customers/{id}/emails/{fk} | Delete a related item by id for emails.
106
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_find_by_id_access_tokens**](docs/CustomerApi.md#customer_prototype_find_by_id_access_tokens) | **GET** /Customers/{id}/accessTokens/{fk} | Find a related item by id for accessTokens.
107
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_find_by_id_emails**](docs/CustomerApi.md#customer_prototype_find_by_id_emails) | **GET** /Customers/{id}/emails/{fk} | Find a related item by id for emails.
108
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_get_access_tokens**](docs/CustomerApi.md#customer_prototype_get_access_tokens) | **GET** /Customers/{id}/accessTokens | Queries accessTokens of Customer.
109
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_get_address**](docs/CustomerApi.md#customer_prototype_get_address) | **GET** /Customers/{id}/address | Fetches hasOne relation address.
110
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_get_emails**](docs/CustomerApi.md#customer_prototype_get_emails) | **GET** /Customers/{id}/emails | Queries emails of Customer.
111
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_update_address**](docs/CustomerApi.md#customer_prototype_update_address) | **PUT** /Customers/{id}/address | Update address of this model.
112
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_update_attributes_patch_customersid**](docs/CustomerApi.md#customer_prototype_update_attributes_patch_customersid) | **PATCH** /Customers/{id} | Patch attributes for a model instance and persist it into the data source.
113
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_update_attributes_put_customersid**](docs/CustomerApi.md#customer_prototype_update_attributes_put_customersid) | **PUT** /Customers/{id} | Patch attributes for a model instance and persist it into the data source.
114
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_update_by_id_access_tokens**](docs/CustomerApi.md#customer_prototype_update_by_id_access_tokens) | **PUT** /Customers/{id}/accessTokens/{fk} | Update a related item by id for accessTokens.
115
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_prototype_update_by_id_emails**](docs/CustomerApi.md#customer_prototype_update_by_id_emails) | **PUT** /Customers/{id}/emails/{fk} | Update a related item by id for emails.
116
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_replace_by_id**](docs/CustomerApi.md#customer_replace_by_id) | **POST** /Customers/{id}/replace | Replace attributes for a model instance and persist it into the data source.
117
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_replace_or_create**](docs/CustomerApi.md#customer_replace_or_create) | **POST** /Customers/replaceOrCreate | Replace an existing model instance or insert a new one into the data source.
118
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_reset_password**](docs/CustomerApi.md#customer_reset_password) | **POST** /Customers/reset | Reset password for a user with email.
119
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_update_all**](docs/CustomerApi.md#customer_update_all) | **POST** /Customers/update | Update instances of the model matched by {{where}} from the data source.
120
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_upsert_patch_customers**](docs/CustomerApi.md#customer_upsert_patch_customers) | **PATCH** /Customers | Patch an existing model instance or insert a new one into the data source.
121
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_upsert_put_customers**](docs/CustomerApi.md#customer_upsert_put_customers) | **PUT** /Customers | Patch an existing model instance or insert a new one into the data source.
122
- *DockGeniusApiRubyClient::CustomerApi* | [**customer_upsert_with_where**](docs/CustomerApi.md#customer_upsert_with_where) | **POST** /Customers/upsertWithWhere | Update an existing model instance or insert a new one into the data source based on the where criteria.
123
- *DockGeniusApiRubyClient::DockApi* | [**dock_count**](docs/DockApi.md#dock_count) | **GET** /Docks/count | Count instances of the model matched by where from the data source.
124
- *DockGeniusApiRubyClient::DockApi* | [**dock_create**](docs/DockApi.md#dock_create) | **POST** /Docks | Create a new instance of the model and persist it into the data source.
125
- *DockGeniusApiRubyClient::DockApi* | [**dock_create_change_stream_get_docks_change_stream**](docs/DockApi.md#dock_create_change_stream_get_docks_change_stream) | **GET** /Docks/change-stream | Create a change stream.
126
- *DockGeniusApiRubyClient::DockApi* | [**dock_create_change_stream_post_docks_change_stream**](docs/DockApi.md#dock_create_change_stream_post_docks_change_stream) | **POST** /Docks/change-stream | Create a change stream.
127
- *DockGeniusApiRubyClient::DockApi* | [**dock_delete_by_id**](docs/DockApi.md#dock_delete_by_id) | **DELETE** /Docks/{id} | Delete a model instance by {{id}} from the data source.
128
- *DockGeniusApiRubyClient::DockApi* | [**dock_exists_get_docksid_exists**](docs/DockApi.md#dock_exists_get_docksid_exists) | **GET** /Docks/{id}/exists | Check whether a model instance exists in the data source.
129
- *DockGeniusApiRubyClient::DockApi* | [**dock_exists_head_docksid**](docs/DockApi.md#dock_exists_head_docksid) | **HEAD** /Docks/{id} | Check whether a model instance exists in the data source.
130
- *DockGeniusApiRubyClient::DockApi* | [**dock_find**](docs/DockApi.md#dock_find) | **GET** /Docks | Find all instances of the model matched by filter from the data source.
131
- *DockGeniusApiRubyClient::DockApi* | [**dock_find_by_id**](docs/DockApi.md#dock_find_by_id) | **GET** /Docks/{id} | Find a model instance by {{id}} from the data source.
132
- *DockGeniusApiRubyClient::DockApi* | [**dock_find_one**](docs/DockApi.md#dock_find_one) | **GET** /Docks/findOne | Find first instance of the model matched by filter from the data source.
133
- *DockGeniusApiRubyClient::DockApi* | [**dock_prototype_create_listing_agent**](docs/DockApi.md#dock_prototype_create_listing_agent) | **POST** /Docks/{id}/listingAgent | Creates a new instance in listingAgent of this model.
134
- *DockGeniusApiRubyClient::DockApi* | [**dock_prototype_destroy_listing_agent**](docs/DockApi.md#dock_prototype_destroy_listing_agent) | **DELETE** /Docks/{id}/listingAgent | Deletes listingAgent of this model.
135
- *DockGeniusApiRubyClient::DockApi* | [**dock_prototype_get_listing_agent**](docs/DockApi.md#dock_prototype_get_listing_agent) | **GET** /Docks/{id}/listingAgent | Fetches hasOne relation listingAgent.
136
- *DockGeniusApiRubyClient::DockApi* | [**dock_prototype_get_marina**](docs/DockApi.md#dock_prototype_get_marina) | **GET** /Docks/{id}/marina | Fetches belongsTo relation marina.
137
- *DockGeniusApiRubyClient::DockApi* | [**dock_prototype_update_attributes_patch_docksid**](docs/DockApi.md#dock_prototype_update_attributes_patch_docksid) | **PATCH** /Docks/{id} | Patch attributes for a model instance and persist it into the data source.
138
- *DockGeniusApiRubyClient::DockApi* | [**dock_prototype_update_attributes_put_docksid**](docs/DockApi.md#dock_prototype_update_attributes_put_docksid) | **PUT** /Docks/{id} | Patch attributes for a model instance and persist it into the data source.
139
- *DockGeniusApiRubyClient::DockApi* | [**dock_prototype_update_listing_agent**](docs/DockApi.md#dock_prototype_update_listing_agent) | **PUT** /Docks/{id}/listingAgent | Update listingAgent of this model.
140
- *DockGeniusApiRubyClient::DockApi* | [**dock_replace_by_id**](docs/DockApi.md#dock_replace_by_id) | **POST** /Docks/{id}/replace | Replace attributes for a model instance and persist it into the data source.
141
- *DockGeniusApiRubyClient::DockApi* | [**dock_replace_or_create**](docs/DockApi.md#dock_replace_or_create) | **POST** /Docks/replaceOrCreate | Replace an existing model instance or insert a new one into the data source.
142
- *DockGeniusApiRubyClient::DockApi* | [**dock_update_all**](docs/DockApi.md#dock_update_all) | **POST** /Docks/update | Update instances of the model matched by {{where}} from the data source.
143
- *DockGeniusApiRubyClient::DockApi* | [**dock_upsert_patch_docks**](docs/DockApi.md#dock_upsert_patch_docks) | **PATCH** /Docks | Patch an existing model instance or insert a new one into the data source.
144
- *DockGeniusApiRubyClient::DockApi* | [**dock_upsert_put_docks**](docs/DockApi.md#dock_upsert_put_docks) | **PUT** /Docks | Patch an existing model instance or insert a new one into the data source.
145
- *DockGeniusApiRubyClient::DockApi* | [**dock_upsert_with_where**](docs/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.
146
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_count**](docs/MarinaApi.md#marina_count) | **GET** /Marinas/count | Count instances of the model matched by where from the data source.
147
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_create**](docs/MarinaApi.md#marina_create) | **POST** /Marinas | Create a new instance of the model and persist it into the data source.
148
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_create_change_stream_get_marinas_change_stream**](docs/MarinaApi.md#marina_create_change_stream_get_marinas_change_stream) | **GET** /Marinas/change-stream | Create a change stream.
149
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_create_change_stream_post_marinas_change_stream**](docs/MarinaApi.md#marina_create_change_stream_post_marinas_change_stream) | **POST** /Marinas/change-stream | Create a change stream.
150
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_delete_by_id**](docs/MarinaApi.md#marina_delete_by_id) | **DELETE** /Marinas/{id} | Delete a model instance by {{id}} from the data source.
151
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_exists_get_marinasid_exists**](docs/MarinaApi.md#marina_exists_get_marinasid_exists) | **GET** /Marinas/{id}/exists | Check whether a model instance exists in the data source.
152
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_exists_head_marinasid**](docs/MarinaApi.md#marina_exists_head_marinasid) | **HEAD** /Marinas/{id} | Check whether a model instance exists in the data source.
153
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_find**](docs/MarinaApi.md#marina_find) | **GET** /Marinas | Find all instances of the model matched by filter from the data source.
154
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_find_by_id**](docs/MarinaApi.md#marina_find_by_id) | **GET** /Marinas/{id} | Find a model instance by {{id}} from the data source.
155
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_find_one**](docs/MarinaApi.md#marina_find_one) | **GET** /Marinas/findOne | Find first instance of the model matched by filter from the data source.
156
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_count_docks**](docs/MarinaApi.md#marina_prototype_count_docks) | **GET** /Marinas/{id}/docks/count | Counts docks of Marina.
157
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_create_address**](docs/MarinaApi.md#marina_prototype_create_address) | **POST** /Marinas/{id}/address | Creates a new instance in address of this model.
158
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_create_docks**](docs/MarinaApi.md#marina_prototype_create_docks) | **POST** /Marinas/{id}/docks | Creates a new instance in docks of this model.
159
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_create_listing_agent**](docs/MarinaApi.md#marina_prototype_create_listing_agent) | **POST** /Marinas/{id}/listingAgent | Creates a new instance in listingAgent of this model.
160
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_delete_docks**](docs/MarinaApi.md#marina_prototype_delete_docks) | **DELETE** /Marinas/{id}/docks | Deletes all docks of this model.
161
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_destroy_address**](docs/MarinaApi.md#marina_prototype_destroy_address) | **DELETE** /Marinas/{id}/address | Deletes address of this model.
162
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_destroy_by_id_docks**](docs/MarinaApi.md#marina_prototype_destroy_by_id_docks) | **DELETE** /Marinas/{id}/docks/{fk} | Delete a related item by id for docks.
163
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_destroy_listing_agent**](docs/MarinaApi.md#marina_prototype_destroy_listing_agent) | **DELETE** /Marinas/{id}/listingAgent | Deletes listingAgent of this model.
164
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_find_by_id_docks**](docs/MarinaApi.md#marina_prototype_find_by_id_docks) | **GET** /Marinas/{id}/docks/{fk} | Find a related item by id for docks.
165
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_get_address**](docs/MarinaApi.md#marina_prototype_get_address) | **GET** /Marinas/{id}/address | Fetches hasOne relation address.
166
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_get_docks**](docs/MarinaApi.md#marina_prototype_get_docks) | **GET** /Marinas/{id}/docks | Queries docks of Marina.
167
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_get_listing_agent**](docs/MarinaApi.md#marina_prototype_get_listing_agent) | **GET** /Marinas/{id}/listingAgent | Fetches hasOne relation listingAgent.
168
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_update_address**](docs/MarinaApi.md#marina_prototype_update_address) | **PUT** /Marinas/{id}/address | Update address of this model.
169
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_update_attributes_patch_marinasid**](docs/MarinaApi.md#marina_prototype_update_attributes_patch_marinasid) | **PATCH** /Marinas/{id} | Patch attributes for a model instance and persist it into the data source.
170
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_update_attributes_put_marinasid**](docs/MarinaApi.md#marina_prototype_update_attributes_put_marinasid) | **PUT** /Marinas/{id} | Patch attributes for a model instance and persist it into the data source.
171
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_update_by_id_docks**](docs/MarinaApi.md#marina_prototype_update_by_id_docks) | **PUT** /Marinas/{id}/docks/{fk} | Update a related item by id for docks.
172
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_prototype_update_listing_agent**](docs/MarinaApi.md#marina_prototype_update_listing_agent) | **PUT** /Marinas/{id}/listingAgent | Update listingAgent of this model.
173
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_replace_by_id**](docs/MarinaApi.md#marina_replace_by_id) | **POST** /Marinas/{id}/replace | Replace attributes for a model instance and persist it into the data source.
174
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_replace_or_create**](docs/MarinaApi.md#marina_replace_or_create) | **POST** /Marinas/replaceOrCreate | Replace an existing model instance or insert a new one into the data source.
175
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_update_all**](docs/MarinaApi.md#marina_update_all) | **POST** /Marinas/update | Update instances of the model matched by {{where}} from the data source.
176
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_upsert_patch_marinas**](docs/MarinaApi.md#marina_upsert_patch_marinas) | **PATCH** /Marinas | Patch an existing model instance or insert a new one into the data source.
177
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_upsert_put_marinas**](docs/MarinaApi.md#marina_upsert_put_marinas) | **PUT** /Marinas | Patch an existing model instance or insert a new one into the data source.
178
- *DockGeniusApiRubyClient::MarinaApi* | [**marina_upsert_with_where**](docs/MarinaApi.md#marina_upsert_with_where) | **POST** /Marinas/upsertWithWhere | Update an existing model instance or insert a new one into the data source based on the where criteria.
179
-
180
-
181
- ## Documentation for Models
182
-
183
- - [DockGeniusApiRubyClient::AccessToken](docs/AccessToken.md)
184
- - [DockGeniusApiRubyClient::Address](docs/Address.md)
185
- - [DockGeniusApiRubyClient::Customer](docs/Customer.md)
186
- - [DockGeniusApiRubyClient::Dock](docs/Dock.md)
187
- - [DockGeniusApiRubyClient::EmailAddress](docs/EmailAddress.md)
188
- - [DockGeniusApiRubyClient::GeoPoint](docs/GeoPoint.md)
189
- - [DockGeniusApiRubyClient::InlineResponse200](docs/InlineResponse200.md)
190
- - [DockGeniusApiRubyClient::InlineResponse2001](docs/InlineResponse2001.md)
191
- - [DockGeniusApiRubyClient::InlineResponse2002](docs/InlineResponse2002.md)
192
- - [DockGeniusApiRubyClient::ListingAgent](docs/ListingAgent.md)
193
- - [DockGeniusApiRubyClient::Marina](docs/Marina.md)
194
- - [DockGeniusApiRubyClient::Phone](docs/Phone.md)
195
-
196
-
197
- ## Documentation for Authorization
198
-
199
- All endpoints do not require authorization.
200
-
@@ -1,55 +0,0 @@
1
- # -*- encoding: utf-8 -*-
2
- #
3
- =begin
4
- #dockgenius-sl
5
-
6
- #No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
7
-
8
- OpenAPI spec version: 0.1.0
9
-
10
- Generated by: https://github.com/swagger-api/swagger-codegen.git
11
-
12
- Licensed under the Apache License, Version 2.0 (the "License");
13
- you may not use this file except in compliance with the License.
14
- You may obtain a copy of the License at
15
-
16
- http://www.apache.org/licenses/LICENSE-2.0
17
-
18
- Unless required by applicable law or agreed to in writing, software
19
- distributed under the License is distributed on an "AS IS" BASIS,
20
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21
- See the License for the specific language governing permissions and
22
- limitations under the License.
23
-
24
- =end
25
-
26
- $:.push File.expand_path("../lib", __FILE__)
27
- require "dock_genius_api_ruby_client/version"
28
-
29
- Gem::Specification.new do |s|
30
- s.name = "dock_genius_api_ruby_client"
31
- s.version = DockGeniusApiRubyClient::VERSION
32
- s.platform = Gem::Platform::RUBY
33
- s.authors = ["The DockGenius Engineering Team"]
34
- s.email = ["hi@dockgenius.com"]
35
- s.homepage = "https://github.com/swagger-api/swagger-codegen"
36
- s.summary = "A ruby gem for the DockGenius API"
37
- s.description = "Use this gem to access the DockGenius API using Ruby"
38
- s.license = "Nonstandard"
39
-
40
- s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
41
- s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
42
-
43
- s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
44
- s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
45
- s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
46
- s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
47
- s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
48
- s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
49
- s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
50
-
51
- s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
52
- s.test_files = `find spec/*`.split("\n")
53
- s.executables = []
54
- s.require_paths = ["lib"]
55
- end
@@ -1,11 +0,0 @@
1
- # DockGeniusApiRubyClient::AccessToken
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | |
7
- **ttl** | **Float** | time to live in seconds (2 weeks by default) | [optional] [default to 1209600.0]
8
- **created** | **Date** | | [optional]
9
- **user_id** | **Float** | | [optional]
10
-
11
-
@@ -1,16 +0,0 @@
1
- # DockGeniusApiRubyClient::Address
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **country** | **String** | Country (always required, 2 character ISO code) | [optional] [default to "US"]
7
- **administrative_area** | **String** | State / Province / Region (ISO code when available) | [optional]
8
- **sub_administrative_area** | **String** | County / District (optional) | [optional]
9
- **locality** | **String** | City / Town | [optional]
10
- **dependent_locality** | **String** | Dependent locality (unused in the US) | [optional]
11
- **postal_code** | **String** | Postal code / ZIP Code | [optional]
12
- **thoroughfare** | **String** | Street address (including number in the US) | [optional]
13
- **premise** | **String** | Apartment, Suite, Box number, etc. | [optional]
14
- **id** | **String** | | [optional]
15
-
16
-
@@ -1,22 +0,0 @@
1
- # DockGeniusApiRubyClient::Customer
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **first_name** | **String** | |
7
- **last_name** | **String** | |
8
- **image_url** | **String** | | [optional]
9
- **realm** | **String** | | [optional]
10
- **username** | **String** | | [optional]
11
- **credentials** | **Object** | | [optional]
12
- **challenges** | **Object** | | [optional]
13
- **email** | **String** | |
14
- **email_verified** | **BOOLEAN** | | [optional]
15
- **status** | **String** | | [optional]
16
- **created** | **Date** | | [optional]
17
- **last_updated** | **Date** | | [optional]
18
- **id** | **Float** | | [optional]
19
- **billing_address** | [**Address**](Address.md) | | [optional]
20
- **email_list** | [**Array<EmailAddress>**](EmailAddress.md) | | [optional]
21
-
22
-
@@ -1,1938 +0,0 @@
1
- # DockGeniusApiRubyClient::CustomerApi
2
-
3
- All URIs are relative to *https://localhost/api*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**customer_confirm**](CustomerApi.md#customer_confirm) | **GET** /Customers/confirm | Confirm a user registration with email verification token.
8
- [**customer_count**](CustomerApi.md#customer_count) | **GET** /Customers/count | Count instances of the model matched by where from the data source.
9
- [**customer_create**](CustomerApi.md#customer_create) | **POST** /Customers | Create a new instance of the model and persist it into the data source.
10
- [**customer_create_change_stream_get_customers_change_stream**](CustomerApi.md#customer_create_change_stream_get_customers_change_stream) | **GET** /Customers/change-stream | Create a change stream.
11
- [**customer_create_change_stream_post_customers_change_stream**](CustomerApi.md#customer_create_change_stream_post_customers_change_stream) | **POST** /Customers/change-stream | Create a change stream.
12
- [**customer_delete_by_id**](CustomerApi.md#customer_delete_by_id) | **DELETE** /Customers/{id} | Delete a model instance by {{id}} from the data source.
13
- [**customer_exists_get_customersid_exists**](CustomerApi.md#customer_exists_get_customersid_exists) | **GET** /Customers/{id}/exists | Check whether a model instance exists in the data source.
14
- [**customer_exists_head_customersid**](CustomerApi.md#customer_exists_head_customersid) | **HEAD** /Customers/{id} | Check whether a model instance exists in the data source.
15
- [**customer_find**](CustomerApi.md#customer_find) | **GET** /Customers | Find all instances of the model matched by filter from the data source.
16
- [**customer_find_by_id**](CustomerApi.md#customer_find_by_id) | **GET** /Customers/{id} | Find a model instance by {{id}} from the data source.
17
- [**customer_find_one**](CustomerApi.md#customer_find_one) | **GET** /Customers/findOne | Find first instance of the model matched by filter from the data source.
18
- [**customer_login**](CustomerApi.md#customer_login) | **POST** /Customers/login | Login a user with username/email and password.
19
- [**customer_logout**](CustomerApi.md#customer_logout) | **POST** /Customers/logout | Logout a user with access token.
20
- [**customer_prototype_count_access_tokens**](CustomerApi.md#customer_prototype_count_access_tokens) | **GET** /Customers/{id}/accessTokens/count | Counts accessTokens of Customer.
21
- [**customer_prototype_count_emails**](CustomerApi.md#customer_prototype_count_emails) | **GET** /Customers/{id}/emails/count | Counts emails of Customer.
22
- [**customer_prototype_create_access_tokens**](CustomerApi.md#customer_prototype_create_access_tokens) | **POST** /Customers/{id}/accessTokens | Creates a new instance in accessTokens of this model.
23
- [**customer_prototype_create_address**](CustomerApi.md#customer_prototype_create_address) | **POST** /Customers/{id}/address | Creates a new instance in address of this model.
24
- [**customer_prototype_create_emails**](CustomerApi.md#customer_prototype_create_emails) | **POST** /Customers/{id}/emails | Creates a new instance in emails of this model.
25
- [**customer_prototype_delete_access_tokens**](CustomerApi.md#customer_prototype_delete_access_tokens) | **DELETE** /Customers/{id}/accessTokens | Deletes all accessTokens of this model.
26
- [**customer_prototype_delete_emails**](CustomerApi.md#customer_prototype_delete_emails) | **DELETE** /Customers/{id}/emails | Deletes all emails of this model.
27
- [**customer_prototype_destroy_address**](CustomerApi.md#customer_prototype_destroy_address) | **DELETE** /Customers/{id}/address | Deletes address of this model.
28
- [**customer_prototype_destroy_by_id_access_tokens**](CustomerApi.md#customer_prototype_destroy_by_id_access_tokens) | **DELETE** /Customers/{id}/accessTokens/{fk} | Delete a related item by id for accessTokens.
29
- [**customer_prototype_destroy_by_id_emails**](CustomerApi.md#customer_prototype_destroy_by_id_emails) | **DELETE** /Customers/{id}/emails/{fk} | Delete a related item by id for emails.
30
- [**customer_prototype_find_by_id_access_tokens**](CustomerApi.md#customer_prototype_find_by_id_access_tokens) | **GET** /Customers/{id}/accessTokens/{fk} | Find a related item by id for accessTokens.
31
- [**customer_prototype_find_by_id_emails**](CustomerApi.md#customer_prototype_find_by_id_emails) | **GET** /Customers/{id}/emails/{fk} | Find a related item by id for emails.
32
- [**customer_prototype_get_access_tokens**](CustomerApi.md#customer_prototype_get_access_tokens) | **GET** /Customers/{id}/accessTokens | Queries accessTokens of Customer.
33
- [**customer_prototype_get_address**](CustomerApi.md#customer_prototype_get_address) | **GET** /Customers/{id}/address | Fetches hasOne relation address.
34
- [**customer_prototype_get_emails**](CustomerApi.md#customer_prototype_get_emails) | **GET** /Customers/{id}/emails | Queries emails of Customer.
35
- [**customer_prototype_update_address**](CustomerApi.md#customer_prototype_update_address) | **PUT** /Customers/{id}/address | Update address of this model.
36
- [**customer_prototype_update_attributes_patch_customersid**](CustomerApi.md#customer_prototype_update_attributes_patch_customersid) | **PATCH** /Customers/{id} | Patch attributes for a model instance and persist it into the data source.
37
- [**customer_prototype_update_attributes_put_customersid**](CustomerApi.md#customer_prototype_update_attributes_put_customersid) | **PUT** /Customers/{id} | Patch attributes for a model instance and persist it into the data source.
38
- [**customer_prototype_update_by_id_access_tokens**](CustomerApi.md#customer_prototype_update_by_id_access_tokens) | **PUT** /Customers/{id}/accessTokens/{fk} | Update a related item by id for accessTokens.
39
- [**customer_prototype_update_by_id_emails**](CustomerApi.md#customer_prototype_update_by_id_emails) | **PUT** /Customers/{id}/emails/{fk} | Update a related item by id for emails.
40
- [**customer_replace_by_id**](CustomerApi.md#customer_replace_by_id) | **POST** /Customers/{id}/replace | Replace attributes for a model instance and persist it into the data source.
41
- [**customer_replace_or_create**](CustomerApi.md#customer_replace_or_create) | **POST** /Customers/replaceOrCreate | Replace an existing model instance or insert a new one into the data source.
42
- [**customer_reset_password**](CustomerApi.md#customer_reset_password) | **POST** /Customers/reset | Reset password for a user with email.
43
- [**customer_update_all**](CustomerApi.md#customer_update_all) | **POST** /Customers/update | Update instances of the model matched by {{where}} from the data source.
44
- [**customer_upsert_patch_customers**](CustomerApi.md#customer_upsert_patch_customers) | **PATCH** /Customers | Patch an existing model instance or insert a new one into the data source.
45
- [**customer_upsert_put_customers**](CustomerApi.md#customer_upsert_put_customers) | **PUT** /Customers | Patch an existing model instance or insert a new one into the data source.
46
- [**customer_upsert_with_where**](CustomerApi.md#customer_upsert_with_where) | **POST** /Customers/upsertWithWhere | Update an existing model instance or insert a new one into the data source based on the where criteria.
47
-
48
-
49
- # **customer_confirm**
50
- > customer_confirm(uid, token, opts)
51
-
52
- Confirm a user registration with email verification token.
53
-
54
- ### Example
55
- ```ruby
56
- # load the gem
57
- require 'dock_genius_api_ruby_client'
58
-
59
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
60
-
61
- uid = "uid_example" # String |
62
-
63
- token = "token_example" # String |
64
-
65
- opts = {
66
- redirect: "redirect_example" # String |
67
- }
68
-
69
- begin
70
- #Confirm a user registration with email verification token.
71
- api_instance.customer_confirm(uid, token, opts)
72
- rescue DockGeniusApiRubyClient::ApiError => e
73
- puts "Exception when calling CustomerApi->customer_confirm: #{e}"
74
- end
75
- ```
76
-
77
- ### Parameters
78
-
79
- Name | Type | Description | Notes
80
- ------------- | ------------- | ------------- | -------------
81
- **uid** | **String**| |
82
- **token** | **String**| |
83
- **redirect** | **String**| | [optional]
84
-
85
- ### Return type
86
-
87
- nil (empty response body)
88
-
89
- ### Authorization
90
-
91
- No authorization required
92
-
93
- ### HTTP request headers
94
-
95
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
96
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
97
-
98
-
99
-
100
- # **customer_count**
101
- > InlineResponse200 customer_count(opts)
102
-
103
- Count instances of the model matched by where from the data source.
104
-
105
- ### Example
106
- ```ruby
107
- # load the gem
108
- require 'dock_genius_api_ruby_client'
109
-
110
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
111
-
112
- opts = {
113
- where: "where_example" # String | Criteria to match model instances
114
- }
115
-
116
- begin
117
- #Count instances of the model matched by where from the data source.
118
- result = api_instance.customer_count(opts)
119
- p result
120
- rescue DockGeniusApiRubyClient::ApiError => e
121
- puts "Exception when calling CustomerApi->customer_count: #{e}"
122
- end
123
- ```
124
-
125
- ### Parameters
126
-
127
- Name | Type | Description | Notes
128
- ------------- | ------------- | ------------- | -------------
129
- **where** | **String**| Criteria to match model instances | [optional]
130
-
131
- ### Return type
132
-
133
- [**InlineResponse200**](InlineResponse200.md)
134
-
135
- ### Authorization
136
-
137
- No authorization required
138
-
139
- ### HTTP request headers
140
-
141
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
142
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
143
-
144
-
145
-
146
- # **customer_create**
147
- > Customer customer_create(opts)
148
-
149
- Create a new instance of the model and persist it into the data source.
150
-
151
- ### Example
152
- ```ruby
153
- # load the gem
154
- require 'dock_genius_api_ruby_client'
155
-
156
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
157
-
158
- opts = {
159
- data: DockGeniusApiRubyClient::Customer.new # Customer | Model instance data
160
- }
161
-
162
- begin
163
- #Create a new instance of the model and persist it into the data source.
164
- result = api_instance.customer_create(opts)
165
- p result
166
- rescue DockGeniusApiRubyClient::ApiError => e
167
- puts "Exception when calling CustomerApi->customer_create: #{e}"
168
- end
169
- ```
170
-
171
- ### Parameters
172
-
173
- Name | Type | Description | Notes
174
- ------------- | ------------- | ------------- | -------------
175
- **data** | [**Customer**](Customer.md)| Model instance data | [optional]
176
-
177
- ### Return type
178
-
179
- [**Customer**](Customer.md)
180
-
181
- ### Authorization
182
-
183
- No authorization required
184
-
185
- ### HTTP request headers
186
-
187
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
188
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
189
-
190
-
191
-
192
- # **customer_create_change_stream_get_customers_change_stream**
193
- > File customer_create_change_stream_get_customers_change_stream(opts)
194
-
195
- Create a change stream.
196
-
197
- ### Example
198
- ```ruby
199
- # load the gem
200
- require 'dock_genius_api_ruby_client'
201
-
202
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
203
-
204
- opts = {
205
- options: "options_example" # String |
206
- }
207
-
208
- begin
209
- #Create a change stream.
210
- result = api_instance.customer_create_change_stream_get_customers_change_stream(opts)
211
- p result
212
- rescue DockGeniusApiRubyClient::ApiError => e
213
- puts "Exception when calling CustomerApi->customer_create_change_stream_get_customers_change_stream: #{e}"
214
- end
215
- ```
216
-
217
- ### Parameters
218
-
219
- Name | Type | Description | Notes
220
- ------------- | ------------- | ------------- | -------------
221
- **options** | **String**| | [optional]
222
-
223
- ### Return type
224
-
225
- **File**
226
-
227
- ### Authorization
228
-
229
- No authorization required
230
-
231
- ### HTTP request headers
232
-
233
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
234
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
235
-
236
-
237
-
238
- # **customer_create_change_stream_post_customers_change_stream**
239
- > File customer_create_change_stream_post_customers_change_stream(opts)
240
-
241
- Create a change stream.
242
-
243
- ### Example
244
- ```ruby
245
- # load the gem
246
- require 'dock_genius_api_ruby_client'
247
-
248
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
249
-
250
- opts = {
251
- options: "options_example" # String |
252
- }
253
-
254
- begin
255
- #Create a change stream.
256
- result = api_instance.customer_create_change_stream_post_customers_change_stream(opts)
257
- p result
258
- rescue DockGeniusApiRubyClient::ApiError => e
259
- puts "Exception when calling CustomerApi->customer_create_change_stream_post_customers_change_stream: #{e}"
260
- end
261
- ```
262
-
263
- ### Parameters
264
-
265
- Name | Type | Description | Notes
266
- ------------- | ------------- | ------------- | -------------
267
- **options** | **String**| | [optional]
268
-
269
- ### Return type
270
-
271
- **File**
272
-
273
- ### Authorization
274
-
275
- No authorization required
276
-
277
- ### HTTP request headers
278
-
279
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
280
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
281
-
282
-
283
-
284
- # **customer_delete_by_id**
285
- > Object customer_delete_by_id(id)
286
-
287
- Delete a model instance by {{id}} from the data source.
288
-
289
- ### Example
290
- ```ruby
291
- # load the gem
292
- require 'dock_genius_api_ruby_client'
293
-
294
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
295
-
296
- id = "id_example" # String | Model id
297
-
298
-
299
- begin
300
- #Delete a model instance by {{id}} from the data source.
301
- result = api_instance.customer_delete_by_id(id)
302
- p result
303
- rescue DockGeniusApiRubyClient::ApiError => e
304
- puts "Exception when calling CustomerApi->customer_delete_by_id: #{e}"
305
- end
306
- ```
307
-
308
- ### Parameters
309
-
310
- Name | Type | Description | Notes
311
- ------------- | ------------- | ------------- | -------------
312
- **id** | **String**| Model id |
313
-
314
- ### Return type
315
-
316
- **Object**
317
-
318
- ### Authorization
319
-
320
- No authorization required
321
-
322
- ### HTTP request headers
323
-
324
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
325
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
326
-
327
-
328
-
329
- # **customer_exists_get_customersid_exists**
330
- > InlineResponse2002 customer_exists_get_customersid_exists(id)
331
-
332
- Check whether a model instance exists in the data source.
333
-
334
- ### Example
335
- ```ruby
336
- # load the gem
337
- require 'dock_genius_api_ruby_client'
338
-
339
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
340
-
341
- id = "id_example" # String | Model id
342
-
343
-
344
- begin
345
- #Check whether a model instance exists in the data source.
346
- result = api_instance.customer_exists_get_customersid_exists(id)
347
- p result
348
- rescue DockGeniusApiRubyClient::ApiError => e
349
- puts "Exception when calling CustomerApi->customer_exists_get_customersid_exists: #{e}"
350
- end
351
- ```
352
-
353
- ### Parameters
354
-
355
- Name | Type | Description | Notes
356
- ------------- | ------------- | ------------- | -------------
357
- **id** | **String**| Model id |
358
-
359
- ### Return type
360
-
361
- [**InlineResponse2002**](InlineResponse2002.md)
362
-
363
- ### Authorization
364
-
365
- No authorization required
366
-
367
- ### HTTP request headers
368
-
369
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
370
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
371
-
372
-
373
-
374
- # **customer_exists_head_customersid**
375
- > InlineResponse2002 customer_exists_head_customersid(id)
376
-
377
- Check whether a model instance exists in the data source.
378
-
379
- ### Example
380
- ```ruby
381
- # load the gem
382
- require 'dock_genius_api_ruby_client'
383
-
384
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
385
-
386
- id = "id_example" # String | Model id
387
-
388
-
389
- begin
390
- #Check whether a model instance exists in the data source.
391
- result = api_instance.customer_exists_head_customersid(id)
392
- p result
393
- rescue DockGeniusApiRubyClient::ApiError => e
394
- puts "Exception when calling CustomerApi->customer_exists_head_customersid: #{e}"
395
- end
396
- ```
397
-
398
- ### Parameters
399
-
400
- Name | Type | Description | Notes
401
- ------------- | ------------- | ------------- | -------------
402
- **id** | **String**| Model id |
403
-
404
- ### Return type
405
-
406
- [**InlineResponse2002**](InlineResponse2002.md)
407
-
408
- ### Authorization
409
-
410
- No authorization required
411
-
412
- ### HTTP request headers
413
-
414
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
415
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
416
-
417
-
418
-
419
- # **customer_find**
420
- > Array<Customer> customer_find(opts)
421
-
422
- Find all instances of the model matched by filter from the data source.
423
-
424
- ### Example
425
- ```ruby
426
- # load the gem
427
- require 'dock_genius_api_ruby_client'
428
-
429
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
430
-
431
- opts = {
432
- filter: "filter_example" # String | Filter defining fields, where, include, order, offset, and limit
433
- }
434
-
435
- begin
436
- #Find all instances of the model matched by filter from the data source.
437
- result = api_instance.customer_find(opts)
438
- p result
439
- rescue DockGeniusApiRubyClient::ApiError => e
440
- puts "Exception when calling CustomerApi->customer_find: #{e}"
441
- end
442
- ```
443
-
444
- ### Parameters
445
-
446
- Name | Type | Description | Notes
447
- ------------- | ------------- | ------------- | -------------
448
- **filter** | **String**| Filter defining fields, where, include, order, offset, and limit | [optional]
449
-
450
- ### Return type
451
-
452
- [**Array<Customer>**](Customer.md)
453
-
454
- ### Authorization
455
-
456
- No authorization required
457
-
458
- ### HTTP request headers
459
-
460
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
461
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
462
-
463
-
464
-
465
- # **customer_find_by_id**
466
- > Customer customer_find_by_id(id, opts)
467
-
468
- Find a model instance by {{id}} from the data source.
469
-
470
- ### Example
471
- ```ruby
472
- # load the gem
473
- require 'dock_genius_api_ruby_client'
474
-
475
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
476
-
477
- id = "id_example" # String | Model id
478
-
479
- opts = {
480
- filter: "filter_example" # String | Filter defining fields and include
481
- }
482
-
483
- begin
484
- #Find a model instance by {{id}} from the data source.
485
- result = api_instance.customer_find_by_id(id, opts)
486
- p result
487
- rescue DockGeniusApiRubyClient::ApiError => e
488
- puts "Exception when calling CustomerApi->customer_find_by_id: #{e}"
489
- end
490
- ```
491
-
492
- ### Parameters
493
-
494
- Name | Type | Description | Notes
495
- ------------- | ------------- | ------------- | -------------
496
- **id** | **String**| Model id |
497
- **filter** | **String**| Filter defining fields and include | [optional]
498
-
499
- ### Return type
500
-
501
- [**Customer**](Customer.md)
502
-
503
- ### Authorization
504
-
505
- No authorization required
506
-
507
- ### HTTP request headers
508
-
509
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
510
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
511
-
512
-
513
-
514
- # **customer_find_one**
515
- > Customer customer_find_one(opts)
516
-
517
- Find first instance of the model matched by filter from the data source.
518
-
519
- ### Example
520
- ```ruby
521
- # load the gem
522
- require 'dock_genius_api_ruby_client'
523
-
524
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
525
-
526
- opts = {
527
- filter: "filter_example" # String | Filter defining fields, where, include, order, offset, and limit
528
- }
529
-
530
- begin
531
- #Find first instance of the model matched by filter from the data source.
532
- result = api_instance.customer_find_one(opts)
533
- p result
534
- rescue DockGeniusApiRubyClient::ApiError => e
535
- puts "Exception when calling CustomerApi->customer_find_one: #{e}"
536
- end
537
- ```
538
-
539
- ### Parameters
540
-
541
- Name | Type | Description | Notes
542
- ------------- | ------------- | ------------- | -------------
543
- **filter** | **String**| Filter defining fields, where, include, order, offset, and limit | [optional]
544
-
545
- ### Return type
546
-
547
- [**Customer**](Customer.md)
548
-
549
- ### Authorization
550
-
551
- No authorization required
552
-
553
- ### HTTP request headers
554
-
555
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
556
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
557
-
558
-
559
-
560
- # **customer_login**
561
- > Object customer_login(credentials, opts)
562
-
563
- Login a user with username/email and password.
564
-
565
- ### Example
566
- ```ruby
567
- # load the gem
568
- require 'dock_genius_api_ruby_client'
569
-
570
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
571
-
572
- credentials = nil # Object |
573
-
574
- opts = {
575
- include: "include_example" # String | Related objects to include in the response. See the description of return value for more details.
576
- }
577
-
578
- begin
579
- #Login a user with username/email and password.
580
- result = api_instance.customer_login(credentials, opts)
581
- p result
582
- rescue DockGeniusApiRubyClient::ApiError => e
583
- puts "Exception when calling CustomerApi->customer_login: #{e}"
584
- end
585
- ```
586
-
587
- ### Parameters
588
-
589
- Name | Type | Description | Notes
590
- ------------- | ------------- | ------------- | -------------
591
- **credentials** | **Object**| |
592
- **include** | **String**| Related objects to include in the response. See the description of return value for more details. | [optional]
593
-
594
- ### Return type
595
-
596
- **Object**
597
-
598
- ### Authorization
599
-
600
- No authorization required
601
-
602
- ### HTTP request headers
603
-
604
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
605
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
606
-
607
-
608
-
609
- # **customer_logout**
610
- > customer_logout
611
-
612
- Logout a user with access token.
613
-
614
- ### Example
615
- ```ruby
616
- # load the gem
617
- require 'dock_genius_api_ruby_client'
618
-
619
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
620
-
621
- begin
622
- #Logout a user with access token.
623
- api_instance.customer_logout
624
- rescue DockGeniusApiRubyClient::ApiError => e
625
- puts "Exception when calling CustomerApi->customer_logout: #{e}"
626
- end
627
- ```
628
-
629
- ### Parameters
630
- This endpoint does not need any parameter.
631
-
632
- ### Return type
633
-
634
- nil (empty response body)
635
-
636
- ### Authorization
637
-
638
- No authorization required
639
-
640
- ### HTTP request headers
641
-
642
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
643
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
644
-
645
-
646
-
647
- # **customer_prototype_count_access_tokens**
648
- > InlineResponse200 customer_prototype_count_access_tokens(id, opts)
649
-
650
- Counts accessTokens of Customer.
651
-
652
- ### Example
653
- ```ruby
654
- # load the gem
655
- require 'dock_genius_api_ruby_client'
656
-
657
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
658
-
659
- id = "id_example" # String | User id
660
-
661
- opts = {
662
- where: "where_example" # String | Criteria to match model instances
663
- }
664
-
665
- begin
666
- #Counts accessTokens of Customer.
667
- result = api_instance.customer_prototype_count_access_tokens(id, opts)
668
- p result
669
- rescue DockGeniusApiRubyClient::ApiError => e
670
- puts "Exception when calling CustomerApi->customer_prototype_count_access_tokens: #{e}"
671
- end
672
- ```
673
-
674
- ### Parameters
675
-
676
- Name | Type | Description | Notes
677
- ------------- | ------------- | ------------- | -------------
678
- **id** | **String**| User id |
679
- **where** | **String**| Criteria to match model instances | [optional]
680
-
681
- ### Return type
682
-
683
- [**InlineResponse200**](InlineResponse200.md)
684
-
685
- ### Authorization
686
-
687
- No authorization required
688
-
689
- ### HTTP request headers
690
-
691
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
692
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
693
-
694
-
695
-
696
- # **customer_prototype_count_emails**
697
- > InlineResponse200 customer_prototype_count_emails(id, opts)
698
-
699
- Counts emails of Customer.
700
-
701
- ### Example
702
- ```ruby
703
- # load the gem
704
- require 'dock_genius_api_ruby_client'
705
-
706
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
707
-
708
- id = "id_example" # String | User id
709
-
710
- opts = {
711
- where: "where_example" # String | Criteria to match model instances
712
- }
713
-
714
- begin
715
- #Counts emails of Customer.
716
- result = api_instance.customer_prototype_count_emails(id, opts)
717
- p result
718
- rescue DockGeniusApiRubyClient::ApiError => e
719
- puts "Exception when calling CustomerApi->customer_prototype_count_emails: #{e}"
720
- end
721
- ```
722
-
723
- ### Parameters
724
-
725
- Name | Type | Description | Notes
726
- ------------- | ------------- | ------------- | -------------
727
- **id** | **String**| User id |
728
- **where** | **String**| Criteria to match model instances | [optional]
729
-
730
- ### Return type
731
-
732
- [**InlineResponse200**](InlineResponse200.md)
733
-
734
- ### Authorization
735
-
736
- No authorization required
737
-
738
- ### HTTP request headers
739
-
740
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
741
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
742
-
743
-
744
-
745
- # **customer_prototype_create_access_tokens**
746
- > AccessToken customer_prototype_create_access_tokens(id, opts)
747
-
748
- Creates a new instance in accessTokens of this model.
749
-
750
- ### Example
751
- ```ruby
752
- # load the gem
753
- require 'dock_genius_api_ruby_client'
754
-
755
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
756
-
757
- id = "id_example" # String | User id
758
-
759
- opts = {
760
- data: DockGeniusApiRubyClient::AccessToken.new # AccessToken |
761
- }
762
-
763
- begin
764
- #Creates a new instance in accessTokens of this model.
765
- result = api_instance.customer_prototype_create_access_tokens(id, opts)
766
- p result
767
- rescue DockGeniusApiRubyClient::ApiError => e
768
- puts "Exception when calling CustomerApi->customer_prototype_create_access_tokens: #{e}"
769
- end
770
- ```
771
-
772
- ### Parameters
773
-
774
- Name | Type | Description | Notes
775
- ------------- | ------------- | ------------- | -------------
776
- **id** | **String**| User id |
777
- **data** | [**AccessToken**](AccessToken.md)| | [optional]
778
-
779
- ### Return type
780
-
781
- [**AccessToken**](AccessToken.md)
782
-
783
- ### Authorization
784
-
785
- No authorization required
786
-
787
- ### HTTP request headers
788
-
789
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
790
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
791
-
792
-
793
-
794
- # **customer_prototype_create_address**
795
- > Address customer_prototype_create_address(id, opts)
796
-
797
- Creates a new instance in address of this model.
798
-
799
- ### Example
800
- ```ruby
801
- # load the gem
802
- require 'dock_genius_api_ruby_client'
803
-
804
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
805
-
806
- id = "id_example" # String | User id
807
-
808
- opts = {
809
- data: DockGeniusApiRubyClient::Address.new # Address |
810
- }
811
-
812
- begin
813
- #Creates a new instance in address of this model.
814
- result = api_instance.customer_prototype_create_address(id, opts)
815
- p result
816
- rescue DockGeniusApiRubyClient::ApiError => e
817
- puts "Exception when calling CustomerApi->customer_prototype_create_address: #{e}"
818
- end
819
- ```
820
-
821
- ### Parameters
822
-
823
- Name | Type | Description | Notes
824
- ------------- | ------------- | ------------- | -------------
825
- **id** | **String**| User id |
826
- **data** | [**Address**](Address.md)| | [optional]
827
-
828
- ### Return type
829
-
830
- [**Address**](Address.md)
831
-
832
- ### Authorization
833
-
834
- No authorization required
835
-
836
- ### HTTP request headers
837
-
838
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
839
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
840
-
841
-
842
-
843
- # **customer_prototype_create_emails**
844
- > EmailAddress customer_prototype_create_emails(id, opts)
845
-
846
- Creates a new instance in emails of this model.
847
-
848
- ### Example
849
- ```ruby
850
- # load the gem
851
- require 'dock_genius_api_ruby_client'
852
-
853
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
854
-
855
- id = "id_example" # String | User id
856
-
857
- opts = {
858
- data: DockGeniusApiRubyClient::EmailAddress.new # EmailAddress |
859
- }
860
-
861
- begin
862
- #Creates a new instance in emails of this model.
863
- result = api_instance.customer_prototype_create_emails(id, opts)
864
- p result
865
- rescue DockGeniusApiRubyClient::ApiError => e
866
- puts "Exception when calling CustomerApi->customer_prototype_create_emails: #{e}"
867
- end
868
- ```
869
-
870
- ### Parameters
871
-
872
- Name | Type | Description | Notes
873
- ------------- | ------------- | ------------- | -------------
874
- **id** | **String**| User id |
875
- **data** | [**EmailAddress**](EmailAddress.md)| | [optional]
876
-
877
- ### Return type
878
-
879
- [**EmailAddress**](EmailAddress.md)
880
-
881
- ### Authorization
882
-
883
- No authorization required
884
-
885
- ### HTTP request headers
886
-
887
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
888
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
889
-
890
-
891
-
892
- # **customer_prototype_delete_access_tokens**
893
- > customer_prototype_delete_access_tokens(id)
894
-
895
- Deletes all accessTokens of this model.
896
-
897
- ### Example
898
- ```ruby
899
- # load the gem
900
- require 'dock_genius_api_ruby_client'
901
-
902
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
903
-
904
- id = "id_example" # String | User id
905
-
906
-
907
- begin
908
- #Deletes all accessTokens of this model.
909
- api_instance.customer_prototype_delete_access_tokens(id)
910
- rescue DockGeniusApiRubyClient::ApiError => e
911
- puts "Exception when calling CustomerApi->customer_prototype_delete_access_tokens: #{e}"
912
- end
913
- ```
914
-
915
- ### Parameters
916
-
917
- Name | Type | Description | Notes
918
- ------------- | ------------- | ------------- | -------------
919
- **id** | **String**| User id |
920
-
921
- ### Return type
922
-
923
- nil (empty response body)
924
-
925
- ### Authorization
926
-
927
- No authorization required
928
-
929
- ### HTTP request headers
930
-
931
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
932
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
933
-
934
-
935
-
936
- # **customer_prototype_delete_emails**
937
- > customer_prototype_delete_emails(id)
938
-
939
- Deletes all emails of this model.
940
-
941
- ### Example
942
- ```ruby
943
- # load the gem
944
- require 'dock_genius_api_ruby_client'
945
-
946
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
947
-
948
- id = "id_example" # String | User id
949
-
950
-
951
- begin
952
- #Deletes all emails of this model.
953
- api_instance.customer_prototype_delete_emails(id)
954
- rescue DockGeniusApiRubyClient::ApiError => e
955
- puts "Exception when calling CustomerApi->customer_prototype_delete_emails: #{e}"
956
- end
957
- ```
958
-
959
- ### Parameters
960
-
961
- Name | Type | Description | Notes
962
- ------------- | ------------- | ------------- | -------------
963
- **id** | **String**| User id |
964
-
965
- ### Return type
966
-
967
- nil (empty response body)
968
-
969
- ### Authorization
970
-
971
- No authorization required
972
-
973
- ### HTTP request headers
974
-
975
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
976
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
977
-
978
-
979
-
980
- # **customer_prototype_destroy_address**
981
- > customer_prototype_destroy_address(id)
982
-
983
- Deletes address of this model.
984
-
985
- ### Example
986
- ```ruby
987
- # load the gem
988
- require 'dock_genius_api_ruby_client'
989
-
990
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
991
-
992
- id = "id_example" # String | User id
993
-
994
-
995
- begin
996
- #Deletes address of this model.
997
- api_instance.customer_prototype_destroy_address(id)
998
- rescue DockGeniusApiRubyClient::ApiError => e
999
- puts "Exception when calling CustomerApi->customer_prototype_destroy_address: #{e}"
1000
- end
1001
- ```
1002
-
1003
- ### Parameters
1004
-
1005
- Name | Type | Description | Notes
1006
- ------------- | ------------- | ------------- | -------------
1007
- **id** | **String**| User id |
1008
-
1009
- ### Return type
1010
-
1011
- nil (empty response body)
1012
-
1013
- ### Authorization
1014
-
1015
- No authorization required
1016
-
1017
- ### HTTP request headers
1018
-
1019
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1020
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1021
-
1022
-
1023
-
1024
- # **customer_prototype_destroy_by_id_access_tokens**
1025
- > customer_prototype_destroy_by_id_access_tokens(fk, id)
1026
-
1027
- Delete a related item by id for accessTokens.
1028
-
1029
- ### Example
1030
- ```ruby
1031
- # load the gem
1032
- require 'dock_genius_api_ruby_client'
1033
-
1034
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1035
-
1036
- fk = "fk_example" # String | Foreign key for accessTokens
1037
-
1038
- id = "id_example" # String | User id
1039
-
1040
-
1041
- begin
1042
- #Delete a related item by id for accessTokens.
1043
- api_instance.customer_prototype_destroy_by_id_access_tokens(fk, id)
1044
- rescue DockGeniusApiRubyClient::ApiError => e
1045
- puts "Exception when calling CustomerApi->customer_prototype_destroy_by_id_access_tokens: #{e}"
1046
- end
1047
- ```
1048
-
1049
- ### Parameters
1050
-
1051
- Name | Type | Description | Notes
1052
- ------------- | ------------- | ------------- | -------------
1053
- **fk** | **String**| Foreign key for accessTokens |
1054
- **id** | **String**| User id |
1055
-
1056
- ### Return type
1057
-
1058
- nil (empty response body)
1059
-
1060
- ### Authorization
1061
-
1062
- No authorization required
1063
-
1064
- ### HTTP request headers
1065
-
1066
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1067
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1068
-
1069
-
1070
-
1071
- # **customer_prototype_destroy_by_id_emails**
1072
- > customer_prototype_destroy_by_id_emails(fk, id)
1073
-
1074
- Delete a related item by id for emails.
1075
-
1076
- ### Example
1077
- ```ruby
1078
- # load the gem
1079
- require 'dock_genius_api_ruby_client'
1080
-
1081
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1082
-
1083
- fk = "fk_example" # String | Foreign key for emails
1084
-
1085
- id = "id_example" # String | User id
1086
-
1087
-
1088
- begin
1089
- #Delete a related item by id for emails.
1090
- api_instance.customer_prototype_destroy_by_id_emails(fk, id)
1091
- rescue DockGeniusApiRubyClient::ApiError => e
1092
- puts "Exception when calling CustomerApi->customer_prototype_destroy_by_id_emails: #{e}"
1093
- end
1094
- ```
1095
-
1096
- ### Parameters
1097
-
1098
- Name | Type | Description | Notes
1099
- ------------- | ------------- | ------------- | -------------
1100
- **fk** | **String**| Foreign key for emails |
1101
- **id** | **String**| User id |
1102
-
1103
- ### Return type
1104
-
1105
- nil (empty response body)
1106
-
1107
- ### Authorization
1108
-
1109
- No authorization required
1110
-
1111
- ### HTTP request headers
1112
-
1113
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1114
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1115
-
1116
-
1117
-
1118
- # **customer_prototype_find_by_id_access_tokens**
1119
- > AccessToken customer_prototype_find_by_id_access_tokens(fk, id)
1120
-
1121
- Find a related item by id for accessTokens.
1122
-
1123
- ### Example
1124
- ```ruby
1125
- # load the gem
1126
- require 'dock_genius_api_ruby_client'
1127
-
1128
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1129
-
1130
- fk = "fk_example" # String | Foreign key for accessTokens
1131
-
1132
- id = "id_example" # String | User id
1133
-
1134
-
1135
- begin
1136
- #Find a related item by id for accessTokens.
1137
- result = api_instance.customer_prototype_find_by_id_access_tokens(fk, id)
1138
- p result
1139
- rescue DockGeniusApiRubyClient::ApiError => e
1140
- puts "Exception when calling CustomerApi->customer_prototype_find_by_id_access_tokens: #{e}"
1141
- end
1142
- ```
1143
-
1144
- ### Parameters
1145
-
1146
- Name | Type | Description | Notes
1147
- ------------- | ------------- | ------------- | -------------
1148
- **fk** | **String**| Foreign key for accessTokens |
1149
- **id** | **String**| User id |
1150
-
1151
- ### Return type
1152
-
1153
- [**AccessToken**](AccessToken.md)
1154
-
1155
- ### Authorization
1156
-
1157
- No authorization required
1158
-
1159
- ### HTTP request headers
1160
-
1161
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1162
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1163
-
1164
-
1165
-
1166
- # **customer_prototype_find_by_id_emails**
1167
- > EmailAddress customer_prototype_find_by_id_emails(fk, id)
1168
-
1169
- Find a related item by id for emails.
1170
-
1171
- ### Example
1172
- ```ruby
1173
- # load the gem
1174
- require 'dock_genius_api_ruby_client'
1175
-
1176
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1177
-
1178
- fk = "fk_example" # String | Foreign key for emails
1179
-
1180
- id = "id_example" # String | User id
1181
-
1182
-
1183
- begin
1184
- #Find a related item by id for emails.
1185
- result = api_instance.customer_prototype_find_by_id_emails(fk, id)
1186
- p result
1187
- rescue DockGeniusApiRubyClient::ApiError => e
1188
- puts "Exception when calling CustomerApi->customer_prototype_find_by_id_emails: #{e}"
1189
- end
1190
- ```
1191
-
1192
- ### Parameters
1193
-
1194
- Name | Type | Description | Notes
1195
- ------------- | ------------- | ------------- | -------------
1196
- **fk** | **String**| Foreign key for emails |
1197
- **id** | **String**| User id |
1198
-
1199
- ### Return type
1200
-
1201
- [**EmailAddress**](EmailAddress.md)
1202
-
1203
- ### Authorization
1204
-
1205
- No authorization required
1206
-
1207
- ### HTTP request headers
1208
-
1209
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1210
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1211
-
1212
-
1213
-
1214
- # **customer_prototype_get_access_tokens**
1215
- > Array<AccessToken> customer_prototype_get_access_tokens(id, opts)
1216
-
1217
- Queries accessTokens of Customer.
1218
-
1219
- ### Example
1220
- ```ruby
1221
- # load the gem
1222
- require 'dock_genius_api_ruby_client'
1223
-
1224
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1225
-
1226
- id = "id_example" # String | User id
1227
-
1228
- opts = {
1229
- filter: "filter_example" # String |
1230
- }
1231
-
1232
- begin
1233
- #Queries accessTokens of Customer.
1234
- result = api_instance.customer_prototype_get_access_tokens(id, opts)
1235
- p result
1236
- rescue DockGeniusApiRubyClient::ApiError => e
1237
- puts "Exception when calling CustomerApi->customer_prototype_get_access_tokens: #{e}"
1238
- end
1239
- ```
1240
-
1241
- ### Parameters
1242
-
1243
- Name | Type | Description | Notes
1244
- ------------- | ------------- | ------------- | -------------
1245
- **id** | **String**| User id |
1246
- **filter** | **String**| | [optional]
1247
-
1248
- ### Return type
1249
-
1250
- [**Array<AccessToken>**](AccessToken.md)
1251
-
1252
- ### Authorization
1253
-
1254
- No authorization required
1255
-
1256
- ### HTTP request headers
1257
-
1258
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1259
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1260
-
1261
-
1262
-
1263
- # **customer_prototype_get_address**
1264
- > Address customer_prototype_get_address(id, opts)
1265
-
1266
- Fetches hasOne relation address.
1267
-
1268
- ### Example
1269
- ```ruby
1270
- # load the gem
1271
- require 'dock_genius_api_ruby_client'
1272
-
1273
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1274
-
1275
- id = "id_example" # String | User id
1276
-
1277
- opts = {
1278
- refresh: true # BOOLEAN |
1279
- }
1280
-
1281
- begin
1282
- #Fetches hasOne relation address.
1283
- result = api_instance.customer_prototype_get_address(id, opts)
1284
- p result
1285
- rescue DockGeniusApiRubyClient::ApiError => e
1286
- puts "Exception when calling CustomerApi->customer_prototype_get_address: #{e}"
1287
- end
1288
- ```
1289
-
1290
- ### Parameters
1291
-
1292
- Name | Type | Description | Notes
1293
- ------------- | ------------- | ------------- | -------------
1294
- **id** | **String**| User id |
1295
- **refresh** | **BOOLEAN**| | [optional]
1296
-
1297
- ### Return type
1298
-
1299
- [**Address**](Address.md)
1300
-
1301
- ### Authorization
1302
-
1303
- No authorization required
1304
-
1305
- ### HTTP request headers
1306
-
1307
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1308
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1309
-
1310
-
1311
-
1312
- # **customer_prototype_get_emails**
1313
- > Array<EmailAddress> customer_prototype_get_emails(id, opts)
1314
-
1315
- Queries emails of Customer.
1316
-
1317
- ### Example
1318
- ```ruby
1319
- # load the gem
1320
- require 'dock_genius_api_ruby_client'
1321
-
1322
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1323
-
1324
- id = "id_example" # String | User id
1325
-
1326
- opts = {
1327
- filter: "filter_example" # String |
1328
- }
1329
-
1330
- begin
1331
- #Queries emails of Customer.
1332
- result = api_instance.customer_prototype_get_emails(id, opts)
1333
- p result
1334
- rescue DockGeniusApiRubyClient::ApiError => e
1335
- puts "Exception when calling CustomerApi->customer_prototype_get_emails: #{e}"
1336
- end
1337
- ```
1338
-
1339
- ### Parameters
1340
-
1341
- Name | Type | Description | Notes
1342
- ------------- | ------------- | ------------- | -------------
1343
- **id** | **String**| User id |
1344
- **filter** | **String**| | [optional]
1345
-
1346
- ### Return type
1347
-
1348
- [**Array<EmailAddress>**](EmailAddress.md)
1349
-
1350
- ### Authorization
1351
-
1352
- No authorization required
1353
-
1354
- ### HTTP request headers
1355
-
1356
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1357
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1358
-
1359
-
1360
-
1361
- # **customer_prototype_update_address**
1362
- > Address customer_prototype_update_address(id, opts)
1363
-
1364
- Update address of this model.
1365
-
1366
- ### Example
1367
- ```ruby
1368
- # load the gem
1369
- require 'dock_genius_api_ruby_client'
1370
-
1371
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1372
-
1373
- id = "id_example" # String | User id
1374
-
1375
- opts = {
1376
- data: DockGeniusApiRubyClient::Address.new # Address |
1377
- }
1378
-
1379
- begin
1380
- #Update address of this model.
1381
- result = api_instance.customer_prototype_update_address(id, opts)
1382
- p result
1383
- rescue DockGeniusApiRubyClient::ApiError => e
1384
- puts "Exception when calling CustomerApi->customer_prototype_update_address: #{e}"
1385
- end
1386
- ```
1387
-
1388
- ### Parameters
1389
-
1390
- Name | Type | Description | Notes
1391
- ------------- | ------------- | ------------- | -------------
1392
- **id** | **String**| User id |
1393
- **data** | [**Address**](Address.md)| | [optional]
1394
-
1395
- ### Return type
1396
-
1397
- [**Address**](Address.md)
1398
-
1399
- ### Authorization
1400
-
1401
- No authorization required
1402
-
1403
- ### HTTP request headers
1404
-
1405
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1406
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1407
-
1408
-
1409
-
1410
- # **customer_prototype_update_attributes_patch_customersid**
1411
- > Customer customer_prototype_update_attributes_patch_customersid(id, opts)
1412
-
1413
- Patch attributes for a model instance and persist it into the data source.
1414
-
1415
- ### Example
1416
- ```ruby
1417
- # load the gem
1418
- require 'dock_genius_api_ruby_client'
1419
-
1420
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1421
-
1422
- id = "id_example" # String | User id
1423
-
1424
- opts = {
1425
- data: DockGeniusApiRubyClient::Customer.new # Customer | An object of model property name/value pairs
1426
- }
1427
-
1428
- begin
1429
- #Patch attributes for a model instance and persist it into the data source.
1430
- result = api_instance.customer_prototype_update_attributes_patch_customersid(id, opts)
1431
- p result
1432
- rescue DockGeniusApiRubyClient::ApiError => e
1433
- puts "Exception when calling CustomerApi->customer_prototype_update_attributes_patch_customersid: #{e}"
1434
- end
1435
- ```
1436
-
1437
- ### Parameters
1438
-
1439
- Name | Type | Description | Notes
1440
- ------------- | ------------- | ------------- | -------------
1441
- **id** | **String**| User id |
1442
- **data** | [**Customer**](Customer.md)| An object of model property name/value pairs | [optional]
1443
-
1444
- ### Return type
1445
-
1446
- [**Customer**](Customer.md)
1447
-
1448
- ### Authorization
1449
-
1450
- No authorization required
1451
-
1452
- ### HTTP request headers
1453
-
1454
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1455
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1456
-
1457
-
1458
-
1459
- # **customer_prototype_update_attributes_put_customersid**
1460
- > Customer customer_prototype_update_attributes_put_customersid(id, opts)
1461
-
1462
- Patch attributes for a model instance and persist it into the data source.
1463
-
1464
- ### Example
1465
- ```ruby
1466
- # load the gem
1467
- require 'dock_genius_api_ruby_client'
1468
-
1469
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1470
-
1471
- id = "id_example" # String | User id
1472
-
1473
- opts = {
1474
- data: DockGeniusApiRubyClient::Customer.new # Customer | An object of model property name/value pairs
1475
- }
1476
-
1477
- begin
1478
- #Patch attributes for a model instance and persist it into the data source.
1479
- result = api_instance.customer_prototype_update_attributes_put_customersid(id, opts)
1480
- p result
1481
- rescue DockGeniusApiRubyClient::ApiError => e
1482
- puts "Exception when calling CustomerApi->customer_prototype_update_attributes_put_customersid: #{e}"
1483
- end
1484
- ```
1485
-
1486
- ### Parameters
1487
-
1488
- Name | Type | Description | Notes
1489
- ------------- | ------------- | ------------- | -------------
1490
- **id** | **String**| User id |
1491
- **data** | [**Customer**](Customer.md)| An object of model property name/value pairs | [optional]
1492
-
1493
- ### Return type
1494
-
1495
- [**Customer**](Customer.md)
1496
-
1497
- ### Authorization
1498
-
1499
- No authorization required
1500
-
1501
- ### HTTP request headers
1502
-
1503
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1504
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1505
-
1506
-
1507
-
1508
- # **customer_prototype_update_by_id_access_tokens**
1509
- > AccessToken customer_prototype_update_by_id_access_tokens(fk, id, opts)
1510
-
1511
- Update a related item by id for accessTokens.
1512
-
1513
- ### Example
1514
- ```ruby
1515
- # load the gem
1516
- require 'dock_genius_api_ruby_client'
1517
-
1518
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1519
-
1520
- fk = "fk_example" # String | Foreign key for accessTokens
1521
-
1522
- id = "id_example" # String | User id
1523
-
1524
- opts = {
1525
- data: DockGeniusApiRubyClient::AccessToken.new # AccessToken |
1526
- }
1527
-
1528
- begin
1529
- #Update a related item by id for accessTokens.
1530
- result = api_instance.customer_prototype_update_by_id_access_tokens(fk, id, opts)
1531
- p result
1532
- rescue DockGeniusApiRubyClient::ApiError => e
1533
- puts "Exception when calling CustomerApi->customer_prototype_update_by_id_access_tokens: #{e}"
1534
- end
1535
- ```
1536
-
1537
- ### Parameters
1538
-
1539
- Name | Type | Description | Notes
1540
- ------------- | ------------- | ------------- | -------------
1541
- **fk** | **String**| Foreign key for accessTokens |
1542
- **id** | **String**| User id |
1543
- **data** | [**AccessToken**](AccessToken.md)| | [optional]
1544
-
1545
- ### Return type
1546
-
1547
- [**AccessToken**](AccessToken.md)
1548
-
1549
- ### Authorization
1550
-
1551
- No authorization required
1552
-
1553
- ### HTTP request headers
1554
-
1555
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1556
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1557
-
1558
-
1559
-
1560
- # **customer_prototype_update_by_id_emails**
1561
- > EmailAddress customer_prototype_update_by_id_emails(fk, id, opts)
1562
-
1563
- Update a related item by id for emails.
1564
-
1565
- ### Example
1566
- ```ruby
1567
- # load the gem
1568
- require 'dock_genius_api_ruby_client'
1569
-
1570
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1571
-
1572
- fk = "fk_example" # String | Foreign key for emails
1573
-
1574
- id = "id_example" # String | User id
1575
-
1576
- opts = {
1577
- data: DockGeniusApiRubyClient::EmailAddress.new # EmailAddress |
1578
- }
1579
-
1580
- begin
1581
- #Update a related item by id for emails.
1582
- result = api_instance.customer_prototype_update_by_id_emails(fk, id, opts)
1583
- p result
1584
- rescue DockGeniusApiRubyClient::ApiError => e
1585
- puts "Exception when calling CustomerApi->customer_prototype_update_by_id_emails: #{e}"
1586
- end
1587
- ```
1588
-
1589
- ### Parameters
1590
-
1591
- Name | Type | Description | Notes
1592
- ------------- | ------------- | ------------- | -------------
1593
- **fk** | **String**| Foreign key for emails |
1594
- **id** | **String**| User id |
1595
- **data** | [**EmailAddress**](EmailAddress.md)| | [optional]
1596
-
1597
- ### Return type
1598
-
1599
- [**EmailAddress**](EmailAddress.md)
1600
-
1601
- ### Authorization
1602
-
1603
- No authorization required
1604
-
1605
- ### HTTP request headers
1606
-
1607
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1608
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1609
-
1610
-
1611
-
1612
- # **customer_replace_by_id**
1613
- > Customer customer_replace_by_id(id, opts)
1614
-
1615
- Replace attributes for a model instance and persist it into the data source.
1616
-
1617
- ### Example
1618
- ```ruby
1619
- # load the gem
1620
- require 'dock_genius_api_ruby_client'
1621
-
1622
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1623
-
1624
- id = "id_example" # String | Model id
1625
-
1626
- opts = {
1627
- data: DockGeniusApiRubyClient::Customer.new # Customer | Model instance data
1628
- }
1629
-
1630
- begin
1631
- #Replace attributes for a model instance and persist it into the data source.
1632
- result = api_instance.customer_replace_by_id(id, opts)
1633
- p result
1634
- rescue DockGeniusApiRubyClient::ApiError => e
1635
- puts "Exception when calling CustomerApi->customer_replace_by_id: #{e}"
1636
- end
1637
- ```
1638
-
1639
- ### Parameters
1640
-
1641
- Name | Type | Description | Notes
1642
- ------------- | ------------- | ------------- | -------------
1643
- **id** | **String**| Model id |
1644
- **data** | [**Customer**](Customer.md)| Model instance data | [optional]
1645
-
1646
- ### Return type
1647
-
1648
- [**Customer**](Customer.md)
1649
-
1650
- ### Authorization
1651
-
1652
- No authorization required
1653
-
1654
- ### HTTP request headers
1655
-
1656
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1657
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1658
-
1659
-
1660
-
1661
- # **customer_replace_or_create**
1662
- > Customer customer_replace_or_create(opts)
1663
-
1664
- Replace an existing model instance or insert a new one into the data source.
1665
-
1666
- ### Example
1667
- ```ruby
1668
- # load the gem
1669
- require 'dock_genius_api_ruby_client'
1670
-
1671
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1672
-
1673
- opts = {
1674
- data: DockGeniusApiRubyClient::Customer.new # Customer | Model instance data
1675
- }
1676
-
1677
- begin
1678
- #Replace an existing model instance or insert a new one into the data source.
1679
- result = api_instance.customer_replace_or_create(opts)
1680
- p result
1681
- rescue DockGeniusApiRubyClient::ApiError => e
1682
- puts "Exception when calling CustomerApi->customer_replace_or_create: #{e}"
1683
- end
1684
- ```
1685
-
1686
- ### Parameters
1687
-
1688
- Name | Type | Description | Notes
1689
- ------------- | ------------- | ------------- | -------------
1690
- **data** | [**Customer**](Customer.md)| Model instance data | [optional]
1691
-
1692
- ### Return type
1693
-
1694
- [**Customer**](Customer.md)
1695
-
1696
- ### Authorization
1697
-
1698
- No authorization required
1699
-
1700
- ### HTTP request headers
1701
-
1702
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1703
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1704
-
1705
-
1706
-
1707
- # **customer_reset_password**
1708
- > customer_reset_password(options)
1709
-
1710
- Reset password for a user with email.
1711
-
1712
- ### Example
1713
- ```ruby
1714
- # load the gem
1715
- require 'dock_genius_api_ruby_client'
1716
-
1717
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1718
-
1719
- options = nil # Object |
1720
-
1721
-
1722
- begin
1723
- #Reset password for a user with email.
1724
- api_instance.customer_reset_password(options)
1725
- rescue DockGeniusApiRubyClient::ApiError => e
1726
- puts "Exception when calling CustomerApi->customer_reset_password: #{e}"
1727
- end
1728
- ```
1729
-
1730
- ### Parameters
1731
-
1732
- Name | Type | Description | Notes
1733
- ------------- | ------------- | ------------- | -------------
1734
- **options** | **Object**| |
1735
-
1736
- ### Return type
1737
-
1738
- nil (empty response body)
1739
-
1740
- ### Authorization
1741
-
1742
- No authorization required
1743
-
1744
- ### HTTP request headers
1745
-
1746
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1747
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1748
-
1749
-
1750
-
1751
- # **customer_update_all**
1752
- > InlineResponse2001 customer_update_all(opts)
1753
-
1754
- Update instances of the model matched by {{where}} from the data source.
1755
-
1756
- ### Example
1757
- ```ruby
1758
- # load the gem
1759
- require 'dock_genius_api_ruby_client'
1760
-
1761
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1762
-
1763
- opts = {
1764
- where: "where_example", # String | Criteria to match model instances
1765
- data: DockGeniusApiRubyClient::Customer.new # Customer | An object of model property name/value pairs
1766
- }
1767
-
1768
- begin
1769
- #Update instances of the model matched by {{where}} from the data source.
1770
- result = api_instance.customer_update_all(opts)
1771
- p result
1772
- rescue DockGeniusApiRubyClient::ApiError => e
1773
- puts "Exception when calling CustomerApi->customer_update_all: #{e}"
1774
- end
1775
- ```
1776
-
1777
- ### Parameters
1778
-
1779
- Name | Type | Description | Notes
1780
- ------------- | ------------- | ------------- | -------------
1781
- **where** | **String**| Criteria to match model instances | [optional]
1782
- **data** | [**Customer**](Customer.md)| An object of model property name/value pairs | [optional]
1783
-
1784
- ### Return type
1785
-
1786
- [**InlineResponse2001**](InlineResponse2001.md)
1787
-
1788
- ### Authorization
1789
-
1790
- No authorization required
1791
-
1792
- ### HTTP request headers
1793
-
1794
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1795
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1796
-
1797
-
1798
-
1799
- # **customer_upsert_patch_customers**
1800
- > Customer customer_upsert_patch_customers(opts)
1801
-
1802
- Patch an existing model instance or insert a new one into the data source.
1803
-
1804
- ### Example
1805
- ```ruby
1806
- # load the gem
1807
- require 'dock_genius_api_ruby_client'
1808
-
1809
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1810
-
1811
- opts = {
1812
- data: DockGeniusApiRubyClient::Customer.new # Customer | Model instance data
1813
- }
1814
-
1815
- begin
1816
- #Patch an existing model instance or insert a new one into the data source.
1817
- result = api_instance.customer_upsert_patch_customers(opts)
1818
- p result
1819
- rescue DockGeniusApiRubyClient::ApiError => e
1820
- puts "Exception when calling CustomerApi->customer_upsert_patch_customers: #{e}"
1821
- end
1822
- ```
1823
-
1824
- ### Parameters
1825
-
1826
- Name | Type | Description | Notes
1827
- ------------- | ------------- | ------------- | -------------
1828
- **data** | [**Customer**](Customer.md)| Model instance data | [optional]
1829
-
1830
- ### Return type
1831
-
1832
- [**Customer**](Customer.md)
1833
-
1834
- ### Authorization
1835
-
1836
- No authorization required
1837
-
1838
- ### HTTP request headers
1839
-
1840
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1841
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1842
-
1843
-
1844
-
1845
- # **customer_upsert_put_customers**
1846
- > Customer customer_upsert_put_customers(opts)
1847
-
1848
- Patch an existing model instance or insert a new one into the data source.
1849
-
1850
- ### Example
1851
- ```ruby
1852
- # load the gem
1853
- require 'dock_genius_api_ruby_client'
1854
-
1855
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1856
-
1857
- opts = {
1858
- data: DockGeniusApiRubyClient::Customer.new # Customer | Model instance data
1859
- }
1860
-
1861
- begin
1862
- #Patch an existing model instance or insert a new one into the data source.
1863
- result = api_instance.customer_upsert_put_customers(opts)
1864
- p result
1865
- rescue DockGeniusApiRubyClient::ApiError => e
1866
- puts "Exception when calling CustomerApi->customer_upsert_put_customers: #{e}"
1867
- end
1868
- ```
1869
-
1870
- ### Parameters
1871
-
1872
- Name | Type | Description | Notes
1873
- ------------- | ------------- | ------------- | -------------
1874
- **data** | [**Customer**](Customer.md)| Model instance data | [optional]
1875
-
1876
- ### Return type
1877
-
1878
- [**Customer**](Customer.md)
1879
-
1880
- ### Authorization
1881
-
1882
- No authorization required
1883
-
1884
- ### HTTP request headers
1885
-
1886
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1887
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1888
-
1889
-
1890
-
1891
- # **customer_upsert_with_where**
1892
- > Customer customer_upsert_with_where(opts)
1893
-
1894
- Update an existing model instance or insert a new one into the data source based on the where criteria.
1895
-
1896
- ### Example
1897
- ```ruby
1898
- # load the gem
1899
- require 'dock_genius_api_ruby_client'
1900
-
1901
- api_instance = DockGeniusApiRubyClient::CustomerApi.new
1902
-
1903
- opts = {
1904
- where: "where_example", # String | Criteria to match model instances
1905
- data: DockGeniusApiRubyClient::Customer.new # Customer | An object of model property name/value pairs
1906
- }
1907
-
1908
- begin
1909
- #Update an existing model instance or insert a new one into the data source based on the where criteria.
1910
- result = api_instance.customer_upsert_with_where(opts)
1911
- p result
1912
- rescue DockGeniusApiRubyClient::ApiError => e
1913
- puts "Exception when calling CustomerApi->customer_upsert_with_where: #{e}"
1914
- end
1915
- ```
1916
-
1917
- ### Parameters
1918
-
1919
- Name | Type | Description | Notes
1920
- ------------- | ------------- | ------------- | -------------
1921
- **where** | **String**| Criteria to match model instances | [optional]
1922
- **data** | [**Customer**](Customer.md)| An object of model property name/value pairs | [optional]
1923
-
1924
- ### Return type
1925
-
1926
- [**Customer**](Customer.md)
1927
-
1928
- ### Authorization
1929
-
1930
- No authorization required
1931
-
1932
- ### HTTP request headers
1933
-
1934
- - **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/xml
1935
- - **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
1936
-
1937
-
1938
-