Class: Twilio::REST::Conversations::V1::ConfigurationContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/configuration.rb,
lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb

Defined Under Namespace

Classes: WebhookContext, WebhookInstance, WebhookList, WebhookPage

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ConfigurationContext

Initialize the ConfigurationContext

Parameters:

  • version (Version) —

    Version that contains the resource



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 47

def initialize(version)
    super(version)

    # Path Solution
    @solution = {  }
    @uri = "/Configuration"

    # Dependents
    @webhooks = nil
end

Instance Method Details

#fetch ⇒ ConfigurationInstance

Fetch the ConfigurationInstance

Returns:



60
61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 60

def fetch

    payload = @version.fetch('GET', @uri)
    ConfigurationInstance.new(
        @version,
        payload,
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



116
117
118
119
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 116

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



109
110
111
112
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 109

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
end

#update(default_chat_service_sid: :unset, default_messaging_service_sid: :unset, default_inactive_timer: :unset, default_closed_timer: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstance

Parameters:

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

    The SID of the default [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.

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

    The SID of the default [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.

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

    Default ISO8601 duration when conversation will be switched to ‘inactive` state. Minimum value for this timer is 1 minute.

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

    Default ISO8601 duration when conversation will be switched to ‘closed` state. Minimum value for this timer is 10 minutes.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 76

def update(
    default_chat_service_sid: :unset, 
    default_messaging_service_sid: :unset, 
    default_inactive_timer: :unset, 
    default_closed_timer: :unset
)

    data = Twilio::Values.of({
        'DefaultChatServiceSid' => default_chat_service_sid,
        'DefaultMessagingServiceSid' => default_messaging_service_sid,
        'DefaultInactiveTimer' => default_inactive_timer,
        'DefaultClosedTimer' => default_closed_timer,
    })

    payload = @version.update('POST', @uri, data: data)
    ConfigurationInstance.new(
        @version,
        payload,
    )
end

#webhooks ⇒ WebhookList, WebhookContext

Access the webhooks

Returns:



101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 101

def webhooks
    WebhookContext.new(
            @version
            )
end