Class: SiteimproveAPIClient::ContentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/siteimprove_api_client/api/content_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentApi

Returns a new instance of ContentApi.



19
20
21
 
# File 'lib/siteimprove_api_client/api/content_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/siteimprove_api_client/api/content_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#content_check_post(opts = {}) ⇒ ContentCheckResult

Upload content for an on-demand content check Upload content for an on-demand content check

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 26

def content_check_post(opts = {})
  data, _status_code, _headers = content_check_post_with_http_info(opts)
  data
end

#content_check_post_with_http_info(opts = {}) ⇒ Array<(ContentCheckResult, Integer, Hash)>

Upload content for an on-demand content check Upload content for an on-demand content check

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ContentCheckResult, Integer, Hash)>) —

    ContentCheckResult data, response status code and response headers



35
36
37
38
39
40
41
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
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 35

def content_check_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.content_check_post ...'
  end
  # resource path
  local_var_path = '/content/check'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentCheckResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_check_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_check_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_a11y_issue_on_page_get(content_id, opts = {}) ⇒ IssueOnPageList

Get the a11y issues found in the content Get the a11y issues found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



86
87
88
89
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 86

def content_checks_content_id_a11y_issue_on_page_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_a11y_issue_on_page_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_a11y_issue_on_page_get_with_http_info(content_id, opts = {}) ⇒ Array<(IssueOnPageList, Integer, Hash)>

Get the a11y issues found in the content Get the a11y issues found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(IssueOnPageList, Integer, Hash)>) —

    IssueOnPageList data, response status code and response headers



98
99
100
101
102
103
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
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 98

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_a11y_issue_on_page_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/a11y/issue_on_page'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IssueOnPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_a11y_issue_on_page_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_a11y_issue_on_page_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_accessibility_issues_get(content_id, opts = {}) ⇒ PageIssueList

Get a list of accessibility issues for the specified content Get a list of accessibility issues for the specified content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



167
168
169
170
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 167

def content_checks_content_id_accessibility_issues_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_accessibility_issues_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_accessibility_issues_get_with_http_info(content_id, opts = {}) ⇒ Array<(PageIssueList, Integer, Hash)>

Get a list of accessibility issues for the specified content Get a list of accessibility issues for the specified content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(PageIssueList, Integer, Hash)>) —

    PageIssueList data, response status code and response headers



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 179

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_accessibility_issues_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/accessibility/issues'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageIssueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_accessibility_issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_accessibility_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_issues_get(content_id, opts = {}) ⇒ ContentCheckIssues

Get issue found for this page Get the full list of content-check issue found for this page.

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Returns:



246
247
248
249
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 246

def content_checks_content_id_issues_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_issues_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_issues_get_with_http_info(content_id, opts = {}) ⇒ Array<(ContentCheckIssues, Integer, Hash)>

Get issue found for this page Get the full list of content-check issue found for this page.

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Returns:

  • (Array<(ContentCheckIssues, Integer, Hash)>) —

    ContentCheckIssues data, response status code and response headers



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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 256

def content_checks_content_id_issues_get_with_http_info(content_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.content_checks_content_id_issues_get ...'
  end
  # verify the required parameter 'content_id' is set
  if @api_client.config.client_side_validation && content_id.nil?
    fail ArgumentError, "Missing the required parameter 'content_id' when calling ContentApi.content_checks_content_id_issues_get"
  end
  # resource path
  local_var_path = '/content/checks/{content_id}/issues'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentCheckIssues'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_policy_matching_policies_get(content_id, opts = {}) ⇒ ContentCheckPolicyInfoList

Get the matching policies for the content Get the matching policies for the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



311
312
313
314
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 311

def content_checks_content_id_policy_matching_policies_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_policy_matching_policies_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_policy_matching_policies_get_with_http_info(content_id, opts = {}) ⇒ Array<(ContentCheckPolicyInfoList, Integer, Hash)>

Get the matching policies for the content Get the matching policies for the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(ContentCheckPolicyInfoList, Integer, Hash)>) —

    ContentCheckPolicyInfoList data, response status code and response headers



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 323

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_policy_matching_policies_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/policy/matching_policies'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentCheckPolicyInfoList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_policy_matching_policies_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_policy_matching_policies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_capture_tags_get(content_id, opts = {}) ⇒ BodyTagNameList

