Class: SiteimproveAPIClient::PolicyApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PolicyApi

Returns a new instance of PolicyApi.



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

def api_client
  @api_client
end

Instance Method Details

#products_policy_archived_policies_get(opts = {}) ⇒ ArchivedPolicyOnAccountList

Get all archived policies An overview of all archived policies.

Parameters:

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



29
30
31
32
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 29

def products_policy_archived_policies_get(opts = {})
  data, _status_code, _headers = products_policy_archived_policies_get_with_http_info(opts)
  data
end

#products_policy_archived_policies_get_with_http_info(opts = {}) ⇒ Array<(ArchivedPolicyOnAccountList, Integer, Hash)>

Get all archived policies An overview of all archived policies.

Parameters:

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

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

    ArchivedPolicyOnAccountList data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 41

def products_policy_archived_policies_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.products_policy_archived_policies_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PolicyApi.products_policy_archived_policies_get, must be greater than or equal to 1.'
  end

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

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

  # resource path
  local_var_path = '/products/policy/archived_policies'

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

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

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

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

#products_policy_archived_policies_policy_id_unarchive_post(policy_id, opts = {}) ⇒ ProductsPolicyArchivedPoliciesPolicyIdUnarchivePost200Response

Unarchive policy Unarchive a policy with a policy id.

Parameters:

  • policy_id (Integer) —

    Id of the policy.

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

    the optional parameters

Returns:



105
106
107
108
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 105

def products_policy_archived_policies_policy_id_unarchive_post(policy_id, opts = {})
  data, _status_code, _headers = products_policy_archived_policies_policy_id_unarchive_post_with_http_info(policy_id, opts)
  data
end

#products_policy_archived_policies_policy_id_unarchive_post_with_http_info(policy_id, opts = {}) ⇒ Array<(ProductsPolicyArchivedPoliciesPolicyIdUnarchivePost200Response, Integer, Hash)>

Unarchive policy Unarchive a policy with a policy id.

Parameters:

  • policy_id (Integer) —

    Id of the policy.

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

    the optional parameters

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 115

def products_policy_archived_policies_policy_id_unarchive_post_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.products_policy_archived_policies_policy_id_unarchive_post ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyApi.products_policy_archived_policies_policy_id_unarchive_post"
  end
  # resource path
  local_var_path = '/products/policy/archived_policies/{policy_id}/unarchive'.sub('{' + 'policy_id' + '}', CGI.escape(policy_id.to_s))

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

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

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

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

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

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

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

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

#products_policy_policies_get(opts = {}) ⇒ PolicyOnAccountList

Get all policies on the account An overview of all policies that have been setup for the account, including their current matches.

Parameters:

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



170
171
172
173
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 170

def products_policy_policies_get(opts = {})
  data, _status_code, _headers = products_policy_policies_get_with_http_info(opts)
  data
end

#products_policy_policies_get_with_http_info(opts = {}) ⇒ Array<(PolicyOnAccountList, Integer, Hash)>

Get all policies on the account An overview of all policies that have been setup for the account, including their current matches.

Parameters:

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

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

    PolicyOnAccountList data, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 182

def products_policy_policies_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.products_policy_policies_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PolicyApi.products_policy_policies_get, must be greater than or equal to 1.'
  end

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

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

  # resource path
  local_var_path = '/products/policy/policies'

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

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

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

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

#products_policy_policies_policy_id_archive_post(policy_id, opts = {}) ⇒ ProductsPolicyArchivedPoliciesPolicyIdUnarchivePost200Response

Archive policy Archive a policy with a policy id.

Parameters:

  • policy_id (Integer) —

    Id of the policy.

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

    the optional parameters

Returns:



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

def products_policy_policies_policy_id_archive_post(policy_id, opts = {})
  data, _status_code, _headers = products_policy_policies_policy_id_archive_post_with_http_info(policy_id, opts)
  data
end

#products_policy_policies_policy_id_archive_post_with_http_info(policy_id, opts = {}) ⇒ Array<(ProductsPolicyArchivedPoliciesPolicyIdUnarchivePost200Response, Integer, Hash)>

Archive policy Archive a policy with a policy id.

