Class: MicrosoftGraph::Models::CallRecordsPstnCallLogRow

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new callRecordsPstnCallLogRow and sets the default values.



224
225
226
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 224

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_pstn_call_log_row

Raises:

  • (StandardError) 


232
233
234
235
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 232

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

Instance Method Details

#additional_data ⇒ Object

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



89
90
91
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 89

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



97
98
99
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 97

def additional_data=(value)
    @additional_data = value
end

#call_duration_source ⇒ Object

Gets the callDurationSource property value. The source of the call duration data. If the call uses a third-party telecommunications operator via the Operator Connect Program, the operator may provide their own call duration data. In this case, the property value is operator. Otherwise, the value is microsoft.

Returns:

  • a call_records_pstn_call_duration_source



104
105
106
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 104

def call_duration_source
    return @call_duration_source
end

#call_duration_source=(value) ⇒ Object

Sets the callDurationSource property value. The source of the call duration data. If the call uses a third-party telecommunications operator via the Operator Connect Program, the operator may provide their own call duration data. In this case, the property value is operator. Otherwise, the value is microsoft.

Parameters:

  • value —

    Value to set for the callDurationSource property.

Returns:

  • a void



112
113
114
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 112

def call_duration_source=(value)
    @call_duration_source = value
end

#call_id ⇒ Object

Gets the callId property value. Call identifier. Not guaranteed to be unique.

Returns:

  • a string



119
120
121
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 119

def call_id
    return @call_id
end

#call_id=(value) ⇒ Object

Sets the callId property value. Call identifier. Not guaranteed to be unique.

Parameters:

  • value —

    Value to set for the callId property.

Returns:

  • a void



127
128
129
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 127

def call_id=(value)
    @call_id = value
end

#call_type ⇒ Object

Gets the callType property value. Whether the call was a PSTN outbound or inbound call and the type of call such as a call placed by a user or an audio conference.

Returns:

  • a string



134
135
136
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 134

def call_type
    return @call_type
end

#call_type=(value) ⇒ Object

Sets the callType property value. Whether the call was a PSTN outbound or inbound call and the type of call such as a call placed by a user or an audio conference.

Parameters:

  • value —

    Value to set for the callType property.

Returns:

  • a void



142
143
144
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 142

def call_type=(value)
    @call_type = value
end

#callee_number ⇒ Object

Gets the calleeNumber property value. Number dialed in E.164 format.

Returns:

  • a string



149
150
151
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 149

def callee_number
    return @callee_number
end

#callee_number=(value) ⇒ Object

Sets the calleeNumber property value. Number dialed in E.164 format.

Parameters:

  • value —

    Value to set for the calleeNumber property.

Returns:

  • a void



157
158
159
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 157

def callee_number=(value)
    @callee_number = value
end

#caller_number ⇒ Object

Gets the callerNumber property value. Number that received the call for inbound calls or the number dialed for outbound calls. E.164 format.

Returns:

  • a string



164
165
166
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 164

def caller_number
    return @caller_number
end

#caller_number=(value) ⇒ Object

Sets the callerNumber property value. Number that received the call for inbound calls or the number dialed for outbound calls. E.164 format.

Parameters:

  • value —

    Value to set for the callerNumber property.

Returns:

  • a void



172
173
174
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 172

def caller_number=(value)
    @caller_number = value
end

#charge ⇒ Object

Gets the charge property value. Amount of money or cost of the call that is charged to your account.

Returns:

  • a decimal



179
180
181
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 179

def charge
    return @charge
end

#charge=(value) ⇒ Object

Sets the charge property value. Amount of money or cost of the call that is charged to your account.

Parameters:

  • value —

    Value to set for the charge property.

Returns:

  • a void



187
188
189
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 187

def charge=(value)
    @charge = value
end

#conference_id ⇒ Object

Gets the conferenceId property value. ID of the audio conference.

Returns:

  • a string



194
195
196
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 194

def conference_id
    return @conference_id
end

#conference_id=(value) ⇒ Object

Sets the conferenceId property value. ID of the audio conference.

Parameters:

  • value —

    Value to set for the conferenceId property.

Returns:

  • a void



202
203
204
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 202

def conference_id=(value)
    @conference_id = value
end

#connection_charge ⇒ Object

Gets the connectionCharge property value. Connection fee price.

Returns:

  • a decimal



209
210
211
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 209

def connection_charge
    return @connection_charge
end

#connection_charge=(value) ⇒ Object

Sets the connectionCharge property value. Connection fee price.

Parameters:

  • value —

    Value to set for the connectionCharge property.

Returns:

  • a void



217
218
219
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 217

def connection_charge=(value)
    @connection_charge = value
end

#currency ⇒ Object

