## # This code was generated by # ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ # | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ # | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ # # Twilio - Conversations # This is the public Twilio REST API. # # NOTE: This class is auto generated by OpenAPI Generator. # https://openapi-generator.tech # Do not edit the class manually. # module Twilio module REST class Conversations < ConversationsBase class V1 < Version class ServiceContext < InstanceContext class ConfigurationContext < InstanceContext class WebhookList < ListResource ## # Initialize the WebhookList # @param [Version] version Version that contains the resource # @return [WebhookList] WebhookList def initialize(version, chat_service_sid: nil) super(version) # Path Solution @solution = { chat_service_sid: chat_service_sid } end # Provide a user friendly representation def to_s '#' end end class WebhookContext < InstanceContext ## # Initialize the WebhookContext # @param [Version] version Version that contains the resource # @param [String] chat_service_sid The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. # @return [WebhookContext] WebhookContext def initialize(version, chat_service_sid) super(version) # Path Solution @solution = { chat_service_sid: chat_service_sid, } @uri = "/Services/#{@solution[:chat_service_sid]}/Configuration/Webhooks" end ## # Fetch the WebhookInstance # @return [WebhookInstance] Fetched WebhookInstance def fetch headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', }) payload = @version.fetch('GET', @uri, headers: headers) WebhookInstance.new( @version, payload, chat_service_sid: @solution[:chat_service_sid], ) end ## # Update the WebhookInstance # @param [String] pre_webhook_url The absolute url the pre-event webhook request should be sent to. # @param [String] post_webhook_url The absolute url the post-event webhook request should be sent to. # @param [Array[String]] filters 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`. # @param [String] method The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. # @return [WebhookInstance] Updated WebhookInstance def update( pre_webhook_url: :unset, post_webhook_url: :unset, filters: :unset, method: :unset ) data = Twilio::Values.of({ 'PreWebhookUrl' => pre_webhook_url, 'PostWebhookUrl' => post_webhook_url, 'Filters' => Twilio.serialize_list(filters) { |e| e }, 'Method' => method, }) headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', }) payload = @version.update('POST', @uri, data: data, headers: headers) WebhookInstance.new( @version, payload, chat_service_sid: @solution[:chat_service_sid], ) end ## # Provide a user friendly representation def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end ## # Provide a detailed, user friendly representation def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end end class WebhookPage < Page ## # Initialize the WebhookPage # @param [Version] version Version that contains the resource # @param [Response] response Response from the API # @param [Hash] solution Path solution for the resource # @return [WebhookPage] WebhookPage def initialize(version, response, solution) super(version, response) # Path Solution @solution = solution end ## # Build an instance of WebhookInstance # @param [Hash] payload Payload response from the API # @return [WebhookInstance] WebhookInstance def get_instance(payload) WebhookInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid]) end ## # Provide a user friendly representation def to_s '' end end class WebhookInstance < InstanceResource ## # Initialize the WebhookInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Webhook # resource. # @param [String] sid The SID of the Call resource to fetch. # @return [WebhookInstance] WebhookInstance 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 || @properties['chat_service_sid'] , } end ## # Generate an instance context for the instance, the context is capable of # performing various actions. All instance actions are proxied to the context # @return [WebhookContext] CallContext for this CallInstance def context unless @instance_context @instance_context = WebhookContext.new(@version , @params['chat_service_sid']) end @instance_context end ## # @return [String] The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service. def account_sid @properties['account_sid'] end ## # @return [String] The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. def chat_service_sid @properties['chat_service_sid'] end ## # @return [String] The absolute url the pre-event webhook request should be sent to. def pre_webhook_url @properties['pre_webhook_url'] end ## # @return [String] The absolute url the post-event webhook request should be sent to. def post_webhook_url @properties['post_webhook_url'] end ## # @return [Array] 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`. def filters @properties['filters'] end ## # @return [Method] def method @properties['method'] end ## # @return [String] An absolute API resource URL for this webhook. def url @properties['url'] end ## # Fetch the WebhookInstance # @return [WebhookInstance] Fetched WebhookInstance def fetch context.fetch end ## # Update the WebhookInstance # @param [String] pre_webhook_url The absolute url the pre-event webhook request should be sent to. # @param [String] post_webhook_url The absolute url the post-event webhook request should be sent to. # @param [Array[String]] filters 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`. # @param [String] method The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. # @return [WebhookInstance] Updated WebhookInstance 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 ## # Provide a user friendly representation def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "" end ## # Provide a detailed, user friendly representation def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "" end end end end end end end end