Parameters:

  • policy_id (Integer) —

    Id of the policy.

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

    the optional parameters

Returns:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 256

def products_policy_policies_policy_id_archive_post_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.products_policy_policies_policy_id_archive_post ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyApi.products_policy_policies_policy_id_archive_post"
  end
  # resource path
  local_var_path = '/products/policy/policies/{policy_id}/archive'.sub('{' + 'policy_id' + '}', CGI.escape(policy_id.to_s))

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

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

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

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

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

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

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

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

#products_policy_policies_policy_id_sites_get(policy_id, opts = {}) ⇒ PolicySiteList

Get policy matches for all sites on the account Information about all sites on which this policy is active. All such sites will be listed here, even if the policy has no matches for that site; in that case matches will simply be 0.

Parameters:

  • policy_id (Integer) —

    Id of the policy.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

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

  • :page_size (Integer) —

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

Returns:



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

def products_policy_policies_policy_id_sites_get(policy_id, opts = {})
  data, _status_code, _headers = products_policy_policies_policy_id_sites_get_with_http_info(policy_id, opts)
  data
end

#products_policy_policies_policy_id_sites_get_with_http_info(policy_id, opts = {}) ⇒ Array<(PolicySiteList, Integer, Hash)>

Get policy matches for all sites on the account Information about all sites on which this policy is active. All such sites will be listed here, even if the policy has no matches for that site; in that case matches will simply be 0.

