twilio-ruby 5.74.3 → 5.75.0

data/lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb

@@ -22,6 +22,100 @@ module Twilio
 
             # Path Solution
             @solution = {}
+            @uri = "/Insights/Segments"
+          end
+
+          ##
+          # Lists InsightsSegmentsInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [Array[String]] reservation_id The list of reservation Ids
+          # @param [String] token The Token HTTP request header
+          # @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(reservation_id: :unset, token: :unset, limit: nil, page_size: nil)
+            self.stream(
+                reservation_id: reservation_id,
+                token: token,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # Streams InsightsSegmentsInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [Array[String]] reservation_id The list of reservation Ids
+          # @param [String] token The Token HTTP request header
+          # @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(reservation_id: :unset, token: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(reservation_id: reservation_id, token: token, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields InsightsSegmentsInstance 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 InsightsSegmentsInstance records from the API.
+          # Request is executed immediately.
+          # @param [Array[String]] reservation_id The list of reservation Ids
+          # @param [String] token The Token HTTP request header
+          # @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 InsightsSegmentsInstance
+          def page(reservation_id: :unset, token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'ReservationId' => Twilio.serialize_list(reservation_id) { |e| e },
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+            headers = Twilio::Values.of({'Token' => token, })
+
+            response = @version.page('GET', @uri, params: params, headers: headers)
+
+            InsightsSegmentsPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of InsightsSegmentsInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of InsightsSegmentsInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            InsightsSegmentsPage.new(@version, response, @solution)
           end
 
           ##
@@ -268,7 +362,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The link for the conversation.
+          # @return [Hash] The media identifiers of the conversation.
           def media
             @properties['media']
           end

data/lib/twilio-ruby/rest/flex_api/v1.rb

@@ -20,6 +20,7 @@ module Twilio
           @flex_flow = nil
           @assessments = nil
           @insights_assessments_comment = nil
+          @insights_conversations = nil
           @insights_questionnaires = nil
           @insights_questionnaires_category = nil
           @insights_questionnaires_question = nil
@@ -69,9 +70,18 @@ module Twilio
         end
 
         ##
-        # @return [Twilio::REST::Flex_api::V1::AssessmentsContext]
-        def assessments
-          @assessments ||= AssessmentsContext.new self
+        # @param [String] assessment_id The id of the assessment to be modified
+        # @return [Twilio::REST::Flex_api::V1::AssessmentsContext] if assessment_id was passed.
+        # @return [Twilio::REST::Flex_api::V1::AssessmentsList]
+        def assessments(assessment_id=:unset)
+          if assessment_id.nil?
+              raise ArgumentError, 'assessment_id cannot be nil'
+          end
+          if assessment_id == :unset
+              @assessments ||= AssessmentsList.new self
+          else
+              AssessmentsContext.new(self, assessment_id)
+          end
         end
 
         ##
@@ -80,6 +90,12 @@ module Twilio
           @insights_assessments_comment ||= InsightsAssessmentsCommentList.new self
         end
 
+        ##
+        # @return [Twilio::REST::Flex_api::V1::InsightsConversationsContext]
+        def insights_conversations
+          @insights_conversations ||= InsightsConversationsList.new self
+        end
+
         ##
         # @param [String] id The unique ID of the questionnaire
         # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesContext] if id was passed.

data/lib/twilio-ruby/rest/flex_api.rb

@@ -60,9 +60,11 @@ module Twilio
       end
 
       ##
-      # @return [Twilio::REST::Flex_api::V1::AssessmentsInstance]
-      def assessments
-        self.v1.assessments()
+      # @param [String] assessment_id The unique id of the assessment
+      # @return [Twilio::REST::Flex_api::V1::AssessmentsInstance] if assessment_id was passed.
+      # @return [Twilio::REST::Flex_api::V1::AssessmentsList]
+      def assessments(assessment_id=:unset)
+        self.v1.assessments(assessment_id)
       end
 
       ##
@@ -71,6 +73,12 @@ module Twilio
         self.v1.insights_assessments_comment()
       end
 
+      ##
+      # @return [Twilio::REST::Flex_api::V1::InsightsConversationsInstance]
+      def insights_conversations
+        self.v1.insights_conversations()
+      end
+
       ##
       # @param [String] id The unique id of this questionnaire
       # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesInstance] if id was passed.

data/lib/twilio-ruby/rest/messaging/v1/domain_cert.rb

@@ -146,7 +146,7 @@ module Twilio
                 'domain_name' => payload['domain_name'],
                 'certificate_sid' => payload['certificate_sid'],
                 'url' => payload['url'],
-                'validated' => payload['validated'],
+                'cert_in_validation' => payload['cert_in_validation'],
             }
 
             # Context
@@ -208,9 +208,9 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Certificate validation field
-          def validated
-            @properties['validated']
+          # @return [Hash] New certificate in process of validation field
+          def cert_in_validation
+            @properties['cert_in_validation']
           end
 
           ##

data/lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb

@@ -0,0 +1,226 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigMessagingServiceList < ListResource
+          ##
+          # Initialize the DomainConfigMessagingServiceList
+          # @param [Version] version Version that contains the resource
+          # @return [DomainConfigMessagingServiceList] DomainConfigMessagingServiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.DomainConfigMessagingServiceList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigMessagingServicePage < Page
+          ##
+          # Initialize the DomainConfigMessagingServicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DomainConfigMessagingServicePage] DomainConfigMessagingServicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DomainConfigMessagingServiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DomainConfigMessagingServiceInstance] DomainConfigMessagingServiceInstance
+          def get_instance(payload)
+            DomainConfigMessagingServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.DomainConfigMessagingServicePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigMessagingServiceContext < InstanceContext
+          ##
+          # Initialize the DomainConfigMessagingServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] messaging_service_sid Unique string used to identify the
+          #   Messaging service that this domain should be associated with.
+          # @return [DomainConfigMessagingServiceContext] DomainConfigMessagingServiceContext
+          def initialize(version, messaging_service_sid)
+            super(version)
+
+            # Path Solution
+            @solution = {messaging_service_sid: messaging_service_sid, }
+            @uri = "/LinkShortening/MessagingService/#{@solution[:messaging_service_sid]}/DomainConfig"
+          end
+
+          ##
+          # Fetch the DomainConfigMessagingServiceInstance
+          # @return [DomainConfigMessagingServiceInstance] Fetched DomainConfigMessagingServiceInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            DomainConfigMessagingServiceInstance.new(
+                @version,
+                payload,
+                messaging_service_sid: @solution[:messaging_service_sid],
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigMessagingServiceContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigMessagingServiceContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigMessagingServiceInstance < InstanceResource
+          ##
+          # Initialize the DomainConfigMessagingServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] messaging_service_sid Unique string used to identify the
+          #   Messaging service that this domain should be associated with.
+          # @return [DomainConfigMessagingServiceInstance] DomainConfigMessagingServiceInstance
+          def initialize(version, payload, messaging_service_sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'domain_sid' => payload['domain_sid'],
+                'config_sid' => payload['config_sid'],
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'fallback_url' => payload['fallback_url'],
+                'callback_url' => payload['callback_url'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'messaging_service_sid' => messaging_service_sid || @properties['messaging_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 [DomainConfigMessagingServiceContext] DomainConfigMessagingServiceContext for this DomainConfigMessagingServiceInstance
+          def context
+            unless @instance_context
+              @instance_context = DomainConfigMessagingServiceContext.new(
+                  @version,
+                  @params['messaging_service_sid'],
+              )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain resource.
+          def domain_sid
+            @properties['domain_sid']
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain config (prefix ZK).
+          def config_sid
+            @properties['config_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the messaging service
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [String] We will redirect requests to urls we are unable to identify to this url.
+          def fallback_url
+            @properties['fallback_url']
+          end
+
+          ##
+          # @return [String] URL to receive click events to your webhook whenever the recipients click on the shortened links.
+          def callback_url
+            @properties['callback_url']
+          end
+
+          ##
+          # @return [Time] Date this Domain Config was created.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] Date that this Domain Config was last updated.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the DomainConfigMessagingServiceInstance
+          # @return [DomainConfigMessagingServiceInstance] Fetched DomainConfigMessagingServiceInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigMessagingServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigMessagingServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service.rb

@@ -0,0 +1,218 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class LinkshorteningMessagingServiceList < ListResource
+          ##
+          # Initialize the LinkshorteningMessagingServiceList
+          # @param [Version] version Version that contains the resource
+          # @return [LinkshorteningMessagingServiceList] LinkshorteningMessagingServiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.LinkshorteningMessagingServiceList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class LinkshorteningMessagingServicePage < Page
+          ##
+          # Initialize the LinkshorteningMessagingServicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [LinkshorteningMessagingServicePage] LinkshorteningMessagingServicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of LinkshorteningMessagingServiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [LinkshorteningMessagingServiceInstance] LinkshorteningMessagingServiceInstance
+          def get_instance(payload)
+            LinkshorteningMessagingServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.LinkshorteningMessagingServicePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class LinkshorteningMessagingServiceContext < InstanceContext
+          ##
+          # Initialize the LinkshorteningMessagingServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] domain_sid The domain SID to dissociate from a messaging
+          #   service. With URL shortening enabled, links in messages sent with the associated
+          #   messaging service will be shortened to the provided domain
+          # @param [String] messaging_service_sid A messaging service SID to dissociate from
+          #   a domain. With URL shortening enabled, links in messages sent with the provided
+          #   messaging service will be shortened to the associated domain
+          # @return [LinkshorteningMessagingServiceContext] LinkshorteningMessagingServiceContext
+          def initialize(version, domain_sid, messaging_service_sid)
+            super(version)
+
+            # Path Solution
+            @solution = {domain_sid: domain_sid, messaging_service_sid: messaging_service_sid, }
+            @uri = "/LinkShortening/Domains/#{@solution[:domain_sid]}/MessagingServices/#{@solution[:messaging_service_sid]}"
+          end
+
+          ##
+          # Create the LinkshorteningMessagingServiceInstance
+          # @return [LinkshorteningMessagingServiceInstance] Created LinkshorteningMessagingServiceInstance
+          def create
+            payload = @version.create('POST', @uri)
+
+            LinkshorteningMessagingServiceInstance.new(
+                @version,
+                payload,
+                domain_sid: @solution[:domain_sid],
+                messaging_service_sid: @solution[:messaging_service_sid],
+            )
+          end
+
+          ##
+          # Delete the LinkshorteningMessagingServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.LinkshorteningMessagingServiceContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.LinkshorteningMessagingServiceContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class LinkshorteningMessagingServiceInstance < InstanceResource
+          ##
+          # Initialize the LinkshorteningMessagingServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] domain_sid The domain SID to dissociate from a messaging
+          #   service. With URL shortening enabled, links in messages sent with the associated
+          #   messaging service will be shortened to the provided domain
+          # @param [String] messaging_service_sid A messaging service SID to dissociate from
+          #   a domain. With URL shortening enabled, links in messages sent with the provided
+          #   messaging service will be shortened to the associated domain
+          # @return [LinkshorteningMessagingServiceInstance] LinkshorteningMessagingServiceInstance
+          def initialize(version, payload, domain_sid: nil, messaging_service_sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'domain_sid' => payload['domain_sid'],
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {
+                'domain_sid' => domain_sid || @properties['domain_sid'],
+                'messaging_service_sid' => messaging_service_sid || @properties['messaging_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 [LinkshorteningMessagingServiceContext] LinkshorteningMessagingServiceContext for this LinkshorteningMessagingServiceInstance
+          def context
+            unless @instance_context
+              @instance_context = LinkshorteningMessagingServiceContext.new(
+                  @version,
+                  @params['domain_sid'],
+                  @params['messaging_service_sid'],
+              )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the domain resource
+          def domain_sid
+            @properties['domain_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the messaging service
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Create the LinkshorteningMessagingServiceInstance
+          # @return [LinkshorteningMessagingServiceInstance] Created LinkshorteningMessagingServiceInstance
+          def create
+            context.create
+          end
+
+          ##
+          # Delete the LinkshorteningMessagingServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.LinkshorteningMessagingServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.LinkshorteningMessagingServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end