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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil) ⇒ WebhookInstance

Initialize the WebhookInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • chat_service_sid (String) (defaults to: nil)

    The unique string that we created to identify the Service configuration resource.


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 144

def initialize(version, payload, chat_service_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'chat_service_sid' => payload['chat_service_sid'],
      'pre_webhook_url' => payload['pre_webhook_url'],
      'post_webhook_url' => payload['post_webhook_url'],
      'filters' => payload['filters'],
      'method' => payload['method'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'chat_service_sid' => chat_service_sid, }
end

Instance Method Details

#account_sidString

Returns The unique ID of the Account responsible for this service.

Returns:

  • (String)

    The unique ID of the Account responsible for this service.


176
177
178
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 176

def 
  @properties['account_sid']
end

#chat_service_sidString

Returns The unique ID of the Conversation Service this conversation belongs to.

Returns:


182
183
184
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 182

def chat_service_sid
  @properties['chat_service_sid']
end

#contextWebhookContext

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

Returns:


167
168
169
170
171
172
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 167

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

#fetchWebhookInstance

Fetch the WebhookInstance

Returns:


246
247
248
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 246

def fetch
  context.fetch
end

#filtersArray[String]

Returns The list of events that your configured webhook targets will receive. Events not configured here will not fire.

Returns:

  • (Array[String])

    The list of events that your configured webhook targets will receive. Events not configured here will not fire.


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

def filters
  @properties['filters']
end

#inspectObject

Provide a detailed, user friendly representation


259
260
261
262
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 259

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

#methodwebhook.Method

Returns The HTTP method to be used when sending a webhook request.

Returns:

  • (webhook.Method)

    The HTTP method to be used when sending a webhook request


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

def method
  @properties['method']
end

#post_webhook_urlString

Returns The absolute url the post-event webhook request should be sent to.

Returns:

  • (String)

    The absolute url the post-event webhook request should be sent to.


194
195
196
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 194

def post_webhook_url
  @properties['post_webhook_url']
end

#pre_webhook_urlString

Returns The absolute url the pre-event webhook request should be sent to.

Returns:

  • (String)

    The absolute url the pre-event webhook request should be sent to.


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

def pre_webhook_url
  @properties['pre_webhook_url']
end

#to_sObject

Provide a user friendly representation


252
253
254
255
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 252

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

#update(pre_webhook_url: :unset, post_webhook_url: :unset, filters: :unset, method: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

  • pre_webhook_url (String) (defaults to: :unset)

    The absolute url the pre-event webhook request should be sent to.

  • post_webhook_url (String) (defaults to: :unset)

    The absolute url the post-event webhook request should be sent to.

  • filters (Array[String]) (defaults to: :unset)

    The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are `onParticipantAdd`, `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`, `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`, `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`, `onConversationAdded`, `onMessageAdded`, `onConversationAdd`, `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`, `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or `onConversationStateUpdated`.

  • method (String) (defaults to: :unset)

    The HTTP method to be used when sending a webhook request. One of `GET` or `POST`.

Returns:


234
235
236
237
238
239
240
241
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 234

def update(pre_webhook_url: :unset, post_webhook_url: :unset, filters: :unset, method: :unset)
  context.update(
      pre_webhook_url: pre_webhook_url,
      post_webhook_url: post_webhook_url,
      filters: filters,
      method: method,
  )
end

#urlString

Returns An absolute URL for this webhook.

Returns:

  • (String)

    An absolute URL for this webhook.


212
213
214
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb', line 212

def url
  @properties['url']
end