Get the capture tags found in the content Get the capture tags found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



392
393
394
395
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 392

def content_checks_content_id_quality_assurance_inventory_capture_tags_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_capture_tags_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_capture_tags_get_with_http_info(content_id, opts = {}) ⇒ Array<(BodyTagNameList, Integer, Hash)>

Get the capture tags found in the content Get the capture tags found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(BodyTagNameList, Integer, Hash)>) —

    BodyTagNameList data, response status code and response headers



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 404

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_capture_tags_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/capture_tags'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BodyTagNameList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_capture_tags_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_capture_tags_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_email_addresses_get(content_id, opts = {}) ⇒ EmailAddressList

Get the email addresses found in the content Get the email addresses found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



473
474
475
476
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 473

def content_checks_content_id_quality_assurance_inventory_email_addresses_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_email_addresses_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_email_addresses_get_with_http_info(content_id, opts = {}) ⇒ Array<(EmailAddressList, Integer, Hash)>

Get the email addresses found in the content Get the email addresses found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(EmailAddressList, Integer, Hash)>) —

    EmailAddressList data, response status code and response headers



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 485

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_email_addresses_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/email_addresses'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailAddressList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_email_addresses_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_email_addresses_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_link_texts_get(content_id, opts = {}) ⇒ LinkTextList

Get the link texts found in the content Get the link texts found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



554
555
556
557
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 554

def content_checks_content_id_quality_assurance_inventory_link_texts_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_link_texts_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_link_texts_get_with_http_info(content_id, opts = {}) ⇒ Array<(LinkTextList, Integer, Hash)>

Get the link texts found in the content Get the link texts found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(LinkTextList, Integer, Hash)>) —

    LinkTextList data, response status code and response headers



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 566

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_link_texts_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/link_texts'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinkTextList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_link_texts_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_link_texts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_links_get(content_id, opts = {}) ⇒ LinkList

Get the links found in the content Get the links found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



635
636
637
638
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 635

def content_checks_content_id_quality_assurance_inventory_links_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_links_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_links_get_with_http_info(content_id, opts = {}) ⇒ Array<(LinkList, Integer, Hash)>

Get the links found in the content Get the links found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(LinkList, Integer, Hash)>) —

    LinkList data, response status code and response headers



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 647

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_links_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/links'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinkList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_links_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_links_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_meta_tags_get(content_id, opts = {}) ⇒ MetaTagNameList

Get the meta tags found in the content Get the meta tags found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



716
717
718
719
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 716

def content_checks_content_id_quality_assurance_inventory_meta_tags_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_meta_tags_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_meta_tags_get_with_http_info(content_id, opts = {}) ⇒ Array<(MetaTagNameList, Integer, Hash)>

Get the meta tags found in the content Get the meta tags found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(MetaTagNameList, Integer, Hash)>) —

    MetaTagNameList data, response status code and response headers



728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 728

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_meta_tags_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/meta_tags'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTagNameList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_meta_tags_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_meta_tags_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_personal_id_numbers_get(content_id, opts = {}) ⇒ PersonalIdNumberList

Get the personal id numbers found in the content Get the personal id numbers found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



797
798
799
800
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 797

def content_checks_content_id_quality_assurance_inventory_personal_id_numbers_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_personal_id_numbers_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_personal_id_numbers_get_with_http_info(content_id, opts = {}) ⇒ Array<(PersonalIdNumberList, Integer, Hash)>

Get the personal id numbers found in the content Get the personal id numbers found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(PersonalIdNumberList, Integer, Hash)>) —

    PersonalIdNumberList data, response status code and response headers



809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 809

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_personal_id_numbers_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/personal_id_numbers'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PersonalIdNumberList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_personal_id_numbers_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_personal_id_numbers_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_phone_numbers_get(content_id, opts = {}) ⇒ PhoneNumberList

Get the phone numbers found in the content Get the phone numbers found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



878
879
880
881
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 878

def content_checks_content_id_quality_assurance_inventory_phone_numbers_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_phone_numbers_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_phone_numbers_get_with_http_info(content_id, opts = {}) ⇒ Array<(PhoneNumberList, Integer, Hash)>

