twilio-ruby 5.46.1 → 5.77.0

data/lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb

@@ -0,0 +1,269 @@
+##
+# 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 ConfigurationContext < InstanceContext
+            class WebhookList < ListResource
+              ##
+              # Initialize the WebhookList
+              # @param [Version] version Version that contains the resource
+              # @param [String] chat_service_sid The unique string that we created to identify
+              #   the Service configuration 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
+                '#<Twilio.Conversations.V1.WebhookList>'
+              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
+                '<Twilio.Conversations.V1.WebhookPage>'
+              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
+
+              ##
+              # 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,
+                })
+
+                payload = @version.update('POST', @uri, data: data)
+
+                WebhookInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+              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], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+              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 unique string that we created to identify
+              #   the Service configuration resource.
+              # @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, }
+              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'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The unique ID of the 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[String]] The list of events that your configured webhook targets will receive. Events not configured here will not fire.
+              def filters
+                @properties['filters']
+              end
+
+              ##
+              # @return [webhook.Method] The HTTP method to be used when sending a webhook request
+              def method
+                @properties['method']
+              end
+
+              ##
+              # @return [String] An absolute URL for this webhook.
+              def url
+                @properties['url']
+              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
+
+              ##
+              # 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(" ")
+                "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb

@@ -77,6 +77,7 @@ module Twilio
 
               # Components
               @notifications = nil
+              @webhooks = nil
             end
 
             ##
@@ -127,6 +128,13 @@ module Twilio
               return NotificationContext.new(@version, @solution[:chat_service_sid], )
             end
 
