Class: SiteimproveAPIClient::A11YNextGenApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ A11YNextGenApi

Returns a new instance of A11YNextGenApi.



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

def api_client
  @api_client
end

Instance Method Details

#sites_site_id_a11y_issue_kinds_issue_kind_issues_get(site_id, issue_kind, opts = {}) ⇒ IssueList

Get issues from accessibility Retrieves the issues from accessibility, per the issue kind; how many pages that have the Issue; how many occurrences of the Issue exist on site in total; it’s Conformance and Difficulty rating.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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



32
33
34
35
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 32

def sites_site_id_a11y_issue_kinds_issue_kind_issues_get(site_id, issue_kind, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_issue_kinds_issue_kind_issues_get_with_http_info(site_id, issue_kind, opts)
  data
end

#sites_site_id_a11y_issue_kinds_issue_kind_issues_get_with_http_info(site_id, issue_kind, opts = {}) ⇒ Array<(IssueList, Integer, Hash)>

Get issues from accessibility Retrieves the issues from accessibility, per the issue kind; how many pages that have the Issue; how many occurrences of the Issue exist on site in total; it&#39;s Conformance and Difficulty rating.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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

    IssueList data, response status code and response headers



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 47

def sites_site_id_a11y_issue_kinds_issue_kind_issues_get_with_http_info(site_id, issue_kind, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_get"
  end
  # verify the required parameter 'issue_kind' is set
  if @api_client.config.client_side_validation && issue_kind.nil?
    fail ArgumentError, "Missing the required parameter 'issue_kind' when calling A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_get"
  end
  # verify enum value
  allowable_values = ["confirmed", "potential", "passed"]
  if @api_client.config.client_side_validation && !allowable_values.include?(issue_kind)
    fail ArgumentError, "invalid value for \"issue_kind\", must be one of #{allowable_values}"
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'conformance'] && !opts[:'conformance'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"conformance\", must include 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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/a11y/issue_kinds/{issue_kind}/issues'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'issue_kind' + '}', CGI.escape(issue_kind.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'conformance'] = @api_client.build_collection_param(opts[:'conformance'], :csv) if !opts[:'conformance'].nil?
  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] || 'IssueList'

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

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

#sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get(site_id, issue_kind, issue_id, opts = {}) ⇒ PageWithIssueList

Get pages with this issue from accessibility Retrieves pages with this issue from accessibility, per issue kind; how many occurrences of given issue exist on the page.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

  • issue_id (Integer) —

    Id of the issue to display

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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



138
139
140
141
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 138

def sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get(site_id, issue_kind, issue_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get_with_http_info(site_id, issue_kind, issue_id, opts)
  data
end

#sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get_with_http_info(site_id, issue_kind, issue_id, opts = {}) ⇒ Array<(PageWithIssueList, Integer, Hash)>

Get pages with this issue from accessibility Retrieves pages with this issue from accessibility, per issue kind; how many occurrences of given issue exist on the page.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

  • issue_id (Integer) —

    Id of the issue to display

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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

    PageWithIssueList data, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 157

def sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get_with_http_info(site_id, issue_kind, issue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get"
  end
  # verify the required parameter 'issue_kind' is set
  if @api_client.config.client_side_validation && issue_kind.nil?
    fail ArgumentError, "Missing the required parameter 'issue_kind' when calling A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get"
  end
  # verify enum value
  allowable_values = ["confirmed", "potential", "passed"]
  if @api_client.config.client_side_validation && !allowable_values.include?(issue_kind)
    fail ArgumentError, "invalid value for \"issue_kind\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'issue_id' is set
  if @api_client.config.client_side_validation && issue_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_id' when calling A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_pages_get"
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'conformance'] && !opts[:'conformance'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"conformance\", must include 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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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}/a11y/issue_kinds/{issue_kind}/issues/{issue_id}/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'issue_kind' + '}', CGI.escape(issue_kind.to_s)).sub('{' + 'issue_id' + '}', CGI.escape(issue_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'conformance'] = @api_client.build_collection_param(opts[:'conformance'], :csv) if !opts[:'conformance'].nil?
  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] || 'PageWithIssueList'

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

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

#sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get(site_id, issue_kind, issue_id, opts = {}) ⇒ A11YSingleIssueHistoryValueList

Get progress for this issue from accessibility Retrieves issue progress for accessibility. Returns a list of how many many occurrences of this issue are present on the site and how many pages in total the site has had over time.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

  • issue_id (Integer) —

    Id of the issue to display

  • 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

Returns:



256
257
258
259
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 256

def sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get(site_id, issue_kind, issue_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get_with_http_info(site_id, issue_kind, issue_id, opts)
  data
end

#sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get_with_http_info(site_id, issue_kind, issue_id, opts = {}) ⇒ Array<(A11YSingleIssueHistoryValueList, Integer, Hash)>

Get progress for this issue from accessibility Retrieves issue progress for accessibility. Returns a list of how many many occurrences of this issue are present on the site and how many pages in total the site has had over time.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

  • issue_id (Integer) —

    Id of the issue to display

  • 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

Returns:



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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 272

def sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get_with_http_info(site_id, issue_kind, issue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get"
  end
  # verify the required parameter 'issue_kind' is set
  if @api_client.config.client_side_validation && issue_kind.nil?
    fail ArgumentError, "Missing the required parameter 'issue_kind' when calling A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get"
  end
  # verify enum value
  allowable_values = ["confirmed", "potential", "passed"]
  if @api_client.config.client_side_validation && !allowable_values.include?(issue_kind)
    fail ArgumentError, "invalid value for \"issue_kind\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'issue_id' is set
  if @api_client.config.client_side_validation && issue_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_id' when calling A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_issues_issue_id_progress_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/a11y/issue_kinds/{issue_kind}/issues/{issue_id}/progress/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'issue_kind' + '}', CGI.escape(issue_kind.to_s)).sub('{' + 'issue_id' + '}', CGI.escape(issue_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] || 'A11YSingleIssueHistoryValueList'

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

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

#sites_site_id_a11y_issue_kinds_issue_kind_pages_get(site_id, issue_kind, opts = {}) ⇒ PageWithIssuesList

Get pages with issues from accessibility Retrieves pages from accessibility with issues per issue kind; how many issues there are on the page; how many occurrences of issues there are on the page in total.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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



362
363
364
365
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 362

def sites_site_id_a11y_issue_kinds_issue_kind_pages_get(site_id, issue_kind, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_issue_kinds_issue_kind_pages_get_with_http_info(site_id, issue_kind, opts)
  data
end

#sites_site_id_a11y_issue_kinds_issue_kind_pages_get_with_http_info(site_id, issue_kind, opts = {}) ⇒ Array<(PageWithIssuesList, Integer, Hash)>

Get pages with issues from accessibility Retrieves pages from accessibility with issues per issue kind; how many issues there are on the page; how many occurrences of issues there are on the page in total.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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

    PageWithIssuesList data, response status code and response headers



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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 380

def sites_site_id_a11y_issue_kinds_issue_kind_pages_get_with_http_info(site_id, issue_kind, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_pages_get"
  end
  # verify the required parameter 'issue_kind' is set
  if @api_client.config.client_side_validation && issue_kind.nil?
    fail ArgumentError, "Missing the required parameter 'issue_kind' when calling A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_pages_get"
  end
  # verify enum value
  allowable_values = ["confirmed", "potential", "passed"]
  if @api_client.config.client_side_validation && !allowable_values.include?(issue_kind)
    fail ArgumentError, "invalid value for \"issue_kind\", must be one of #{allowable_values}"
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'conformance'] && !opts[:'conformance'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"conformance\", must include 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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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}/a11y/issue_kinds/{issue_kind}/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'issue_kind' + '}', CGI.escape(issue_kind.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'conformance'] = @api_client.build_collection_param(opts[:'conformance'], :csv) if !opts[:'conformance'].nil?
  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] || 'PageWithIssuesList'

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

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

#sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get(site_id, issue_kind, page_id, opts = {}) ⇒ IssueOnPageList

Get issues on this page from accessibility Retrieves issues for a give page from accessibility, per issue kind; occurrences of the Issue, Conformance of the Issue and its Difficulty rating.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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



475
476
477
478
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 475

def sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get(site_id, issue_kind, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get_with_http_info(site_id, issue_kind, page_id, opts)
  data
end

#sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get_with_http_info(site_id, issue_kind, page_id, opts = {}) ⇒ Array<(IssueOnPageList, Integer, Hash)>

Get issues on this page from accessibility Retrieves issues for a give page from accessibility, per issue kind; occurrences of the Issue, Conformance of the Issue and its Difficulty rating.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues)

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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

    IssueOnPageList data, response status code and response headers



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

def sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get_with_http_info(site_id, issue_kind, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get"
  end
  # verify the required parameter 'issue_kind' is set
  if @api_client.config.client_side_validation && issue_kind.nil?
    fail ArgumentError, "Missing the required parameter 'issue_kind' when calling A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get"
  end
  # verify enum value
  allowable_values = ["confirmed", "potential", "passed"]
  if @api_client.config.client_side_validation && !allowable_values.include?(issue_kind)
    fail ArgumentError, "invalid value for \"issue_kind\", must be one of #{allowable_values}"
  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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get"
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'conformance'] && !opts[:'conformance'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"conformance\", must include 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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_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 A11YNextGenApi.sites_site_id_a11y_issue_kinds_issue_kind_pages_page_id_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/a11y/issue_kinds/{issue_kind}/pages/{page_id}/issues'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'issue_kind' + '}', CGI.escape(issue_kind.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'conformance'] = @api_client.build_collection_param(opts[:'conformance'], :csv) if !opts[:'conformance'].nil?
  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] || 'IssueOnPageList'

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

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

#sites_site_id_a11y_overview_groups_get(site_id, opts = {}) ⇒ A11YGroupsList

Get overview of Groups for Accessibility Retrieves overview of Groups for Accessibility. Returns the name of the Group; its ID; the number of pages in the group; the number of issues, potential issues, and PDF issues for pages in the Group.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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



581
582
583
584
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 581

def sites_site_id_a11y_overview_groups_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_overview_groups_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_a11y_overview_groups_get_with_http_info(site_id, opts = {}) ⇒ Array<(A11YGroupsList, Integer, Hash)>

Get overview of Groups for Accessibility Retrieves overview of Groups for Accessibility. Returns the name of the Group; its ID; the number of pages in the group; the number of issues, potential issues, and PDF issues for pages in the Group.

Parameters:

  • site_id (Integer) —

    Id for specific site.

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

    the optional parameters

Options Hash (opts):

  • :conformance (Array<String>) —

    Conformance filter

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

    A11YGroupsList data, response status code and response headers



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
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
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 595

def sites_site_id_a11y_overview_groups_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_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 A11YNextGenApi.sites_site_id_a11y_overview_groups_get"
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'conformance'] && !opts[:'conformance'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"conformance\", must include 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 A11YNextGenApi.sites_site_id_a11y_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 A11YNextGenApi.sites_site_id_a11y_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 A11YNextGenApi.sites_site_id_a11y_overview_groups_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/a11y/overview/groups'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'conformance'] = @api_client.build_collection_param(opts[:'conformance'], :csv) if !opts[:'conformance'].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] || 'A11YGroupsList'

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

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

#sites_site_id_a11y_overview_progress_history_get(site_id, opts = {}) ⇒ A11YHistoryValueList

Get progress for all issues and occurrences from Accessibility Retrieves overall issue and occurrence progress for accessibility. Returns a list of total issues and occurrences present on the site, as well as total pages present. All of the data is filterable by issue type.

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.

  • :issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues) (default to ‘confirmed’)

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



673
674
675
676
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 673

def sites_site_id_a11y_overview_progress_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_overview_progress_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_a11y_overview_progress_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(A11YHistoryValueList, Integer, Hash)>

Get progress for all issues and occurrences from Accessibility Retrieves overall issue and occurrence progress for accessibility. Returns a list of total issues and occurrences present on the site, as well as total pages present. All of the data is filterable by issue type.

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.

  • :issue_kind (String) —

    Kind of issue state requested (potential, passed or confirmed issues) (default to ‘confirmed’)

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

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

    A11YHistoryValueList data, response status code and response headers



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
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
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 688

def sites_site_id_a11y_overview_progress_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_overview_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 A11YNextGenApi.sites_site_id_a11y_overview_progress_history_get"
  end
  allowable_values = ["confirmed", "potential", "passed"]
  if @api_client.config.client_side_validation && opts[:'issue_kind'] && !allowable_values.include?(opts[:'issue_kind'])
    fail ArgumentError, "invalid value for \"issue_kind\", 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 A11YNextGenApi.sites_site_id_a11y_overview_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 A11YNextGenApi.sites_site_id_a11y_overview_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 A11YNextGenApi.sites_site_id_a11y_overview_progress_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/a11y/overview/progress/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[:'issue_kind'] = opts[:'issue_kind'] if !opts[:'issue_kind'].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] || 'A11YHistoryValueList'

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

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

#sites_site_id_a11y_overview_summary_get(site_id, opts = {}) ⇒ IssuesByConformanceList

Get summary for Accessibility Retrieves issue overview for accessibility, according to conformance level (A, AA, AAA, WAI-ARIA, accessibility best practices) and issue type. 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:



765
766
767
768
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 765

def sites_site_id_a11y_overview_summary_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_overview_summary_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_a11y_overview_summary_get_with_http_info(site_id, opts = {}) ⇒ Array<(IssuesByConformanceList, Integer, Hash)>

Get summary for Accessibility Retrieves issue overview for accessibility, according to conformance level (A, AA, AAA, WAI-ARIA, accessibility best practices) and issue type. 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<(IssuesByConformanceList, Integer, Hash)>) —

    IssuesByConformanceList data, response status code and response headers



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 778

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

  # resource path
  local_var_path = '/sites/{site_id}/a11y/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] || 'IssuesByConformanceList'

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

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

#sites_site_id_a11y_validation_pdfs_get(site_id, opts = {}) ⇒ DocumentWithErrorList

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:



852
853
854
855
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 852

def sites_site_id_a11y_validation_pdfs_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_validation_pdfs_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_a11y_validation_pdfs_get_with_http_info(site_id, opts = {}) ⇒ Array<(DocumentWithErrorList, 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<(DocumentWithErrorList, Integer, Hash)>) —

    DocumentWithErrorList data, response status code and response headers



868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 868

def sites_site_id_a11y_validation_pdfs_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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}/a11y/validation/pdfs'.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] || 'DocumentWithErrorList'

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

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

#sites_site_id_a11y_validation_pdfs_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:



946
947
948
949
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 946

def sites_site_id_a11y_validation_pdfs_link_id_issues_get(site_id, link_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_validation_pdfs_link_id_issues_get_with_http_info(site_id, link_id, opts)
  data
end

#sites_site_id_a11y_validation_pdfs_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



959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 959

def sites_site_id_a11y_validation_pdfs_link_id_issues_get_with_http_info(site_id, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_link_id_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/a11y/validation/pdfs/{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 => :"A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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: A11YNextGenApi#sites_site_id_a11y_validation_pdfs_link_id_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_a11y_validation_pdfs_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:



1035
1036
1037
1038
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 1035

def sites_site_id_a11y_validation_pdfs_pdf_id_pages_using_pdf_get(site_id, pdf_id, opts = {})
  data, _status_code, _headers = sites_site_id_a11y_validation_pdfs_pdf_id_pages_using_pdf_get_with_http_info(site_id, pdf_id, opts)
  data
end

#sites_site_id_a11y_validation_pdfs_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



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
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/siteimprove_api_client/api/a11_y_next_gen_api.rb', line 1050

def sites_site_id_a11y_validation_pdfs_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: A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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 A11YNextGenApi.sites_site_id_a11y_validation_pdfs_pdf_id_pages_using_pdf_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/a11y/validation/pdfs/{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 => :"A11YNextGenApi.sites_site_id_a11y_validation_pdfs_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: A11YNextGenApi#sites_site_id_a11y_validation_pdfs_pdf_id_pages_using_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end