Class: SiteimproveAPIClient::AccessibilityApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccessibilityApi

Returns a new instance of AccessibilityApi.



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

def api_client
  @api_client
end

Instance Method Details

#sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get(site_id, chapter, check_id, subtype, opts = {}) ⇒ PageForIgnoredIssueDecisionList

Get decisions on issues for specific pages from accessibility Get decisions on issues for specific pages from accessibility

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • chapter (String) —

    WCAG issue chapter for the problem

  • check_id (Integer) —

    id for the Accessibility check. 2, … 135 Lookup: support.siteimprove.com/hc/en-gb/articles/360002273918

  • subtype (String) —

    Decision type (approved, cant fix, etc.)

  • 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)

Returns:



34
35
36
37
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 34

def sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get(site_id, chapter, check_id, subtype, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get_with_http_info(site_id, chapter, check_id, subtype, opts)
  data
end

#sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get_with_http_info(site_id, chapter, check_id, subtype, opts = {}) ⇒ Array<(PageForIgnoredIssueDecisionList, Integer, Hash)>

Get decisions on issues for specific pages from accessibility Get decisions on issues for specific pages from accessibility

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • chapter (String) —

    WCAG issue chapter for the problem

  • check_id (Integer) —

    id for the Accessibility check. 2, … 135 Lookup: support.siteimprove.com/hc/en-gb/articles/360002273918

  • subtype (String) —

    Decision type (approved, cant fix, etc.)

  • 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)

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 51

def sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get_with_http_info(site_id, chapter, check_id, subtype, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_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 AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get"
  end
  # verify the required parameter 'chapter' is set
  if @api_client.config.client_side_validation && chapter.nil?
    fail ArgumentError, "Missing the required parameter 'chapter' when calling AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get"
  end
  # verify the required parameter 'check_id' is set
  if @api_client.config.client_side_validation && check_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_id' when calling AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get"
  end
  # verify the required parameter 'subtype' is set
  if @api_client.config.client_side_validation && subtype.nil?
    fail ArgumentError, "Missing the required parameter 'subtype' when calling AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get"
  end
  # verify enum value
  allowable_values = ["ignored", "cant_fix", "approved"]
  if @api_client.config.client_side_validation && !allowable_values.include?(subtype)
    fail ArgumentError, "invalid value for \"subtype\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_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 AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_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 AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/decision/issues/{chapter}/{check_id}/{subtype}/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'chapter' + '}', CGI.escape(chapter.to_s)).sub('{' + 'check_id' + '}', CGI.escape(check_id.to_s)).sub('{' + 'subtype' + '}', CGI.escape(subtype.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?

  # 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] || 'PageForIgnoredIssueDecisionList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_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: AccessibilityApi#sites_site_id_accessibility_decision_issues_chapter_check_id_subtype_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_decision_issues_get(site_id, opts = {}) ⇒ IgnoredIssueDecisionList

Get decisions on issues from accessibility Get decisions on issues from accessibility

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.

  • :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:



140
141
142
143
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 140

def sites_site_id_accessibility_decision_issues_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_decision_issues_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_decision_issues_get_with_http_info(site_id, opts = {}) ⇒ Array<(IgnoredIssueDecisionList, Integer, Hash)>

Get decisions on issues from accessibility Get decisions on issues from accessibility

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.

  • :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<(IgnoredIssueDecisionList, Integer, Hash)>) —

    IgnoredIssueDecisionList data, response status code and response headers



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 153

def sites_site_id_accessibility_decision_issues_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_decision_issues_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 AccessibilityApi.sites_site_id_accessibility_decision_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 AccessibilityApi.sites_site_id_accessibility_decision_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 AccessibilityApi.sites_site_id_accessibility_decision_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 AccessibilityApi.sites_site_id_accessibility_decision_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/decision/issues'.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[:'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] || 'IgnoredIssueDecisionList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_decision_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: AccessibilityApi#sites_site_id_accessibility_decision_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get(site_id, chapter, check_id, subtype, hash, opts = {}) ⇒ IgnoredItemPageList

