Class: MicrosoftGraph::Models::CallRecordsDirectRoutingLogRow

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/call_records_direct_routing_log_row.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeObject

Instantiates a new callRecordsDirectRoutingLogRow and sets the default values.



158
159
160
# File 'lib/models/call_records_direct_routing_log_row.rb', line 158

def initialize()
    @additional_data = Hash.new
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a call_records_direct_routing_log_row

Raises:

  • (StandardError)


181
182
183
184
# File 'lib/models/call_records_direct_routing_log_row.rb', line 181

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return CallRecordsDirectRoutingLogRow.new
end

Instance Method Details

#additional_dataObject

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



83
84
85
# File 'lib/models/call_records_direct_routing_log_row.rb', line 83

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value

    Value to set for the additionalData property.

Returns:

  • a void



91
92
93
# File 'lib/models/call_records_direct_routing_log_row.rb', line 91

def additional_data=(value)
    @additional_data = value
end

#call_end_sub_reasonObject

Gets the callEndSubReason property value. In addition to the SIP codes, Microsoft has own subcodes that indicate the specific issue.

Returns:

  • a integer



98
99
100
# File 'lib/models/call_records_direct_routing_log_row.rb', line 98

def call_end_sub_reason
    return @call_end_sub_reason
end

#call_end_sub_reason=(value) ⇒ Object

Sets the callEndSubReason property value. In addition to the SIP codes, Microsoft has own subcodes that indicate the specific issue.

Parameters:

  • value

    Value to set for the callEndSubReason property.

Returns:

  • a void



106
107
108
# File 'lib/models/call_records_direct_routing_log_row.rb', line 106

def call_end_sub_reason=(value)
    @call_end_sub_reason = value
end

#call_typeObject

Gets the callType property value. Call type and direction.

Returns:

  • a string



113
114
115
# File 'lib/models/call_records_direct_routing_log_row.rb', line 113

def call_type
    return @call_type
end

#call_type=(value) ⇒ Object

Sets the callType property value. Call type and direction.

Parameters:

  • value

    Value to set for the callType property.

Returns:

  • a void



121
122
123
# File 'lib/models/call_records_direct_routing_log_row.rb', line 121

def call_type=(value)
    @call_type = value
end

#callee_numberObject

Gets the calleeNumber property value. Number of the user or bot who received the call. E.164 format, but may include additional data.

Returns:

  • a string



128
129
130
# File 'lib/models/call_records_direct_routing_log_row.rb', line 128

def callee_number
    return @callee_number
end

#callee_number=(value) ⇒ Object

Sets the calleeNumber property value. Number of the user or bot who received the call. E.164 format, but may include additional data.

Parameters:

  • value

    Value to set for the calleeNumber property.

Returns:

  • a void



136
137
138
# File 'lib/models/call_records_direct_routing_log_row.rb', line 136

def callee_number=(value)
    @callee_number = value
end

#caller_numberObject

Gets the callerNumber property value. Number of the user or bot who made the call. E.164 format, but may include additional data.

Returns:

  • a string



143
144
145
# File 'lib/models/call_records_direct_routing_log_row.rb', line 143

def caller_number
    return @caller_number
end

#caller_number=(value) ⇒ Object

Sets the callerNumber property value. Number of the user or bot who made the call. E.164 format, but may include additional data.

Parameters:

  • value

    Value to set for the callerNumber property.

Returns:

  • a void



151
152
153
# File 'lib/models/call_records_direct_routing_log_row.rb', line 151

def caller_number=(value)
    @caller_number = value
end

#correlation_idObject

Gets the correlationId property value. Identifier for the call that you can use when calling Microsoft Support. GUID.

Returns:

  • a string



165
166
167
# File 'lib/models/call_records_direct_routing_log_row.rb', line 165

def correlation_id
    return @correlation_id
end

#correlation_id=(value) ⇒ Object

Sets the correlationId property value. Identifier for the call that you can use when calling Microsoft Support. GUID.

Parameters:

  • value

    Value to set for the correlationId property.

Returns:

  • a void



173
174
175
# File 'lib/models/call_records_direct_routing_log_row.rb', line 173

def correlation_id=(value)
    @correlation_id = value
end

#durationObject

Gets the duration property value. Duration of the call in seconds.

Returns:

  • a integer



189
190
191
# File 'lib/models/call_records_direct_routing_log_row.rb', line 189

def duration
    return @duration
end

#duration=(value) ⇒ Object

Sets the duration property value. Duration of the call in seconds.

Parameters:

  • value

    Value to set for the duration property.

Returns:

  • a void