Get the phone numbers found in the content Get the phone numbers found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(PhoneNumberList, Integer, Hash)>) —

    PhoneNumberList data, response status code and response headers



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 890

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_phone_numbers_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/phone_numbers'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PhoneNumberList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_phone_numbers_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_phone_numbers_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_inventory_trademarks_get(content_id, opts = {}) ⇒ TrademarkList

Get the trademarks found in the content Get the trademarks found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



959
960
961
962
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 959

def content_checks_content_id_quality_assurance_inventory_trademarks_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_inventory_trademarks_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_inventory_trademarks_get_with_http_info(content_id, opts = {}) ⇒ Array<(TrademarkList, Integer, Hash)>

Get the trademarks found in the content Get the trademarks found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(TrademarkList, Integer, Hash)>) —

    TrademarkList data, response status code and response headers



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 971

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_inventory_trademarks_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/inventory/trademarks'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TrademarkList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_inventory_trademarks_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_inventory_trademarks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_links_broken_links_get(content_id, opts = {}) ⇒ BrokenPageLinkList

Get the broken links found in the content Get the broken links found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1040
1041
1042
1043
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1040

def content_checks_content_id_quality_assurance_links_broken_links_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_links_broken_links_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_links_broken_links_get_with_http_info(content_id, opts = {}) ⇒ Array<(BrokenPageLinkList, Integer, Hash)>

Get the broken links found in the content Get the broken links found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(BrokenPageLinkList, Integer, Hash)>) —

    BrokenPageLinkList data, response status code and response headers



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1052

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_links_broken_links_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/links/broken_links'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BrokenPageLinkList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_links_broken_links_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_links_broken_links_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_links_unsafe_domains_get(content_id, opts = {}) ⇒ UnsafeDomainList

Get the list of links to unsafe domains found in the content Get the list of links to unsafe domains found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1121
1122
1123
1124
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1121

def content_checks_content_id_quality_assurance_links_unsafe_domains_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_links_unsafe_domains_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_links_unsafe_domains_get_with_http_info(content_id, opts = {}) ⇒ Array<(UnsafeDomainList, Integer, Hash)>

Get the list of links to unsafe domains found in the content Get the list of links to unsafe domains found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(UnsafeDomainList, Integer, Hash)>) —

    UnsafeDomainList data, response status code and response headers



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1133

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_links_unsafe_domains_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/links/unsafe_domains'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UnsafeDomainList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_links_unsafe_domains_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_links_unsafe_domains_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_readability_get(content_id, opts = {}) ⇒ ContentCheckReadability

Get detailed information of the readability scores of the content for the various metrics Get detailed information of the readability scores of the content for the various metrics

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Returns:



1200
1201
1202
1203
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1200

def content_checks_content_id_quality_assurance_readability_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_readability_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_readability_get_with_http_info(content_id, opts = {}) ⇒ Array<(ContentCheckReadability, Integer, Hash)>

Get detailed information of the readability scores of the content for the various metrics Get detailed information of the readability scores of the content for the various metrics

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Returns:

  • (Array<(ContentCheckReadability, Integer, Hash)>) —

    ContentCheckReadability data, response status code and response headers



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1210

def content_checks_content_id_quality_assurance_readability_get_with_http_info(content_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.content_checks_content_id_quality_assurance_readability_get ...'
  end
  # verify the required parameter 'content_id' is set
  if @api_client.config.client_side_validation && content_id.nil?
    fail ArgumentError, "Missing the required parameter 'content_id' when calling ContentApi.content_checks_content_id_quality_assurance_readability_get"
  end
  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/readability'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentCheckReadability'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_readability_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_readability_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_spelling_languages_get(content_id, opts = {}) ⇒ LanguageList

Get the languages found in the content Lists the languages that was detected in the content, along with info about the percentage of the total content is in that language, and whether spellchecking is supported for the language.

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1265
1266
1267
1268
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1265

def content_checks_content_id_quality_assurance_spelling_languages_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_spelling_languages_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_spelling_languages_get_with_http_info(content_id, opts = {}) ⇒ Array<(LanguageList, Integer, Hash)>

Get the languages found in the content Lists the languages that was detected in the content, along with info about the percentage of the total content is in that language, and whether spellchecking is supported for the language.

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(LanguageList, Integer, Hash)>) —

    LanguageList data, response status code and response headers



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1277

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_spelling_languages_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/spelling/languages'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LanguageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_spelling_languages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_spelling_languages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_spelling_misspellings_get(content_id, opts = {}) ⇒ MisspellingOnPageList