Get decisions on items for specific pages from accessibility Get decisions on items for specific pages from accessibility

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • chapter (String) —

    WCAG issue chapter for the problem

  • check_id (Integer) —

    id for the Accessibility check. 2, … 135 Lookup: support.siteimprove.com/hc/en-gb/articles/360002273918

  • subtype (String) —

    Decision type (approved, cant fix, etc.)

  • hash (String) —

    MD5 hash identifying the item the decision is made for

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :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:



228
229
230
231
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 228

def sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get(site_id, chapter, check_id, subtype, hash, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get_with_http_info(site_id, chapter, check_id, subtype, hash, opts)
  data
end

#sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get_with_http_info(site_id, chapter, check_id, subtype, hash, opts = {}) ⇒ Array<(IgnoredItemPageList, Integer, Hash)>

Get decisions on items for specific pages from accessibility Get decisions on items for specific pages from accessibility

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • chapter (String) —

    WCAG issue chapter for the problem

  • check_id (Integer) —

    id for the Accessibility check. 2, … 135 Lookup: support.siteimprove.com/hc/en-gb/articles/360002273918

  • subtype (String) —

    Decision type (approved, cant fix, etc.)

  • hash (String) —

    MD5 hash identifying the item the decision is made for

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :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<(IgnoredItemPageList, Integer, Hash)>) —

    IgnoredItemPageList data, response status code and response headers



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 245

def sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get_with_http_info(site_id, chapter, check_id, subtype, hash, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_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 AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get"
  end
  # verify the required parameter 'chapter' is set
  if @api_client.config.client_side_validation && chapter.nil?
    fail ArgumentError, "Missing the required parameter 'chapter' when calling AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get"
  end
  # verify the required parameter 'check_id' is set
  if @api_client.config.client_side_validation && check_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_id' when calling AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get"
  end
  # verify the required parameter 'subtype' is set
  if @api_client.config.client_side_validation && subtype.nil?
    fail ArgumentError, "Missing the required parameter 'subtype' when calling AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get"
  end
  # verify enum value
  allowable_values = ["ignored", "cant_fix", "approved"]
  if @api_client.config.client_side_validation && !allowable_values.include?(subtype)
    fail ArgumentError, "invalid value for \"subtype\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'hash' is set
  if @api_client.config.client_side_validation && hash.nil?
    fail ArgumentError, "Missing the required parameter 'hash' when calling AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_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 AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_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 AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_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 AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/decision/items/{chapter}/{check_id}/{subtype}/{hash}/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'chapter' + '}', CGI.escape(chapter.to_s)).sub('{' + 'check_id' + '}', CGI.escape(check_id.to_s)).sub('{' + 'subtype' + '}', CGI.escape(subtype.to_s)).sub('{' + 'hash' + '}', CGI.escape(hash.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  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] || 'IgnoredItemPageList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_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: AccessibilityApi#sites_site_id_accessibility_decision_items_chapter_check_id_subtype_hash_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_decision_items_get(site_id, opts = {}) ⇒ IgnoredItemDecisionList

Get decisions on items from accessibility Get decisions on items from accessibility

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.

  • :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:



337
338
339
340
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 337

def sites_site_id_accessibility_decision_items_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_decision_items_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_decision_items_get_with_http_info(site_id, opts = {}) ⇒ Array<(IgnoredItemDecisionList, Integer, Hash)>

Get decisions on items from accessibility Get decisions on items from accessibility

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.

  • :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<(IgnoredItemDecisionList, Integer, Hash)>) —

    IgnoredItemDecisionList data, response status code and response headers



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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 350

def sites_site_id_accessibility_decision_items_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_decision_items_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 AccessibilityApi.sites_site_id_accessibility_decision_items_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_decision_items_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 AccessibilityApi.sites_site_id_accessibility_decision_items_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 AccessibilityApi.sites_site_id_accessibility_decision_items_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/decision/items'.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[:'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] || 'IgnoredItemDecisionList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_decision_items_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: AccessibilityApi#sites_site_id_accessibility_decision_items_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_issues_get(site_id, opts = {}) ⇒ IssueList1

Get issues from accessibility Retrieves the issues from accessibility; how many pages that have the Issue; the guideline; its conformance level (A, AA, or AAA); its severity; links to pages having the Issue

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.

  • :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:



421
422
423
424
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 421

