twilio-ruby 5.39.2 → 5.60.0

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

@@ -0,0 +1,312 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class ParticipantConversationList < ListResource
+          ##
+          # Initialize the ParticipantConversationList
+          # @param [Version] version Version that contains the resource
+          # @return [ParticipantConversationList] ParticipantConversationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/ParticipantConversations"
+          end
+
+          ##
+          # Lists ParticipantConversationInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] identity A unique string identifier for the conversation
+          #   participant as {Conversation
+          #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
+          #   parameter is non-null if (and only if) the participant is using the
+          #   Conversations SDK to communicate. Limited to 256 characters.
+          # @param [String] address A unique string identifier for the conversation
+          #   participant who's not a Conversation User. This parameter could be found in
+          #   messaging_binding.address field of Participant resource. It should be
+          #   url-encoded.
+          # @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(identity: :unset, address: :unset, limit: nil, page_size: nil)
+            self.stream(identity: identity, address: address, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams ParticipantConversationInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] identity A unique string identifier for the conversation
+          #   participant as {Conversation
+          #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
+          #   parameter is non-null if (and only if) the participant is using the
+          #   Conversations SDK to communicate. Limited to 256 characters.
+          # @param [String] address A unique string identifier for the conversation
+          #   participant who's not a Conversation User. This parameter could be found in
+          #   messaging_binding.address field of Participant resource. It should be
+          #   url-encoded.
+          # @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(identity: :unset, address: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(identity: identity, address: address, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields ParticipantConversationInstance 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 ParticipantConversationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] identity A unique string identifier for the conversation
+          #   participant as {Conversation
+          #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
+          #   parameter is non-null if (and only if) the participant is using the
+          #   Conversations SDK to communicate. Limited to 256 characters.
+          # @param [String] address A unique string identifier for the conversation
+          #   participant who's not a Conversation User. This parameter could be found in
+          #   messaging_binding.address field of Participant resource. It should be
+          #   url-encoded.
+          # @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 ParticipantConversationInstance
+          def page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'Identity' => identity,
+                'Address' => address,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            ParticipantConversationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ParticipantConversationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of ParticipantConversationInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            ParticipantConversationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.ParticipantConversationList>'
+          end
+        end
+
+        class ParticipantConversationPage < Page
+          ##
+          # Initialize the ParticipantConversationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ParticipantConversationPage] ParticipantConversationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ParticipantConversationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ParticipantConversationInstance] ParticipantConversationInstance
+          def get_instance(payload)
+            ParticipantConversationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.ParticipantConversationPage>'
+          end
+        end
+
+        class ParticipantConversationInstance < InstanceResource
+          ##
+          # Initialize the ParticipantConversationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [ParticipantConversationInstance] ParticipantConversationInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'chat_service_sid' => payload['chat_service_sid'],
+                'participant_sid' => payload['participant_sid'],
+                'participant_user_sid' => payload['participant_user_sid'],
+                'participant_identity' => payload['participant_identity'],
+                'participant_messaging_binding' => payload['participant_messaging_binding'],
+                'conversation_sid' => payload['conversation_sid'],
+                'conversation_unique_name' => payload['conversation_unique_name'],
+                'conversation_friendly_name' => payload['conversation_friendly_name'],
+                'conversation_attributes' => payload['conversation_attributes'],
+                'conversation_date_created' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_created']),
+                'conversation_date_updated' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_updated']),
+                'conversation_created_by' => payload['conversation_created_by'],
+                'conversation_state' => payload['conversation_state'],
+                'conversation_timers' => payload['conversation_timers'],
+                'links' => payload['links'],
+            }
+          end
+
+          ##
+          # @return [String] The unique ID of the Account responsible for this conversation.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The unique ID of the Conversation Service this conversation belongs to.
+          def chat_service_sid
+            @properties['chat_service_sid']
+          end
+
+          ##
+          # @return [String] The unique ID of the Participant.
+          def participant_sid
+            @properties['participant_sid']
+          end
+
+          ##
+          # @return [String] The unique ID for the conversation participant as Conversation User.
+          def participant_user_sid
+            @properties['participant_user_sid']
+          end
+
+          ##
+          # @return [String] A unique string identifier for the conversation participant as Conversation User.
+          def participant_identity
+            @properties['participant_identity']
+          end
+
+          ##
+          # @return [Hash] Information about how this participant exchanges messages with the conversation.
+          def participant_messaging_binding
+            @properties['participant_messaging_binding']
+          end
+
+          ##
+          # @return [String] The unique ID of the Conversation this Participant belongs to.
+          def conversation_sid
+            @properties['conversation_sid']
+          end
+
+          ##
+          # @return [String] An application-defined string that uniquely identifies the Conversation resource
+          def conversation_unique_name
+            @properties['conversation_unique_name']
+          end
+
+          ##
+          # @return [String] The human-readable name of this conversation.
+          def conversation_friendly_name
+            @properties['conversation_friendly_name']
+          end
+
+          ##
+          # @return [String] An optional string metadata field you can use to store any data you wish.
+          def conversation_attributes
+            @properties['conversation_attributes']
+          end
+
+          ##
+          # @return [Time] The date that this conversation was created.
+          def conversation_date_created
+            @properties['conversation_date_created']
+          end
+
+          ##
+          # @return [Time] The date that this conversation was last updated.
+          def conversation_date_updated
+            @properties['conversation_date_updated']
+          end
+
+          ##
+          # @return [String] Creator of this conversation.
+          def conversation_created_by
+            @properties['conversation_created_by']
+          end
+
+          ##
+          # @return [participant_conversation.State] The current state of this User Conversation
+          def conversation_state
+            @properties['conversation_state']
+          end
+
+          ##
+          # @return [Hash] Timer date values for this conversation.
+          def conversation_timers
+            @properties['conversation_timers']
+          end
+
+          ##
+          # @return [String] Absolute URLs to access the participant and conversation of this Participant Conversation.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Conversations.V1.ParticipantConversationInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Conversations.V1.ParticipantConversationInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,366 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        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 {Conversation
+          #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] roles.
+          # @param [Array[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
+
+        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
+
+        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 [Array[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
+
+        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 Conversation 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 [Array[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] An absolute URL for this user role.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the RoleInstance
+          # @param [Array[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