Class: Twilio::REST::Trusthub::V1::CustomerProfilesInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ CustomerProfilesInstance

Initialize the CustomerProfilesInstance

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

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 641

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'policy_sid' => payload['policy_sid'],
        'friendly_name' => payload['friendly_name'],
        'status' => payload['status'],
        'valid_until' => Twilio.deserialize_iso8601_datetime(payload['valid_until']),
        'email' => payload['email'],
        'status_callback' => payload['status_callback'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
        'errors' => payload['errors'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Customer-Profile resource.

Returns:



686
687
688
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 686

def 
    @properties['account_sid']
end

#context ⇒ CustomerProfilesContext

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

Returns:



671
672
673
674
675
676
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 671

def context
    unless @instance_context
        @instance_context = CustomerProfilesContext.new(@version , @params['sid'])
    end
    @instance_context
end

#customer_profiles_channel_endpoint_assignment ⇒ customer_profiles_channel_endpoint_assignment

Access the customer_profiles_channel_endpoint_assignment

Returns:



797
798
799
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 797

def customer_profiles_channel_endpoint_assignment
    context.customer_profiles_channel_endpoint_assignment
end

#customer_profiles_entity_assignments ⇒ customer_profiles_entity_assignments

Access the customer_profiles_entity_assignments

Returns:



804
805
806
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 804

def customer_profiles_entity_assignments
    context.customer_profiles_entity_assignments
end

#customer_profiles_evaluations ⇒ customer_profiles_evaluations

Access the customer_profiles_evaluations

Returns:



811
812
813
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 811

def customer_profiles_evaluations
    context.customer_profiles_evaluations
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



728
729
730
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 728

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



734
735
736
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 734

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CustomerProfilesInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



759
760
761
762
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 759

def delete

    context.delete
end

#email ⇒ String

Returns The email address that will receive updates when the Customer-Profile resource changes status.

Returns:

  • (String) —

    The email address that will receive updates when the Customer-Profile resource changes status.



716
717
718
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 716

def email
    @properties['email']
end

#errors ⇒ Array<Hash>

Returns The error codes associated with the rejection of the Customer-Profile.

Returns:

  • (Array<Hash>) —

    The error codes associated with the rejection of the Customer-Profile.



752
753
754
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 752

def errors
    @properties['errors']
end

#fetch ⇒ CustomerProfilesInstance

Fetch the CustomerProfilesInstance

Returns:



767
768
769
770
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 767

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



698
699
700
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 698

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



824
825
826
827
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 824

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

#links ⇒ Hash

Returns The URLs of the Assigned Items of the Customer-Profile resource.

Returns:

  • (Hash) —

    The URLs of the Assigned Items of the Customer-Profile resource.



746
747
748
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 746

def links
    @properties['links']
end

#policy_sid ⇒ String

Returns The unique string of a policy that is associated to the Customer-Profile resource.

Returns:

  • (String) —

    The unique string of a policy that is associated to the Customer-Profile resource.



692
693
694
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 692

def policy_sid
    @properties['policy_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Customer-Profile resource.

Returns:

  • (String) —

    The unique string that we created to identify the Customer-Profile resource.



680
681
682
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 680

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


704
705
706
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 704

def status
    @properties['status']
end

#status_callback ⇒ String

Returns The URL we call to inform your application of status changes.

Returns:

  • (String) —

    The URL we call to inform your application of status changes.



722
723
724
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 722

def status_callback
    @properties['status_callback']
end

#to_s ⇒ Object

Provide a user friendly representation



817
818
819
820
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 817

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

#update(status: :unset, status_callback: :unset, friendly_name: :unset, email: :unset) ⇒ CustomerProfilesInstance

Update the CustomerProfilesInstance

Parameters:

  • status (Status) (defaults to: :unset)
  • status_callback (String) (defaults to: :unset) —

    The URL we call to inform your application of status changes.

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource.

  • email (String) (defaults to: :unset) —

    The email address that will receive updates when the Customer-Profile resource changes status.

Returns:



779
780
781
782
783
784
785
786
787
788
789
790
791
792
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 779

def update(
    status: :unset, 
    status_callback: :unset, 
    friendly_name: :unset, 
    email: :unset
)

    context.update(
        status: status, 
        status_callback: status_callback, 
        friendly_name: friendly_name, 
        email: email, 
    )
end

#url ⇒ String

Returns The absolute URL of the Customer-Profile resource.

Returns:

  • (String) —

    The absolute URL of the Customer-Profile resource.



740
741
742
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 740

def url
    @properties['url']
end

#valid_until ⇒ Time

Returns The date and time in GMT in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.

Returns:



710
711
712
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 710

def valid_until
    @properties['valid_until']
end