def sites_site_id_accessibility_issues_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_issues_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_issues_get_with_http_info(site_id, opts = {}) ⇒ Array<(IssueList1, Integer, Hash)>

Get issues from accessibility Retrieves the issues from accessibility; how many pages that have the Issue; the guideline; its conformance level (A, AA, or AAA); its severity; links to pages having the Issue

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.

  • :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<(IssueList1, Integer, Hash)>) —

    IssueList1 data, response status code and response headers



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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 434

def sites_site_id_accessibility_issues_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_issues_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 AccessibilityApi.sites_site_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 AccessibilityApi.sites_site_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 AccessibilityApi.sites_site_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 AccessibilityApi.sites_site_id_accessibility_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/issues'.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[:'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] || 'IssueList1'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_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: AccessibilityApi#sites_site_id_accessibility_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_issues_success_criterion_check_id_pages_get(site_id, success_criterion, check_id, opts = {}) ⇒ SpecificIssuePageList

Get pages with this issue from accessibility Retrieves pages with this issue from accessibility. The issue is identified by its check_id.

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:



510
511
512
513
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 510

def sites_site_id_accessibility_issues_success_criterion_check_id_pages_get(site_id, success_criterion, check_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_issues_success_criterion_check_id_pages_get_with_http_info(site_id, success_criterion, check_id, opts)
  data
end

#sites_site_id_accessibility_issues_success_criterion_check_id_pages_get_with_http_info(site_id, success_criterion, check_id, opts = {}) ⇒ Array<(SpecificIssuePageList, Integer, Hash)>

Get pages with this issue from accessibility Retrieves pages with this issue from accessibility. The issue is identified by its check_id.

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:

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

    SpecificIssuePageList data, response status code and response headers



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 528

def sites_site_id_accessibility_issues_success_criterion_check_id_pages_get_with_http_info(site_id, success_criterion, check_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_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 AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_pages_get"
  end
  # verify the required parameter 'success_criterion' is set
  if @api_client.config.client_side_validation && success_criterion.nil?
    fail ArgumentError, "Missing the required parameter 'success_criterion' when calling AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_pages_get"
  end
  # verify the required parameter 'check_id' is set
  if @api_client.config.client_side_validation && check_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_id' when calling AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_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 AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_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 AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_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 AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_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}/accessibility/issues/{success_criterion}/{check_id}/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'success_criterion' + '}', CGI.escape(success_criterion.to_s)).sub('{' + 'check_id' + '}', CGI.escape(check_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[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].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] || 'SpecificIssuePageList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_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: AccessibilityApi#sites_site_id_accessibility_issues_success_criterion_check_id_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get(site_id, success_criterion, check_id, opts = {}) ⇒ AccessibilityHistoryIssueInstancesList

Get progress for this issue from accessibility Retrieves issue progress for accessibility. Returns a list of how many many instances of this issue is present on the site, how many pages have this issue, how many pages the issue has been ignored on, and how many pages in total the site has had over time.

Parameters:

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :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)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



617
618
619
620
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 617

def sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get(site_id, success_criterion, check_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get_with_http_info(site_id, success_criterion, check_id, opts)
  data
end

#sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get_with_http_info(site_id, success_criterion, check_id, opts = {}) ⇒ Array<(AccessibilityHistoryIssueInstancesList, Integer, Hash)>

Get progress for this issue from accessibility Retrieves issue progress for accessibility. Returns a list of how many many instances of this issue is present on the site, how many pages have this issue, how many pages the issue has been ignored on, and how many pages in total the site has had over time.

Parameters:

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :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)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



633
634
635
636
637
638
639
640
641
642
643
644
645
646
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 633

def sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get_with_http_info(site_id, success_criterion, check_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_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 AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get"
  end
  # verify the required parameter 'success_criterion' is set
  if @api_client.config.client_side_validation && success_criterion.nil?
    fail ArgumentError, "Missing the required parameter 'success_criterion' when calling AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get"
  end
  # verify the required parameter 'check_id' is set
  if @api_client.config.client_side_validation && check_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_id' when calling AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_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 AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_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 AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/issues/{success_criterion}/{check_id}/progress/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'success_criterion' + '}', CGI.escape(success_criterion.to_s)).sub('{' + 'check_id' + '}', CGI.escape(check_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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] || 'AccessibilityHistoryIssueInstancesList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_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: AccessibilityApi#sites_site_id_accessibility_issues_success_criterion_check_id_progress_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_overview_groups_get(site_id, opts = {}) ⇒ AccessibilityGroupsOverviewList

