Class: PureCloud::ScriptsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/api/scripts_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

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

Get a script

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:



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

def get_script(script_id, opts = {})
  data, _status_code, _headers = get_script_with_http_info(script_id, opts)
  return data
end

#get_script_page(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:



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

def get_script_page(script_id, page_id, opts = {})
  data, _status_code, _headers = get_script_page_with_http_info(script_id, page_id, opts)
  return data
end

#get_script_page_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



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

def get_script_page_with_http_info(script_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_script_page ..."
  end
  
  
  # verify the required parameter 'script_id' is set
  fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_script_page" if script_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'page_id' is set
  fail ArgumentError, "Missing the required parameter 'page_id' when calling ScriptsApi.get_script_page" 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)
  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 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_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get the list of pages

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:



172
173
174
175
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 172

def get_script_pages(script_id, opts = {})
  data, _status_code, _headers = get_script_pages_with_http_info(script_id, opts)
  return data
end

#get_script_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



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

def get_script_pages_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_script_pages ..."
  end
  
  
  # verify the required parameter 'script_id' is set
  fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_script_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)
  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 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_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_script_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



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/scripts_api.rb', line 42

def get_script_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_script ..."
  end
  
  
  # verify the required parameter 'script_id' is set
  fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_script" 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)
  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 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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scripts(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:



244
245
246
247
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 244

def get_scripts(opts = {})
  data, _status_code, _headers = get_scripts_with_http_info(opts)
  return data
end

#get_scripts_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:



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

def get_scripts_published(opts = {})
  data, _status_code, _headers = get_scripts_published_with_http_info(opts)
  return data
end

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

Get the published script.

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Returns:



481
482
483
484
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 481

def get_scripts_published_script_id(script_id, opts = {})
  data, _status_code, _headers = get_scripts_published_script_id_with_http_info(script_id, opts)
  return data
end

#get_scripts_published_script_id_page(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:



547
548
549
550
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 547

def get_scripts_published_script_id_page(script_id, page_id, opts = {})
  data, _status_code, _headers = get_scripts_published_script_id_page_with_http_info(script_id, page_id, opts)
  return data
end

#get_scripts_published_script_id_page_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



558
559
560
561
562
563
564
565
566
567
568
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
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 558

def get_scripts_published_script_id_page_with_http_info(script_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts_published_script_id_page ..."
  end
  
  
  # verify the required parameter 'script_id' is set
  fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_scripts_published_script_id_page" if script_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'page_id' is set
  fail ArgumentError, "Missing the required parameter 'page_id' when calling ScriptsApi.get_scripts_published_script_id_page" 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)
  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 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_scripts_published_script_id_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scripts_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:



621
622
623
624
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 621

def get_scripts_published_script_id_pages(script_id, opts = {})
  data, _status_code, _headers = get_scripts_published_script_id_pages_with_http_info(script_id, opts)
  return data
end

#get_scripts_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



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 631

def get_scripts_published_script_id_pages_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts_published_script_id_pages ..."
  end
  
  
  # verify the required parameter 'script_id' is set
  fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_scripts_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)
  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 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_scripts_published_script_id_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get the published variables

Parameters:

  • script_id —

    Script ID

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

    the optional parameters

Options Hash (opts):

  • :input (String) —

    input

  • :output (String) —

    output

  • :type (String) —

    type

Returns:

  • (Object) 


689
690
691
692
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 689

def get_scripts_published_script_id_variables(script_id, opts = {})
  data, _status_code, _headers = get_scripts_published_script_id_variables_with_http_info(script_id, opts)
  return data
end

#get_scripts_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

Options Hash (opts):

  • :input (String) —

    input

  • :output (String) —

    output

  • :type (String) —

    type

Returns:

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

    Object data, response status code and response headers



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 702

def get_scripts_published_script_id_variables_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts_published_script_id_variables ..."
  end
  
  
  # verify the required parameter 'script_id' is set
  fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_scripts_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 = {}
  query_params[:'input'] = opts[:'input'] if opts[:'input']
  query_params[:'output'] = opts[:'output'] if opts[:'output']
  query_params[:'type'] = opts[:'type'] if opts[:'type']

  # 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 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_scripts_published_script_id_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scripts_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



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
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
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 491

def get_scripts_published_script_id_with_http_info(script_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts_published_script_id ..."
  end
  
  
  # verify the required parameter 'script_id' is set
  fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_scripts_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)
  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 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_scripts_published_script_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scripts_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



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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
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
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 392

def get_scripts_published_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts_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)
  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 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_scripts_published\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scripts_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



261
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
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
 
# File 'lib/purecloudplatformclientv2/api/scripts_api.rb', line 261

def get_scripts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['modifiedDate', 'createdDate'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of modifiedDate, createdDate'
  end
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, '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)
  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 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_scripts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end