Class: PureCloud::UtilitiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UtilitiesApi

Returns a new instance of UtilitiesApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/utilities_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/utilities_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_date(opts = {}) ⇒ ServerDate

Get the current system date/time

Parameters:

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

    the optional parameters

Returns:



31
32
33
34
 
# File 'lib/purecloudplatformclientv2/api/utilities_api.rb', line 31

def get_date(opts = {})
  data, _status_code, _headers = get_date_with_http_info(opts)
  return data
end

#get_date_with_http_info(opts = {}) ⇒ Array<(ServerDate, Fixnum, Hash)>

Get the current system date/time

Parameters:

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

    the optional parameters

Returns:

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

    ServerDate data, response status code and response headers



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

def get_date_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UtilitiesApi.get_date ..."
  end
  
  # resource path
  local_var_path = "/api/v2/date".sub('{format}','json')

  # 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 => 'ServerDate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilitiesApi#get_date\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ipranges(opts = {}) ⇒ IpAddressRangeListing

Get public ip address ranges for PureCloud

Parameters:

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

    the optional parameters

Returns:



86
87
88
89
 
# File 'lib/purecloudplatformclientv2/api/utilities_api.rb', line 86

def get_ipranges(opts = {})
  data, _status_code, _headers = get_ipranges_with_http_info(opts)
  return data
end

#get_ipranges_with_http_info(opts = {}) ⇒ Array<(IpAddressRangeListing, Fixnum, Hash)>

Get public ip address ranges for PureCloud

Parameters:

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

    the optional parameters

Returns:

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

    IpAddressRangeListing data, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/purecloudplatformclientv2/api/utilities_api.rb', line 95

def get_ipranges_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UtilitiesApi.get_ipranges ..."
  end
  
  # resource path
  local_var_path = "/api/v2/ipranges".sub('{format}','json')

  # 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 => 'IpAddressRangeListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilitiesApi#get_ipranges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_timezones(opts = {}) ⇒ TimeZoneEntityListing

Get time zones list

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:



143
144
145
146
 
# File 'lib/purecloudplatformclientv2/api/utilities_api.rb', line 143

def get_timezones(opts = {})
  data, _status_code, _headers = get_timezones_with_http_info(opts)
  return data
end

#get_timezones_with_http_info(opts = {}) ⇒ Array<(TimeZoneEntityListing, Fixnum, Hash)>

Get time zones list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    TimeZoneEntityListing data, response status code and response headers



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/purecloudplatformclientv2/api/utilities_api.rb', line 154

def get_timezones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UtilitiesApi.get_timezones ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/timezones".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 => 'TimeZoneEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilitiesApi#get_timezones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_certificate_details(body, opts = {}) ⇒ ParsedCertificate

Returns the information about an X509 PEM encoded certificate or certificate chain.

Parameters:

  • body —

    Certificate

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

    the optional parameters

Returns:



215
216
217
218
 
# File 'lib/purecloudplatformclientv2/api/utilities_api.rb', line 215

def post_certificate_details(body, opts = {})
  data, _status_code, _headers = post_certificate_details_with_http_info(body, opts)
  return data
end

#post_certificate_details_with_http_info(body, opts = {}) ⇒ Array<(ParsedCertificate, Fixnum, Hash)>

Returns the information about an X509 PEM encoded certificate or certificate chain.

Parameters:

  • body —

    Certificate

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

    the optional parameters

Returns:

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

    ParsedCertificate data, response status code and response headers



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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/purecloudplatformclientv2/api/utilities_api.rb', line 225

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

  # 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 = @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 => 'ParsedCertificate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilitiesApi#post_certificate_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end