Parameters:

  • policy_id (Integer) —

    Id of the policy.

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

    PolicySiteList data, response status code and response headers



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

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

  # resource path
  local_var_path = '/products/policy/policies/{policy_id}/sites'.sub('{' + 'policy_id' + '}', CGI.escape(policy_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] || 'PolicySiteList'

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

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

#sites_site_id_policy_history_get(site_id, opts = {}) ⇒ PolicySiteTotalHistoryEntryList

Get history of total matches across a site Total amount of matches for all policies on a given 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.

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



393
394
395
396
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 393

def sites_site_id_policy_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_policy_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(PolicySiteTotalHistoryEntryList, Integer, Hash)>

Get history of total matches across a site Total amount of matches for all policies on a given 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.

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



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

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/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?

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

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

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

#sites_site_id_policy_links_link_id_referring_documents_get(site_id, link_id, opts = {}) ⇒ PolicyDocumentWithLinkList

Get referring documents for specific match in policies Documents that refer to the resource being matched by this policy.

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:



477
478
479
480
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 477

def sites_site_id_policy_links_link_id_referring_documents_get(site_id, link_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_links_link_id_referring_documents_get_with_http_info(site_id, link_id, opts)
  data
end

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

Get referring documents for specific match in policies Documents that refer to the resource being matched by this policy.

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

    PolicyDocumentWithLinkList data, response status code and response headers



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

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/links/{link_id}/referring_documents'.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] || 'PolicyDocumentWithLinkList'

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

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

#sites_site_id_policy_links_link_id_referring_media_get(site_id, link_id, opts = {}) ⇒ PolicyMediaWithLinkList

Get referring media for specific match in policies Media that refer to the resource being matched by this policy.

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:



564
565
566
567
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 564

def sites_site_id_policy_links_link_id_referring_media_get(site_id, link_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_links_link_id_referring_media_get_with_http_info(site_id, link_id, opts)
  data
end

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

Get referring media for specific match in policies Media that refer to the resource being matched by this policy.

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

    PolicyMediaWithLinkList data, response status code and response headers



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 577

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/links/{link_id}/referring_media'.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] || 'PolicyMediaWithLinkList'

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

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

#sites_site_id_policy_links_link_id_referring_pages_get(site_id, link_id, opts = {}) ⇒ PolicyLinkDetailsList

Get referring pages for specific match in policies Pages that refer to the resource being matched by this policy.

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

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



652
653
654
655
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 652

def sites_site_id_policy_links_link_id_referring_pages_get(site_id, link_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_links_link_id_referring_pages_get_with_http_info(site_id, link_id, opts)
  data
end

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

Get referring pages for specific match in policies Pages that refer to the resource being matched by this policy.

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

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

    PolicyLinkDetailsList data, response status code and response headers



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 666

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/links/{link_id}/referring_pages'.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[:'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] || 'PolicyLinkDetailsList'

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

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

#sites_site_id_policy_matches_content_get(site_id, opts = {}) ⇒ PageWithPoliciesList

Get content matched by any policy All content on the site which is matched by one or more policies.

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:



744
745
746
747
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 744

def sites_site_id_policy_matches_content_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_matches_content_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_policy_matches_content_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithPoliciesList, Integer, Hash)>

Get content matched by any policy All content on the site which is matched by one or more policies.

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

    PageWithPoliciesList data, response status code and response headers



760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
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
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 760

def sites_site_id_policy_matches_content_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.sites_site_id_policy_matches_content_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 PolicyApi.sites_site_id_policy_matches_content_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PolicyApi.sites_site_id_policy_matches_content_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 PolicyApi.sites_site_id_policy_matches_content_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 PolicyApi.sites_site_id_policy_matches_content_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}/policy/matches/content'.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] || 'PageWithPoliciesList'

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

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

#sites_site_id_policy_matches_details_links_link_id_referring_pages_get(site_id, link_id, opts = {}) ⇒ PagesWithPolicyExpanderList

Referring pages to item matched by specific policy All pages that refer to the item that is matched by this specific policy.

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

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



839
840
841
842
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 839

def sites_site_id_policy_matches_details_links_link_id_referring_pages_get(site_id, link_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_matches_details_links_link_id_referring_pages_get_with_http_info(site_id, link_id, opts)
  data
end

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

Referring pages to item matched by specific policy All pages that refer to the item that is matched by this specific policy.

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

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

    PagesWithPolicyExpanderList data, response status code and response headers



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
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
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 853

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/matches/details/links/{link_id}/referring_pages'.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[:'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] || 'PagesWithPolicyExpanderList'

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

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

#sites_site_id_policy_matches_details_matches_match_id_matching_policies_get(site_id, match_id, opts = {}) ⇒ PolicyInfoList

Matching policies to item matched by specific policy All policies that matches the item that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • match_id (Integer) —

    Id of the match.

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



928
929
930
931
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 928

def sites_site_id_policy_matches_details_matches_match_id_matching_policies_get(site_id, match_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_matches_details_matches_match_id_matching_policies_get_with_http_info(site_id, match_id, opts)
  data
end

#sites_site_id_policy_matches_details_matches_match_id_matching_policies_get_with_http_info(site_id, match_id, opts = {}) ⇒ Array<(PolicyInfoList, Integer, Hash)>

Matching policies to item matched by specific policy All policies that matches the item that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • match_id (Integer) —

    Id of the match.

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

    PolicyInfoList data, response status code and response headers



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
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
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 941

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

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

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/matches/details/matches/{match_id}/matching_policies'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'match_id' + '}', CGI.escape(match_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] || 'PolicyInfoList'

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

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

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

#sites_site_id_policy_pages_page_id_matching_policies_get(site_id, page_id, opts = {}) ⇒ PagePolicyList

Get policy matches for page in policies All policies that match this specific page.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

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



1016
1017
1018
1019
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1016

def sites_site_id_policy_pages_page_id_matching_policies_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_pages_page_id_matching_policies_get_with_http_info(site_id, page_id, opts)
  data
end

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

Get policy matches for page in policies All policies that match this specific page.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

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

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

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

    PagePolicyList data, response status code and response headers



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
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1030

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

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

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/pages/{page_id}/matching_policies'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

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

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

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

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

#sites_site_id_policy_policies_get(site_id, opts = {}) ⇒ ExecutedPolicyList

Get policies An overview of all policies that have been setup and any current matches.

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:



1107
1108
1109
1110
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1107

def sites_site_id_policy_policies_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_policies_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_policy_policies_get_with_http_info(site_id, opts = {}) ⇒ Array<(ExecutedPolicyList, Integer, Hash)>

Get policies An overview of all policies that have been setup and any current matches.

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

    ExecutedPolicyList data, response status code and response headers



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
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1122

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

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

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/policies'.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] || 'ExecutedPolicyList'

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

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

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

#sites_site_id_policy_policies_policy_id_content_get(site_id, policy_id, opts = {}) ⇒ PolicyContentPageList

Get content matched by policy Get a list of all content (pages) on the site that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • policy_id (Integer) —

    Id of the policy.

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

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



1198
1199
1200
1201
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1198

def sites_site_id_policy_policies_policy_id_content_get(site_id, policy_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_policies_policy_id_content_get_with_http_info(site_id, policy_id, opts)
  data
end

#sites_site_id_policy_policies_policy_id_content_get_with_http_info(site_id, policy_id, opts = {}) ⇒ Array<(PolicyContentPageList, Integer, Hash)>

Get content matched by policy Get a list of all content (pages) on the site that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • policy_id (Integer) —

    Id of the policy.

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

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

    PolicyContentPageList data, response status code and response headers



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
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1214

def sites_site_id_policy_policies_policy_id_content_get_with_http_info(site_id, policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.sites_site_id_policy_policies_policy_id_content_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 PolicyApi.sites_site_id_policy_policies_policy_id_content_get"
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyApi.sites_site_id_policy_policies_policy_id_content_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PolicyApi.sites_site_id_policy_policies_policy_id_content_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 PolicyApi.sites_site_id_policy_policies_policy_id_content_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 PolicyApi.sites_site_id_policy_policies_policy_id_content_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}/policy/policies/{policy_id}/content'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'policy_id' + '}', CGI.escape(policy_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[:'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] || 'PolicyContentPageList'

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

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