Get the misspellings found in the content Get the misspellings found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1346
1347
1348
1349
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1346

def content_checks_content_id_quality_assurance_spelling_misspellings_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_spelling_misspellings_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_spelling_misspellings_get_with_http_info(content_id, opts = {}) ⇒ Array<(MisspellingOnPageList, Integer, Hash)>

Get the misspellings found in the content Get the misspellings found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(MisspellingOnPageList, Integer, Hash)>) —

    MisspellingOnPageList data, response status code and response headers



1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1358

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_spelling_misspellings_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/spelling/misspellings'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MisspellingOnPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_spelling_misspellings_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_spelling_misspellings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_quality_assurance_spelling_potential_misspellings_get(content_id, opts = {}) ⇒ PagePotentialMisspellingList

Get the potential misspellings found in the content Get the potential misspellings found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1427
1428
1429
1430
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1427

def content_checks_content_id_quality_assurance_spelling_potential_misspellings_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_quality_assurance_spelling_potential_misspellings_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_quality_assurance_spelling_potential_misspellings_get_with_http_info(content_id, opts = {}) ⇒ Array<(PagePotentialMisspellingList, Integer, Hash)>

Get the potential misspellings found in the content Get the potential misspellings found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1439

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_quality_assurance_spelling_potential_misspellings_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/quality_assurance/spelling/potential_misspellings'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagePotentialMisspellingList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_quality_assurance_spelling_potential_misspellings_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_quality_assurance_spelling_potential_misspellings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_seov2_issues_get(content_id, opts = {}) ⇒ SeoIssueWithRecommendationList

Get a list of SEO issues found in the content Get a list of SEO issues found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1508
1509
1510
1511
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1508

def content_checks_content_id_seov2_issues_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_seov2_issues_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_seov2_issues_get_with_http_info(content_id, opts = {}) ⇒ Array<(SeoIssueWithRecommendationList, Integer, Hash)>

Get a list of SEO issues found in the content Get a list of SEO issues found in the content

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1520

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.content_checks_content_id_seov2_issues_get, must be smaller than or equal to 1000.'
  end

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

  # resource path
  local_var_path = '/content/checks/{content_id}/seov2/issues'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueWithRecommendationList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_seov2_issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_seov2_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_checks_content_id_summary_get(content_id, opts = {}) ⇒ ContentCheckSummary

Get a summary of the findings of the content check Get a summary of the findings of the content check

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Returns:



1587
1588
1589
1590
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1587

def content_checks_content_id_summary_get(content_id, opts = {})
  data, _status_code, _headers = content_checks_content_id_summary_get_with_http_info(content_id, opts)
  data
end

#content_checks_content_id_summary_get_with_http_info(content_id, opts = {}) ⇒ Array<(ContentCheckSummary, Integer, Hash)>

Get a summary of the findings of the content check Get a summary of the findings of the content check

Parameters:

  • content_id (Integer) —

    The content id returned when the content was uploaded

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

    the optional parameters

Returns:

  • (Array<(ContentCheckSummary, Integer, Hash)>) —

    ContentCheckSummary data, response status code and response headers



1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1597

