Warning This document has not been updated for a while now. It may be out of date.

Last updated: 5 Jul 2023

siteimprove_api_client: SiteimproveAPIClient::ArchivedPolicyOnAccount

Properties

Name	Type	Description	Notes
id	Integer	The ID of the policy.
name	String	The name of the policy.	[optional]
all_sites	Boolean	True if this policy applies to all sites on your account; false if it only applies to a specific site.
archived_by	String	The name of the user who archived the policy.	[optional]
archived_date	Time	The date and time the policy was archived.
category	String	The category of the policy: content, media, documents.	[default to 'content']
created_by	String	The name of the user who created the policy.	[optional]
created_date	Time	The data and time the policy was created.
edited_by	String	The name of the user who last edited the policy.	[optional]
last_edited	Time	The data and time the policy was last edited.	[optional]
matches	Integer	The number of matches for this policy on all sites.
note	String	Explain what the policy does and any actions editors should take (recommended).	[optional]
priority	String	The priority of the policy: low, medium, high.	[default to 'none']
sites	Integer	The number of sites where this policy is used.

Example

require 'siteimprove_api_client'

instance = SiteimproveAPIClient::ArchivedPolicyOnAccount.new(
  id: null,
  name: null,
  all_sites: null,
  archived_by: null,
  archived_date: null,
  category: null,
  created_by: null,
  created_date: null,
  edited_by: null,
  last_edited: null,
  matches: null,
  note: null,
  priority: null,
  sites: null
)