+            ##
+            # Access the webhooks
+            # @return [WebhookContext] WebhookContext
+            def webhooks
+              return WebhookContext.new(@version, @solution[:chat_service_sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb

@@ -251,7 +251,7 @@ module Twilio
                       'channel_message_sid' => payload['channel_message_sid'],
                       'participant_sid' => payload['participant_sid'],
                       'status' => payload['status'],
-                      'error_code' => payload['error_code'].to_i,
+                      'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
                       'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                       'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                       'url' => payload['url'],

data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb

@@ -44,10 +44,16 @@ module Twilio
               #   you wish. The string value must contain structurally valid JSON if specified.
               #   **Note** that if the attributes are not set "{}" will be returned.
               # @param [String] media_sid The Media SID to be attached to the new Message.
+              # @param [String] content_sid The unique ID of the multi-channel {Rich
+              #   Content}[https://www.twilio.com/docs/content-api] template, required for
+              #   template-generated messages.  **Note** that if this field is set, `Body` and
+              #   `MediaSid` parameters are ignored.
+              # @param [String] content_variables A structurally valid JSON string that contains
+              #   values to resolve Rich Content template variables.
               # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
               #   X-Twilio-Webhook-Enabled HTTP request header
               # @return [MessageInstance] Created MessageInstance
-              def create(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, x_twilio_webhook_enabled: :unset)
+              def create(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, content_sid: :unset, content_variables: :unset, x_twilio_webhook_enabled: :unset)
                 data = Twilio::Values.of({
                     'Author' => author,
                     'Body' => body,
@@ -55,6 +61,8 @@ module Twilio
                     'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                     'Attributes' => attributes,
                     'MediaSid' => media_sid,
+                    'ContentSid' => content_sid,
+                    'ContentVariables' => content_variables,
                 })
                 headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
@@ -72,6 +80,8 @@ module Twilio
               # Lists MessageInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
               # @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
@@ -79,14 +89,16 @@ module Twilio
               #    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
+              def list(order: :unset, limit: nil, page_size: nil)
+                self.stream(order: order, limit: limit, page_size: page_size).entries
               end
 
               ##
               # Streams MessageInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
               # @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
@@ -94,10 +106,10 @@ module Twilio
               #    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)
+              def stream(order: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size], )
+                page = self.page(order: order, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -119,12 +131,15 @@ module Twilio
               ##
               # Retrieve a single page of MessageInstance records from the API.
               # Request is executed immediately.
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
               # @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 MessageInstance
-              def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              def page(order: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
+                    'Order' => order,
                     'PageToken' => page_token,
                     'Page' => page_number,
                     'PageSize' => page_size,
@@ -342,7 +357,7 @@ module Twilio
                     'chat_service_sid' => payload['chat_service_sid'],
                     'conversation_sid' => payload['conversation_sid'],
                     'sid' => payload['sid'],
-                    'index' => payload['index'].to_i,
+                    'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i,
                     'author' => payload['author'],
                     'body' => payload['body'],
                     'media' => payload['media'],
@@ -353,6 +368,7 @@ module Twilio
                     'delivery' => payload['delivery'],
                     'url' => payload['url'],
                     'links' => payload['links'],
+                    'content_sid' => payload['content_sid'],
                 }
 
                 # Context
@@ -470,6 +486,12 @@ module Twilio
                 @properties['links']
               end
 
+              ##
+              # @return [String] The unique ID of the multi-channel Rich Content template.
+              def content_sid
+                @properties['content_sid']
+              end
+
               ##
               # Update the MessageInstance
               # @param [String] author The channel specific identifier of the message's author.

data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb

@@ -75,6 +75,14 @@ module Twilio
             # Lists ConversationInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
+            # @param [String] start_date Start date or time in ISO8601 format for filtering
+            #   list of Conversations. If a date is provided, the start time of the date is used
+            #   (YYYY-MM-DDT00:00:00Z). Can be combined with other filters.
+            # @param [String] end_date End date or time in ISO8601 format for filtering list
+            #   of Conversations. If a date is provided, the end time of the date is used
+            #   (YYYY-MM-DDT23:59:59Z). Can be combined with other filters.
+            # @param [conversation.State] state State for sorting and filtering list of
+            #   Conversations. Can be `active`, `inactive` or `closed`
             # @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
@@ -82,14 +90,28 @@ module Twilio
             #    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
+            def list(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil)
+              self.stream(
+                  start_date: start_date,
+                  end_date: end_date,
+                  state: state,
+                  limit: limit,
+                  page_size: page_size
+              ).entries
             end
 
             ##
             # Streams ConversationInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
+            # @param [String] start_date Start date or time in ISO8601 format for filtering
+            #   list of Conversations. If a date is provided, the start time of the date is used
+            #   (YYYY-MM-DDT00:00:00Z). Can be combined with other filters.
+            # @param [String] end_date End date or time in ISO8601 format for filtering list
+            #   of Conversations. If a date is provided, the end time of the date is used
+            #   (YYYY-MM-DDT23:59:59Z). Can be combined with other filters.
+            # @param [conversation.State] state State for sorting and filtering list of
+            #   Conversations. Can be `active`, `inactive` or `closed`
             # @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
@@ -97,10 +119,15 @@ module Twilio
             #    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)
+            def stream(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size], )
+              page = self.page(
+                  start_date: start_date,
+                  end_date: end_date,
+                  state: state,
+                  page_size: limits[:page_size],
+              )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -122,12 +149,23 @@ module Twilio
             ##
             # Retrieve a single page of ConversationInstance records from the API.
             # Request is executed immediately.
+            # @param [String] start_date Start date or time in ISO8601 format for filtering
+            #   list of Conversations. If a date is provided, the start time of the date is used
+            #   (YYYY-MM-DDT00:00:00Z). Can be combined with other filters.
+            # @param [String] end_date End date or time in ISO8601 format for filtering list
+            #   of Conversations. If a date is provided, the end time of the date is used
+            #   (YYYY-MM-DDT23:59:59Z). Can be combined with other filters.
+            # @param [conversation.State] state State for sorting and filtering list of
+            #   Conversations. Can be `active`, `inactive` or `closed`
             # @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 ConversationInstance
-            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(start_date: :unset, end_date: :unset, state: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
+                  'StartDate' => start_date,
+                  'EndDate' => end_date,
+                  'State' => state,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
@@ -394,6 +432,7 @@ module Twilio
                   'timers' => payload['timers'],
                   'url' => payload['url'],
                   'links' => payload['links'],
+                  'bindings' => payload['bindings'],
               }
 
               # Context
@@ -490,6 +529,12 @@ module Twilio
               @properties['links']
             end
 
+            ##
+            # @return [Hash] The bindings
+            def bindings
+              @properties['bindings']
+            end
+
             ##
             # Update the ConversationInstance
             # @param [String] friendly_name The human-readable name of this conversation,