Class: PureCloud::ScriptsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/scripts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScriptsApi

Returns a new instance of ScriptsApi.



23
24
25
 
# File 'lib/purecloud/api/scripts_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/purecloud/api/scripts_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get(opts = {}) ⇒ ScriptEntityListing

Get the list of scripts

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)

  • :expand (String) —

    Expand

  • :name (String) —

    Name filter

  • :feature (String) —

    Feature filter

  • :flow_id (String) —

    Secure flow id filter

  • :sort_by (String) —

    SortBy

  • :sort_order (String) —

    SortOrder

Returns:



39
40
41
42
 
# File 'lib/purecloud/api/scripts_api.rb', line 39

def get(opts = {})
  data, status_code, headers = get_with_http_info(opts)
  return data
end

#get_published(opts = {}) ⇒ ScriptEntityListing

Get the published scripts.

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)

  • :expand (String) —

    Expand

  • :name (String) —

    Name filter

  • :feature (String) —

    Feature filter

  • :flow_id (String) —

    Secure flow id filter

Returns:



124
125
126
127
 
# File 'lib/purecloud/api/scripts_api.rb', line 124

def get_published(opts = {})
  data, status_code, headers = get_published_with_http_info(opts)
  return data
end

#get_published_script_id(script_id, opts = {}) ⇒ Script

Get the published script.

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:



192
193
194
195
 
# File 'lib/purecloud/api/scripts_api.rb', line 192

def get_published_script_id(script_id, opts = {})
  data, status_code, headers = get_published_script_id_with_http_info(script_id, opts)
  return data
end

#get_published_script_id_pages(script_id, opts = {}) ⇒ Array<Page>

Get the list of published pages

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:



252
253
254
255
 
# File 'lib/purecloud/api/scripts_api.rb', line 252

def get_published_script_id_pages(script_id, opts = {})
  data, status_code, headers = get_published_script_id_pages_with_http_info(script_id, opts)
  return data
end

#get_published_script_id_pages_page_id(script_id, page_id, opts = {}) ⇒ Page

Get the published page.

Parameters:

  • script_id —

    Script ID

  • page_id —

    Page ID

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

    the optional parameters

Returns:



313
314
315
316
 
# File 'lib/purecloud/api/scripts_api.rb', line 313

def get_published_script_id_pages_page_id(script_id, page_id, opts = {})
  data, status_code, headers = get_published_script_id_pages_page_id_with_http_info(script_id, page_id, opts)
  return data
end

#get_published_script_id_pages_page_id_with_http_info(script_id, page_id, opts = {}) ⇒ Array<(Page, Fixnum, Hash)>

Get the published page.

Parameters:

  • script_id —

    Script ID

  • page_id —

    Page ID

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

    the optional parameters

Returns:

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

    Page data, response status code and response headers



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
 
# File 'lib/purecloud/api/scripts_api.rb', line 324

