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

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 User resource.

  • sid (String) —

    The SID of the Call resource to fetch.



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 776

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

Returns Indicates whether the user is active.

Returns:

  • (Boolean) —

    Indicates whether the user is active



854
855
856
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 854

def active
    @properties['active']
end

#code ⇒ String

Returns Twilio-specific error code.

Returns:

  • (String) —

    Twilio-specific error code



902
903
904
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 902

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

Returns:



809
810
811
812
813
814
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 809

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

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



915
916
917
918
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 915

def delete

    context.delete
end

#detail ⇒ String

Returns A human-readable description of the error.

Returns:

  • (String) —

    A human-readable description of the error



884
885
886
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 884

def detail
    @properties['detail']
end

#display_name ⇒ String

Returns User friendly display name.

Returns:

  • (String) —

    User friendly display name



836
837
838
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 836

def display_name
    @properties['display_name']
end

#emails ⇒ Array<UserList.ScimEmailAddress>

Returns Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

Returns:

  • (Array<UserList.ScimEmailAddress>) —

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.



848
849
850
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 848

def emails
    @properties['emails']
end

#external_id ⇒ String

Returns External unique resource id defined by provisioning client.

Returns:

  • (String) —

    External unique resource id defined by provisioning client



824
825
826
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 824

def external_id
    @properties['external_id']
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



923
924
925
926
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 923

def fetch

    context.fetch
end

#id ⇒ String

Returns Unique Twilio user sid.

Returns:

  • (String) —

    Unique Twilio user sid



818
819
820
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 818

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



969
970
971
972
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 969

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

#locale ⇒ String

Returns User's locale.

Returns:

  • (String) —

    User's locale



860
861
862
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 860

def locale
    @properties['locale']
end

#meta ⇒ UserList.ScimMeta

Returns:



878
879
880
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 878

def meta
    @properties['meta']
end

#more_info ⇒ String

Returns Link to Error Code References.

Returns:

  • (String) —

    Link to Error Code References



908
909
910
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 908

def more_info
    @properties['more_info']
end

#name ⇒ UserList.ScimName

Returns:



842
843
844
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 842

def name
    @properties['name']
end

#patch(if_match: :unset, scim_patch_request: nil) ⇒ UserInstance

Patch the UserInstance

Parameters:

  • if_match (String) (defaults to: :unset)
  • scim_patch_request (ScimPatchRequest) (defaults to: nil)

Returns:



933
934
935
936
937
938
939
940
941
942
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 933

def patch(
  if_match: :unset,
  scim_patch_request: nil
)

    context.patch(
        if_match: if_match, 
        scim_patch_request: scim_patch_request, 
    )
end

#schemas ⇒ Array<String>

Returns An array of URIs that indicate the schemas supported for this user resource.

Returns:

  • (Array<String>) —

    An array of URIs that indicate the schemas supported for this user resource



872
873
874
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 872

def schemas
    @properties['schemas']
end

#scim_type ⇒ String

Returns A scimType error code as defined in RFC7644.

Returns:

  • (String) —

    A scimType error code as defined in RFC7644



890
891
892
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 890

def scim_type
    @properties['scim_type']
end

#status ⇒ String

Returns Http status code.

Returns:

  • (String) —

    Http status code



896
897
898
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 896

def status
    @properties['status']
end

#timezone ⇒ String

Returns User's time zone.

Returns:

  • (String) —

    User's time zone



866
867
868
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 866

def timezone
    @properties['timezone']
end

#to_s ⇒ Object

Provide a user friendly representation



962
963
964
965
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 962

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

Parameters:

  • if_match (String) (defaults to: :unset)
  • scim_user (ScimUser) (defaults to: nil)

Returns:



949
950
951
952
953
954
955
956
957
958
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 949

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

    context.update(
        if_match: if_match, 
        scim_user: scim_user, 
    )
end

#user_name ⇒ String

Returns Unique username, MUST be same as primary email address.

Returns:

  • (String) —

    Unique username, MUST be same as primary email address



830
831
832
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 830

def user_name
    @properties['user_name']
end