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.



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 469

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'],
        'meta' => payload['meta'],
    }

    # 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



549
550
551
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 549

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:



498
499
500
501
502
503
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 498

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



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

def created_at
    @properties['created_at']
end

#fetch ⇒ ImportInstance

Fetch the ImportInstance

Returns:



574
575
576
577
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 574

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)



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

def file_size
    @properties['file_size']
end

#filename ⇒ String

Returns Original filename of the uploaded CSV.

Returns:

  • (String) —

    Original filename of the uploaded CSV



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

def filename
    @properties['filename']
end

#import_id ⇒ String

Returns ID of the import task.

Returns:

  • (String) —

    ID of the import task.



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

def import_id
    @properties['import_id']
end

#imports ⇒ Array<String>

Returns:

  • (Array<String>) 


561
562
563
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 561

def imports
    @properties['imports']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



588
589
590
591
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 588

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

#meta ⇒ ListProfileImportsV2200ResponseMeta

Returns:

  • (ListProfileImportsV2200ResponseMeta) 


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

def meta
    @properties['meta']
end

#status ⇒ String

Returns Current processing status of the import task.

Returns:

  • (String) —

    Current processing status of the import task



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

def status
    @properties['status']
end

#summary ⇒ FetchProfileImportV2200ResponseSummary

Returns:

  • (FetchProfileImportV2200ResponseSummary) 


555
556
557
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 555

def summary
    @properties['summary']
end

#to_s ⇒ Object

Provide a user friendly representation



581
582
583
584
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 581

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



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

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.



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

def url
    @properties['url']
end