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

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

Defined Under Namespace

Classes: NotificationContext, NotificationInstance, NotificationInstanceMetadata, NotificationList, NotificationListResponse, NotificationPage, NotificationPageMetadata, WebhookContext, WebhookInstance, WebhookInstanceMetadata, WebhookList, WebhookListResponse, WebhookPage, WebhookPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid) ⇒ ConfigurationContext

Initialize the ConfigurationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • chat_service_sid (String) —

    The SID of the Service configuration resource to update.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 52

def initialize(version, chat_service_sid)
    super(version)
    

    # Path Solution
    @solution = { chat_service_sid: chat_service_sid,  }
    @uri = "/Services/#{@solution[:chat_service_sid]}/Configuration"

    # Dependents
    @webhooks = nil
    @notifications = nil
end

Instance Method Details

#fetch ⇒ ConfigurationInstance

Fetch the ConfigurationInstance

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 67

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ConfigurationInstance.new(
        @version,
        payload,
        chat_service_sid: @solution[:chat_service_sid],
    )
end

#fetch_with_metadata ⇒ ConfigurationInstance

Fetch the ConfigurationInstanceMetadata

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 86

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    configuration_instance = ConfigurationInstance.new(
        @version,
        response.body,
        chat_service_sid: @solution[:chat_service_sid],
    )
    ConfigurationInstanceMetadata.new(
        @version,
        configuration_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



214
215
216
217
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 214

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

#notifications ⇒ NotificationList, NotificationContext

Access the notifications

Returns:



198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 198

def notifications
    NotificationContext.new(
            @version,
            @solution[:chat_service_sid]
            )
end

#to_s ⇒ Object

Provide a user friendly representation



207
208
209
210
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 207

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

#update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstance

Parameters:

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 115

def update(
    default_conversation_creator_role_sid: :unset, 
    default_conversation_role_sid: :unset, 
    default_chat_service_role_sid: :unset, 
    reachability_enabled: :unset
)

    data = Twilio::Values.of({
        'DefaultConversationCreatorRoleSid' => default_conversation_creator_role_sid,
        'DefaultConversationRoleSid' => default_conversation_role_sid,
        'DefaultChatServiceRoleSid' => default_chat_service_role_sid,
        'ReachabilityEnabled' => reachability_enabled,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ConfigurationInstance.new(
        @version,
        payload,
        chat_service_sid: @solution[:chat_service_sid],
    )
end

#update_with_metadata(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstanceMetadata

Parameters:

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 150

def update_with_metadata(
  default_conversation_creator_role_sid: :unset, 
  default_conversation_role_sid: :unset, 
  default_chat_service_role_sid: :unset, 
  reachability_enabled: :unset
)

    data = Twilio::Values.of({
        'DefaultConversationCreatorRoleSid' => default_conversation_creator_role_sid,
        'DefaultConversationRoleSid' => default_conversation_role_sid,
        'DefaultChatServiceRoleSid' => default_chat_service_role_sid,
        'ReachabilityEnabled' => reachability_enabled,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    configuration_instance = ConfigurationInstance.new(
        @version,
        response.body,
        chat_service_sid: @solution[:chat_service_sid],
    )
    ConfigurationInstanceMetadata.new(
        @version,
        configuration_instance,
        response.headers,
        response.status_code
    )
end

#webhooks ⇒ WebhookList, WebhookContext

Access the webhooks

Returns:



188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 188

def webhooks
    WebhookContext.new(
            @version,
            @solution[:chat_service_sid]
            )
end