docs/ScriptsApi.md in purecloudplatformclientv2-19.0.0 vs docs/ScriptsApi.md in purecloudplatformclientv2-20.0.0
- old
+ new
@@ -78,11 +78,11 @@
<a name="get_script_page"></a>
-## -[**Page**](Page.html) get_script_page(script_id, page_id)
+## -[**Page**](Page.html) get_script_page(script_id, page_id, opts)
Get a page
@@ -108,14 +108,17 @@
script_id = "script_id_example" # String | Script ID
page_id = "page_id_example" # String | Page ID
+opts = {
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
+}
begin
#Get a page
- result = api_instance.get_script_page(script_id, page_id)
+ result = api_instance.get_script_page(script_id, page_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ScriptsApi->get_script_page: #{e}"
end
~~~
@@ -124,10 +127,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**script_id** | **String**| Script ID | |
**page_id** | **String**| Page ID | |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type
@@ -140,11 +144,11 @@
<a name="get_script_pages"></a>
-## -[**Array<Page>**](Page.html) get_script_pages(script_id)
+## -[**Array<Page>**](Page.html) get_script_pages(script_id, opts)
Get the list of pages
@@ -168,14 +172,17 @@
api_instance = PureCloud::ScriptsApi.new
script_id = "script_id_example" # String | Script ID
+opts = {
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
+}
begin
#Get the list of pages
- result = api_instance.get_script_pages(script_id)
+ result = api_instance.get_script_pages(script_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ScriptsApi->get_script_pages: #{e}"
end
~~~
@@ -183,10 +190,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**script_id** | **String**| Script ID | |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type
@@ -233,11 +241,12 @@
expand: "expand_example", # String | Expand
name: "name_example", # String | Name filter
feature: "feature_example", # String | Feature filter
flow_id: "flow_id_example", # String | Secure flow id filter
sort_by: "sort_by_example", # String | SortBy
- sort_order: "sort_order_example" # String | SortOrder
+ sort_order: "sort_order_example", # String | SortOrder
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
}
begin
#Get the list of scripts
result = api_instance.get_scripts(opts)
@@ -257,10 +266,11 @@
**name** | **String**| Name filter | [optional] |
**feature** | **String**| Feature filter | [optional] |
**flow_id** | **String**| Secure flow id filter | [optional] |
**sort_by** | **String**| SortBy | [optional] <br />**Values**: modifiedDate, createdDate |
**sort_order** | **String**| SortOrder | [optional] <br />**Values**: ascending, descending |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type
@@ -273,11 +283,11 @@
<a name="get_scripts_published"></a>
-## -[**ScriptEntityListing**](ScriptEntityListing.html) get_scripts_published(opts)
+## -[**ScriptEntityListing**](ScriptEntityListing.html) get_scripts_published(script_id, opts)
Get the published scripts.
@@ -299,38 +309,43 @@
config.access_token = @authToken
end
api_instance = PureCloud::ScriptsApi.new
+script_id = "script_id_example" # String | Script ID
+
opts = {
page_size: 25, # Integer | Page size
page_number: 1, # Integer | Page number
expand: "expand_example", # String | Expand
name: "name_example", # String | Name filter
feature: "feature_example", # String | Feature filter
- flow_id: "flow_id_example" # String | Secure flow id filter
+ flow_id: "flow_id_example", # String | Secure flow id filter
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
}
begin
#Get the published scripts.
- result = api_instance.get_scripts_published(opts)
+ result = api_instance.get_scripts_published(script_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ScriptsApi->get_scripts_published: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+ **script_id** | **String**| Script ID | |
**page_size** | **Integer**| Page size | [optional] [default to 25] |
**page_number** | **Integer**| Page number | [optional] [default to 1] |
**expand** | **String**| Expand | [optional] |
**name** | **String**| Name filter | [optional] |
**feature** | **String**| Feature filter | [optional] |
**flow_id** | **String**| Secure flow id filter | [optional] |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type
@@ -343,11 +358,11 @@
<a name="get_scripts_published_script_id"></a>
-## -[**Script**](Script.html) get_scripts_published_script_id(script_id)
+## -[**Script**](Script.html) get_scripts_published_script_id(script_id, opts)
Get the published script.
@@ -371,14 +386,17 @@
api_instance = PureCloud::ScriptsApi.new
script_id = "script_id_example" # String | Script ID
+opts = {
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
+}
begin
#Get the published script.
- result = api_instance.get_scripts_published_script_id(script_id)
+ result = api_instance.get_scripts_published_script_id(script_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ScriptsApi->get_scripts_published_script_id: #{e}"
end
~~~
@@ -386,10 +404,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**script_id** | **String**| Script ID | |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type
@@ -402,11 +421,11 @@
<a name="get_scripts_published_script_id_page"></a>
-## -[**Page**](Page.html) get_scripts_published_script_id_page(script_id, page_id)
+## -[**Page**](Page.html) get_scripts_published_script_id_page(script_id, page_id, opts)
Get the published page.
@@ -432,14 +451,17 @@
script_id = "script_id_example" # String | Script ID
page_id = "page_id_example" # String | Page ID
+opts = {
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
+}
begin
#Get the published page.
- result = api_instance.get_scripts_published_script_id_page(script_id, page_id)
+ result = api_instance.get_scripts_published_script_id_page(script_id, page_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ScriptsApi->get_scripts_published_script_id_page: #{e}"
end
~~~
@@ -448,10 +470,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**script_id** | **String**| Script ID | |
**page_id** | **String**| Page ID | |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type
@@ -464,11 +487,11 @@
<a name="get_scripts_published_script_id_pages"></a>
-## -[**Array<Page>**](Page.html) get_scripts_published_script_id_pages(script_id)
+## -[**Array<Page>**](Page.html) get_scripts_published_script_id_pages(script_id, opts)
Get the list of published pages
@@ -492,14 +515,18 @@
api_instance = PureCloud::ScriptsApi.new
script_id = "script_id_example" # String | Script ID
+opts = {
+ foo: 25, # Integer |
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
+}
begin
#Get the list of published pages
- result = api_instance.get_scripts_published_script_id_pages(script_id)
+ result = api_instance.get_scripts_published_script_id_pages(script_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ScriptsApi->get_scripts_published_script_id_pages: #{e}"
end
~~~
@@ -507,10 +534,12 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**script_id** | **String**| Script ID | |
+ **foo** | **Integer**| | [optional] [default to 25] |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type
@@ -554,11 +583,12 @@
script_id = "script_id_example" # String | Script ID
opts = {
input: "input_example", # String | input
output: "output_example", # String | output
- type: "type_example" # String | type
+ type: "type_example", # String | type
+ script_data_version: "script_data_version_example" # String | Advanced usage - controls the data version of the script
}
begin
#Get the published variables
result = api_instance.get_scripts_published_script_id_variables(script_id, opts)
@@ -574,9 +604,10 @@
------------- | ------------- | ------------- | -------------
**script_id** | **String**| Script ID | |
**input** | **String**| input | [optional] |
**output** | **String**| output | [optional] |
**type** | **String**| type | [optional] |
+ **script_data_version** | **String**| Advanced usage - controls the data version of the script | [optional] |
{: class="table table-striped"}
### Return type