Gets the currency property value. Type of currency used to calculate the cost of the call. For details, see (ISO 4217.

Returns:

  • a string



240
241
242
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 240

def currency
    return @currency
end

#currency=(value) ⇒ Object

Sets the currency property value. Type of currency used to calculate the cost of the call. For details, see (ISO 4217.

Parameters:

  • value —

    Value to set for the currency property.

Returns:

  • a void



248
249
250
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 248

def currency=(value)
    @currency = value
end

#destination_context ⇒ Object

Gets the destinationContext property value. Whether the call was domestic (within a country or region) or international (outside a country or region) based on the user’s location.

Returns:

  • a string



255
256
257
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 255

def destination_context
    return @destination_context
end

#destination_context=(value) ⇒ Object

Sets the destinationContext property value. Whether the call was domestic (within a country or region) or international (outside a country or region) based on the user’s location.

Parameters:

  • value —

    Value to set for the destinationContext property.

Returns:

  • a void



263
264
265
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 263

def destination_context=(value)
    @destination_context = value
end

#destination_name ⇒ Object

Gets the destinationName property value. Country or region dialed.

Returns:

  • a string



270
271
272
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 270

def destination_name
    return @destination_name
end

#destination_name=(value) ⇒ Object

Sets the destinationName property value. Country or region dialed.

Parameters:

  • value —

    Value to set for the destinationName property.

Returns:

  • a void



278
279
280
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 278

def destination_name=(value)
    @destination_name = value
end

#duration ⇒ Object

Gets the duration property value. How long the call was connected, in seconds.

Returns:

  • a integer



285
286
287
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 285

def duration
    return @duration
end

#duration=(value) ⇒ Object

Sets the duration property value. How long the call was connected, in seconds.

Parameters:

  • value —

    Value to set for the duration property.

Returns:

  • a void



293
294
295
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 293

def duration=(value)
    @duration = value
end

#end_date_time ⇒ Object

Gets the endDateTime property value. Call end time.

Returns:

  • a date_time



300
301
302
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 300

def end_date_time
    return @end_date_time
end

#end_date_time=(value) ⇒ Object

Sets the endDateTime property value. Call end time.

Parameters:

  • value —

    Value to set for the endDateTime property.

Returns:

  • a void



308
309
310
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 308

def end_date_time=(value)
    @end_date_time = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



315
316
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
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 315

def get_field_deserializers()
    return {
        "callDurationSource" => lambda {|n| @call_duration_source = n.get_enum_value(MicrosoftGraph::Models::CallRecordsPstnCallDurationSource) },
        "callId" => lambda {|n| @call_id = n.get_string_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() },
        "charge" => lambda {|n| @charge = n.get_object_value(lambda {|pn| Decimal.create_from_discriminator_value(pn) }) },
        "conferenceId" => lambda {|n| @conference_id = n.get_string_value() },
        "connectionCharge" => lambda {|n| @connection_charge = n.get_object_value(lambda {|pn| Decimal.create_from_discriminator_value(pn) }) },
        "currency" => lambda {|n| @currency = n.get_string_value() },
        "destinationContext" => lambda {|n| @destination_context = n.get_string_value() },
        "destinationName" => lambda {|n| @destination_name = n.get_string_value() },
        "duration" => lambda {|n| @duration = n.get_number_value() },
        "endDateTime" => lambda {|n| @end_date_time = n.get_date_time_value() },
        "id" => lambda {|n| @id = n.get_string_value() },
        "inventoryType" => lambda {|n| @inventory_type = n.get_string_value() },
        "licenseCapability" => lambda {|n| @license_capability = n.get_string_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "operator" => lambda {|n| @operator = n.get_string_value() },
        "startDateTime" => lambda {|n| @start_date_time = n.get_date_time_value() },
        "tenantCountryCode" => lambda {|n| @tenant_country_code = n.get_string_value() },
        "usageCountryCode" => lambda {|n| @usage_country_code = 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

#id ⇒ Object

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

Returns:

  • a string



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

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



355
356
357
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 355

def id=(value)
    @id = value
end

#inventory_type ⇒ Object

Gets the inventoryType property value. User’s phone number type, such as a service of toll-free number.

Returns:

  • a string



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

def inventory_type
    return @inventory_type
end

#inventory_type=(value) ⇒ Object

Sets the inventoryType property value. User’s phone number type, such as a service of toll-free number.

Parameters:

  • value —

    Value to set for the inventoryType property.

Returns:

  • a void



370
371
372
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 370

def inventory_type=(value)
    @inventory_type = value
end

#license_capability ⇒ Object

Gets the licenseCapability property value. The license used for the call.

Returns:

  • a string



377
378
379
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 377

def license_capability
    return @license_capability
end

#license_capability=(value) ⇒ Object

Sets the licenseCapability property value. The license used for the call.

Parameters:

  • value —

    Value to set for the licenseCapability property.

Returns:

  • a void



385
386
387
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 385

def license_capability=(value)
    @license_capability = value
end

#odata_type ⇒ Object

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

Returns:

  • a string



392
393
394
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 392

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



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

def odata_type=(value)
    @odata_type = value
end

#operator ⇒ Object

Gets the operator property value. The telecommunications operator which provided PSTN services for this call. This may be Microsoft, or it may be a third-party operator via the Operator Connect Program.

Returns:

  • a string



407
408
409
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 407

def operator
    return @operator
end

#operator=(value) ⇒ Object

Sets the operator property value. The telecommunications operator which provided PSTN services for this call. This may be Microsoft, or it may be a third-party operator via the Operator Connect Program.

Parameters:

  • value —

    Value to set for the operator property.

Returns:

  • a void



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

def operator=(value)
    @operator = 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) 


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
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 423

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_enum_value("callDurationSource", @call_duration_source)
    writer.write_string_value("callId", @call_id)
    writer.write_string_value("callType", @call_type)
    writer.write_string_value("calleeNumber", @callee_number)
    writer.write_string_value("callerNumber", @caller_number)
    writer.write_object_value("charge", @charge)
    writer.write_string_value("conferenceId", @conference_id)
    writer.write_object_value("connectionCharge", @connection_charge)
    writer.write_string_value("currency", @currency)
    writer.write_string_value("destinationContext", @destination_context)
    writer.write_string_value("destinationName", @destination_name)
    writer.write_number_value("duration", @duration)
    writer.write_date_time_value("endDateTime", @end_date_time)
    writer.write_string_value("id", @id)
    writer.write_string_value("inventoryType", @inventory_type)
    writer.write_string_value("licenseCapability", @license_capability)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_string_value("operator", @operator)
    writer.write_date_time_value("startDateTime", @start_date_time)
    writer.write_string_value("tenantCountryCode", @tenant_country_code)
    writer.write_string_value("usageCountryCode", @usage_country_code)
    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

#start_date_time ⇒ Object

Gets the startDateTime property value. Call start time.

Returns:

  • a date_time



455
456
457
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 455

def start_date_time
    return @start_date_time
end

#start_date_time=(value) ⇒ Object

Sets the startDateTime property value. Call start time.

Parameters:

  • value —

    Value to set for the startDateTime property.

Returns:

  • a void



463
464
465
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 463

def start_date_time=(value)
    @start_date_time = value
end

#tenant_country_code ⇒ Object

Gets the tenantCountryCode property value. Country code of the tenant. For details, see ISO 3166-1 alpha-2.

Returns:

  • a string



470
471
472
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 470

def tenant_country_code
    return @tenant_country_code
end

#tenant_country_code=(value) ⇒ Object

Sets the tenantCountryCode property value. Country code of the tenant. For details, see ISO 3166-1 alpha-2.

Parameters:

  • value —

    Value to set for the tenantCountryCode property.

Returns:

  • a void



478
479
480
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 478

def tenant_country_code=(value)
    @tenant_country_code = value
end

#usage_country_code ⇒ Object

Gets the usageCountryCode property value. Country code of the user. For details, see ISO 3166-1 alpha-2.

Returns:

  • a string



485
486
487
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 485

def usage_country_code
    return @usage_country_code
end

#usage_country_code=(value) ⇒ Object

Sets the usageCountryCode property value. Country code of the user. For details, see ISO 3166-1 alpha-2.

Parameters:

  • value —

    Value to set for the usageCountryCode property.

Returns:

  • a void



493
494
495
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 493

def usage_country_code=(value)
    @usage_country_code = value
end

#user_display_name ⇒ Object

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

Returns:

  • a string



500
501
502
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 500

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



508
509
510
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 508

def user_display_name=(value)
    @user_display_name = value
end

#user_id ⇒ Object

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

Returns:

  • a string



515
516
517
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 515

def user_id
    return @user_id
end

#user_id=(value) ⇒ Object

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

Parameters:

  • value —

    Value to set for the userId property.

Returns:

  • a void



523
524
525
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 523

def user_id=(value)
    @user_id = value
end

#user_principal_name ⇒ Object

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

Returns:

  • a string



530
531
532
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 530

def user_principal_name
    return @user_principal_name
end

#user_principal_name=(value) ⇒ Object

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

Parameters:

  • value —

    Value to set for the userPrincipalName property.

Returns:

  • a void



538
539
540
 
# File 'lib/models/call_records_pstn_call_log_row.rb', line 538

def user_principal_name=(value)
    @user_principal_name = value
end