def get_published_script_id_pages_page_id_with_http_info(script_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id_pages_page_id ..."
  end
  
  # verify the required parameter 'script_id' is set
  fail "Missing the required parameter 'script_id' when calling get_published_script_id_pages_page_id" if script_id.nil?
  
  # verify the required parameter 'page_id' is set
  fail "Missing the required parameter 'page_id' when calling get_published_script_id_pages_page_id" if page_id.nil?
  
  # resource path
  local_var_path = "/api/v2/scripts/published/{scriptId}/pages/{pageId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s).sub('{' + 'pageId' + '}', page_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Page')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id_pages_page_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_published_script_id_pages_with_http_info(script_id, opts = {}) ⇒ Array<(Array<Page>, Fixnum, Hash)>

Get the list of published pages

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:

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

    Array<Page> data, response status code and response headers



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
303
304
305
 
# File 'lib/purecloud/api/scripts_api.rb', line 262

def get_published_script_id_pages_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id_pages ..."
  end
  
  # verify the required parameter 'script_id' is set
  fail "Missing the required parameter 'script_id' when calling get_published_script_id_pages" if script_id.nil?
  
  # resource path
  local_var_path = "/api/v2/scripts/published/{scriptId}/pages".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Array<Page>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_published_script_id_variables(script_id, opts = {}) ⇒ Object

Get the published variables

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:

  • (Object) 


377
378
379
380
 
# File 'lib/purecloud/api/scripts_api.rb', line 377

def get_published_script_id_variables(script_id, opts = {})
  data, status_code, headers = get_published_script_id_variables_with_http_info(script_id, opts)
  return data
end

#get_published_script_id_variables_with_http_info(script_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get the published variables

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
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
 
# File 'lib/purecloud/api/scripts_api.rb', line 387

def get_published_script_id_variables_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id_variables ..."
  end
  
  # verify the required parameter 'script_id' is set
  fail "Missing the required parameter 'script_id' when calling get_published_script_id_variables" if script_id.nil?
  
  # resource path
  local_var_path = "/api/v2/scripts/published/{scriptId}/variables".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_published_script_id_with_http_info(script_id, opts = {}) ⇒ Array<(Script, Fixnum, Hash)>

Get the published script.

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:

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

    Script data, response status code and response headers



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/purecloud/api/scripts_api.rb', line 202

def get_published_script_id_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id ..."
  end
  
  # verify the required parameter 'script_id' is set
  fail "Missing the required parameter 'script_id' when calling get_published_script_id" if script_id.nil?
  
  # resource path
  local_var_path = "/api/v2/scripts/published/{scriptId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Script')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_published_with_http_info(opts = {}) ⇒ Array<(ScriptEntityListing, Fixnum, Hash)>

Get the published scripts.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :expand (String) —

    Expand

  • :name (String) —

    Name filter

  • :feature (String) —

    Feature filter

  • :flow_id (String) —

    Secure flow id filter

Returns:

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

    ScriptEntityListing data, response status code and response headers



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/purecloud/api/scripts_api.rb', line 139

def get_published_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_published ..."
  end
  
  # resource path
  local_var_path = "/api/v2/scripts/published".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']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
  query_params[:'flowId'] = opts[:'flow_id'] if opts[:'flow_id']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'ScriptEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_published\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_script_id(script_id, opts = {}) ⇒ Script

Get a script

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:



437
438
439
440
 
# File 'lib/purecloud/api/scripts_api.rb', line 437

def get_script_id(script_id, opts = {})
  data, status_code, headers = get_script_id_with_http_info(script_id, opts)
  return data
end

#get_script_id_pages(script_id, opts = {}) ⇒ Array<Page>

Get the list of pages

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:



497
498
499
500
 
# File 'lib/purecloud/api/scripts_api.rb', line 497

def get_script_id_pages(script_id, opts = {})
  data, status_code, headers = get_script_id_pages_with_http_info(script_id, opts)
  return data
end

#get_script_id_pages_page_id(script_id, page_id, opts = {}) ⇒ Page

Get a page

Parameters:

  • script_id —

    Script ID

  • page_id —

    Page ID

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

    the optional parameters

Returns:



558
559
560
561
 
# File 'lib/purecloud/api/scripts_api.rb', line 558

def get_script_id_pages_page_id(script_id, page_id, opts = {})
  data, status_code, headers = get_script_id_pages_page_id_with_http_info(script_id, page_id, opts)
  return data
end

#get_script_id_pages_page_id_with_http_info(script_id, page_id, opts = {}) ⇒ Array<(Page, Fixnum, Hash)>

Get a page

Parameters:

  • script_id —

    Script ID

  • page_id —

    Page ID

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

    the optional parameters

Returns:

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

    Page data, response status code and response headers



569
570
571
572
573
574
575
576
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
 
# File 'lib/purecloud/api/scripts_api.rb', line 569

def get_script_id_pages_page_id_with_http_info(script_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_script_id_pages_page_id ..."
  end
  
  # verify the required parameter 'script_id' is set
  fail "Missing the required parameter 'script_id' when calling get_script_id_pages_page_id" if script_id.nil?
  
  # verify the required parameter 'page_id' is set
  fail "Missing the required parameter 'page_id' when calling get_script_id_pages_page_id" if page_id.nil?
  
  # resource path
  local_var_path = "/api/v2/scripts/{scriptId}/pages/{pageId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s).sub('{' + 'pageId' + '}', page_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Page')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_script_id_pages_page_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_script_id_pages_with_http_info(script_id, opts = {}) ⇒ Array<(Array<Page>, Fixnum, Hash)>

Get the list of pages

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:

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

    Array<Page> data, response status code and response headers



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
 
# File 'lib/purecloud/api/scripts_api.rb', line 507

def get_script_id_pages_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_script_id_pages ..."
  end
  
  # verify the required parameter 'script_id' is set
  fail "Missing the required parameter 'script_id' when calling get_script_id_pages" if script_id.nil?
  
  # resource path
  local_var_path = "/api/v2/scripts/{scriptId}/pages".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Array<Page>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_script_id_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_script_id_with_http_info(script_id, opts = {}) ⇒ Array<(Script, Fixnum, Hash)>

Get a script

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:

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

    Script data, response status code and response headers



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/purecloud/api/scripts_api.rb', line 447

def get_script_id_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get_script_id ..."
  end
  
  # verify the required parameter 'script_id' is set
  fail "Missing the required parameter 'script_id' when calling get_script_id" if script_id.nil?
  
  # resource path
  local_var_path = "/api/v2/scripts/{scriptId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Script')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get_script_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_with_http_info(opts = {}) ⇒ Array<(ScriptEntityListing, Fixnum, Hash)>

Get the list of scripts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :expand (String) —

    Expand

  • :name (String) —

    Name filter

  • :feature (String) —

    Feature filter

  • :flow_id (String) —

    Secure flow id filter

  • :sort_by (String) —

    SortBy

  • :sort_order (String) —

    SortOrder

Returns:

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

    ScriptEntityListing data, response status code and response headers



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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/purecloud/api/scripts_api.rb', line 56

def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi#get ..."
  end
  
  if opts[:'sort_by'] && !['modifiedDate', 'createdDate'].include?(opts[:'sort_by'])
    fail 'invalid value for "sort_by", must be one of modifiedDate, createdDate'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/scripts".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']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
  query_params[:'flowId'] = opts[:'flow_id'] if opts[:'flow_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'ScriptEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScriptsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end