Get overview of groups for accessibility Retrieve overview of groups for accessibility. Returns the name of the group; its id; the number of pages in the group; the number of A, AA, AAA, and PDF issues for pages handled by this group

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • 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)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



713
714
715
716
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 713

def sites_site_id_accessibility_overview_groups_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_overview_groups_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_overview_groups_get_with_http_info(site_id, opts = {}) ⇒ Array<(AccessibilityGroupsOverviewList, Integer, Hash)>

Get overview of groups for accessibility Retrieve overview of groups for accessibility. Returns the name of the group; its id; the number of pages in the group; the number of A, AA, AAA, and PDF issues for pages handled by this group

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • 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)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



726
727
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 726

def sites_site_id_accessibility_overview_groups_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_overview_groups_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 AccessibilityApi.sites_site_id_accessibility_overview_groups_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_overview_groups_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 AccessibilityApi.sites_site_id_accessibility_overview_groups_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 AccessibilityApi.sites_site_id_accessibility_overview_groups_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/overview/groups'.sub('{' + 'site_id' + '}', CGI.escape(site_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?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].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] || 'AccessibilityGroupsOverviewList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_overview_groups_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: AccessibilityApi#sites_site_id_accessibility_overview_groups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_overview_groups_group_id_users_get(site_id, group_id, opts = {}) ⇒ AccessibilityGroupPersonList

Get list of users for this group Retrieves list of users for this group. Returns id for user, user name, and user email

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • group_id (Integer) —

    Id for specific group.

  • 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/accessibility_api.rb', line 797

def sites_site_id_accessibility_overview_groups_group_id_users_get(site_id, group_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_overview_groups_group_id_users_get_with_http_info(site_id, group_id, opts)
  data
end

#sites_site_id_accessibility_overview_groups_group_id_users_get_with_http_info(site_id, group_id, opts = {}) ⇒ Array<(AccessibilityGroupPersonList, Integer, Hash)>

Get list of users for this group Retrieves list of users for this group. Returns id for user, user name, and user email

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • group_id (Integer) —

    Id for specific group.

  • 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:



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
870
871
872
873
874
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 810

def sites_site_id_accessibility_overview_groups_group_id_users_get_with_http_info(site_id, group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_overview_groups_group_id_users_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 AccessibilityApi.sites_site_id_accessibility_overview_groups_group_id_users_get"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling AccessibilityApi.sites_site_id_accessibility_overview_groups_group_id_users_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_overview_groups_group_id_users_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 AccessibilityApi.sites_site_id_accessibility_overview_groups_group_id_users_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 AccessibilityApi.sites_site_id_accessibility_overview_groups_group_id_users_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/overview/groups/{group_id}/users'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'group_id' + '}', CGI.escape(group_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] || 'AccessibilityGroupPersonList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_overview_groups_group_id_users_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: AccessibilityApi#sites_site_id_accessibility_overview_groups_group_id_users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_overview_progress_instances_history_get(site_id, opts = {}) ⇒ IHistoryInstancesValuableList

Get progress for all instances from accessibility Retrieves overall instance progress for accessibility. Returns a list of how many total instances are present on the site, as well as how many total pages are present. All of the data is filterable by conformance level (A, AA, AAA), severity, and responsibility.

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.

  • :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)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

  • :roles (String) —

    Roles to be included in the result. (default to ‘editor’)

  • :severities (String) —

    Severities to be included in the result. (default to ‘error’)

Returns:



887
888
889
890
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 887

def sites_site_id_accessibility_overview_progress_instances_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_overview_progress_instances_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_overview_progress_instances_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(IHistoryInstancesValuableList, Integer, Hash)>

Get progress for all instances from accessibility Retrieves overall instance progress for accessibility. Returns a list of how many total instances are present on the site, as well as how many total pages are present. All of the data is filterable by conformance level (A, AA, AAA), severity, and responsibility.

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.

  • :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)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

  • :roles (String) —

    Roles to be included in the result. (default to ‘editor’)

  • :severities (String) —

    Severities to be included in the result. (default to ‘error’)

