Class: PureCloud::GeneralDataProtectionRegulationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GeneralDataProtectionRegulationApi

Returns a new instance of GeneralDataProtectionRegulationApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_gdpr_request(request_id, opts = {}) ⇒ GDPRRequest

Get an existing GDPR request

Parameters:

  • request_id —

    Request id

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 32

def get_gdpr_request(request_id, opts = {})
  data, _status_code, _headers = get_gdpr_request_with_http_info(request_id, opts)
  return data
end

#get_gdpr_request_with_http_info(request_id, opts = {}) ⇒ Array<(GDPRRequest, Fixnum, Hash)>

Get an existing GDPR request

Parameters:

  • request_id —

    Request id

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

    the optional parameters

Returns:

  • (Array<(GDPRRequest, Fixnum, Hash)>) —

    GDPRRequest data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 42

def get_gdpr_request_with_http_info(request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GeneralDataProtectionRegulationApi.get_gdpr_request ..."
  end
  
  
  # verify the required parameter 'request_id' is set
  fail ArgumentError, "Missing the required parameter 'request_id' when calling GeneralDataProtectionRegulationApi.get_gdpr_request" if request_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/gdpr/requests/{requestId}".sub('{format}','json').sub('{' + 'requestId' + '}', request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GDPRRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GeneralDataProtectionRegulationApi#get_gdpr_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_gdpr_requests(opts = {}) ⇒ GDPRRequestEntityListing

Get all GDPR requests

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



98
99
100
101
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 98

def get_gdpr_requests(opts = {})
  data, _status_code, _headers = get_gdpr_requests_with_http_info(opts)
  return data
end

#get_gdpr_requests_with_http_info(opts = {}) ⇒ Array<(GDPRRequestEntityListing, Fixnum, Hash)>

Get all GDPR requests

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

  • (Array<(GDPRRequestEntityListing, Fixnum, Hash)>) —

    GDPRRequestEntityListing data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 109

def get_gdpr_requests_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GeneralDataProtectionRegulationApi.get_gdpr_requests ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/gdpr/requests".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GDPRRequestEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GeneralDataProtectionRegulationApi#get_gdpr_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_gdpr_subjects(search_type, search_value, opts = {}) ⇒ GDPRSubjectEntityListing

Get GDPR subjects

Parameters:

  • search_type —

    Search Type

  • search_value —

    Search Value

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

    the optional parameters

Returns:



171
172
173
174
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 171

def get_gdpr_subjects(search_type, search_value, opts = {})
  data, _status_code, _headers = get_gdpr_subjects_with_http_info(search_type, search_value, opts)
  return data
end

#get_gdpr_subjects_with_http_info(search_type, search_value, opts = {}) ⇒ Array<(GDPRSubjectEntityListing, Fixnum, Hash)>

Get GDPR subjects

Parameters:

  • search_type —

    Search Type

  • search_value —

    Search Value

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

    the optional parameters

Returns:

  • (Array<(GDPRSubjectEntityListing, Fixnum, Hash)>) —

    GDPRSubjectEntityListing 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
240
241
242
243
244
245
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 182

def get_gdpr_subjects_with_http_info(search_type, search_value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GeneralDataProtectionRegulationApi.get_gdpr_subjects ..."
  end
  
  
  # verify the required parameter 'search_type' is set
  fail ArgumentError, "Missing the required parameter 'search_type' when calling GeneralDataProtectionRegulationApi.get_gdpr_subjects" if search_type.nil?
  
  # verify enum value
  unless ['NAME', 'ADDRESS', 'PHONE', 'EMAIL', 'TWITTER'].include?(search_type)
    fail ArgumentError, "invalid value for 'search_type', must be one of NAME, ADDRESS, PHONE, EMAIL, TWITTER"
  end
  
  
  
  
  
  
  # verify the required parameter 'search_value' is set
  fail ArgumentError, "Missing the required parameter 'search_value' when calling GeneralDataProtectionRegulationApi.get_gdpr_subjects" if search_value.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/gdpr/subjects".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'searchType'] = search_type
  query_params[:'searchValue'] = search_value

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GDPRSubjectEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GeneralDataProtectionRegulationApi#get_gdpr_subjects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_gdpr_requests(body, opts = {}) ⇒ GDPRRequest

Submit a new GDPR request

Parameters:

  • body —

    GDPR request

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

    the optional parameters

Options Hash (opts):

  • :delete_confirmed (BOOLEAN) —

    Confirm delete (default to false)

Returns:



253
254
255
256
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 253

def post_gdpr_requests(body, opts = {})
  data, _status_code, _headers = post_gdpr_requests_with_http_info(body, opts)
  return data
end

#post_gdpr_requests_with_http_info(body, opts = {}) ⇒ Array<(GDPRRequest, Fixnum, Hash)>

Submit a new GDPR request

Parameters:

  • body —

    GDPR request

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

    the optional parameters

Options Hash (opts):

  • :delete_confirmed (BOOLEAN) —

    Confirm delete

Returns:

  • (Array<(GDPRRequest, Fixnum, Hash)>) —

    GDPRRequest data, response status code and response headers



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb', line 264

def post_gdpr_requests_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GeneralDataProtectionRegulationApi.post_gdpr_requests ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling GeneralDataProtectionRegulationApi.post_gdpr_requests" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/gdpr/requests".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'deleteConfirmed'] = opts[:'delete_confirmed'] if opts[:'delete_confirmed']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GDPRRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GeneralDataProtectionRegulationApi#post_gdpr_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end