def content_checks_content_id_summary_get_with_http_info(content_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.content_checks_content_id_summary_get ...'
  end
  # verify the required parameter 'content_id' is set
  if @api_client.config.client_side_validation && content_id.nil?
    fail ArgumentError, "Missing the required parameter 'content_id' when calling ContentApi.content_checks_content_id_summary_get"
  end
  # resource path
  local_var_path = '/content/checks/{content_id}/summary'.sub('{' + 'content_id' + '}', CGI.escape(content_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentCheckSummary'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_checks_content_id_summary_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_checks_content_id_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_unpublish_impact_get(url, opts = {}) ⇒ PageDeletionMetaCrossProduct

Get unpublishing impact for a page via Url Get all information for this page that will be impacted in case of unpublishing it.

Parameters:

  • url (String) —

    Url of the site

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

    the optional parameters

Returns:



1650
1651
1652
1653
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1650

def content_unpublish_impact_get(url, opts = {})
  data, _status_code, _headers = content_unpublish_impact_get_with_http_info(url, opts)
  data
end

#content_unpublish_impact_get_with_http_info(url, opts = {}) ⇒ Array<(PageDeletionMetaCrossProduct, Integer, Hash)>

Get unpublishing impact for a page via Url Get all information for this page that will be impacted in case of unpublishing it.

Parameters:

  • url (String) —

    Url of the site

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

    the optional parameters

Returns:



1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1660

def content_unpublish_impact_get_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.content_unpublish_impact_get ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ContentApi.content_unpublish_impact_get"
  end
  # resource path
  local_var_path = '/content/unpublish_impact'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageDeletionMetaCrossProduct'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.content_unpublish_impact_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#content_unpublish_impact_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_check_page_get(site_id, url, opts = {}) ⇒ PageChecking

Get check status for a page via Url Get check status for a page specified by Url.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • url (String) —

    Url of the site

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



1716
1717
1718
1719
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1716

def sites_site_id_content_check_page_get(site_id, url, opts = {})
  data, _status_code, _headers = sites_site_id_content_check_page_get_with_http_info(site_id, url, opts)
  data
end

#sites_site_id_content_check_page_get_with_http_info(site_id, url, opts = {}) ⇒ Array<(PageChecking, Integer, Hash)>

Get check status for a page via Url Get check status for a page specified by Url.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • url (String) —

    Url of the site

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PageChecking, Integer, Hash)>) —

    PageChecking data, response status code and response headers



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1728

def sites_site_id_content_check_page_get_with_http_info(site_id, url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_check_page_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_check_page_get"
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ContentApi.sites_site_id_content_check_page_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/check/page'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageChecking'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_check_page_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_check_page_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_check_page_page_id_get(site_id, page_id, opts = {}) ⇒ PageChecking

Get check status for a page via page id Get check status for a page via page id.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



1789
1790
1791
1792
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1789

def sites_site_id_content_check_page_page_id_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_content_check_page_page_id_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_content_check_page_page_id_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(PageChecking, Integer, Hash)>

Get check status for a page via page id Get check status for a page via page id.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PageChecking, Integer, Hash)>) —

    PageChecking data, response status code and response headers



1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1801

def sites_site_id_content_check_page_page_id_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_check_page_page_id_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_check_page_page_id_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling ContentApi.sites_site_id_content_check_page_page_id_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/check/page/{page_id}'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageChecking'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_check_page_page_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_check_page_page_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_check_page_page_id_post(site_id, page_id, opts = {}) ⇒ RecheckResult

Post a page check request via page id POST a page check request via page id.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Returns:



1860
1861
1862
1863
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1860