Returns:



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
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 903

def sites_site_id_accessibility_overview_progress_instances_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_overview_progress_instances_history_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 AccessibilityApi.sites_site_id_accessibility_overview_progress_instances_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_overview_progress_instances_history_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 AccessibilityApi.sites_site_id_accessibility_overview_progress_instances_history_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 AccessibilityApi.sites_site_id_accessibility_overview_progress_instances_history_get, must be greater than or equal to 1.'
  end

  allowable_values = ["editor", "developer", "webmaster", "editor,developer", "editor,webmaster", "developer,webmaster", "editor,developer,webmaster"]
  if @api_client.config.client_side_validation && opts[:'roles'] && !allowable_values.include?(opts[:'roles'])
    fail ArgumentError, "invalid value for \"roles\", must be one of #{allowable_values}"
  end
  allowable_values = ["error", "warning", "review", "error,warning", "error,review", "warning,review", "error,warning,review"]
  if @api_client.config.client_side_validation && opts[:'severities'] && !allowable_values.include?(opts[:'severities'])
    fail ArgumentError, "invalid value for \"severities\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/accessibility/overview/progress/instances/history'.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[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'roles'] = opts[:'roles'] if !opts[:'roles'].nil?
  query_params[:'severities'] = opts[:'severities'] if !opts[:'severities'].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] || 'IHistoryInstancesValuableList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_overview_progress_instances_history_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: AccessibilityApi#sites_site_id_accessibility_overview_progress_instances_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_overview_progress_issues_history_get(site_id, opts = {}) ⇒ IHistoryIssuesValuableList

Get progress for all issues from accessibility Retrieves overall issue progress for accessibility. Returns a list of how many total issues are present on the site, how many issues are excluded, as well as how many total pages are present. All of the data is filterable by conformance level (A, AA, AAA), severity, and responsibility.

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.

  • :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)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

  • :roles (String) —

    Roles to be included in the result. (default to ‘editor’)

  • :severities (String) —

    Severities to be included in the result. (default to ‘error’)

Returns:



988
989
990
991
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 988

def sites_site_id_accessibility_overview_progress_issues_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_overview_progress_issues_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_overview_progress_issues_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(IHistoryIssuesValuableList, Integer, Hash)>

Get progress for all issues from accessibility Retrieves overall issue progress for accessibility. Returns a list of how many total issues are present on the site, how many issues are excluded, as well as how many total pages are present. All of the data is filterable by conformance level (A, AA, AAA), severity, and responsibility.

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.

  • :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)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

  • :roles (String) —

    Roles to be included in the result. (default to ‘editor’)

  • :severities (String) —

    Severities to be included in the result. (default to ‘error’)

Returns:

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

    IHistoryIssuesValuableList data, response status code and response headers



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
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1004

def sites_site_id_accessibility_overview_progress_issues_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_overview_progress_issues_history_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 AccessibilityApi.sites_site_id_accessibility_overview_progress_issues_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_overview_progress_issues_history_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 AccessibilityApi.sites_site_id_accessibility_overview_progress_issues_history_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 AccessibilityApi.sites_site_id_accessibility_overview_progress_issues_history_get, must be greater than or equal to 1.'
  end

  allowable_values = ["editor", "developer", "webmaster", "editor,developer", "editor,webmaster", "developer,webmaster", "editor,developer,webmaster"]
  if @api_client.config.client_side_validation && opts[:'roles'] && !allowable_values.include?(opts[:'roles'])
    fail ArgumentError, "invalid value for \"roles\", must be one of #{allowable_values}"
  end
  allowable_values = ["error", "warning", "review", "error,warning", "error,review", "warning,review", "error,warning,review"]
  if @api_client.config.client_side_validation && opts[:'severities'] && !allowable_values.include?(opts[:'severities'])
    fail ArgumentError, "invalid value for \"severities\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/accessibility/overview/progress/issues/history'.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[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'roles'] = opts[:'roles'] if !opts[:'roles'].nil?
  query_params[:'severities'] = opts[:'severities'] if !opts[:'severities'].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] || 'IHistoryIssuesValuableList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_overview_progress_issues_history_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: AccessibilityApi#sites_site_id_accessibility_overview_progress_issues_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_overview_summary_get(site_id, opts = {}) ⇒ SummaryIssueList

