Class: Twilio::REST::PreviewIam::Versionless::OrganizationContext::UserInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, organization_sid: nil, id: nil) ⇒ UserInstance

Initialize the UserInstance



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 581

def initialize(version, payload , organization_sid: nil, id: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'id' => payload['id'],
        'external_id' => payload['external_id'],
        'user_name' => payload['user_name'],
        'display_name' => payload['display_name'],
        'name' => payload['name'],
        'emails' => payload['emails'],
        'active' => payload['active'],
        'locale' => payload['locale'],
        'timezone' => payload['timezone'],
        'schemas' => payload['schemas'],
        'meta' => payload['meta'],
        'detail' => payload['detail'],
        'scim_type' => payload['scim_type'],
        'status' => payload['status'],
        'code' => payload['code'],
        'more_info' => payload['more_info'],
    }

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

Instance Method Details

#active ⇒ Boolean 



659
660
661
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 659

def active
    @properties['active']
end

#code ⇒ String 



707
708
709
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 707

def code
    @properties['code']
end

#context ⇒ UserContext

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



614
615
616
617
618
619
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 614

def context
    unless @instance_context
        @instance_context = UserContext.new(@version , @params['organization_sid'], @params['id'])
    end
    @instance_context
end

#delete ⇒ Boolean

Delete the UserInstance



720
721
722
723
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 720

def delete

    context.delete
end

#detail ⇒ String 



689
690
691
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 689

def detail
    @properties['detail']
end

#display_name ⇒ String 



641
642
643
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 641

def display_name
    @properties['display_name']
end

#emails ⇒ Array<UserList.ScimEmailAddress> 



653
654
655
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 653

def emails
    @properties['emails']
end

#external_id ⇒ String 



629
630
631
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 629

def external_id
    @properties['external_id']
end

#fetch ⇒ UserInstance

Fetch the UserInstance



728
729
730
731
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 728

def fetch

    context.fetch
end

#id ⇒ String 



623
624
625
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 623

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



756
757
758
759
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 756

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

#locale ⇒ String 



665
666
667
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 665

def locale
    @properties['locale']
end

#meta ⇒ UserList.ScimMeta 



683
684
685
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 683

def meta
    @properties['meta']
end

#more_info ⇒ String 



713
714
715
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 713

def more_info
    @properties['more_info']
end

#name ⇒ UserList.ScimName 



647
648
649
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 647

def name
    @properties['name']
end

#schemas ⇒ Array<String> 



677
678
679
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 677

def schemas
    @properties['schemas']
end

#scim_type ⇒ String 



695
696
697
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 695

def scim_type
    @properties['scim_type']
end

#status ⇒ String 



701
702
703
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 701

def status
    @properties['status']
end

#timezone ⇒ String 



671
672
673
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 671

def timezone
    @properties['timezone']
end

#to_s ⇒ Object

Provide a user friendly representation



749
750
751
752
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 749

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

#update(if_match: :unset, scim_user: nil) ⇒ UserInstance

Update the UserInstance



738
739
740
741
742
743
744
745
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 738

def update(
    if_match: :unset,scim_user: nil
)

    context.update(
        if_match: if_match, 
    )
end

#user_name ⇒ String 



635
636
637
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 635

def user_name
    @properties['user_name']
end