lib/purecloudplatformclientv2/api/scripts_api.rb in purecloudplatformclientv2-19.0.0 vs lib/purecloudplatformclientv2/api/scripts_api.rb in purecloudplatformclientv2-20.0.0

- old
+ new

@@ -92,10 +92,11 @@ # Get a page # # @param script_id Script ID # @param page_id Page ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Page] 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 @@ -103,10 +104,11 @@ # Get a page # # @param script_id Script ID # @param page_id Page ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(Page, Fixnum, Hash)>] Page data, response status code and response headers 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 @@ -125,15 +127,22 @@ + + + + + + # 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 = {} + query_params[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -166,20 +175,22 @@ # Get the list of pages # # @param script_id Script ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<Page>] def get_script_pages(script_id, opts = {}) data, _status_code, _headers = get_script_pages_with_http_info(script_id, opts) return data end # Get the list of pages # # @param script_id Script ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(Array<Page>, Fixnum, Hash)>] Array<Page> data, response status code and response headers 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 @@ -190,15 +201,22 @@ + + + + + + # resource path local_var_path = "/api/v2/scripts/{scriptId}/pages".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s) # query parameters query_params = {} + query_params[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -238,10 +256,11 @@ # @option opts [String] :name Name filter # @option opts [String] :feature Feature filter # @option opts [String] :flow_id Secure flow id filter # @option opts [String] :sort_by SortBy # @option opts [String] :sort_order SortOrder + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [ScriptEntityListing] def get_scripts(opts = {}) data, _status_code, _headers = get_scripts_with_http_info(opts) return data end @@ -255,10 +274,11 @@ # @option opts [String] :name Name filter # @option opts [String] :feature Feature filter # @option opts [String] :flow_id Secure flow id filter # @option opts [String] :sort_by SortBy # @option opts [String] :sort_order SortOrder + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(ScriptEntityListing, Fixnum, Hash)>] ScriptEntityListing data, response status code and response headers def get_scripts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts ..." end @@ -317,10 +337,16 @@ end + + + + + + # resource path local_var_path = "/api/v2/scripts".sub('{format}','json') # query parameters query_params = {} @@ -330,10 +356,11 @@ 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'] + query_params[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -364,39 +391,45 @@ return data, status_code, headers end # Get the published scripts. # + # @param script_id Script ID # @param [Hash] opts the optional parameters # @option opts [Integer] :page_size Page size (default to 25) # @option opts [Integer] :page_number Page number (default to 1) # @option opts [String] :expand Expand # @option opts [String] :name Name filter # @option opts [String] :feature Feature filter # @option opts [String] :flow_id Secure flow id filter + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [ScriptEntityListing] - def get_scripts_published(opts = {}) - data, _status_code, _headers = get_scripts_published_with_http_info(opts) + def get_scripts_published(script_id, opts = {}) + data, _status_code, _headers = get_scripts_published_with_http_info(script_id, opts) return data end # Get the published scripts. # + # @param script_id Script ID # @param [Hash] opts the optional parameters # @option opts [Integer] :page_size Page size # @option opts [Integer] :page_number Page number # @option opts [String] :expand Expand # @option opts [String] :name Name filter # @option opts [String] :feature Feature filter # @option opts [String] :flow_id Secure flow id filter + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(ScriptEntityListing, Fixnum, Hash)>] ScriptEntityListing data, response status code and response headers - def get_scripts_published_with_http_info(opts = {}) + def get_scripts_published_with_http_info(script_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts_published ..." end + # verify the required parameter 'script_id' is set + fail ArgumentError, "Missing the required parameter 'script_id' when calling ScriptsApi.get_scripts_published" if script_id.nil? @@ -428,21 +461,34 @@ + + + + + + + + + + + + # resource path - local_var_path = "/api/v2/scripts/published".sub('{format}','json') + local_var_path = "/api/v2/scripts/published".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s) # 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[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -475,20 +521,22 @@ # Get the published script. # # @param script_id Script ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Script] 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 the published script. # # @param script_id Script ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(Script, Fixnum, Hash)>] Script data, response status code and response headers 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 @@ -499,15 +547,22 @@ + + + + + + # resource path local_var_path = "/api/v2/scripts/published/{scriptId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s) # query parameters query_params = {} + query_params[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -541,10 +596,11 @@ # Get the published page. # # @param script_id Script ID # @param page_id Page ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Page] 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 @@ -552,10 +608,11 @@ # Get the published page. # # @param script_id Script ID # @param page_id Page ID # @param [Hash] opts the optional parameters + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(Page, Fixnum, Hash)>] Page data, response status code and response headers 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 @@ -574,15 +631,22 @@ + + + + + + # 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 = {} + query_params[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -615,20 +679,24 @@ # Get the list of published pages # # @param script_id Script ID # @param [Hash] opts the optional parameters + # @option opts [Integer] :foo (default to 25) + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<Page>] 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 the list of published pages # # @param script_id Script ID # @param [Hash] opts the optional parameters + # @option opts [Integer] :foo + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(Array<Page>, Fixnum, Hash)>] Array<Page> data, response status code and response headers 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 @@ -639,15 +707,29 @@ + + + + + + + + + + + + # resource path local_var_path = "/api/v2/scripts/published/{scriptId}/pages".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s) # query parameters query_params = {} + query_params[:'foo'] = opts[:'foo'] if opts[:'foo'] + query_params[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -683,10 +765,11 @@ # @param script_id Script ID # @param [Hash] opts the optional parameters # @option opts [String] :input input # @option opts [String] :output output # @option opts [String] :type type + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Object] 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 @@ -696,10 +779,11 @@ # @param script_id Script ID # @param [Hash] opts the optional parameters # @option opts [String] :input input # @option opts [String] :output output # @option opts [String] :type type + # @option opts [String] :script_data_version Advanced usage - controls the data version of the script # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers 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 @@ -728,17 +812,24 @@ + + + + + + # 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'] + query_params[:'scriptDataVersion'] = opts[:'script_data_version'] if opts[:'script_data_version'] # header parameters header_params = {} # HTTP header 'Accept' (if needed)