twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/{preview/proxy → conversations/v1}/service.rb

@@ -3,13 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Proxy < Version
-        ##
-        # 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 Conversations < Domain
+      class V1 < Version
         class ServiceList < ListResource
           ##
           # Initialize the ServiceList
@@ -23,6 +23,19 @@ module Twilio
             @uri = "/Services"
           end
 
+          ##
+          # Create the ServiceInstance
+          # @param [String] friendly_name The human-readable name of this service, limited
+          #   to 256 characters. Optional.
+          # @return [ServiceInstance] Created ServiceInstance
+          def create(friendly_name: nil)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            ServiceInstance.new(@version, payload, )
+          end
+
           ##
           # Lists ServiceInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
@@ -52,7 +65,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -64,7 +77,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -84,11 +97,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -105,41 +116,13 @@ module Twilio
             ServicePage.new(@version, response, @solution)
           end
 
-          ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [Boolean] auto_create Boolean flag specifying whether to create threads
-          #   when a user communticates out of band.
-          # @param [String] callback_url The URL Twilio will request for callback
-          #   notifications.
-          # @return [ServiceInstance] Newly created ServiceInstance
-          def create(friendly_name: :unset, auto_create: :unset, callback_url: :unset)
-            data = Twilio::Values.of({
-                'FriendlyName' => friendly_name,
-                'AutoCreate' => auto_create,
-                'CallbackUrl' => callback_url,
-            })
-
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
-
-            ServiceInstance.new(@version, payload)
-          end
-
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.Proxy.ServiceList>'
+            '#<Twilio.Conversations.V1.ServiceList>'
           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 ServicePage < Page
           ##
           # Initialize the ServicePage
@@ -159,165 +142,181 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [ServiceInstance] ServiceInstance
           def get_instance(payload)
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.Proxy.ServicePage>'
+            '<Twilio.Conversations.V1.ServicePage>'
           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 ServiceContext < InstanceContext
           ##
           # Initialize the ServiceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this Service.
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   resource.
           # @return [ServiceContext] ServiceContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Services/#{@solution[:sid]}"
 
             # Dependents