#sites_site_id_policy_policies_policy_id_documents_get(site_id, policy_id, opts = {}) ⇒ PolicyDocumentLinkList

Get documents matched by policy Get a list of all documents on the site that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • policy_id (Integer) —

    Id of the policy.

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

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



1298
1299
1300
1301
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1298

def sites_site_id_policy_policies_policy_id_documents_get(site_id, policy_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_policies_policy_id_documents_get_with_http_info(site_id, policy_id, opts)
  data
end

#sites_site_id_policy_policies_policy_id_documents_get_with_http_info(site_id, policy_id, opts = {}) ⇒ Array<(PolicyDocumentLinkList, Integer, Hash)>

Get documents matched by policy Get a list of all documents on the site that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • policy_id (Integer) —

    Id of the policy.

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

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

    PolicyDocumentLinkList data, response status code and response headers



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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1314

def sites_site_id_policy_policies_policy_id_documents_get_with_http_info(site_id, policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyApi.sites_site_id_policy_policies_policy_id_documents_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 PolicyApi.sites_site_id_policy_policies_policy_id_documents_get"
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling PolicyApi.sites_site_id_policy_policies_policy_id_documents_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PolicyApi.sites_site_id_policy_policies_policy_id_documents_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 PolicyApi.sites_site_id_policy_policies_policy_id_documents_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 PolicyApi.sites_site_id_policy_policies_policy_id_documents_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}/policy/policies/{policy_id}/documents'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'policy_id' + '}', CGI.escape(policy_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[:'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] || 'PolicyDocumentLinkList'

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

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

#sites_site_id_policy_policies_policy_id_media_get(site_id, policy_id, opts = {}) ⇒ PolicyMediaLinkList

Get media matched by policy Get a list of all media on the site that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • policy_id (Integer) —

    Id of the policy.

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

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



1397
1398
1399
1400
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1397

def sites_site_id_policy_policies_policy_id_media_get(site_id, policy_id, opts = {})
  data, _status_code, _headers = sites_site_id_policy_policies_policy_id_media_get_with_http_info(site_id, policy_id, opts)
  data
end

#sites_site_id_policy_policies_policy_id_media_get_with_http_info(site_id, policy_id, opts = {}) ⇒ Array<(PolicyMediaLinkList, Integer, Hash)>

Get media matched by policy Get a list of all media on the site that is matched by this specific policy.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • policy_id (Integer) —

    Id of the policy.

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

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

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

    PolicyMediaLinkList data, response status code and response headers



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
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/siteimprove_api_client/api/policy_api.rb', line 1412

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

  # resource path
  local_var_path = '/sites/{site_id}/policy/policies/{policy_id}/media'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'policy_id' + '}', CGI.escape(policy_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[:'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] || 'PolicyMediaLinkList'

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

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