## # This code was generated by # \ / _ _ _| _ _ # | (_)\/(_)(_|\/| |(/_ v1.0.0 # / / # # frozen_string_literal: true module Twilio module REST class Conversations < Domain class V1 < Version class ServiceContext < InstanceContext class ConversationContext < InstanceContext class WebhookList < ListResource ## # Initialize the WebhookList # @param [Version] version Version that contains the resource # @param [String] chat_service_sid The SID of the {Conversation # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @return [WebhookList] WebhookList def initialize(version, chat_service_sid: nil, conversation_sid: nil) super(version) # Path Solution @solution = {chat_service_sid: chat_service_sid, conversation_sid: conversation_sid} @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Webhooks" end ## # Create the WebhookInstance # @param [webhook.Target] target The target of this webhook: `webhook`, `studio`, # `trigger` # @param [String] configuration_url The absolute url the webhook request should be # sent to. # @param [webhook.Method] configuration_method The HTTP method to be used when # sending a webhook request. # @param [Array[String]] configuration_filters The list of events, firing webhook # event for this Conversation. # @param [Array[String]] configuration_triggers The list of keywords, firing # webhook event for this Conversation. # @param [String] configuration_flow_sid The studio flow SID, where the webhook # should be sent to. # @param [String] configuration_replay_after The message index for which and it's # successors the webhook will be replayed. Not set by default # @return [WebhookInstance] Created WebhookInstance def create(target: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_replay_after: :unset) data = Twilio::Values.of({ 'Target' => target, 'Configuration.Url' => configuration_url, 'Configuration.Method' => configuration_method, 'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e }, 'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e }, 'Configuration.FlowSid' => configuration_flow_sid, 'Configuration.ReplayAfter' => configuration_replay_after, }) payload = @version.create('POST', @uri, data: data) WebhookInstance.new( @version, payload, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:conversation_sid], ) end ## # Lists WebhookInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when # not set will use the default value of 50 records. If no page_size is defined # but a limit is defined, stream() will attempt to read the limit with the most # efficient page size, i.e. min(limit, 1000) # @return [Array] Array of up to limit results def list(limit: nil, page_size: nil) self.stream(limit: limit, page_size: page_size).entries end ## # Streams WebhookInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when # not set will use the default value of 50 records. If no page_size is defined # but a limit is defined, stream() will attempt to read the limit with the most # efficient page size, i.e. min(limit, 1000) # @return [Enumerable] Enumerable that will yield up to limit results def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end ## # When passed a block, yields WebhookInstance records from the API. # This operation lazily loads records as efficiently as possible until the limit # is reached. def each limits = @version.read_limits page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]).each {|x| yield x} end ## # Retrieve a single page of WebhookInstance records from the API. # Request is executed immediately. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 # @return [Page] Page of WebhookInstance def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) WebhookPage.new(@version, response, @solution) end ## # Retrieve a single page of WebhookInstance records from the API. # Request is executed immediately. # @param [String] target_url API-generated URL for the requested results page # @return [Page] Page of WebhookInstance def get_page(target_url) response = @version.domain.request( 'GET', target_url ) WebhookPage.new(@version, response, @solution) end ## # Provide a user friendly representation def to_s '#' 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], conversation_sid: @solution[:conversation_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 SID of the {Conversation # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. # @return [WebhookContext] WebhookContext def initialize(version, chat_service_sid, conversation_sid, sid) super(version) # Path Solution @solution = {chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, sid: sid, } @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Webhooks/#{@solution[:sid]}" end ## # Update the WebhookInstance # @param [String] configuration_url The absolute url the webhook request should be # sent to. # @param [webhook.Method] configuration_method The HTTP method to be used when # sending a webhook request. # @param [Array[String]] configuration_filters The list of events, firing webhook # event for this Conversation. # @param [Array[String]] configuration_triggers The list of keywords, firing # webhook event for this Conversation. # @param [String] configuration_flow_sid The studio flow SID, where the webhook # should be sent to. # @return [WebhookInstance] Updated WebhookInstance def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) data = Twilio::Values.of({ 'Configuration.Url' => configuration_url, 'Configuration.Method' => configuration_method, 'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e }, 'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e }, 'Configuration.FlowSid' => configuration_flow_sid, }) payload = @version.update('POST', @uri, data: data) WebhookInstance.new( @version, payload, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:conversation_sid], sid: @solution[:sid], ) end ## # Delete the WebhookInstance # @return [Boolean] true if delete succeeds, false otherwise def delete @version.delete('DELETE', @uri) end ## # Fetch the WebhookInstance # @return [WebhookInstance] Fetched WebhookInstance def fetch payload = @version.fetch('GET', @uri) WebhookInstance.new( @version, payload, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:conversation_sid], sid: @solution[: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 WebhookInstance < InstanceResource ## # Initialize the WebhookInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] chat_service_sid The SID of the {Conversation # Service}[https://www.twilio.com/docs/conversations/api/service-resource] the # Participant resource is associated with. # @param [String] conversation_sid The unique ID of the # {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. # @return [WebhookInstance] WebhookInstance def initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'chat_service_sid' => payload['chat_service_sid'], 'conversation_sid' => payload['conversation_sid'], 'target' => payload['target'], 'url' => payload['url'], 'configuration' => payload['configuration'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), } # Context @instance_context = nil @params = { 'chat_service_sid' => chat_service_sid, 'conversation_sid' => conversation_sid, 'sid' => sid || @properties['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] WebhookContext for this WebhookInstance def context unless @instance_context @instance_context = WebhookContext.new( @version, @params['chat_service_sid'], @params['conversation_sid'], @params['sid'], ) end @instance_context end ## # @return [String] A 34 character string that uniquely identifies this resource. def sid @properties['sid'] end ## # @return [String] The unique ID of the Account responsible for this conversation. def account_sid @properties['account_sid'] end ## # @return [String] The SID of the Conversation Service that the resource is associated with. def chat_service_sid @properties['chat_service_sid'] end ## # @return [String] The unique ID of the Conversation for this webhook. def conversation_sid @properties['conversation_sid'] end ## # @return [String] The target of this webhook. def target @properties['target'] end ## # @return [String] An absolute URL for this webhook. def url @properties['url'] end ## # @return [Hash] The configuration of this webhook. def configuration @properties['configuration'] end ## # @return [Time] The date that this resource was created. def date_created @properties['date_created'] end ## # @return [Time] The date that this resource was last updated. def date_updated @properties['date_updated'] end ## # Update the WebhookInstance # @param [String] configuration_url The absolute url the webhook request should be # sent to. # @param [webhook.Method] configuration_method The HTTP method to be used when # sending a webhook request. # @param [Array[String]] configuration_filters The list of events, firing webhook # event for this Conversation. # @param [Array[String]] configuration_triggers The list of keywords, firing # webhook event for this Conversation. # @param [String] configuration_flow_sid The studio flow SID, where the webhook # should be sent to. # @return [WebhookInstance] Updated WebhookInstance def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) context.update( configuration_url: configuration_url, configuration_method: configuration_method, configuration_filters: configuration_filters, configuration_triggers: configuration_triggers, configuration_flow_sid: configuration_flow_sid, ) end ## # Delete the WebhookInstance # @return [Boolean] true if delete succeeds, false otherwise def delete context.delete end ## # Fetch the WebhookInstance # @return [WebhookInstance] Fetched WebhookInstance def fetch context.fetch 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