Get summary for accessibility Retrieves issue overview for accessibility, according to conformance level (a, aa, aaa) and severity. I.e. up to 9 items. Items that don’t contain any issues are not returned

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.

  • :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:



1086
1087
1088
1089
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1086

def sites_site_id_accessibility_overview_summary_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_overview_summary_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_overview_summary_get_with_http_info(site_id, opts = {}) ⇒ Array<(SummaryIssueList, Integer, Hash)>

Get summary for accessibility Retrieves issue overview for accessibility, according to conformance level (a, aa, aaa) and severity. I.e. up to 9 items. Items that don&#39;t contain any issues are not returned

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.

  • :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<(SummaryIssueList, Integer, Hash)>) —

    SummaryIssueList data, response status code and response headers



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1099

def sites_site_id_accessibility_overview_summary_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_overview_summary_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 AccessibilityApi.sites_site_id_accessibility_overview_summary_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_overview_summary_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 AccessibilityApi.sites_site_id_accessibility_overview_summary_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 AccessibilityApi.sites_site_id_accessibility_overview_summary_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/overview/summary'.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[:'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] || 'SummaryIssueList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_overview_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: AccessibilityApi#sites_site_id_accessibility_overview_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_pages_get(site_id, opts = {}) ⇒ PageList

Get HTML pages from accessibility Retrieves HTML pages from accessibility with the number of A, AA, and AAA issues on the page

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:



1173
1174
1175
1176
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1173

def sites_site_id_accessibility_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageList, Integer, Hash)>

Get HTML pages from accessibility Retrieves HTML pages from accessibility with the number of A, AA, and AAA issues on the page

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:

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

    PageList data, response status code and response headers



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
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
1257
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1189

def sites_site_id_accessibility_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_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 AccessibilityApi.sites_site_id_accessibility_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 AccessibilityApi.sites_site_id_accessibility_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 AccessibilityApi.sites_site_id_accessibility_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 AccessibilityApi.sites_site_id_accessibility_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}/accessibility/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[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].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] || 'PageList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_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: AccessibilityApi#sites_site_id_accessibility_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_pages_page_id_issues_get(site_id, page_id, opts = {}) ⇒ IssueSummaryPageList

Get overview of issues for page in accessibility Retrieves the number of issues within a conformance level * severity set

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):

  • :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:



1267
1268
1269
1270
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1267

def sites_site_id_accessibility_pages_page_id_issues_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_pages_page_id_issues_get_with_http_info(site_id, page_id, opts)
  data
end

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

Get overview of issues for page in accessibility Retrieves the number of issues within a conformance level * severity set

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):

  • :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<(IssueSummaryPageList, Integer, Hash)>) —

    IssueSummaryPageList data, response status code and response headers



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
1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1280

def sites_site_id_accessibility_pages_page_id_issues_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_pages_page_id_issues_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 AccessibilityApi.sites_site_id_accessibility_pages_page_id_issues_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 AccessibilityApi.sites_site_id_accessibility_pages_page_id_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 AccessibilityApi.sites_site_id_accessibility_pages_page_id_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 AccessibilityApi.sites_site_id_accessibility_pages_page_id_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 AccessibilityApi.sites_site_id_accessibility_pages_page_id_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/pages/{page_id}/issues'.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[:'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] || 'IssueSummaryPageList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_pages_page_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: AccessibilityApi#sites_site_id_accessibility_pages_page_id_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_validation_css_css_id_pages_using_css_get(site_id, css_id, opts = {}) ⇒ ReferringPageCssList

Get HTML pages referencing specific CSS stylesheet Retrieves the HTML pages referencing specific CSS stylesheet. Returns name of HTML page, its url, and usage.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • css_id (Integer) —

    Id of the CSS file

  • 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)

Returns:



1356
1357
1358
1359
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1356

