twilio-ruby 5.28.0 → 5.29.0

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

@@ -39,20 +39,22 @@ module Twilio
             #   device, e.g. a phone number or Messenger ID. Together with the Proxy address,
             #   this determines a participant uniquely. This field (with proxy_address) is only
             #   null when the participant is interacting from a Chat endpoint (see the
-            #   'identity' field). Limited to 256 characters.
+            #   'identity' field).
             # @param [String] messaging_binding_proxy_address The address of the Twilio phone
             #   number (or WhatsApp number, or Messenger Page ID) that the participant is in
             #   contact with. This field, together with participant address, is only null when
             #   the participant is interacting from a Chat endpoint (see the 'identity' field).
-            #   Limited to 256 characters.
             # @param [Time] date_created The date that this resource was created.
             # @param [Time] date_updated The date that this resource was last updated.
             # @param [String] attributes An optional string metadata field you can use to
             #   store any data 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] messaging_binding_projected_address The address of the Twilio
+            #   phone number that is used in Group MMS. Communication mask for the Chat
+            #   participant with Identity.
             # @return [ParticipantInstance] Newly created ParticipantInstance
-            def create(identity: :unset, messaging_binding_address: :unset, messaging_binding_proxy_address: :unset, date_created: :unset, date_updated: :unset, attributes: :unset)
+            def create(identity: :unset, messaging_binding_address: :unset, messaging_binding_proxy_address: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_binding_projected_address: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
                   'MessagingBinding.Address' => messaging_binding_address,
@@ -60,6 +62,7 @@ module Twilio
                   'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                   'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                   'Attributes' => attributes,
+                  'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
               })
 
               payload = @version.create(

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

@@ -28,15 +28,6 @@ module Twilio
         @v1 ||= V1.new self
       end
 
-      ##
-      # @param [String] sid The unique string that we created to identify the FlexFlow
-      #   resource.
-      # @return [Twilio::REST::Flex_api::V1::FlexFlowInstance] if sid was passed.
-      # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
-      def flex_flow(sid=:unset)
-        self.v1.flex_flow(sid)
-      end
-
       ##
       # @param [String] sid The unique string that we created to identify the Channel
       #   resource.
@@ -46,6 +37,21 @@ module Twilio
         self.v1.channel(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Flex_api::V1::ConfigurationInstance]
+      def configuration
+        self.v1.configuration()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the FlexFlow
+      #   resource.
+      # @return [Twilio::REST::Flex_api::V1::FlexFlowInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
+      def flex_flow(sid=:unset)
+        self.v1.flex_flow(sid)
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the WebChannel
       #   resource.
@@ -55,12 +61,6 @@ module Twilio
         self.v1.web_channel(sid)
       end
 
-      ##
-      # @return [Twilio::REST::Flex_api::V1::ConfigurationInstance]
-      def configuration
-        self.v1.configuration()
-      end
-
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -15,37 +15,43 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
-          @flex_flow = nil
           @channel = nil
-          @web_channel = nil
           @configuration = nil
+          @flex_flow = nil
+          @web_channel = nil
         end
 
         ##
-        # @param [String] sid The SID of the FlexFlow resource to fetch.
-        # @return [Twilio::REST::Flex_api::V1::FlexFlowContext] if sid was passed.
-        # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
-        def flex_flow(sid=:unset)
+        # @param [String] sid The SID of the Flex chat channel resource to fetch.
+        # @return [Twilio::REST::Flex_api::V1::ChannelContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::ChannelList]
+        def channel(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @flex_flow ||= FlexFlowList.new self
+            @channel ||= ChannelList.new self
           else
-            FlexFlowContext.new(self, sid)
+            ChannelContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The SID of the Flex chat channel resource to fetch.
-        # @return [Twilio::REST::Flex_api::V1::ChannelContext] if sid was passed.
-        # @return [Twilio::REST::Flex_api::V1::ChannelList]
-        def channel(sid=:unset)
+        # @return [Twilio::REST::Flex_api::V1::ConfigurationContext]
+        def configuration
+          @configuration ||= ConfigurationContext.new self
+        end
+
+        ##
+        # @param [String] sid The SID of the FlexFlow resource to fetch.
+        # @return [Twilio::REST::Flex_api::V1::FlexFlowContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
+        def flex_flow(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @channel ||= ChannelList.new self
+            @flex_flow ||= FlexFlowList.new self
           else
-            ChannelContext.new(self, sid)
+            FlexFlowContext.new(self, sid)
           end
         end
 
@@ -63,12 +69,6 @@ module Twilio
           end
         end
 
-        ##
-        # @return [Twilio::REST::Flex_api::V1::ConfigurationContext]
-        def configuration
-          @configuration ||= ConfigurationContext.new self
-        end
-
         ##
         # Provide a user friendly representation
         def to_s

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

@@ -28,15 +28,6 @@ module Twilio
         @v1 ||= V1.new self
       end
 
-      ##
-      # @param [String] sid The unique string that we created to identify the Session
-      #   resource.
-      # @return [Twilio::REST::Messaging::V1::SessionInstance] if sid was passed.
-      # @return [Twilio::REST::Messaging::V1::SessionList]
-      def sessions(sid=:unset)
-        self.v1.sessions(sid)
-      end
-
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.
@@ -46,6 +37,15 @@ module Twilio
         self.v1.services(sid)
       end
 
+      ##
+      # @param [String] sid The unique string that we created to identify the Session
+      #   resource.
+      # @return [Twilio::REST::Messaging::V1::SessionInstance] if sid was passed.
+      # @return [Twilio::REST::Messaging::V1::SessionList]
+      def sessions(sid=:unset)
+        self.v1.sessions(sid)
+      end
+
       ##
       # @return [Twilio::REST::Messaging::V1::WebhookInstance]
       def webhooks

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

@@ -15,36 +15,36 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
-          @sessions = nil
           @services = nil
+          @sessions = nil
           @webhooks = nil
         end
 
         ##
-        # @param [String] sid The SID of the Session resource to fetch.
-        # @return [Twilio::REST::Messaging::V1::SessionContext] if sid was passed.
-        # @return [Twilio::REST::Messaging::V1::SessionList]
-        def sessions(sid=:unset)
+        # @param [String] sid The SID of the Service resource to fetch.
+        # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Messaging::V1::ServiceList]
+        def services(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @sessions ||= SessionList.new self
+            @services ||= ServiceList.new self
           else
-            SessionContext.new(self, sid)
+            ServiceContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The SID of the Service resource to fetch.
-        # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
-        # @return [Twilio::REST::Messaging::V1::ServiceList]
-        def services(sid=:unset)
+        # @param [String] sid The SID of the Session resource to fetch.
+        # @return [Twilio::REST::Messaging::V1::SessionContext] if sid was passed.
+        # @return [Twilio::REST::Messaging::V1::SessionList]
+        def sessions(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @services ||= ServiceList.new self
+            @sessions ||= SessionList.new self
           else
-            ServiceContext.new(self, sid)
+            SessionContext.new(self, sid)
           end
         end
 

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

@@ -127,6 +127,14 @@ module Twilio
         self.hosted_numbers.hosted_number_orders(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+      def available_add_ons(sid=:unset)
+        self.marketplace.available_add_ons(sid)
+      end
+
       ##
       # @param [String] sid 34 character string that uniquely identifies the Add-on.
       #   This Sid can also be found in the Console on that specific Add-ons page as the
@@ -137,14 +145,6 @@ module Twilio
         self.marketplace.installed_add_ons(sid)
       end
 
-      ##
-      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
-      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
-      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-      def available_add_ons(sid=:unset)
-        self.marketplace.available_add_ons(sid)
-      end
-
       ##
       # @param [String] sid The sid
       # @return [Twilio::REST::Preview::Sync::ServiceInstance] if sid was passed.
@@ -193,15 +193,9 @@ module Twilio
       end
 
       ##
-      # @return [Twilio::REST::Preview::TrustedComms::DeviceInstance]
-      def devices
-        self.trusted_comms.devices()
-      end
-
-      ##
-      # @return [Twilio::REST::Preview::TrustedComms::PhoneCallInstance]
-      def phone_calls
-        self.trusted_comms.phone_calls()
+      # @return [Twilio::REST::Preview::TrustedComms::CpsInstance]
+      def cps
+        self.trusted_comms.cps()
       end
 
       ##
@@ -211,9 +205,15 @@ module Twilio
       end
 
       ##
-      # @return [Twilio::REST::Preview::TrustedComms::CpsInstance]
-      def cps
-        self.trusted_comms.cps()
+      # @return [Twilio::REST::Preview::TrustedComms::DeviceInstance]
+      def devices
+        self.trusted_comms.devices()
+      end
+
+      ##
+      # @return [Twilio::REST::Preview::TrustedComms::PhoneCallInstance]
+      def phone_calls
+        self.trusted_comms.phone_calls()
       end
 
       ##

data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb

@@ -22,6 +22,24 @@ module Twilio
 
             # Path Solution
             @solution = {}
+
+            # Components
+            @jobs = nil
+          end
+
+          ##
+          # Access the jobs
+          # @param [String] job_sid The job_sid
+          # @return [JobList]
+          # @return [JobContext] if job_sid was passed.
+          def jobs(job_sid=:unset)
+            raise ArgumentError, 'job_sid cannot be nil' if job_sid.nil?
+
+            if job_sid != :unset
+              return JobContext.new(@version, job_sid, )
+            end
+
+              @jobs ||= JobList.new(@version, )
           end
 
           ##
@@ -79,6 +97,7 @@ module Twilio
 
             # Dependents
             @days = nil
+            @export_custom_jobs = nil
           end
 
           ##
@@ -108,6 +127,18 @@ module Twilio
             @days
           end
 
+          ##
+          # Access the export_custom_jobs
+          # @return [ExportCustomJobList]
+          # @return [ExportCustomJobContext]
+          def export_custom_jobs
+            unless @export_custom_jobs
+              @export_custom_jobs = ExportCustomJobList.new(@version, resource_type: @solution[:resource_type], )
+            end
+
+            @export_custom_jobs
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -190,6 +221,13 @@ module Twilio
             context.days
           end
 
+          ##
+          # Access the export_custom_jobs
+          # @return [export_custom_jobs] export_custom_jobs
+          def export_custom_jobs
+            context.export_custom_jobs
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb

@@ -0,0 +1,298 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class BulkExports < Version
+        class ExportContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class ExportCustomJobList < ListResource
+            ##
+            # Initialize the ExportCustomJobList
+            # @param [Version] version Version that contains the resource
+            # @param [String] resource_type The type of communication – Messages, Calls
+            # @return [ExportCustomJobList] ExportCustomJobList
+            def initialize(version, resource_type: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {resource_type: resource_type}
+              @uri = "/Exports/#{@solution[:resource_type]}/Jobs"
+            end
+
+            ##
+            # Lists ExportCustomJobInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [String] next_token The token for the next page of job results, and may
+            #   be null if there are no more pages
+            # @param [String] previous_token The token for the previous page of results, and
+            #   may be null if this is the first page
+            # @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(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
+              self.stream(
+                  next_token: next_token,
+                  previous_token: previous_token,
+                  limit: limit,
+                  page_size: page_size
+              ).entries
+            end
+
+            ##
+            # Streams ExportCustomJobInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [String] next_token The token for the next page of job results, and may
+            #   be null if there are no more pages
+            # @param [String] previous_token The token for the previous page of results, and
+            #   may be null if this is the first page
+            # @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(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(
+                  next_token: next_token,
+                  previous_token: previous_token,
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields ExportCustomJobInstance 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 ExportCustomJobInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] next_token The token for the next page of job results, and may
+            #   be null if there are no more pages
+            # @param [String] previous_token The token for the previous page of results, and
+            #   may be null if this is the first page
+            # @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 ExportCustomJobInstance
+            def page(next_token: :unset, previous_token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'NextToken' => next_token,
+                  'PreviousToken' => previous_token,
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              ExportCustomJobPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of ExportCustomJobInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of ExportCustomJobInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              ExportCustomJobPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of ExportCustomJobInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] friendly_name The friendly_name
+            # @param [String] start_day The start_day
+            # @param [String] end_day The end_day
+            # @param [String] webhook_url The webhook_url
+            # @param [String] webhook_method The webhook_method
+            # @param [String] email The email
+            # @return [ExportCustomJobInstance] Newly created ExportCustomJobInstance
+            def create(friendly_name: :unset, start_day: :unset, end_day: :unset, webhook_url: :unset, webhook_method: :unset, email: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'StartDay' => start_day,
+                  'EndDay' => end_day,
+                  'WebhookUrl' => webhook_url,
+                  'WebhookMethod' => webhook_method,
+                  'Email' => email,
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              ExportCustomJobInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.BulkExports.ExportCustomJobList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class ExportCustomJobPage < Page
+            ##
+            # Initialize the ExportCustomJobPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [ExportCustomJobPage] ExportCustomJobPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of ExportCustomJobInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [ExportCustomJobInstance] ExportCustomJobInstance
+            def get_instance(payload)
+              ExportCustomJobInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.BulkExports.ExportCustomJobPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class ExportCustomJobInstance < InstanceResource
+            ##
+            # Initialize the ExportCustomJobInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] resource_type The type of communication – Messages, Calls
+            # @return [ExportCustomJobInstance] ExportCustomJobInstance
+            def initialize(version, payload, resource_type: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'friendly_name' => payload['friendly_name'],
+                  'resource_type' => payload['resource_type'],
+                  'start_day' => payload['start_day'],
+                  'end_day' => payload['end_day'],
+                  'webhook_url' => payload['webhook_url'],
+                  'webhook_method' => payload['webhook_method'],
+                  'email' => payload['email'],
+                  'job_sid' => payload['job_sid'],
+                  'details' => payload['details'],
+              }
+            end
+
+            ##
+            # @return [String] The friendly name specified when creating the job
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The type of communication – Messages, Calls
+            def resource_type
+              @properties['resource_type']
+            end
+
+            ##
+            # @return [String] The start time for the export specified when creating the job
+            def start_day
+              @properties['start_day']
+            end
+
+            ##
+            # @return [String] The end time for the export specified when creating the job
+            def end_day
+              @properties['end_day']
+            end
+
+            ##
+            # @return [String] The optional webhook url called on completion
+            def webhook_url
+              @properties['webhook_url']
+            end
+
+            ##
+            # @return [String] This is the method used to call the webhook
+            def webhook_method
+              @properties['webhook_method']
+            end
+
+            ##
+            # @return [String] The optional email to send the completion notification to
+            def email
+              @properties['email']
+            end
+
+            ##
+            # @return [String] The job_sid returned when the export was created
+            def job_sid
+              @properties['job_sid']
+            end
+
+            ##
+            # @return [Hash] The details
+            def details
+              @properties['details']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Preview.BulkExports.ExportCustomJobInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Preview.BulkExports.ExportCustomJobInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end