twilio-ruby 5.40.1 → 5.40.2

data/lib/twilio-ruby/rest/conversations/v1/notification.rb

@@ -0,0 +1,310 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class NotificationList < ListResource
+          ##
+          # Initialize the NotificationList
+          # @param [Version] version Version that contains the resource
+          # @return [NotificationList] NotificationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.NotificationList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class NotificationPage < Page
+          ##
+          # Initialize the NotificationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [NotificationPage] NotificationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of NotificationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [NotificationInstance] NotificationInstance
+          def get_instance(payload)
+            NotificationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.NotificationPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class NotificationContext < InstanceContext
+          ##
+          # Initialize the NotificationContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] chat_service_sid The SID of the [Chat
+          #   Service](https://www.twilio.com/docs/chat/rest/service-resource) the
+          #   Configuration applies to.
+          # @return [NotificationContext] NotificationContext
+          def initialize(version, chat_service_sid)
+            super(version)
+
+            # Path Solution
+            @solution = {chat_service_sid: chat_service_sid, }
+            @uri = "/Services/#{@solution[:chat_service_sid]}/Configuration/Notifications"
+          end
+
+          ##
+          # Update the NotificationInstance
+          # @param [Boolean] log_enabled Weather the notification logging is enabled.
+          # @param [Boolean] new_message_enabled Whether to send a notification when a new
+          #   message is added to a conversation. The default is `false`.
+          # @param [String] new_message_template The template to use to create the
+          #   notification text displayed when a new message is added to a conversation and
+          #   `new_message.enabled` is `true`.
+          # @param [String] new_message_sound The name of the sound to play when a new
+          #   message is added to a conversation and `new_message.enabled` is `true`.
+          # @param [Boolean] new_message_badge_count_enabled Whether the new message badge
+          #   is enabled. The default is `false`.
+          # @param [Boolean] added_to_conversation_enabled Whether to send a notification
+          #   when a participant is added to a conversation. The default is `false`.
+          # @param [String] added_to_conversation_template The template to use to create the
+          #   notification text displayed when a participant is added to a conversation and
+          #   `added_to_conversation.enabled` is `true`.
+          # @param [String] added_to_conversation_sound The name of the sound to play when a
+          #   participant is added to a conversation and `added_to_conversation.enabled` is
+          #   `true`.
+          # @param [Boolean] removed_from_conversation_enabled Whether to send a
+          #   notification to a user when they are removed from a conversation. The default is
+          #   `false`.
+          # @param [String] removed_from_conversation_template The template to use to create
+          #   the notification text displayed to a user when they are removed from a
+          #   conversation and `removed_from_conversation.enabled` is `true`.
+          # @param [String] removed_from_conversation_sound The name of the sound to play to
+          #   a user when they are removed from a conversation and
+          #   `removed_from_conversation.enabled` is `true`.
+          # @return [NotificationInstance] Updated NotificationInstance
+          def update(log_enabled: :unset, new_message_enabled: :unset, new_message_template: :unset, new_message_sound: :unset, new_message_badge_count_enabled: :unset, added_to_conversation_enabled: :unset, added_to_conversation_template: :unset, added_to_conversation_sound: :unset, removed_from_conversation_enabled: :unset, removed_from_conversation_template: :unset, removed_from_conversation_sound: :unset)
+            data = Twilio::Values.of({
+                'LogEnabled' => log_enabled,
+                'NewMessage.Enabled' => new_message_enabled,
+                'NewMessage.Template' => new_message_template,
+                'NewMessage.Sound' => new_message_sound,
+                'NewMessage.BadgeCountEnabled' => new_message_badge_count_enabled,
+                'AddedToConversation.Enabled' => added_to_conversation_enabled,
+                'AddedToConversation.Template' => added_to_conversation_template,
+                'AddedToConversation.Sound' => added_to_conversation_sound,
+                'RemovedFromConversation.Enabled' => removed_from_conversation_enabled,
+                'RemovedFromConversation.Template' => removed_from_conversation_template,
+                'RemovedFromConversation.Sound' => removed_from_conversation_sound,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            NotificationInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+          end
+
+          ##
+          # Fetch the NotificationInstance
+          # @return [NotificationInstance] Fetched NotificationInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            NotificationInstance.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.NotificationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.NotificationContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class NotificationInstance < InstanceResource
+          ##
+          # Initialize the NotificationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] chat_service_sid The SID of the [Chat
+          #   Service](https://www.twilio.com/docs/chat/rest/service-resource) the
+          #   Configuration applies to.
+          # @return [NotificationInstance] NotificationInstance
+          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'],
+                'new_message' => payload['new_message'],
+                'added_to_conversation' => payload['added_to_conversation'],
+                'removed_from_conversation' => payload['removed_from_conversation'],
+                'log_enabled' => payload['log_enabled'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'chat_service_sid' => chat_service_sid || @properties['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 [NotificationContext] NotificationContext for this NotificationInstance
+          def context
+            unless @instance_context
+              @instance_context = NotificationContext.new(@version, @params['chat_service_sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique id of the Account responsible for this configuration.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The SID of the Chat Service that the Configuration applies to.
+          def chat_service_sid
+            @properties['chat_service_sid']
+          end
+
+          ##
+          # @return [Hash] The Push Notification configuration for New Messages.
+          def new_message
+            @properties['new_message']
+          end
+
+          ##
+          # @return [Hash] The Push Notification configuration for being added to a Conversation.
+          def added_to_conversation
+            @properties['added_to_conversation']
+          end
+
+          ##
+          # @return [Hash] The Push Notification configuration for being removed from a Conversation.
+          def removed_from_conversation
+            @properties['removed_from_conversation']
+          end
+
+          ##
+          # @return [Boolean] Weather the notification logging is enabled.
+          def log_enabled
+            @properties['log_enabled']
+          end
+
+          ##
+          # @return [String] An absolute URL for this configuration.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the NotificationInstance
+          # @param [Boolean] log_enabled Weather the notification logging is enabled.
+          # @param [Boolean] new_message_enabled Whether to send a notification when a new
+          #   message is added to a conversation. The default is `false`.
+          # @param [String] new_message_template The template to use to create the
+          #   notification text displayed when a new message is added to a conversation and
+          #   `new_message.enabled` is `true`.
+          # @param [String] new_message_sound The name of the sound to play when a new
+          #   message is added to a conversation and `new_message.enabled` is `true`.
+          # @param [Boolean] new_message_badge_count_enabled Whether the new message badge
+          #   is enabled. The default is `false`.
+          # @param [Boolean] added_to_conversation_enabled Whether to send a notification
+          #   when a participant is added to a conversation. The default is `false`.
+          # @param [String] added_to_conversation_template The template to use to create the
+          #   notification text displayed when a participant is added to a conversation and
+          #   `added_to_conversation.enabled` is `true`.
+          # @param [String] added_to_conversation_sound The name of the sound to play when a
+          #   participant is added to a conversation and `added_to_conversation.enabled` is
+          #   `true`.
+          # @param [Boolean] removed_from_conversation_enabled Whether to send a
+          #   notification to a user when they are removed from a conversation. The default is
+          #   `false`.
+          # @param [String] removed_from_conversation_template The template to use to create
+          #   the notification text displayed to a user when they are removed from a
+          #   conversation and `removed_from_conversation.enabled` is `true`.
+          # @param [String] removed_from_conversation_sound The name of the sound to play to
+          #   a user when they are removed from a conversation and
+          #   `removed_from_conversation.enabled` is `true`.
+          # @return [NotificationInstance] Updated NotificationInstance
+          def update(log_enabled: :unset, new_message_enabled: :unset, new_message_template: :unset, new_message_sound: :unset, new_message_badge_count_enabled: :unset, added_to_conversation_enabled: :unset, added_to_conversation_template: :unset, added_to_conversation_sound: :unset, removed_from_conversation_enabled: :unset, removed_from_conversation_template: :unset, removed_from_conversation_sound: :unset)
+            context.update(
+                log_enabled: log_enabled,
+                new_message_enabled: new_message_enabled,
+                new_message_template: new_message_template,
+                new_message_sound: new_message_sound,
+                new_message_badge_count_enabled: new_message_badge_count_enabled,
+                added_to_conversation_enabled: added_to_conversation_enabled,
+                added_to_conversation_template: added_to_conversation_template,
+                added_to_conversation_sound: added_to_conversation_sound,
+                removed_from_conversation_enabled: removed_from_conversation_enabled,
+                removed_from_conversation_template: removed_from_conversation_template,
+                removed_from_conversation_sound: removed_from_conversation_sound,
+            )
+          end
+
+          ##
+          # Fetch the NotificationInstance
+          # @return [NotificationInstance] Fetched NotificationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.NotificationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.NotificationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/conversations/v1/role.rb

@@ -0,0 +1,372 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class RoleList < ListResource
+          ##
+          # Initialize the RoleList
+          # @param [Version] version Version that contains the resource
+          # @return [RoleList] RoleList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Roles"
+          end
+
+          ##
+          # Create the RoleInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the new resource. It can be up to 64 characters long.
+          # @param [role.RoleType] type The type of role. Can be: `conversation` for
+          #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles.
+          # @param [String] permission A permission that you grant to the new role. Only one
+          #   permission can be granted per parameter. To assign more than one permission,
+          #   repeat this parameter for each permission value. The values for this parameter
+          #   depend on the role's `type`.
+          # @return [RoleInstance] Created RoleInstance
+          def create(friendly_name: nil, type: nil, permission: nil)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Type' => type,
+                'Permission' => Twilio.serialize_list(permission) { |e| e },
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            RoleInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists RoleInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit.  Default is no limit
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams RoleInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit. Default is no limit.
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields RoleInstance 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 RoleInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] page_token PageToken provided by the API
+          # @param [Integer] page_number Page Number, this value is simply for client state
+          # @param [Integer] page_size Number of records to return, defaults to 50
+          # @return [Page] Page of RoleInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            RolePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of RoleInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of RoleInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            RolePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.RoleList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class RolePage < Page
+          ##
+          # Initialize the RolePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [RolePage] RolePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of RoleInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [RoleInstance] RoleInstance
+          def get_instance(payload)
+            RoleInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.RolePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class RoleContext < InstanceContext
+          ##
+          # Initialize the RoleContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the Role resource to fetch.
+          # @return [RoleContext] RoleContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Roles/#{@solution[:sid]}"
+          end
+
+          ##
+          # Update the RoleInstance
+          # @param [String] permission A permission that you grant to the role. Only one
+          #   permission can be granted per parameter. To assign more than one permission,
+          #   repeat this parameter for each permission value. Note that the update action
+          #   replaces all previously assigned permissions with those defined in the update
+          #   action. To remove a permission, do not include it in the subsequent update
+          #   action. The values for this parameter depend on the role's `type`.
+          # @return [RoleInstance] Updated RoleInstance
+          def update(permission: nil)
+            data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            RoleInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Delete the RoleInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Fetch the RoleInstance
+          # @return [RoleInstance] Fetched RoleInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            RoleInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.RoleContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.RoleContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class RoleInstance < InstanceResource
+          ##
+          # Initialize the RoleInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the Role resource to fetch.
+          # @return [RoleInstance] RoleInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'chat_service_sid' => payload['chat_service_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'type' => payload['type'],
+                'permissions' => payload['permissions'],
+                '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 = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [RoleContext] RoleContext for this RoleInstance
+          def context
+            unless @instance_context
+              @instance_context = RoleContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The SID of the Service that the resource is associated with
+          def chat_service_sid
+            @properties['chat_service_sid']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the resource
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [role.RoleType] The type of role
+          def type
+            @properties['type']
+          end
+
+          ##
+          # @return [String] An array of the permissions the role has been granted
+          def permissions
+            @properties['permissions']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The absolute URL of the Role resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the RoleInstance
+          # @param [String] permission A permission that you grant to the role. Only one
+          #   permission can be granted per parameter. To assign more than one permission,
+          #   repeat this parameter for each permission value. Note that the update action
+          #   replaces all previously assigned permissions with those defined in the update
+          #   action. To remove a permission, do not include it in the subsequent update
+          #   action. The values for this parameter depend on the role's `type`.
+          # @return [RoleInstance] Updated RoleInstance
+          def update(permission: nil)
+            context.update(permission: permission, )
+          end
+
+          ##
+          # Delete the RoleInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Fetch the RoleInstance
+          # @return [RoleInstance] Fetched RoleInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.RoleInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.RoleInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end