class Azure::CustomerInsights::Mgmt::V2017_04_26::Interactions
The Azure
Customer Insights management API provides a RESTful set of web services that interact with Azure
Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure
Customer Insights service.
Attributes
@return [CustomerInsightsManagementClient] reference to the CustomerInsightsManagementClient
Private Class Methods
Creates and initializes a new instance of the Interactions
class. @param client service class for accessing basic functionality.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 20 def initialize(client) @client = client end
Private Instance Methods
Creates an interaction or updates an existing interaction within a hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param parameters [InteractionResourceFormat] Parameters supplied to the CreateOrUpdate Interaction operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [InteractionResourceFormat] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 384 def begin_create_or_update(resource_group_name, hub_name, interaction_name, parameters, custom_headers:nil) response = begin_create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Creates an interaction or updates an existing interaction within a hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param parameters [InteractionResourceFormat] Parameters supplied to the CreateOrUpdate Interaction operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 419 def begin_create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'hub_name is nil' if hub_name.nil? fail ArgumentError, 'interaction_name is nil' if interaction_name.nil? fail ArgumentError, "'interaction_name' should satisfy the constraint - 'MaxLength': '128'" if !interaction_name.nil? && interaction_name.length > 128 fail ArgumentError, "'interaction_name' should satisfy the constraint - 'MinLength': '1'" if !interaction_name.nil? && interaction_name.length < 1 fail ArgumentError, "'interaction_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9_]+$'" if !interaction_name.nil? && interaction_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9_]+$$')).nil? fail ArgumentError, 'parameters is nil' if parameters.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? # Serialize Request request_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::InteractionResourceFormat.mapper() request_content = @client.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions/{interactionName}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'interactionName' => interaction_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 || status_code == 202 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::InteractionResourceFormat.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Creates an interaction or updates an existing interaction within a hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param parameters [InteractionResourceFormat] Parameters supplied to the CreateOrUpdate Interaction operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 402 def begin_create_or_update_with_http_info(resource_group_name, hub_name, interaction_name, parameters, custom_headers:nil) begin_create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers:custom_headers).value! end
Creates an interaction or updates an existing interaction within a hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param parameters [InteractionResourceFormat] Parameters supplied to the CreateOrUpdate Interaction operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [InteractionResourceFormat] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 40 def create_or_update(resource_group_name, hub_name, interaction_name, parameters, custom_headers:nil) response = create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param parameters [InteractionResourceFormat] Parameters supplied to the CreateOrUpdate Interaction operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] promise which provides async access to http response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 57 def create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers:nil) # Send request promise = begin_create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::InteractionResourceFormat.mapper() parsed_response = @client.deserialize(result_mapper, parsed_response) end # Waiting for response. @client.get_long_running_operation_result(response, deserialize_method) end promise end
Gets information about the specified interaction.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param locale_code [String] Locale of interaction to retrieve, default is en-us. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [InteractionResourceFormat] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 88 def get(resource_group_name, hub_name, interaction_name, locale_code:'en-us', custom_headers:nil) response = get_async(resource_group_name, hub_name, interaction_name, locale_code:locale_code, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets information about the specified interaction.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param locale_code [String] Locale of interaction to retrieve, default is en-us. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 123 def get_async(resource_group_name, hub_name, interaction_name, locale_code:'en-us', custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'hub_name is nil' if hub_name.nil? fail ArgumentError, 'interaction_name is nil' if interaction_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions/{interactionName}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'interactionName' => interaction_name,'subscriptionId' => @client.subscription_id}, query_params: {'locale-code' => locale_code,'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::InteractionResourceFormat.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets information about the specified interaction.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param locale_code [String] Locale of interaction to retrieve, default is en-us. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 106 def get_with_http_info(resource_group_name, hub_name, interaction_name, locale_code:'en-us', custom_headers:nil) get_async(resource_group_name, hub_name, interaction_name, locale_code:locale_code, custom_headers:custom_headers).value! end
Gets all interactions in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param locale_code [String] Locale of interaction to retrieve, default is en-us. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<InteractionResourceFormat>] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 189 def list_by_hub(resource_group_name, hub_name, locale_code:'en-us', custom_headers:nil) first_page = list_by_hub_as_lazy(resource_group_name, hub_name, locale_code:locale_code, custom_headers:custom_headers) first_page.get_all_items end
Gets all interactions in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param locale_code [String] Locale of interaction to retrieve, default is en-us. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [InteractionListResult] which provide lazy access to pages of the response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 585 def list_by_hub_as_lazy(resource_group_name, hub_name, locale_code:'en-us', custom_headers:nil) response = list_by_hub_async(resource_group_name, hub_name, locale_code:locale_code, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_hub_next_async(next_page_link, custom_headers:custom_headers) end page end end
Gets all interactions in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param locale_code [String] Locale of interaction to retrieve, default is en-us. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 222 def list_by_hub_async(resource_group_name, hub_name, locale_code:'en-us', custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'hub_name is nil' if hub_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'subscriptionId' => @client.subscription_id}, query_params: {'locale-code' => locale_code,'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::InteractionListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets all interactions in the hub.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [InteractionListResult] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 494 def list_by_hub_next(next_page_link, custom_headers:nil) response = list_by_hub_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets all interactions in the hub.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 523 def list_by_hub_next_async(next_page_link, custom_headers:nil) fail ArgumentError, 'next_page_link is nil' if next_page_link.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = '{nextLink}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'nextLink' => next_page_link}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::InteractionListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets all interactions in the hub.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 509 def list_by_hub_next_with_http_info(next_page_link, custom_headers:nil) list_by_hub_next_async(next_page_link, custom_headers:custom_headers).value! end
Gets all interactions in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param locale_code [String] Locale of interaction to retrieve, default is en-us. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 206 def list_by_hub_with_http_info(resource_group_name, hub_name, locale_code:'en-us', custom_headers:nil) list_by_hub_async(resource_group_name, hub_name, locale_code:locale_code, custom_headers:custom_headers).value! end
Suggests relationships to create relationship links.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [SuggestRelationshipLinksResponse] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 286 def suggest_relationship_links(resource_group_name, hub_name, interaction_name, custom_headers:nil) response = suggest_relationship_links_async(resource_group_name, hub_name, interaction_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Suggests relationships to create relationship links.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 317 def suggest_relationship_links_async(resource_group_name, hub_name, interaction_name, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'hub_name is nil' if hub_name.nil? fail ArgumentError, 'interaction_name is nil' if interaction_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions/{interactionName}/suggestRelationshipLinks' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'interactionName' => interaction_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::SuggestRelationshipLinksResponse.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Suggests relationships to create relationship links.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param interaction_name [String] The name of the interaction. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb, line 302 def suggest_relationship_links_with_http_info(resource_group_name, hub_name, interaction_name, custom_headers:nil) suggest_relationship_links_async(resource_group_name, hub_name, interaction_name, custom_headers:custom_headers).value! end