Class: AlfrescoAPI::RatingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco_api/api/ratings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RatingsApi

Returns a new instance of RatingsApi.



19
20
21
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_rating(node_id, rating_body_create, opts = {}) ⇒ RatingEntry

Create a rating Create a rating for the node with identifier nodeId

Parameters:

  • node_id —

    The identifier of a node.

  • rating_body_create —

    For "myRating" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar. For example, to "like" a file the following body would be used: ```JSON { "id": "likes", "myRating": true } ```

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter.

Returns:



30
31
32
33
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 30

def create_rating(node_id, rating_body_create, opts = {})
  data, _status_code, _headers = create_rating_with_http_info(node_id, rating_body_create, opts)
  return data
end

#create_rating_with_http_info(node_id, rating_body_create, opts = {}) ⇒ Array<(RatingEntry, Fixnum, Hash)>

Create a rating Create a rating for the node with identifier nodeId

Parameters:

  • node_id —

    The identifier of a node.

  • rating_body_create —

    For &quot;myRating&quot; the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar. For example, to &quot;like&quot; a file the following body would be used: &#x60;&#x60;&#x60;JSON { &quot;id&quot;: &quot;likes&quot;, &quot;myRating&quot;: true } &#x60;&#x60;&#x60;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter.

Returns:

  • (Array<(RatingEntry, Fixnum, Hash)>) —

    RatingEntry data, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 42

def create_rating_with_http_info(node_id, rating_body_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RatingsApi.create_rating ..."
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.create_rating"
  end
  # verify the required parameter 'rating_body_create' is set
  if @api_client.config.client_side_validation && rating_body_create.nil?
    fail ArgumentError, "Missing the required parameter 'rating_body_create' when calling RatingsApi.create_rating"
  end
  # resource path
  local_var_path = "/nodes/{nodeId}/ratings".sub('{' + 'nodeId' + '}', node_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(rating_body_create)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RatingEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RatingsApi#create_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_rating(node_id, rating_id, opts = {}) ⇒ nil

Delete a rating Deletes rating ratingId from node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rating_id —

    The identifier of a rating.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


93
94
95
96
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 93

def delete_rating(node_id, rating_id, opts = {})
  delete_rating_with_http_info(node_id, rating_id, opts)
  return nil
end

#delete_rating_with_http_info(node_id, rating_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a rating Deletes rating ratingId from node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rating_id —

    The identifier of a rating.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 104

def delete_rating_with_http_info(node_id, rating_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RatingsApi.delete_rating ..."
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.delete_rating"
  end
  # verify the required parameter 'rating_id' is set
  if @api_client.config.client_side_validation && rating_id.nil?
    fail ArgumentError, "Missing the required parameter 'rating_id' when calling RatingsApi.delete_rating"
  end
  # resource path
  local_var_path = "/nodes/{nodeId}/ratings/{ratingId}".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'ratingId' + '}', rating_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RatingsApi#delete_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rating(node_id, rating_id, opts = {}) ⇒ RatingEntry

Get a rating Get the specific rating ratingId on node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rating_id —

    The identifier of a rating.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter.

Returns:



154
155
156
157
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 154

def get_rating(node_id, rating_id, opts = {})
  data, _status_code, _headers = get_rating_with_http_info(node_id, rating_id, opts)
  return data
end

#get_rating_with_http_info(node_id, rating_id, opts = {}) ⇒ Array<(RatingEntry, Fixnum, Hash)>

Get a rating Get the specific rating ratingId on node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rating_id —

    The identifier of a rating.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter.

Returns:

  • (Array<(RatingEntry, Fixnum, Hash)>) —

    RatingEntry data, response status code and response headers



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 166

def get_rating_with_http_info(node_id, rating_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RatingsApi.get_rating ..."
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.get_rating"
  end
  # verify the required parameter 'rating_id' is set
  if @api_client.config.client_side_validation && rating_id.nil?
    fail ArgumentError, "Missing the required parameter 'rating_id' when calling RatingsApi.get_rating"
  end
  # resource path
  local_var_path = "/nodes/{nodeId}/ratings/{ratingId}".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'ratingId' + '}', rating_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RatingEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RatingsApi#get_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_ratings(node_id, opts = {}) ⇒ RatingPaging

List ratings Gets a list of ratings for node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :skip_count (Integer) —

    The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (default to 0)

  • :max_items (Integer) —

    The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)

  • :fields (Array<String>) —

    A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter.

Returns:



219
220
221
222
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 219

def list_ratings(node_id, opts = {})
  data, _status_code, _headers = list_ratings_with_http_info(node_id, opts)
  return data
end

#list_ratings_with_http_info(node_id, opts = {}) ⇒ Array<(RatingPaging, Fixnum, Hash)>

List ratings Gets a list of ratings for node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :skip_count (Integer) —

    The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.

  • :max_items (Integer) —

    The maximum number of items to return in the list. If not supplied then the default value is 100.

  • :fields (Array<String>) —

    A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter.

Returns:

  • (Array<(RatingPaging, Fixnum, Hash)>) —

    RatingPaging data, response status code and response headers



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/alfresco_api/api/ratings_api.rb', line 232

def list_ratings_with_http_info(node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RatingsApi.list_ratings ..."
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.list_ratings"
  end
  if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
    fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling RatingsApi.list_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
    fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling RatingsApi.list_ratings, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/nodes/{nodeId}/ratings".sub('{' + 'nodeId' + '}', node_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
  query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RatingPaging')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RatingsApi#list_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end