def sites_site_id_accessibility_validation_css_css_id_pages_using_css_get(site_id, css_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_validation_css_css_id_pages_using_css_get_with_http_info(site_id, css_id, opts)
  data
end

#sites_site_id_accessibility_validation_css_css_id_pages_using_css_get_with_http_info(site_id, css_id, opts = {}) ⇒ Array<(ReferringPageCssList, Integer, Hash)>

Get HTML pages referencing specific CSS stylesheet Retrieves the HTML pages referencing specific CSS stylesheet. Returns name of HTML page, its url, and usage.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • css_id (Integer) —

    Id of the CSS file

  • 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)

Returns:

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

    ReferringPageCssList data, response status code and response headers



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
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1371

def sites_site_id_accessibility_validation_css_css_id_pages_using_css_get_with_http_info(site_id, css_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_validation_css_css_id_pages_using_css_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 AccessibilityApi.sites_site_id_accessibility_validation_css_css_id_pages_using_css_get"
  end
  # verify the required parameter 'css_id' is set
  if @api_client.config.client_side_validation && css_id.nil?
    fail ArgumentError, "Missing the required parameter 'css_id' when calling AccessibilityApi.sites_site_id_accessibility_validation_css_css_id_pages_using_css_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_validation_css_css_id_pages_using_css_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 AccessibilityApi.sites_site_id_accessibility_validation_css_css_id_pages_using_css_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 AccessibilityApi.sites_site_id_accessibility_validation_css_css_id_pages_using_css_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/validation/css/{css_id}/pages_using_css'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'css_id' + '}', CGI.escape(css_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?

  # 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] || 'ReferringPageCssList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_validation_css_css_id_pages_using_css_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: AccessibilityApi#sites_site_id_accessibility_validation_css_css_id_pages_using_css_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_validation_css_get(site_id, opts = {}) ⇒ CssValidationList

Get W3C CSS error report from accessibility Retrieves CSS error report from accesibility. Contains the number of CSS errors for each CSS stylesheet used on the 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)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



1449
1450
1451
1452
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1449

def sites_site_id_accessibility_validation_css_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_validation_css_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_validation_css_get_with_http_info(site_id, opts = {}) ⇒ Array<(CssValidationList, Integer, Hash)>

Get W3C CSS error report from accessibility Retrieves CSS error report from accesibility. Contains the number of CSS errors for each CSS stylesheet used on the 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)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

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

    CssValidationList data, response status code and response headers



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
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1464

def sites_site_id_accessibility_validation_css_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_validation_css_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 AccessibilityApi.sites_site_id_accessibility_validation_css_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_validation_css_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 AccessibilityApi.sites_site_id_accessibility_validation_css_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 AccessibilityApi.sites_site_id_accessibility_validation_css_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/validation/css'.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[:'query'] = opts[:'query'] if !opts[:'query'].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] || 'CssValidationList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_validation_css_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: AccessibilityApi#sites_site_id_accessibility_validation_css_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_validation_html_get(site_id, opts = {}) ⇒ HtmlValidationPageList

Get W3C HTML error report from accessibility Retrieves W3C HTML error report from accesibility. Returns name of HTML page, its url, and usage.

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:



1540
1541
1542
1543
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1540

def sites_site_id_accessibility_validation_html_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_validation_html_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_validation_html_get_with_http_info(site_id, opts = {}) ⇒ Array<(HtmlValidationPageList, Integer, Hash)>

Get W3C HTML error report from accessibility Retrieves W3C HTML error report from accesibility. Returns name of HTML page, its url, and usage.

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:

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

    HtmlValidationPageList data, response status code and response headers



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
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1556

def sites_site_id_accessibility_validation_html_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_validation_html_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 AccessibilityApi.sites_site_id_accessibility_validation_html_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_validation_html_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 AccessibilityApi.sites_site_id_accessibility_validation_html_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 AccessibilityApi.sites_site_id_accessibility_validation_html_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}/accessibility/validation/html'.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[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].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] || 'HtmlValidationPageList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_validation_html_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: AccessibilityApi#sites_site_id_accessibility_validation_html_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_validation_pdf_get(site_id, opts = {}) ⇒ DocumentWithErrorList1