197
198
199
# File 'lib/models/call_records_direct_routing_log_row.rb', line 197

def duration=(value)
    @duration = value
end

#end_date_timeObject

Gets the endDateTime property value. Only exists for successful (fully established) calls. Time when call ended.

Returns:

  • a date_time



204
205
206
# File 'lib/models/call_records_direct_routing_log_row.rb', line 204

def end_date_time
    return @end_date_time
end

#end_date_time=(value) ⇒ Object

Sets the endDateTime property value. Only exists for successful (fully established) calls. Time when call ended.

Parameters:

  • value

    Value to set for the endDateTime property.

Returns:

  • a void



212
213
214
# File 'lib/models/call_records_direct_routing_log_row.rb', line 212

def end_date_time=(value)
    @end_date_time = value
end

#failure_date_timeObject

Gets the failureDateTime property value. Only exists for failed (not fully established) calls.

Returns:

  • a date_time



219
220
221
# File 'lib/models/call_records_direct_routing_log_row.rb', line 219

def failure_date_time
    return @failure_date_time
end

#failure_date_time=(value) ⇒ Object

Sets the failureDateTime property value. Only exists for failed (not fully established) calls.

Parameters:

  • value

    Value to set for the failureDateTime property.

Returns:

  • a void



227
228
229
# File 'lib/models/call_records_direct_routing_log_row.rb', line 227

def failure_date_time=(value)
    @failure_date_time = value
end

#final_sip_codeObject

Gets the finalSipCode property value. The code with which the call ended, RFC 3261.

Returns:

  • a integer



234
235
236
# File 'lib/models/call_records_direct_routing_log_row.rb', line 234

def final_sip_code
    return @final_sip_code
end

#final_sip_code=(value) ⇒ Object

Sets the finalSipCode property value. The code with which the call ended, RFC 3261.

Parameters:

  • value

    Value to set for the finalSipCode property.

Returns:

  • a void



242
243
244
# File 'lib/models/call_records_direct_routing_log_row.rb', line 242

def final_sip_code=(value)
    @final_sip_code = value
end

#final_sip_code_phraseObject

Gets the finalSipCodePhrase property value. Description of the SIP code and Microsoft subcode.

Returns:

  • a string



249
250
251
# File 'lib/models/call_records_direct_routing_log_row.rb', line 249

def final_sip_code_phrase
    return @final_sip_code_phrase
end

#final_sip_code_phrase=(value) ⇒ Object

Sets the finalSipCodePhrase property value. Description of the SIP code and Microsoft subcode.

Parameters:

  • value

    Value to set for the finalSipCodePhrase property.

Returns:

  • a void



257
258
259
# File 'lib/models/call_records_direct_routing_log_row.rb', line 257

def final_sip_code_phrase=(value)
    @final_sip_code_phrase = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/models/call_records_direct_routing_log_row.rb', line 264