-            @sessions = nil
-            @phone_numbers = nil
-            @short_codes = nil
+            @conversations = nil
+            @bindings = nil
+            @users = nil
+            @roles = nil
+            @configuration = nil
+            @participant_conversations = nil
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
+            payload = @version.fetch('GET', @uri)
 
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            @version.delete('delete', @uri)
-          end
-
-          ##
-          # Update the ServiceInstance
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [Boolean] auto_create Boolean flag specifying whether to create threads
-          #   when a user communticates out of band.
-          # @param [String] callback_url The URL Twilio will request for callback
-          #   notifications.
-          # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, auto_create: :unset, callback_url: :unset)
-            data = Twilio::Values.of({
-                'FriendlyName' => friendly_name,
-                'AutoCreate' => auto_create,
-                'CallbackUrl' => callback_url,
-            })
+          # Access the conversations
+          # @return [ConversationList]
+          # @return [ConversationContext] if sid was passed.
+          def conversations(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            if sid != :unset
+              return ConversationContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @conversations
+              @conversations = ConversationList.new(@version, chat_service_sid: @solution[:sid], )
+            end
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            @conversations
           end
 
           ##
-          # Access the sessions
-          # @return [SessionList]
-          # @return [SessionContext] if sid was passed.
-          def sessions(sid=:unset)
+          # Access the bindings
+          # @return [BindingList]
+          # @return [BindingContext] if sid was passed.
+          def bindings(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return SessionContext.new(@version, @solution[:sid], sid)
+              return BindingContext.new(@version, @solution[:sid], sid, )
             end
 
-            unless @sessions
-              @sessions = SessionList.new(@version, service_sid: @solution[:sid])
+            unless @bindings
+              @bindings = BindingList.new(@version, chat_service_sid: @solution[:sid], )
             end
 
-            @sessions
+            @bindings
           end
 
           ##
-          # Access the phone_numbers
-          # @return [PhoneNumberList]
-          # @return [PhoneNumberContext] if sid was passed.
-          def phone_numbers(sid=:unset)
+          # Access the users
+          # @return [UserList]
+          # @return [UserContext] if sid was passed.
+          def users(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return PhoneNumberContext.new(@version, @solution[:sid], sid)
+              return UserContext.new(@version, @solution[:sid], sid, )
             end
 
-            unless @phone_numbers
-              @phone_numbers = PhoneNumberList.new(@version, service_sid: @solution[:sid])
+            unless @users
+              @users = UserList.new(@version, chat_service_sid: @solution[:sid], )
             end
 
-            @phone_numbers
+            @users
           end
 
           ##
-          # Access the short_codes
-          # @return [ShortCodeList]
-          # @return [ShortCodeContext] if sid was passed.
-          def short_codes(sid=:unset)
+          # Access the roles
+          # @return [RoleList]
+          # @return [RoleContext] if sid was passed.
+          def roles(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return ShortCodeContext.new(@version, @solution[:sid], sid)
+              return RoleContext.new(@version, @solution[:sid], sid, )
             end
 
-            unless @short_codes
-              @short_codes = ShortCodeList.new(@version, service_sid: @solution[:sid])
+            unless @roles
+              @roles = RoleList.new(@version, chat_service_sid: @solution[:sid], )
             end
 
-            @short_codes
+            @roles
+          end
+
+          ##
+          # Access the configuration
+          # @return [ConfigurationList]
+          # @return [ConfigurationContext]
+          def configuration
+            ConfigurationContext.new(@version, @solution[:sid], )
+          end
+
+          ##
+          # Access the participant_conversations
+          # @return [ParticipantConversationList]
+          # @return [ParticipantConversationContext]
+          def participant_conversations
+            unless @participant_conversations
+              @participant_conversations = ParticipantConversationList.new(
+                  @version,
+                  chat_service_sid: @solution[:sid],
+              )
+            end
+
+            @participant_conversations
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.Proxy.ServiceContext #{context}>"
+            "#<Twilio.Conversations.V1.ServiceContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.ServiceContext #{context}>"
           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 ServiceInstance < InstanceResource
           ##
           # Initialize the ServiceInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid A 34 character string that uniquely identifies this Service.
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   resource.
           # @return [ServiceInstance] ServiceInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
             # Marshaled Properties
             @properties = {
+                'account_sid' => payload['account_sid'],
                 'sid' => payload['sid'],
                 'friendly_name' => payload['friendly_name'],
-                'account_sid' => payload['account_sid'],
-                'auto_create' => payload['auto_create'],
-                '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'],
@@ -326,7 +325,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -335,125 +334,121 @@ module Twilio
           # @return [ServiceContext] ServiceContext for this ServiceInstance
           def context
             unless @instance_context
-              @instance_context = ServiceContext.new(@version, @params['sid'])
+              @instance_context = ServiceContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Service.
-          def sid
-            @properties['sid']
-          end
-
-          ##
-          # @return [String] A human readable description of this resource
-          def friendly_name
-            @properties['friendly_name']
-          end
-
-          ##
-          # @return [String] Account Sid.
+          # @return [String] The unique ID of the Account responsible for this service.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [Boolean] Boolean flag specifying whether to auto-create threads.
-          def auto_create
-            @properties['auto_create']
+          # @return [String] A 34 character string that uniquely identifies this resource.
+          def sid
+            @properties['sid']
           end
 
           ##
-          # @return [String] URL Twilio will request for callbacks.
-          def callback_url
-            @properties['callback_url']
+          # @return [String] The human-readable name of this service.
+          def friendly_name
+            @properties['friendly_name']
           end
 
           ##
-          # @return [Time] The date this Service was created
+          # @return [Time] The date that this resource was created.
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date this Service was updated
+          # @return [Time] The date that this resource was last updated.
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The URL of this resource.
+          # @return [String] An absolute URL for this service.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] Nested resource URLs.
+          # @return [String] Absolute URLs to access the conversations, users, roles, bindings and configuration of this service.
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            context.delete
+          # Access the conversations
+          # @return [conversations] conversations
+          def conversations
+            context.conversations
+          end
+
+          ##
+          # Access the bindings
+          # @return [bindings] bindings
+          def bindings
+            context.bindings
           end
 
           ##
-          # Update the ServiceInstance
-          # @param [String] friendly_name A human readable description of this resource, up
-          #   to 64 characters.
-          # @param [Boolean] auto_create Boolean flag specifying whether to create threads
-          #   when a user communticates out of band.
-          # @param [String] callback_url The URL Twilio will request for callback
-          #   notifications.
-          # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, auto_create: :unset, callback_url: :unset)
-            context.update(friendly_name: friendly_name, auto_create: auto_create, callback_url: callback_url)
+          # Access the users
+          # @return [users] users
+          def users
+            context.users
           end
 
           ##
-          # Access the sessions
-          # @return [sessions] sessions
-          def sessions
-            context.sessions
+          # Access the roles
+          # @return [roles] roles
+          def roles
+            context.roles
           end
 
           ##
-          # Access the phone_numbers
-          # @return [phone_numbers] phone_numbers
-          def phone_numbers
-            context.phone_numbers
+          # Access the configuration
+          # @return [configuration] configuration
+          def configuration
+            context.configuration
           end
 
           ##
-          # Access the short_codes
-          # @return [short_codes] short_codes
-          def short_codes
-            context.short_codes
+          # Access the participant_conversations
+          # @return [participant_conversations] participant_conversations
+          def participant_conversations
+            context.participant_conversations
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Proxy.ServiceInstance #{values}>"
+            "<Twilio.Conversations.V1.ServiceInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Proxy.ServiceInstance #{values}>"
+            "<Twilio.Conversations.V1.ServiceInstance #{values}>"
           end
         end
       end