Class: Azure::CustomerInsights::Mgmt::V2017_04_26::Interactions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Interactions

Creates and initializes a new instance of the Interactions class.

Parameters:

  • client

    service class for accessing basic functionality.



20
21
22
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientCustomerInsightsManagementClient (readonly)

Returns reference to the CustomerInsightsManagementClient.

Returns:



25
26
27
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/interactions.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, hub_name, interaction_name, parameters, custom_headers: nil) ⇒ InteractionResourceFormat

Creates an interaction or updates an existing interaction within a hub.

CreateOrUpdate Interaction operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • parameters (InteractionResourceFormat)

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (InteractionResourceFormat)

    operation results.



384
385
386
387
# 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

#begin_create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates an interaction or updates an existing interaction within a hub.

CreateOrUpdate Interaction operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • parameters (InteractionResourceFormat)

    Parameters supplied to the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
475
476
477
478
479
480
481
482
# 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

#begin_create_or_update_with_http_info(resource_group_name, hub_name, interaction_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates an interaction or updates an existing interaction within a hub.

CreateOrUpdate Interaction operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • parameters (InteractionResourceFormat)

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



402
403
404
# 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

#create_or_update(resource_group_name, hub_name, interaction_name, parameters, custom_headers: nil) ⇒ InteractionResourceFormat

Creates an interaction or updates an existing interaction within a hub.

CreateOrUpdate Interaction operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • parameters (InteractionResourceFormat)

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (InteractionResourceFormat)

    operation results.



40
41
42
43
# 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

#create_or_update_async(resource_group_name, hub_name, interaction_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

CreateOrUpdate Interaction operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • parameters (InteractionResourceFormat)

    Parameters supplied to the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# 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

#get(resource_group_name, hub_name, interaction_name, locale_code: 'en-us', custom_headers: nil) ⇒ InteractionResourceFormat

Gets information about the specified interaction.

en-us. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • locale_code (String) (defaults to: 'en-us')

    Locale of interaction to retrieve, default is

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (InteractionResourceFormat)

    operation results.



88
89
90
91
# 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

#get_async(resource_group_name, hub_name, interaction_name, locale_code: 'en-us', custom_headers: nil) ⇒ Concurrent::Promise

Gets information about the specified interaction.

en-us. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • locale_code (String) (defaults to: 'en-us')

    Locale of interaction to retrieve, default is

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
166
167
168
169
170
171
172
173
174
175
# 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

#get_with_http_info(resource_group_name, hub_name, interaction_name, locale_code: 'en-us', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the specified interaction.

en-us. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • locale_code (String) (defaults to: 'en-us')

    Locale of interaction to retrieve, default is

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



106
107
108
# 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

#list_by_hub(resource_group_name, hub_name, locale_code: 'en-us', custom_headers: nil) ⇒ Array<InteractionResourceFormat>

Gets all interactions in the hub.

en-us. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us')

    Locale of interaction to retrieve, default is

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Array<InteractionResourceFormat>)

    operation results.



189
190
191
192
# 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

#list_by_hub_as_lazy(resource_group_name, hub_name, locale_code: 'en-us', custom_headers: nil) ⇒ InteractionListResult

Gets all interactions in the hub.

en-us. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us')

    Locale of interaction to retrieve, default is

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (InteractionListResult)

    which provide lazy access to pages of the



585
586
587
588
589
590
591
592
593
594
# 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

#list_by_hub_async(resource_group_name, hub_name, locale_code: 'en-us', custom_headers: nil) ⇒ Concurrent::Promise

Gets all interactions in the hub.

en-us. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us')

    Locale of interaction to retrieve, default is

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# 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

#list_by_hub_next(next_page_link, custom_headers: nil) ⇒ InteractionListResult

Gets all interactions in the hub.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (InteractionListResult)

    operation results.



494
495
496
497
# 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

#list_by_hub_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Gets all interactions in the hub.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# 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

#list_by_hub_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all interactions in the hub.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



509
510
511
# 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

#list_by_hub_with_http_info(resource_group_name, hub_name, locale_code: 'en-us', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all interactions in the hub.

en-us. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us')

    Locale of interaction to retrieve, default is

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



206
207
208
# 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.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (SuggestRelationshipLinksResponse)

    operation results.



286
287
288
289
# 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.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
366
367
368
369
# 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.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • hub_name (String)

    The name of the hub.

  • interaction_name (String)

    The name of the interaction.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



302
303
304
# 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