Get report on PDF errors from accessibility Retrieves PDF documents from accessibility. Contains the PDF documents referred on the site, whether they’re tagged, contains text, and their errors

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:



1637
1638
1639
1640
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1637

def sites_site_id_accessibility_validation_pdf_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_validation_pdf_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_accessibility_validation_pdf_get_with_http_info(site_id, opts = {}) ⇒ Array<(DocumentWithErrorList1, Integer, Hash)>

Get report on PDF errors from accessibility Retrieves PDF documents from accessibility. Contains the PDF documents referred on the site, whether they&#39;re tagged, contains text, and their errors

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)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

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

Returns:

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

    DocumentWithErrorList1 data, response status code and response headers



1653
1654
1655
1656
1657
1658
1659
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
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1653

def sites_site_id_accessibility_validation_pdf_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_validation_pdf_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_validation_pdf_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_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}/accessibility/validation/pdf'.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[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].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] || 'DocumentWithErrorList1'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_validation_pdf_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: AccessibilityApi#sites_site_id_accessibility_validation_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_validation_pdf_link_id_issues_get(site_id, link_id, opts = {}) ⇒ DocumentErrorDetailsList

Get errors for specific PDF document List of errors for the PDF document

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • link_id (Integer) —

    Id of a specific link/URL.

  • 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:



1731
1732
1733
1734
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1731

def sites_site_id_accessibility_validation_pdf_link_id_issues_get(site_id, link_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_validation_pdf_link_id_issues_get_with_http_info(site_id, link_id, opts)
  data
end

#sites_site_id_accessibility_validation_pdf_link_id_issues_get_with_http_info(site_id, link_id, opts = {}) ⇒ Array<(DocumentErrorDetailsList, Integer, Hash)>

Get errors for specific PDF document List of errors for the PDF document

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • link_id (Integer) —

    Id of a specific link/URL.

  • 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<(DocumentErrorDetailsList, Integer, Hash)>) —

    DocumentErrorDetailsList data, response status code and response headers



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
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1744

def sites_site_id_accessibility_validation_pdf_link_id_issues_get_with_http_info(site_id, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_validation_pdf_link_id_issues_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_link_id_issues_get"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling AccessibilityApi.sites_site_id_accessibility_validation_pdf_link_id_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_link_id_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_link_id_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_link_id_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/validation/pdf/{link_id}/issues'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'link_id' + '}', CGI.escape(link_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] || 'DocumentErrorDetailsList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_validation_pdf_link_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: AccessibilityApi#sites_site_id_accessibility_validation_pdf_link_id_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get(site_id, pdf_id, opts = {}) ⇒ ReferringPageList

Get HTML pages referring to specific PDF document List of HTML pages on the site that refers to the PDF document

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • pdf_id (Integer) —

    id of the PDF document

  • 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)

Returns:



1820
1821
1822
1823
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1820

def sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get(site_id, pdf_id, opts = {})
  data, _status_code, _headers = sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get_with_http_info(site_id, pdf_id, opts)
  data
end

#sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get_with_http_info(site_id, pdf_id, opts = {}) ⇒ Array<(ReferringPageList, Integer, Hash)>

Get HTML pages referring to specific PDF document List of HTML pages on the site that refers to the PDF document

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • pdf_id (Integer) —

    id of the PDF document

  • 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)

Returns:

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

    ReferringPageList data, response status code and response headers



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
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
 
# File 'lib/siteimprove_api_client/api/accessibility_api.rb', line 1835

def sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get_with_http_info(site_id, pdf_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessibilityApi.sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get"
  end
  # verify the required parameter 'pdf_id' is set
  if @api_client.config.client_side_validation && pdf_id.nil?
    fail ArgumentError, "Missing the required parameter 'pdf_id' when calling AccessibilityApi.sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccessibilityApi.sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_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 AccessibilityApi.sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/accessibility/validation/pdf/{pdf_id}/pages_using_pdf'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'pdf_id' + '}', CGI.escape(pdf_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?

  # 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] || 'ReferringPageList'

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

  new_options = opts.merge(
    :operation => :"AccessibilityApi.sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_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: AccessibilityApi#sites_site_id_accessibility_validation_pdf_pdf_id_pages_using_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end