def get_field_deserializers()
    return {
        "callEndSubReason" => lambda {|n| @call_end_sub_reason = n.get_number_value() },
        "callType" => lambda {|n| @call_type = n.get_string_value() },
        "calleeNumber" => lambda {|n| @callee_number = n.get_string_value() },
        "callerNumber" => lambda {|n| @caller_number = n.get_string_value() },
        "correlationId" => lambda {|n| @correlation_id = n.get_string_value() },
        "duration" => lambda {|n| @duration = n.get_number_value() },
        "endDateTime" => lambda {|n| @end_date_time = n.get_date_time_value() },
        "failureDateTime" => lambda {|n| @failure_date_time = n.get_date_time_value() },
        "finalSipCode" => lambda {|n| @final_sip_code = n.get_number_value() },
        "finalSipCodePhrase" => lambda {|n| @final_sip_code_phrase = n.get_string_value() },
        "id" => lambda {|n| @id = n.get_string_value() },
        "inviteDateTime" => lambda {|n| @invite_date_time = n.get_date_time_value() },
        "mediaBypassEnabled" => lambda {|n| @media_bypass_enabled = n.get_boolean_value() },
        "mediaPathLocation" => lambda {|n| @media_path_location = n.get_string_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "signalingLocation" => lambda {|n| @signaling_location = n.get_string_value() },
        "startDateTime" => lambda {|n| @start_date_time = n.get_date_time_value() },
        "successfulCall" => lambda {|n| @successful_call = n.get_boolean_value() },
        "trunkFullyQualifiedDomainName" => lambda {|n| @trunk_fully_qualified_domain_name = n.get_string_value() },
        "userDisplayName" => lambda {|n| @user_display_name = n.get_string_value() },
        "userId" => lambda {|n| @user_id = n.get_string_value() },
        "userPrincipalName" => lambda {|n| @user_principal_name = n.get_string_value() },
    }
end

#idObject

Gets the id property value. Unique call identifier. GUID.

Returns:

  • a string



294
295
296
# File 'lib/models/call_records_direct_routing_log_row.rb', line 294

def id
    return @id
end

#id=(value) ⇒ Object

Sets the id property value. Unique call identifier. GUID.

Parameters:

  • value

    Value to set for the id property.

Returns:

  • a void



302
303
304
# File 'lib/models/call_records_direct_routing_log_row.rb', line 302

def id=(value)
    @id = value
end

#invite_date_timeObject

Gets the inviteDateTime property value. When the initial invite was sent.

Returns:

  • a date_time



309
310
311
# File 'lib/models/call_records_direct_routing_log_row.rb', line 309

def invite_date_time
    return @invite_date_time
end

#invite_date_time=(value) ⇒ Object

Sets the inviteDateTime property value. When the initial invite was sent.

Parameters:

  • value

    Value to set for the inviteDateTime property.

Returns:

  • a void



317
318
319
# File 'lib/models/call_records_direct_routing_log_row.rb', line 317

def invite_date_time=(value)
    @invite_date_time = value
end

#media_bypass_enabledObject

Gets the mediaBypassEnabled property value. Indicates if the trunk was enabled for media bypass or not.

Returns:

  • a boolean



324
325
326
# File 'lib/models/call_records_direct_routing_log_row.rb', line 324

def media_bypass_enabled
    return @media_bypass_enabled
end

#media_bypass_enabled=(value) ⇒ Object

Sets the mediaBypassEnabled property value. Indicates if the trunk was enabled for media bypass or not.

Parameters:

  • value

    Value to set for the mediaBypassEnabled property.

Returns:

  • a void



332
333
334
# File 'lib/models/call_records_direct_routing_log_row.rb', line 332

def media_bypass_enabled=(value)
    @media_bypass_enabled = value
end

#media_path_locationObject

Gets the mediaPathLocation property value. The datacenter used for media path in non-bypass call.

Returns:

  • a string



339
340
341
# File 'lib/models/call_records_direct_routing_log_row.rb', line 339

def media_path_location
    return @media_path_location
end

#media_path_location=(value) ⇒ Object

Sets the mediaPathLocation property value. The datacenter used for media path in non-bypass call.

Parameters:

  • value

    Value to set for the mediaPathLocation property.

Returns:

  • a void



347
348
349
# File 'lib/models/call_records_direct_routing_log_row.rb', line 347

def media_path_location=(value)
    @media_path_location = value
end

#odata_typeObject

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



354
355
356
# File 'lib/models/call_records_direct_routing_log_row.rb', line 354

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value

    Value to set for the @odata.type property.

Returns:

  • a void



362
363
364
# File 'lib/models/call_records_direct_routing_log_row.rb', line 362

def odata_type=(value)
    @odata_type = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# File 'lib/models/call_records_direct_routing_log_row.rb', line 370

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_number_value("callEndSubReason", @call_end_sub_reason)
    writer.write_string_value("callType", @call_type)
    writer.write_string_value("calleeNumber", @callee_number)
    writer.write_string_value("callerNumber", @caller_number)
    writer.write_string_value("correlationId", @correlation_id)
    writer.write_number_value("duration", @duration)
    writer.write_date_time_value("endDateTime", @end_date_time)
    writer.write_date_time_value("failureDateTime", @failure_date_time)
    writer.write_number_value("finalSipCode", @final_sip_code)
    writer.write_string_value("finalSipCodePhrase", @final_sip_code_phrase)
    writer.write_string_value("id", @id)
    writer.write_date_time_value("inviteDateTime", @invite_date_time)
    writer.write_boolean_value("mediaBypassEnabled", @media_bypass_enabled)
    writer.write_string_value("mediaPathLocation", @media_path_location)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_string_value("signalingLocation", @signaling_location)
    writer.write_date_time_value("startDateTime", @start_date_time)
    writer.write_boolean_value("successfulCall", @successful_call)
    writer.write_string_value("trunkFullyQualifiedDomainName", @trunk_fully_qualified_domain_name)
    writer.write_string_value("userDisplayName", @user_display_name)
    writer.write_string_value("userId", @user_id)
    writer.write_string_value("userPrincipalName", @user_principal_name)
    writer.write_additional_data(@additional_data)
end

#signaling_locationObject

Gets the signalingLocation property value. The datacenter used for signaling for both bypass and non-bypass calls.

Returns:

  • a string



400
401
402
# File 'lib/models/call_records_direct_routing_log_row.rb', line 400

def signaling_location
    return @signaling_location
end

#signaling_location=(value) ⇒ Object

Sets the signalingLocation property value. The datacenter used for signaling for both bypass and non-bypass calls.

Parameters:

  • value

    Value to set for the signalingLocation property.

Returns:

  • a void



408
409
410
# File 'lib/models/call_records_direct_routing_log_row.rb', line 408

def signaling_location=(value)
    @signaling_location = value
end

#start_date_timeObject

Gets the startDateTime property value. Call start time.For failed and unanswered calls, this can be equal to invite or failure time.

Returns:

  • a date_time



415
416
417
# File 'lib/models/call_records_direct_routing_log_row.rb', line 415

def start_date_time
    return @start_date_time
end

#start_date_time=(value) ⇒ Object

Sets the startDateTime property value. Call start time.For failed and unanswered calls, this can be equal to invite or failure time.

Parameters:

  • value

    Value to set for the startDateTime property.

Returns:

  • a void



423
424
425
# File 'lib/models/call_records_direct_routing_log_row.rb', line 423

def start_date_time=(value)
    @start_date_time = value
end

#successful_callObject

Gets the successfulCall property value. Success or attempt.

Returns:

  • a boolean



430
431
432
# File 'lib/models/call_records_direct_routing_log_row.rb', line 430

def successful_call
    return @successful_call
end

#successful_call=(value) ⇒ Object

Sets the successfulCall property value. Success or attempt.

Parameters:

  • value

    Value to set for the successfulCall property.

Returns:

  • a void



438
439
440
# File 'lib/models/call_records_direct_routing_log_row.rb', line 438

def successful_call=(value)
    @successful_call = value
end

#trunk_fully_qualified_domain_nameObject

Gets the trunkFullyQualifiedDomainName property value. Fully qualified domain name of the session border controller.

Returns:

  • a string



445
446
447
# File 'lib/models/call_records_direct_routing_log_row.rb', line 445

def trunk_fully_qualified_domain_name
    return @trunk_fully_qualified_domain_name
end

#trunk_fully_qualified_domain_name=(value) ⇒ Object

Sets the trunkFullyQualifiedDomainName property value. Fully qualified domain name of the session border controller.

Parameters:

  • value

    Value to set for the trunkFullyQualifiedDomainName property.

Returns:

  • a void



453
454
455
# File 'lib/models/call_records_direct_routing_log_row.rb', line 453

def trunk_fully_qualified_domain_name=(value)
    @trunk_fully_qualified_domain_name = value
end

#user_display_nameObject

Gets the userDisplayName property value. Display name of the user.

Returns:

  • a string



460
461
462
# File 'lib/models/call_records_direct_routing_log_row.rb', line 460

def user_display_name
    return @user_display_name
end

#user_display_name=(value) ⇒ Object

Sets the userDisplayName property value. Display name of the user.

Parameters:

  • value

    Value to set for the userDisplayName property.

Returns:

  • a void



468
469
470
# File 'lib/models/call_records_direct_routing_log_row.rb', line 468

def user_display_name=(value)
    @user_display_name = value
end

#user_idObject

Gets the userId property value. Calling user’s ID in Graph. This and other user info will be null/empty for bot call types. GUID.

Returns:

  • a string



475
476
477
# File 'lib/models/call_records_direct_routing_log_row.rb', line 475

def user_id
    return @user_id
end

#user_id=(value) ⇒ Object

Sets the userId property value. Calling user’s ID in Graph. This and other user info will be null/empty for bot call types. GUID.

Parameters:

  • value

    Value to set for the userId property.

Returns:

  • a void



483
484
485
# File 'lib/models/call_records_direct_routing_log_row.rb', line 483

def user_id=(value)
    @user_id = value
end

#user_principal_nameObject

Gets the userPrincipalName property value. UserPrincipalName (sign-in name) in Azure Active Directory. This is usually the same as user’s SIP Address, and can be same as user’s e-mail address.

Returns:

  • a string



490
491
492
# File 'lib/models/call_records_direct_routing_log_row.rb', line 490

def user_principal_name
    return @user_principal_name
end

#user_principal_name=(value) ⇒ Object

Sets the userPrincipalName property value. UserPrincipalName (sign-in name) in Azure Active Directory. This is usually the same as user’s SIP Address, and can be same as user’s e-mail address.

Parameters:

  • value

    Value to set for the userPrincipalName property.

Returns:

  • a void



498
499
500
# File 'lib/models/call_records_direct_routing_log_row.rb', line 498

def user_principal_name=(value)
    @user_principal_name = value
end