Class: SiteimproveAPIClient::GDPRApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GDPRApi

Returns a new instance of GDPRApi.



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

def api_client
  @api_client
end

Instance Method Details

#gdpr_domains_and_ip_addresses_domains_domain_id_get(domain_id, opts = {}) ⇒ DomainDetails

Get GDPR-information for a specific domain Get information about nameservers, registrant, subdomains etc for a specific domain.

Parameters:

  • domain_id (Integer) —

    Id for specific domain.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/siteimprove_api_client/api/gdpr_api.rb', line 27

def gdpr_domains_and_ip_addresses_domains_domain_id_get(domain_id, opts = {})
  data, _status_code, _headers = gdpr_domains_and_ip_addresses_domains_domain_id_get_with_http_info(domain_id, opts)
  data
end

#gdpr_domains_and_ip_addresses_domains_domain_id_get_with_http_info(domain_id, opts = {}) ⇒ Array<(DomainDetails, Integer, Hash)>

Get GDPR-information for a specific domain Get information about nameservers, registrant, subdomains etc for a specific domain.

Parameters:

  • domain_id (Integer) —

    Id for specific domain.

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

    the optional parameters

Returns:

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

    DomainDetails data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/siteimprove_api_client/api/gdpr_api.rb', line 37

def gdpr_domains_and_ip_addresses_domains_domain_id_get_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GDPRApi.gdpr_domains_and_ip_addresses_domains_domain_id_get ...'
  end
  # verify the required parameter 'domain_id' is set
  if @api_client.config.client_side_validation && domain_id.nil?
    fail ArgumentError, "Missing the required parameter 'domain_id' when calling GDPRApi.gdpr_domains_and_ip_addresses_domains_domain_id_get"
  end
  # resource path
  local_var_path = '/gdpr/domains_and_ip_addresses/domains/{domain_id}'.sub('{' + 'domain_id' + '}', CGI.escape(domain_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] || 'DomainDetails'

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

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

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

#gdpr_domains_and_ip_addresses_domains_domain_id_subdomains_get(domain_id, opts = {}) ⇒ DomainsSubdomainsList

Get GDPR-information about subdomains Get information about all subdomains to this domain, inclusive optional redirects.

Parameters:

  • domain_id (Integer) —

    Id for specific domain.

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



92
93
94
95
 
# File 'lib/siteimprove_api_client/api/gdpr_api.rb', line 92

def gdpr_domains_and_ip_addresses_domains_domain_id_subdomains_get(domain_id, opts = {})
  data, _status_code, _headers = gdpr_domains_and_ip_addresses_domains_domain_id_subdomains_get_with_http_info(domain_id, opts)
  data
end

#gdpr_domains_and_ip_addresses_domains_domain_id_subdomains_get_with_http_info(domain_id, opts = {}) ⇒ Array<(DomainsSubdomainsList, Integer, Hash)>

Get GDPR-information about subdomains Get information about all subdomains to this domain, inclusive optional redirects.

Parameters:

  • domain_id (Integer) —

    Id for specific domain.

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

    DomainsSubdomainsList data, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/siteimprove_api_client/api/gdpr_api.rb', line 104

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

  # resource path
  local_var_path = '/gdpr/domains_and_ip_addresses/domains/{domain_id}/subdomains'.sub('{' + 'domain_id' + '}', CGI.escape(domain_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] || 'DomainsSubdomainsList'

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

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

#gdpr_domains_and_ip_addresses_domains_get(opts = {}) ⇒ DomainIndexList

Get GDPR-info for all domains Get all available GDPR-information about the domains, IP-addresses, and sub-domains related to the account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :domain_status (String) —

    Domain status to show confirmed, uncertain or rejected domains. (default to ‘confirmed’)

  • :is_top_level (Boolean) —

    True for &quot;a.com&quot; and &quot;b.co.uk&quot; but false for &quot;c.d.com&quot; and &quot;e.f.co.uk&quot;.

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



175
176
177
178
 
# File 'lib/siteimprove_api_client/api/gdpr_api.rb', line 175

def gdpr_domains_and_ip_addresses_domains_get(opts = {})
  data, _status_code, _headers = gdpr_domains_and_ip_addresses_domains_get_with_http_info(opts)
  data
end

#gdpr_domains_and_ip_addresses_domains_get_with_http_info(opts = {}) ⇒ Array<(DomainIndexList, Integer, Hash)>

Get GDPR-info for all domains Get all available GDPR-information about the domains, IP-addresses, and sub-domains related to the account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :domain_status (String) —

    Domain status to show confirmed, uncertain or rejected domains. (default to ‘confirmed’)

  • :is_top_level (Boolean) —

    True for &quot;a.com&quot; and &quot;b.co.uk&quot; but false for &quot;c.d.com&quot; and &quot;e.f.co.uk&quot;.

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

    DomainIndexList data, response status code and response headers



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
244
245
246
247
248
249
250
251
252
 
# File 'lib/siteimprove_api_client/api/gdpr_api.rb', line 189

def gdpr_domains_and_ip_addresses_domains_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GDPRApi.gdpr_domains_and_ip_addresses_domains_get ...'
  end
  allowable_values = ["confirmed", "unconfirmed", "rejected"]
  if @api_client.config.client_side_validation && opts[:'domain_status'] && !allowable_values.include?(opts[:'domain_status'])
    fail ArgumentError, "invalid value for \"domain_status\", 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 GDPRApi.gdpr_domains_and_ip_addresses_domains_get, must be greater than or equal to 1.'
  end

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

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

  # resource path
  local_var_path = '/gdpr/domains_and_ip_addresses/domains'

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

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

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

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