spartera_api_sdk 1.0.58
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +11 -0
- data/Gemfile.lock +69 -0
- data/LICENSE +21 -0
- data/README.md +360 -0
- data/Rakefile +10 -0
- data/config.json +10 -0
- data/docs/APIKeysApi.md +353 -0
- data/docs/Alert.md +36 -0
- data/docs/AlertsApi.md +511 -0
- data/docs/Apikey.md +36 -0
- data/docs/Asset.md +110 -0
- data/docs/AssetPriceHistoryApi.md +573 -0
- data/docs/Assetpricehistory.md +38 -0
- data/docs/AssetsApi.md +1131 -0
- data/docs/CloudProvidersApi.md +341 -0
- data/docs/Cloudprovider.md +30 -0
- data/docs/CompaniesApi.md +619 -0
- data/docs/Company.md +44 -0
- data/docs/Connection.md +54 -0
- data/docs/ConnectionsApi.md +497 -0
- data/docs/Error.md +24 -0
- data/docs/Favorite.md +36 -0
- data/docs/FavoritesApi.md +581 -0
- data/docs/InlineObject.md +22 -0
- data/docs/InlineObject1.md +20 -0
- data/docs/InlineObject2.md +20 -0
- data/docs/InlineObject3.md +20 -0
- data/docs/User.md +34 -0
- data/docs/UsersApi.md +357 -0
- data/example.rb +51 -0
- data/git_push.sh +57 -0
- data/lib/spartera_api_sdk/api/alerts_api.rb +543 -0
- data/lib/spartera_api_sdk/api/api_keys_api.rb +345 -0
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +576 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +1106 -0
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +315 -0
- data/lib/spartera_api_sdk/api/companies_api.rb +571 -0
- data/lib/spartera_api_sdk/api/connections_api.rb +501 -0
- data/lib/spartera_api_sdk/api/favorites_api.rb +610 -0
- data/lib/spartera_api_sdk/api/users_api.rb +367 -0
- data/lib/spartera_api_sdk/api_client.rb +393 -0
- data/lib/spartera_api_sdk/api_error.rb +58 -0
- data/lib/spartera_api_sdk/configuration.rb +320 -0
- data/lib/spartera_api_sdk/models/alert.rb +353 -0
- data/lib/spartera_api_sdk/models/apikey.rb +370 -0
- data/lib/spartera_api_sdk/models/asset.rb +686 -0
- data/lib/spartera_api_sdk/models/assetpricehistory.rb +345 -0
- data/lib/spartera_api_sdk/models/cloudprovider.rb +292 -0
- data/lib/spartera_api_sdk/models/company.rb +389 -0
- data/lib/spartera_api_sdk/models/connection.rb +434 -0
- data/lib/spartera_api_sdk/models/error.rb +285 -0
- data/lib/spartera_api_sdk/models/favorite.rb +353 -0
- data/lib/spartera_api_sdk/models/inline_object.rb +240 -0
- data/lib/spartera_api_sdk/models/inline_object1.rb +229 -0
- data/lib/spartera_api_sdk/models/inline_object2.rb +229 -0
- data/lib/spartera_api_sdk/models/inline_object3.rb +229 -0
- data/lib/spartera_api_sdk/models/user.rb +327 -0
- data/lib/spartera_api_sdk/version.rb +15 -0
- data/lib/spartera_api_sdk.rb +62 -0
- data/spartera_api_sdk.gemspec +28 -0
- data/spec/api/alerts_api_spec.rb +126 -0
- data/spec/api/api_keys_api_spec.rb +93 -0
- data/spec/api/asset_price_history_api_spec.rb +134 -0
- data/spec/api/assets_api_spec.rb +228 -0
- data/spec/api/cloud_providers_api_spec.rb +88 -0
- data/spec/api/companies_api_spec.rb +134 -0
- data/spec/api/connections_api_spec.rb +119 -0
- data/spec/api/favorites_api_spec.rb +138 -0
- data/spec/api/users_api_spec.rb +95 -0
- data/spec/models/alert_spec.rb +90 -0
- data/spec/models/apikey_spec.rb +90 -0
- data/spec/models/asset_spec.rb +312 -0
- data/spec/models/assetpricehistory_spec.rb +96 -0
- data/spec/models/cloudprovider_spec.rb +72 -0
- data/spec/models/company_spec.rb +114 -0
- data/spec/models/connection_spec.rb +144 -0
- data/spec/models/error_spec.rb +54 -0
- data/spec/models/favorite_spec.rb +90 -0
- data/spec/models/inline_object1_spec.rb +42 -0
- data/spec/models/inline_object2_spec.rb +42 -0
- data/spec/models/inline_object3_spec.rb +42 -0
- data/spec/models/inline_object_spec.rb +48 -0
- data/spec/models/user_spec.rb +84 -0
- data/spec/spec_helper.rb +111 -0
- data/test.sh +42 -0
- metadata +204 -0
@@ -0,0 +1,610 @@
|
|
1
|
+
=begin
|
2
|
+
#Spartera API Documentation
|
3
|
+
|
4
|
+
#Auto-generated API documentation for REST services of the Spartera platform
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.0.0
|
7
|
+
Contact: support@spartera.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.13.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module SparteraApiSdk
|
16
|
+
class FavoritesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get all favorites for the specified user in a specific category
|
23
|
+
# @param company_id [String]
|
24
|
+
# @param user_id [String]
|
25
|
+
# @param category [String]
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [Object]
|
28
|
+
def companies_company_id_users_user_id_favorites_category_category_get(company_id, user_id, category, opts = {})
|
29
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_category_category_get_with_http_info(company_id, user_id, category, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Get all favorites for the specified user in a specific category
|
34
|
+
# @param company_id [String]
|
35
|
+
# @param user_id [String]
|
36
|
+
# @param category [String]
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
39
|
+
def companies_company_id_users_user_id_favorites_category_category_get_with_http_info(company_id, user_id, category, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_category_category_get ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'company_id' is set
|
44
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_category_category_get"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'user_id' is set
|
48
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_category_category_get"
|
50
|
+
end
|
51
|
+
# verify the required parameter 'category' is set
|
52
|
+
if @api_client.config.client_side_validation && category.nil?
|
53
|
+
fail ArgumentError, "Missing the required parameter 'category' when calling FavoritesApi.companies_company_id_users_user_id_favorites_category_category_get"
|
54
|
+
end
|
55
|
+
# resource path
|
56
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites/category/{category}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'category' + '}', CGI.escape(category.to_s))
|
57
|
+
|
58
|
+
# query parameters
|
59
|
+
query_params = opts[:query_params] || {}
|
60
|
+
|
61
|
+
# header parameters
|
62
|
+
header_params = opts[:header_params] || {}
|
63
|
+
# HTTP header 'Accept' (if needed)
|
64
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
65
|
+
|
66
|
+
# form parameters
|
67
|
+
form_params = opts[:form_params] || {}
|
68
|
+
|
69
|
+
# http body (model)
|
70
|
+
post_body = opts[:debug_body]
|
71
|
+
|
72
|
+
# return_type
|
73
|
+
return_type = opts[:debug_return_type] || 'Object'
|
74
|
+
|
75
|
+
# auth_names
|
76
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
77
|
+
|
78
|
+
new_options = opts.merge(
|
79
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_category_category_get",
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names,
|
85
|
+
:return_type => return_type
|
86
|
+
)
|
87
|
+
|
88
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_category_category_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
|
95
|
+
# Check if the specified user has favorited a specific asset Returns the favorite record if it exists, or empty result if not Useful for UI to show/hide favorite button states
|
96
|
+
# @param company_id [String]
|
97
|
+
# @param user_id [String]
|
98
|
+
# @param asset_id [String]
|
99
|
+
# @param [Hash] opts the optional parameters
|
100
|
+
# @return [Object]
|
101
|
+
def companies_company_id_users_user_id_favorites_check_asset_id_get(company_id, user_id, asset_id, opts = {})
|
102
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info(company_id, user_id, asset_id, opts)
|
103
|
+
data
|
104
|
+
end
|
105
|
+
|
106
|
+
# Check if the specified user has favorited a specific asset Returns the favorite record if it exists, or empty result if not Useful for UI to show/hide favorite button states
|
107
|
+
# @param company_id [String]
|
108
|
+
# @param user_id [String]
|
109
|
+
# @param asset_id [String]
|
110
|
+
# @param [Hash] opts the optional parameters
|
111
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
112
|
+
def companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info(company_id, user_id, asset_id, opts = {})
|
113
|
+
if @api_client.config.debugging
|
114
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_check_asset_id_get ...'
|
115
|
+
end
|
116
|
+
# verify the required parameter 'company_id' is set
|
117
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
118
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_check_asset_id_get"
|
119
|
+
end
|
120
|
+
# verify the required parameter 'user_id' is set
|
121
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
122
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_check_asset_id_get"
|
123
|
+
end
|
124
|
+
# verify the required parameter 'asset_id' is set
|
125
|
+
if @api_client.config.client_side_validation && asset_id.nil?
|
126
|
+
fail ArgumentError, "Missing the required parameter 'asset_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_check_asset_id_get"
|
127
|
+
end
|
128
|
+
# resource path
|
129
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites/check/{asset_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_id.to_s))
|
130
|
+
|
131
|
+
# query parameters
|
132
|
+
query_params = opts[:query_params] || {}
|
133
|
+
|
134
|
+
# header parameters
|
135
|
+
header_params = opts[:header_params] || {}
|
136
|
+
# HTTP header 'Accept' (if needed)
|
137
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
138
|
+
|
139
|
+
# form parameters
|
140
|
+
form_params = opts[:form_params] || {}
|
141
|
+
|
142
|
+
# http body (model)
|
143
|
+
post_body = opts[:debug_body]
|
144
|
+
|
145
|
+
# return_type
|
146
|
+
return_type = opts[:debug_return_type] || 'Object'
|
147
|
+
|
148
|
+
# auth_names
|
149
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
150
|
+
|
151
|
+
new_options = opts.merge(
|
152
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_check_asset_id_get",
|
153
|
+
:header_params => header_params,
|
154
|
+
:query_params => query_params,
|
155
|
+
:form_params => form_params,
|
156
|
+
:body => post_body,
|
157
|
+
:auth_names => auth_names,
|
158
|
+
:return_type => return_type
|
159
|
+
)
|
160
|
+
|
161
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
162
|
+
if @api_client.config.debugging
|
163
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_check_asset_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
164
|
+
end
|
165
|
+
return data, status_code, headers
|
166
|
+
end
|
167
|
+
|
168
|
+
# Delete single favorite by ID (unfavorite an asset)
|
169
|
+
# @param company_id [String]
|
170
|
+
# @param user_id [String]
|
171
|
+
# @param favorite_id [String]
|
172
|
+
# @param [Hash] opts the optional parameters
|
173
|
+
# @return [Object]
|
174
|
+
def companies_company_id_users_user_id_favorites_favorite_id_delete(company_id, user_id, favorite_id, opts = {})
|
175
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info(company_id, user_id, favorite_id, opts)
|
176
|
+
data
|
177
|
+
end
|
178
|
+
|
179
|
+
# Delete single favorite by ID (unfavorite an asset)
|
180
|
+
# @param company_id [String]
|
181
|
+
# @param user_id [String]
|
182
|
+
# @param favorite_id [String]
|
183
|
+
# @param [Hash] opts the optional parameters
|
184
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
185
|
+
def companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info(company_id, user_id, favorite_id, opts = {})
|
186
|
+
if @api_client.config.debugging
|
187
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_delete ...'
|
188
|
+
end
|
189
|
+
# verify the required parameter 'company_id' is set
|
190
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
191
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_delete"
|
192
|
+
end
|
193
|
+
# verify the required parameter 'user_id' is set
|
194
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
195
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_delete"
|
196
|
+
end
|
197
|
+
# verify the required parameter 'favorite_id' is set
|
198
|
+
if @api_client.config.client_side_validation && favorite_id.nil?
|
199
|
+
fail ArgumentError, "Missing the required parameter 'favorite_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_delete"
|
200
|
+
end
|
201
|
+
# resource path
|
202
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites/{favorite_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'favorite_id' + '}', CGI.escape(favorite_id.to_s))
|
203
|
+
|
204
|
+
# query parameters
|
205
|
+
query_params = opts[:query_params] || {}
|
206
|
+
|
207
|
+
# header parameters
|
208
|
+
header_params = opts[:header_params] || {}
|
209
|
+
# HTTP header 'Accept' (if needed)
|
210
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
211
|
+
|
212
|
+
# form parameters
|
213
|
+
form_params = opts[:form_params] || {}
|
214
|
+
|
215
|
+
# http body (model)
|
216
|
+
post_body = opts[:debug_body]
|
217
|
+
|
218
|
+
# return_type
|
219
|
+
return_type = opts[:debug_return_type] || 'Object'
|
220
|
+
|
221
|
+
# auth_names
|
222
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
223
|
+
|
224
|
+
new_options = opts.merge(
|
225
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_delete",
|
226
|
+
:header_params => header_params,
|
227
|
+
:query_params => query_params,
|
228
|
+
:form_params => form_params,
|
229
|
+
:body => post_body,
|
230
|
+
:auth_names => auth_names,
|
231
|
+
:return_type => return_type
|
232
|
+
)
|
233
|
+
|
234
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
235
|
+
if @api_client.config.debugging
|
236
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_favorite_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
237
|
+
end
|
238
|
+
return data, status_code, headers
|
239
|
+
end
|
240
|
+
|
241
|
+
# Get single favorite by ID
|
242
|
+
# @param company_id [String]
|
243
|
+
# @param user_id [String]
|
244
|
+
# @param favorite_id [String]
|
245
|
+
# @param [Hash] opts the optional parameters
|
246
|
+
# @return [Object]
|
247
|
+
def companies_company_id_users_user_id_favorites_favorite_id_get(company_id, user_id, favorite_id, opts = {})
|
248
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info(company_id, user_id, favorite_id, opts)
|
249
|
+
data
|
250
|
+
end
|
251
|
+
|
252
|
+
# Get single favorite by ID
|
253
|
+
# @param company_id [String]
|
254
|
+
# @param user_id [String]
|
255
|
+
# @param favorite_id [String]
|
256
|
+
# @param [Hash] opts the optional parameters
|
257
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
258
|
+
def companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info(company_id, user_id, favorite_id, opts = {})
|
259
|
+
if @api_client.config.debugging
|
260
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_get ...'
|
261
|
+
end
|
262
|
+
# verify the required parameter 'company_id' is set
|
263
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
264
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_get"
|
265
|
+
end
|
266
|
+
# verify the required parameter 'user_id' is set
|
267
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
268
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_get"
|
269
|
+
end
|
270
|
+
# verify the required parameter 'favorite_id' is set
|
271
|
+
if @api_client.config.client_side_validation && favorite_id.nil?
|
272
|
+
fail ArgumentError, "Missing the required parameter 'favorite_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_get"
|
273
|
+
end
|
274
|
+
# resource path
|
275
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites/{favorite_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'favorite_id' + '}', CGI.escape(favorite_id.to_s))
|
276
|
+
|
277
|
+
# query parameters
|
278
|
+
query_params = opts[:query_params] || {}
|
279
|
+
|
280
|
+
# header parameters
|
281
|
+
header_params = opts[:header_params] || {}
|
282
|
+
# HTTP header 'Accept' (if needed)
|
283
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
284
|
+
|
285
|
+
# form parameters
|
286
|
+
form_params = opts[:form_params] || {}
|
287
|
+
|
288
|
+
# http body (model)
|
289
|
+
post_body = opts[:debug_body]
|
290
|
+
|
291
|
+
# return_type
|
292
|
+
return_type = opts[:debug_return_type] || 'Object'
|
293
|
+
|
294
|
+
# auth_names
|
295
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
296
|
+
|
297
|
+
new_options = opts.merge(
|
298
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_get",
|
299
|
+
:header_params => header_params,
|
300
|
+
:query_params => query_params,
|
301
|
+
:form_params => form_params,
|
302
|
+
:body => post_body,
|
303
|
+
:auth_names => auth_names,
|
304
|
+
:return_type => return_type
|
305
|
+
)
|
306
|
+
|
307
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
308
|
+
if @api_client.config.debugging
|
309
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_favorite_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
310
|
+
end
|
311
|
+
return data, status_code, headers
|
312
|
+
end
|
313
|
+
|
314
|
+
# Update an existing favorite by ID Can update notes, category, priority
|
315
|
+
# @param company_id [String]
|
316
|
+
# @param user_id [String]
|
317
|
+
# @param favorite_id [String]
|
318
|
+
# @param favorite [Favorite]
|
319
|
+
# @param [Hash] opts the optional parameters
|
320
|
+
# @return [Object]
|
321
|
+
def companies_company_id_users_user_id_favorites_favorite_id_patch(company_id, user_id, favorite_id, favorite, opts = {})
|
322
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info(company_id, user_id, favorite_id, favorite, opts)
|
323
|
+
data
|
324
|
+
end
|
325
|
+
|
326
|
+
# Update an existing favorite by ID Can update notes, category, priority
|
327
|
+
# @param company_id [String]
|
328
|
+
# @param user_id [String]
|
329
|
+
# @param favorite_id [String]
|
330
|
+
# @param favorite [Favorite]
|
331
|
+
# @param [Hash] opts the optional parameters
|
332
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
333
|
+
def companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info(company_id, user_id, favorite_id, favorite, opts = {})
|
334
|
+
if @api_client.config.debugging
|
335
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_patch ...'
|
336
|
+
end
|
337
|
+
# verify the required parameter 'company_id' is set
|
338
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
339
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_patch"
|
340
|
+
end
|
341
|
+
# verify the required parameter 'user_id' is set
|
342
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
343
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_patch"
|
344
|
+
end
|
345
|
+
# verify the required parameter 'favorite_id' is set
|
346
|
+
if @api_client.config.client_side_validation && favorite_id.nil?
|
347
|
+
fail ArgumentError, "Missing the required parameter 'favorite_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_patch"
|
348
|
+
end
|
349
|
+
# verify the required parameter 'favorite' is set
|
350
|
+
if @api_client.config.client_side_validation && favorite.nil?
|
351
|
+
fail ArgumentError, "Missing the required parameter 'favorite' when calling FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_patch"
|
352
|
+
end
|
353
|
+
# resource path
|
354
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites/{favorite_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'favorite_id' + '}', CGI.escape(favorite_id.to_s))
|
355
|
+
|
356
|
+
# query parameters
|
357
|
+
query_params = opts[:query_params] || {}
|
358
|
+
|
359
|
+
# header parameters
|
360
|
+
header_params = opts[:header_params] || {}
|
361
|
+
# HTTP header 'Accept' (if needed)
|
362
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
363
|
+
# HTTP header 'Content-Type'
|
364
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
365
|
+
if !content_type.nil?
|
366
|
+
header_params['Content-Type'] = content_type
|
367
|
+
end
|
368
|
+
|
369
|
+
# form parameters
|
370
|
+
form_params = opts[:form_params] || {}
|
371
|
+
|
372
|
+
# http body (model)
|
373
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(favorite)
|
374
|
+
|
375
|
+
# return_type
|
376
|
+
return_type = opts[:debug_return_type] || 'Object'
|
377
|
+
|
378
|
+
# auth_names
|
379
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
380
|
+
|
381
|
+
new_options = opts.merge(
|
382
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_favorite_id_patch",
|
383
|
+
:header_params => header_params,
|
384
|
+
:query_params => query_params,
|
385
|
+
:form_params => form_params,
|
386
|
+
:body => post_body,
|
387
|
+
:auth_names => auth_names,
|
388
|
+
:return_type => return_type
|
389
|
+
)
|
390
|
+
|
391
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
392
|
+
if @api_client.config.debugging
|
393
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_favorite_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
394
|
+
end
|
395
|
+
return data, status_code, headers
|
396
|
+
end
|
397
|
+
|
398
|
+
# Get a list of all favorites for a specific user Query params: - category: filter by category - sort: sort field (priority, date_created, etc.) - order: sort direction (asc, desc)
|
399
|
+
# @param company_id [String]
|
400
|
+
# @param user_id [String]
|
401
|
+
# @param [Hash] opts the optional parameters
|
402
|
+
# @return [Object]
|
403
|
+
def companies_company_id_users_user_id_favorites_get(company_id, user_id, opts = {})
|
404
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_get_with_http_info(company_id, user_id, opts)
|
405
|
+
data
|
406
|
+
end
|
407
|
+
|
408
|
+
# Get a list of all favorites for a specific user Query params: - category: filter by category - sort: sort field (priority, date_created, etc.) - order: sort direction (asc, desc)
|
409
|
+
# @param company_id [String]
|
410
|
+
# @param user_id [String]
|
411
|
+
# @param [Hash] opts the optional parameters
|
412
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
413
|
+
def companies_company_id_users_user_id_favorites_get_with_http_info(company_id, user_id, opts = {})
|
414
|
+
if @api_client.config.debugging
|
415
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_get ...'
|
416
|
+
end
|
417
|
+
# verify the required parameter 'company_id' is set
|
418
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
419
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_get"
|
420
|
+
end
|
421
|
+
# verify the required parameter 'user_id' is set
|
422
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
423
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_get"
|
424
|
+
end
|
425
|
+
# resource path
|
426
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
|
427
|
+
|
428
|
+
# query parameters
|
429
|
+
query_params = opts[:query_params] || {}
|
430
|
+
|
431
|
+
# header parameters
|
432
|
+
header_params = opts[:header_params] || {}
|
433
|
+
# HTTP header 'Accept' (if needed)
|
434
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
435
|
+
|
436
|
+
# form parameters
|
437
|
+
form_params = opts[:form_params] || {}
|
438
|
+
|
439
|
+
# http body (model)
|
440
|
+
post_body = opts[:debug_body]
|
441
|
+
|
442
|
+
# return_type
|
443
|
+
return_type = opts[:debug_return_type] || 'Object'
|
444
|
+
|
445
|
+
# auth_names
|
446
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
447
|
+
|
448
|
+
new_options = opts.merge(
|
449
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_get",
|
450
|
+
:header_params => header_params,
|
451
|
+
:query_params => query_params,
|
452
|
+
:form_params => form_params,
|
453
|
+
:body => post_body,
|
454
|
+
:auth_names => auth_names,
|
455
|
+
:return_type => return_type
|
456
|
+
)
|
457
|
+
|
458
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
459
|
+
if @api_client.config.debugging
|
460
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
461
|
+
end
|
462
|
+
return data, status_code, headers
|
463
|
+
end
|
464
|
+
|
465
|
+
# POST /companies/{company_id}/users/{user_id}/favorites
|
466
|
+
# @param company_id [String]
|
467
|
+
# @param user_id [String]
|
468
|
+
# @param favorite [Favorite]
|
469
|
+
# @param [Hash] opts the optional parameters
|
470
|
+
# @return [Object]
|
471
|
+
def companies_company_id_users_user_id_favorites_post(company_id, user_id, favorite, opts = {})
|
472
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_post_with_http_info(company_id, user_id, favorite, opts)
|
473
|
+
data
|
474
|
+
end
|
475
|
+
|
476
|
+
# POST /companies/{company_id}/users/{user_id}/favorites
|
477
|
+
# @param company_id [String]
|
478
|
+
# @param user_id [String]
|
479
|
+
# @param favorite [Favorite]
|
480
|
+
# @param [Hash] opts the optional parameters
|
481
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
482
|
+
def companies_company_id_users_user_id_favorites_post_with_http_info(company_id, user_id, favorite, opts = {})
|
483
|
+
if @api_client.config.debugging
|
484
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_post ...'
|
485
|
+
end
|
486
|
+
# verify the required parameter 'company_id' is set
|
487
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
488
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_post"
|
489
|
+
end
|
490
|
+
# verify the required parameter 'user_id' is set
|
491
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
492
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_post"
|
493
|
+
end
|
494
|
+
# verify the required parameter 'favorite' is set
|
495
|
+
if @api_client.config.client_side_validation && favorite.nil?
|
496
|
+
fail ArgumentError, "Missing the required parameter 'favorite' when calling FavoritesApi.companies_company_id_users_user_id_favorites_post"
|
497
|
+
end
|
498
|
+
# resource path
|
499
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
|
500
|
+
|
501
|
+
# query parameters
|
502
|
+
query_params = opts[:query_params] || {}
|
503
|
+
|
504
|
+
# header parameters
|
505
|
+
header_params = opts[:header_params] || {}
|
506
|
+
# HTTP header 'Accept' (if needed)
|
507
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
508
|
+
# HTTP header 'Content-Type'
|
509
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
510
|
+
if !content_type.nil?
|
511
|
+
header_params['Content-Type'] = content_type
|
512
|
+
end
|
513
|
+
|
514
|
+
# form parameters
|
515
|
+
form_params = opts[:form_params] || {}
|
516
|
+
|
517
|
+
# http body (model)
|
518
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(favorite)
|
519
|
+
|
520
|
+
# return_type
|
521
|
+
return_type = opts[:debug_return_type] || 'Object'
|
522
|
+
|
523
|
+
# auth_names
|
524
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
525
|
+
|
526
|
+
new_options = opts.merge(
|
527
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_post",
|
528
|
+
:header_params => header_params,
|
529
|
+
:query_params => query_params,
|
530
|
+
:form_params => form_params,
|
531
|
+
:body => post_body,
|
532
|
+
:auth_names => auth_names,
|
533
|
+
:return_type => return_type
|
534
|
+
)
|
535
|
+
|
536
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
537
|
+
if @api_client.config.debugging
|
538
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
539
|
+
end
|
540
|
+
return data, status_code, headers
|
541
|
+
end
|
542
|
+
|
543
|
+
# Get all favorites for the specified user that don't have a category
|
544
|
+
# @param company_id [String]
|
545
|
+
# @param user_id [String]
|
546
|
+
# @param [Hash] opts the optional parameters
|
547
|
+
# @return [Object]
|
548
|
+
def companies_company_id_users_user_id_favorites_uncategorized_get(company_id, user_id, opts = {})
|
549
|
+
data, _status_code, _headers = companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info(company_id, user_id, opts)
|
550
|
+
data
|
551
|
+
end
|
552
|
+
|
553
|
+
# Get all favorites for the specified user that don't have a category
|
554
|
+
# @param company_id [String]
|
555
|
+
# @param user_id [String]
|
556
|
+
# @param [Hash] opts the optional parameters
|
557
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
558
|
+
def companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info(company_id, user_id, opts = {})
|
559
|
+
if @api_client.config.debugging
|
560
|
+
@api_client.config.logger.debug 'Calling API: FavoritesApi.companies_company_id_users_user_id_favorites_uncategorized_get ...'
|
561
|
+
end
|
562
|
+
# verify the required parameter 'company_id' is set
|
563
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
564
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_uncategorized_get"
|
565
|
+
end
|
566
|
+
# verify the required parameter 'user_id' is set
|
567
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
568
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling FavoritesApi.companies_company_id_users_user_id_favorites_uncategorized_get"
|
569
|
+
end
|
570
|
+
# resource path
|
571
|
+
local_var_path = '/companies/{company_id}/users/{user_id}/favorites/uncategorized'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
|
572
|
+
|
573
|
+
# query parameters
|
574
|
+
query_params = opts[:query_params] || {}
|
575
|
+
|
576
|
+
# header parameters
|
577
|
+
header_params = opts[:header_params] || {}
|
578
|
+
# HTTP header 'Accept' (if needed)
|
579
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
580
|
+
|
581
|
+
# form parameters
|
582
|
+
form_params = opts[:form_params] || {}
|
583
|
+
|
584
|
+
# http body (model)
|
585
|
+
post_body = opts[:debug_body]
|
586
|
+
|
587
|
+
# return_type
|
588
|
+
return_type = opts[:debug_return_type] || 'Object'
|
589
|
+
|
590
|
+
# auth_names
|
591
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
592
|
+
|
593
|
+
new_options = opts.merge(
|
594
|
+
:operation => :"FavoritesApi.companies_company_id_users_user_id_favorites_uncategorized_get",
|
595
|
+
:header_params => header_params,
|
596
|
+
:query_params => query_params,
|
597
|
+
:form_params => form_params,
|
598
|
+
:body => post_body,
|
599
|
+
:auth_names => auth_names,
|
600
|
+
:return_type => return_type
|
601
|
+
)
|
602
|
+
|
603
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
604
|
+
if @api_client.config.debugging
|
605
|
+
@api_client.config.logger.debug "API called: FavoritesApi#companies_company_id_users_user_id_favorites_uncategorized_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
606
|
+
end
|
607
|
+
return data, status_code, headers
|
608
|
+
end
|
609
|
+
end
|
610
|
+
end
|