def sites_site_id_content_check_page_page_id_post(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_content_check_page_page_id_post_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_content_check_page_page_id_post_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(RecheckResult, Integer, Hash)>

Post a page check request via page id POST a page check request via page id.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Returns:

  • (Array<(RecheckResult, Integer, Hash)>) —

    RecheckResult data, response status code and response headers



1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1871

def sites_site_id_content_check_page_page_id_post_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_check_page_page_id_post ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_check_page_page_id_post"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling ContentApi.sites_site_id_content_check_page_page_id_post"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/check/page/{page_id}'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RecheckResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_check_page_page_id_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_check_page_page_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_check_page_post(site_id, url, opts = {}) ⇒ SinglePageCheckResult

Post a page check request via Url POST a page check request via Url.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • url (String) —

    Url of the site

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

    the optional parameters

Returns:



1929
1930
1931
1932
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1929

def sites_site_id_content_check_page_post(site_id, url, opts = {})
  data, _status_code, _headers = sites_site_id_content_check_page_post_with_http_info(site_id, url, opts)
  data
end

#sites_site_id_content_check_page_post_with_http_info(site_id, url, opts = {}) ⇒ Array<(SinglePageCheckResult, Integer, Hash)>

Post a page check request via Url POST a page check request via Url.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • url (String) —

    Url of the site

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

    the optional parameters

Returns:

  • (Array<(SinglePageCheckResult, Integer, Hash)>) —

    SinglePageCheckResult data, response status code and response headers



1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1940

def sites_site_id_content_check_page_post_with_http_info(site_id, url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_check_page_post ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_check_page_post"
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ContentApi.sites_site_id_content_check_page_post"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/check/page'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SinglePageCheckResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_check_page_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_check_page_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_crawl_get(site_id, opts = {}) ⇒ CrawlStatus

Get crawl status for a site Get info about the crawl status for a site.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



1999
2000
2001
2002
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 1999

def sites_site_id_content_crawl_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_content_crawl_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_content_crawl_get_with_http_info(site_id, opts = {}) ⇒ Array<(CrawlStatus, Integer, Hash)>

Get crawl status for a site Get info about the crawl status for a site.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(CrawlStatus, Integer, Hash)>) —

    CrawlStatus data, response status code and response headers



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2010

def sites_site_id_content_crawl_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_crawl_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_crawl_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/crawl'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CrawlStatus'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_crawl_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_crawl_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_crawl_post(site_id, opts = {}) ⇒ SiteCheckResult

Request a crawl for the site POST a crawl request for the site.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Returns:



2064
2065
2066
2067
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2064

def sites_site_id_content_crawl_post(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_content_crawl_post_with_http_info(site_id, opts)
  data
end

#sites_site_id_content_crawl_post_with_http_info(site_id, opts = {}) ⇒ Array<(SiteCheckResult, Integer, Hash)>

Request a crawl for the site POST a crawl request for the site.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Returns:

  • (Array<(SiteCheckResult, Integer, Hash)>) —

    SiteCheckResult data, response status code and response headers



2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2074

def sites_site_id_content_crawl_post_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_crawl_post ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_crawl_post"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/crawl'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SiteCheckResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_crawl_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_crawl_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_pages_get(site_id, opts = {}) ⇒ PageApiList

Get list of pages for a site Get list of pages for a site.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

  • :url (String) —

    Url of the site

Returns:



2133
2134
2135
2136
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2133

def sites_site_id_content_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_content_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_content_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageApiList, Integer, Hash)>

Get list of pages for a site Get list of pages for a site.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

  • :url (String) —

    Url of the site

Returns:

  • (Array<(PageApiList, Integer, Hash)>) —

    PageApiList data, response status code and response headers



2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2149

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContentApi.sites_site_id_content_pages_get, must be smaller than or equal to 1000.'
  end

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

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?
  query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageApiList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_pages_page_id_get(site_id, page_id, opts = {}) ⇒ PageSummary

Get page details for page Get page details for a page.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



2226
2227
2228
2229
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2226

def sites_site_id_content_pages_page_id_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_content_pages_page_id_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_content_pages_page_id_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(PageSummary, Integer, Hash)>

Get page details for page Get page details for a page.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PageSummary, Integer, Hash)>) —

    PageSummary data, response status code and response headers



2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2238

def sites_site_id_content_pages_page_id_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_pages_page_id_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_pages_page_id_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling ContentApi.sites_site_id_content_pages_page_id_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/pages/{page_id}'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageSummary'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_pages_page_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_pages_page_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_content_pages_page_id_unpublish_impact_get(site_id, page_id, opts = {}) ⇒ UnpublishPageCheck

Get unpublishing impact for a page Get all information for this page that will be impacted in case of unpublishing it.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Returns:



2297
2298
2299
2300
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2297

def sites_site_id_content_pages_page_id_unpublish_impact_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_content_pages_page_id_unpublish_impact_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_content_pages_page_id_unpublish_impact_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(UnpublishPageCheck, Integer, Hash)>

Get unpublishing impact for a page Get all information for this page that will be impacted in case of unpublishing it.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Returns:

  • (Array<(UnpublishPageCheck, Integer, Hash)>) —

    UnpublishPageCheck data, response status code and response headers



2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/siteimprove_api_client/api/content_api.rb', line 2308

def sites_site_id_content_pages_page_id_unpublish_impact_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentApi.sites_site_id_content_pages_page_id_unpublish_impact_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling ContentApi.sites_site_id_content_pages_page_id_unpublish_impact_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling ContentApi.sites_site_id_content_pages_page_id_unpublish_impact_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/content/pages/{page_id}/unpublish_impact'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UnpublishPageCheck'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"ContentApi.sites_site_id_content_pages_page_id_unpublish_impact_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentApi#sites_site_id_content_pages_page_id_unpublish_impact_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end