lib/purecloudplatformclientv2/api/architect_api.rb in purecloudplatformclientv2-52.0.0 vs lib/purecloudplatformclientv2/api/architect_api.rb in purecloudplatformclientv2-53.0.0
- old
+ new
@@ -5,14 +5,14 @@
OpenAPI spec version: v2
Contact: DeveloperEvangelists@genesys.com
Generated by: https://github.com/swagger-api/swagger-codegen.git
-License: ININ
-http://www.inin.com
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
-Terms of Service: https://developer.mypurecloud.com/tos
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
=end
require "uri"
@@ -297,10 +297,84 @@
@api_client.config.logger.debug "API called: ArchitectApi#delete_architect_prompt_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
+ # Delete specified user prompt resource audio
+ #
+ # @param prompt_id Prompt ID
+ # @param language_code Language
+ # @param [Hash] opts the optional parameters
+ # @return [nil]
+ def delete_architect_prompt_resource_audio(prompt_id, language_code, opts = {})
+ delete_architect_prompt_resource_audio_with_http_info(prompt_id, language_code, opts)
+ return nil
+ end
+
+ # Delete specified user prompt resource audio
+ #
+ # @param prompt_id Prompt ID
+ # @param language_code Language
+ # @param [Hash] opts the optional parameters
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+ def delete_architect_prompt_resource_audio_with_http_info(prompt_id, language_code, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "Calling API: ArchitectApi.delete_architect_prompt_resource_audio ..."
+ end
+
+
+ # verify the required parameter 'prompt_id' is set
+ fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.delete_architect_prompt_resource_audio" if prompt_id.nil?
+
+
+
+
+
+
+ # verify the required parameter 'language_code' is set
+ fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.delete_architect_prompt_resource_audio" if language_code.nil?
+
+
+
+
+
+ # resource path
+ local_var_path = "/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.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(:DELETE, local_var_path,
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ArchitectApi#delete_architect_prompt_resource_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ return data, status_code, headers
+ end
+
# Batch-delete a list of prompts
# Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}
# @param id List of Prompt IDs
# @param [Hash] opts the optional parameters
# @return [Operation]
@@ -696,22 +770,22 @@
end
return data, status_code, headers
end
# deletes a specific datatable by id
- # deletes an entire datatable (including schema and data) with a given id)
+ # Deletes an entire datatable (including the schema and data) with a given datatableId
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [BOOLEAN] :force force delete, even if in use (default to false)
# @return [nil]
def delete_flows_datatable(datatable_id, opts = {})
delete_flows_datatable_with_http_info(datatable_id, opts)
return nil
end
# deletes a specific datatable by id
- # deletes an entire datatable (including schema and data) with a given id)
+ # Deletes an entire datatable (including the schema and data) with a given datatableId
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [BOOLEAN] :force force delete, even if in use
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
def delete_flows_datatable_with_http_info(datatable_id, opts = {})
@@ -769,22 +843,22 @@
end
return data, status_code, headers
end
# Delete a row entry
- # Deletes a row with a given rowId.
+ # Deletes a row with a given rowId (the value of the key field).
# @param datatable_id id of datatable
# @param row_id the key for the row
# @param [Hash] opts the optional parameters
# @return [nil]
def delete_flows_datatable_row(datatable_id, row_id, opts = {})
delete_flows_datatable_row_with_http_info(datatable_id, row_id, opts)
return nil
end
# Delete a row entry
- # Deletes a row with a given rowId.
+ # Deletes a row with a given rowId (the value of the key field).
# @param datatable_id id of datatable
# @param row_id the key for the row
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
def delete_flows_datatable_row_with_http_info(datatable_id, row_id, opts = {})
@@ -2394,11 +2468,11 @@
# Get a pageable list of user prompts
# The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_number Page number (default to 1)
# @option opts [Integer] :page_size Page size (default to 25)
- # @option opts [String] :name Name
+ # @option opts [Array<String>] :name Name
# @option opts [String] :description Description
# @option opts [String] :name_or_description Name or description
# @option opts [String] :sort_by Sort by (default to id)
# @option opts [String] :sort_order Sort order (default to asc)
# @return [PromptEntityListing]
@@ -2410,11 +2484,11 @@
# Get a pageable list of user prompts
# The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_number Page number
# @option opts [Integer] :page_size Page size
- # @option opts [String] :name Name
+ # @option opts [Array<String>] :name Name
# @option opts [String] :description Description
# @option opts [String] :name_or_description Name or description
# @option opts [String] :sort_by Sort by
# @option opts [String] :sort_order Sort order
# @return [Array<(PromptEntityListing, Fixnum, Hash)>] PromptEntityListing data, response status code and response headers
@@ -2470,11 +2544,11 @@
# query parameters
query_params = {}
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
- query_params[:'name'] = opts[:'name'] if opts[:'name']
+ query_params[:'name'] = @api_client.build_collection_param(opts[:'name'], :multi) if opts[:'name']
query_params[:'description'] = opts[:'description'] if opts[:'description']
query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
@@ -4074,22 +4148,22 @@
end
return data, status_code, headers
end
# Returns a specific datatable by id
- # Given a datableid returns the schema associated with it.
+ # Given a datatableId returns the datatable object and schema associated with it.
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [String] :expand Expand instructions for the result
# @return [DataTable]
def get_flows_datatable(datatable_id, opts = {})
data, _status_code, _headers = get_flows_datatable_with_http_info(datatable_id, opts)
return data
end
# Returns a specific datatable by id
- # Given a datableid returns the schema associated with it.
+ # Given a datatableId returns the datatable object and schema associated with it.
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [String] :expand Expand instructions for the result
# @return [Array<(DataTable, Fixnum, Hash)>] DataTable data, response status code and response headers
def get_flows_datatable_with_http_info(datatable_id, opts = {})
@@ -4152,11 +4226,11 @@
end
return data, status_code, headers
end
# Returns a specific row for the datatable
- # Given a datatable id and a rowId (key) will return the full row contents for that rowId.
+ # Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
# @param datatable_id id of datatable
# @param row_id The key for the row
# @param [Hash] opts the optional parameters
# @option opts [BOOLEAN] :showbrief if true returns just the key field for the row (default to true)
# @return [Hash<String, Object>]
@@ -4164,11 +4238,11 @@
data, _status_code, _headers = get_flows_datatable_row_with_http_info(datatable_id, row_id, opts)
return data
end
# Returns a specific row for the datatable
- # Given a datatable id and a rowId (key) will return the full row contents for that rowId.
+ # Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
# @param datatable_id id of datatable
# @param row_id The key for the row
# @param [Hash] opts the optional parameters
# @option opts [BOOLEAN] :showbrief if true returns just the key field for the row
# @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -4235,12 +4309,12 @@
@api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatable_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Returns the rows for the datatable
- # Returns all of the rows for the datatable with the given id. By default this will just be a shortened list returning the key for each row. Set expand to all to return all of the row contents.
+ # Returns the rows for the datatable with the given id
+ # Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_number Page number (default to 1)
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [BOOLEAN] :showbrief If true returns just the key value of the row (default to true)
@@ -4248,12 +4322,12 @@
def get_flows_datatable_rows(datatable_id, opts = {})
data, _status_code, _headers = get_flows_datatable_rows_with_http_info(datatable_id, opts)
return data
end
- # Returns the rows for the datatable
- # Returns all of the rows for the datatable with the given id. By default this will just be a shortened list returning the key for each row. Set expand to all to return all of the row contents.
+ # Returns the rows for the datatable with the given id
+ # Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_number Page number
# @option opts [Integer] :page_size Page size
# @option opts [BOOLEAN] :showbrief If true returns just the key value of the row
@@ -4328,11 +4402,11 @@
end
return data, status_code, headers
end
# Retrieve a list of datatables for the org
- # Returns a metadata list of the datatables associated with this org, including ID, name and description.
+ # Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
# @param [Hash] opts the optional parameters
# @option opts [String] :expand Expand instructions for the result
# @option opts [Integer] :page_number Page number (default to 1)
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [String] :sort_by Sort by (default to id)
@@ -4342,11 +4416,11 @@
data, _status_code, _headers = get_flows_datatables_with_http_info(opts)
return data
end
# Retrieve a list of datatables for the org
- # Returns a metadata list of the datatables associated with this org, including ID, name and description.
+ # Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
# @param [Hash] opts the optional parameters
# @option opts [String] :expand Expand instructions for the result
# @option opts [Integer] :page_number Page number
# @option opts [Integer] :page_size Page size
# @option opts [String] :sort_by Sort by
@@ -5392,21 +5466,21 @@
# Check-in flow
# Asynchronous. Notification topic: v2.flows.{flowId}
# @param flow Flow ID
# @param [Hash] opts the optional parameters
- # @return [Flow]
+ # @return [Operation]
def post_flows_actions_checkin(flow, opts = {})
data, _status_code, _headers = post_flows_actions_checkin_with_http_info(flow, opts)
return data
end
# Check-in flow
# Asynchronous. Notification topic: v2.flows.{flowId}
# @param flow Flow ID
# @param [Hash] opts the optional parameters
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
+ # @return [Array<(Operation, Fixnum, Hash)>] Operation data, response status code and response headers
def post_flows_actions_checkin_with_http_info(flow, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_actions_checkin ..."
end
@@ -5447,11 +5521,11 @@
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
- :return_type => 'Flow')
+ :return_type => 'Operation')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: ArchitectApi#post_flows_actions_checkin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
@@ -5793,23 +5867,23 @@
@api_client.config.logger.debug "API called: ArchitectApi#post_flows_actions_unlock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Create a new row entry
- # Will add the passed in row entry to the datatable with the given id after verifying it against the schema.
+ # Create a new row entry for the datatable.
+ # Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }
# @param datatable_id id of datatable
# @param data_table_row
# @param [Hash] opts the optional parameters
# @return [Hash<String, Object>]
def post_flows_datatable_rows(datatable_id, data_table_row, opts = {})
data, _status_code, _headers = post_flows_datatable_rows_with_http_info(datatable_id, data_table_row, opts)
return data
end
- # Create a new row entry
- # Will add the passed in row entry to the datatable with the given id after verifying it against the schema.
+ # Create a new row entry for the datatable.
+ # Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }
# @param datatable_id id of datatable
# @param data_table_row
# @param [Hash] opts the optional parameters
# @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
def post_flows_datatable_rows_with_http_info(datatable_id, data_table_row, opts = {})
@@ -5869,21 +5943,21 @@
end
return data, status_code, headers
end
# Create a new datatable with the specified json-schema definition
- # This will create a new datatable with fields that match the property definitions in the JSON schema. The name of the table from the title field of the json-schema. See also http://json-schema.org/
+ # This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/
# @param body datatable json-schema
# @param [Hash] opts the optional parameters
# @return [DataTable]
def post_flows_datatables(body, opts = {})
data, _status_code, _headers = post_flows_datatables_with_http_info(body, opts)
return data
end
# Create a new datatable with the specified json-schema definition
- # This will create a new datatable with fields that match the property definitions in the JSON schema. The name of the table from the title field of the json-schema. See also http://json-schema.org/
+ # This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/
# @param body datatable json-schema
# @param [Hash] opts the optional parameters
# @return [Array<(DataTable, Fixnum, Hash)>] DataTable data, response status code and response headers
def post_flows_datatables_with_http_info(body, opts = {})
if @api_client.config.debugging
@@ -6554,11 +6628,11 @@
end
return data, status_code, headers
end
# Updates a specific datatable by id
- # Updates a schema for a datatable with the given id - updates are additive only, no changes or removals of existing fields.
+ # Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [String] :expand Expand instructions for the result
# @option opts [DataTable] :body datatable json-schema
# @return [DataTable]
@@ -6566,11 +6640,11 @@
data, _status_code, _headers = put_flows_datatable_with_http_info(datatable_id, opts)
return data
end
# Updates a specific datatable by id
- # Updates a schema for a datatable with the given id - updates are additive only, no changes or removals of existing fields.
+ # Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
# @param datatable_id id of datatable
# @param [Hash] opts the optional parameters
# @option opts [String] :expand Expand instructions for the result
# @option opts [DataTable] :body datatable json-schema
# @return [Array<(DataTable, Fixnum, Hash)>] DataTable data, response status code and response headers
@@ -6640,11 +6714,11 @@
end
return data, status_code, headers
end
# Update a row entry
- # Updates a row with the given to the new values.
+ # Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }
# @param datatable_id id of datatable
# @param row_id the key for the row
# @param [Hash] opts the optional parameters
# @option opts [Object] :body datatable row
# @return [Hash<String, Object>]
@@ -6652,10 +6726,10 @@
data, _status_code, _headers = put_flows_datatable_row_with_http_info(datatable_id, row_id, opts)
return data
end
# Update a row entry
- # Updates a row with the given to the new values.
+ # Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }
# @param datatable_id id of datatable
# @param row_id the key for the row
# @param [Hash] opts the optional parameters
# @option opts [Object] :body datatable row
# @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers