Class: Twilio::REST::Memory::V1::ImportInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/memory/v1/import.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, store_id: nil, import_id: nil) ⇒ ImportInstance

Initialize the ImportInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Import resource.

  • sid (String) —

    The SID of the Call resource to fetch.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 453

def initialize(version, payload , store_id: nil, import_id: nil)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    
    # Marshaled Properties
    @properties = { 
        'import_id' => payload['import_id'],
        'url' => payload['url'],
        'status' => payload['status'],
        'filename' => payload['filename'],
        'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
        'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
        'file_size' => payload['file_size'] == nil ? payload['file_size'] : payload['file_size'].to_i,
        'column_mappings' => payload['column_mappings'],
        'summary' => payload['summary'],
        'imports' => payload['imports'],
    }

    # Context
    @instance_context = nil
    @params = { 'store_id' => store_id  || @properties['store_id']  ,'import_id' => import_id  || @properties['import_id']  , }
end

Instance Method Details

#column_mappings ⇒ Array<ColumnMappingItem>

Returns Mappings of CSV header columns to traits’ fields.

Returns:

  • (Array<ColumnMappingItem>) —

    Mappings of CSV header columns to traits’ fields



532
533
534
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 532

def column_mappings
    @properties['column_mappings']
end

#context ⇒ ImportContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



481
482
483
484
485
486
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 481

def context
    unless @instance_context
        @instance_context = ImportContext.new(@version , @params['store_id'], @params['import_id'])
    end
    @instance_context
end

#created_at ⇒ Time

Returns Timestamp when the import was created.

Returns:

  • (Time) —

    Timestamp when the import was created



514
515
516
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 514

def created_at
    @properties['created_at']
end

#fetch ⇒ ImportInstance

Fetch the ImportInstance

Returns:



551
552
553
554
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 551

def fetch

    context.fetch
end

#file_size ⇒ String

Returns Size of the uploaded file in bytes (1 byte to 100 MiB).

Returns:

  • (String) —

    Size of the uploaded file in bytes (1 byte to 100 MiB)



526
527
528
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 526

def file_size
    @properties['file_size']
end

#filename ⇒ String

Returns Original filename of the uploaded CSV.

Returns:

  • (String) —

    Original filename of the uploaded CSV



508
509
510
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 508

def filename
    @properties['filename']
end

#import_id ⇒ String

Returns ID of the import task.

Returns:

  • (String) —

    ID of the import task.



490
491
492
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 490

def import_id
    @properties['import_id']
end

#imports ⇒ Array<String>

Returns:

  • (Array<String>) 


544
545
546
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 544

def imports
    @properties['imports']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



565
566
567
568
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 565

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Memory.V1.ImportInstance #{values}>"
end

#status ⇒ String

Returns Current processing status of the import task.

Returns:

  • (String) —

    Current processing status of the import task



502
503
504
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 502

def status
    @properties['status']
end

#summary ⇒ FetchProfileImportV2200ResponseSummary

Returns:

  • (FetchProfileImportV2200ResponseSummary) 


538
539
540
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 538

def summary
    @properties['summary']
end

#to_s ⇒ Object

Provide a user friendly representation



558
559
560
561
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 558

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Memory.V1.ImportInstance #{values}>"
end

#updated_at ⇒ Time

Returns Timestamp when the import was last updated.

Returns:

  • (Time) —

    Timestamp when the import was last updated



520
521
522
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 520

def updated_at
    @properties['updated_at']
end

#url ⇒ String

Returns Pre-signed URL to upload the CSV via a single PUT request.

Returns:

  • (String) —

    Pre-signed URL to upload the CSV via a single PUT request.



496
497
498
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 496

def url
    @properties['url']
end