twilio-ruby 5.40.3 → 5.74.1

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

@@ -10,8 +10,6 @@ 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 ConversationList < ListResource
           ##
           # Initialize the ConversationList
@@ -34,8 +32,8 @@ module Twilio
           #   resource's `sid` in the URL.
           # @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] messaging_service_sid The unique ID of the [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @param [String] messaging_service_sid The unique ID of the {Messaging
+          #   Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs
           #   to.
           # @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
@@ -156,8 +154,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationPage < Page
           ##
           # Initialize the ConversationPage
@@ -187,8 +183,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationContext < InstanceContext
           ##
           # Initialize the ConversationContext
@@ -219,8 +213,8 @@ module Twilio
           #   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_service_sid The unique ID of the [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @param [String] messaging_service_sid The unique ID of the {Messaging
+          #   Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs
           #   to.
           # @param [conversation.State] state Current state of this conversation. Can be
           #   either `active`, `inactive` or `closed` and defaults to `active`
@@ -228,10 +222,13 @@ module Twilio
           #   switched to `inactive` state. Minimum value for this timer is 1 minute.
           # @param [String] timers_closed ISO8601 duration when conversation will be
           #   switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used to address the resource in place of the
+          #   resource's `sid` in the URL.
           # @param [conversation.WebhookEnabledType] x_twilio_webhook_enabled The
           #   X-Twilio-Webhook-Enabled HTTP request header
           # @return [ConversationInstance] Updated ConversationInstance
-          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
@@ -241,6 +238,7 @@ module Twilio
                 'State' => state,
                 'Timers.Inactive' => timers_inactive,
                 'Timers.Closed' => timers_closed,
+                'UniqueName' => unique_name,
             })
             headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
@@ -338,8 +336,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationInstance < InstanceResource
           ##
           # Initialize the ConversationInstance
@@ -366,6 +362,7 @@ module Twilio
                 'timers' => payload['timers'],
                 'url' => payload['url'],
                 'links' => payload['links'],
+                'bindings' => payload['bindings'],
             }
 
             # Context
@@ -457,11 +454,17 @@ module Twilio
           end
 
           ##
-          # @return [String] Absolute URLs to access the Participants, Messages and Webhooks of this Conversation.
+          # @return [String] Absolute URLs to access the participants, messages and webhooks of this conversation.
           def links
             @properties['links']
           end
 
+          ##
+          # @return [Hash] The bindings
+          def bindings
+            @properties['bindings']
+          end
+
           ##
           # Update the ConversationInstance
           # @param [String] friendly_name The human-readable name of this conversation,
@@ -472,8 +475,8 @@ module Twilio
           #   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_service_sid The unique ID of the [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @param [String] messaging_service_sid The unique ID of the {Messaging
+          #   Service}[https://www.twilio.com/docs/sms/services/api] this conversation belongs
           #   to.
           # @param [conversation.State] state Current state of this conversation. Can be
           #   either `active`, `inactive` or `closed` and defaults to `active`
@@ -481,10 +484,13 @@ module Twilio
           #   switched to `inactive` state. Minimum value for this timer is 1 minute.
           # @param [String] timers_closed ISO8601 duration when conversation will be
           #   switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used to address the resource in place of the
+          #   resource's `sid` in the URL.
           # @param [conversation.WebhookEnabledType] x_twilio_webhook_enabled The
           #   X-Twilio-Webhook-Enabled HTTP request header
           # @return [ConversationInstance] Updated ConversationInstance
-          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset)
             context.update(
                 friendly_name: friendly_name,
                 date_created: date_created,
@@ -494,6 +500,7 @@ module Twilio
                 state: state,
                 timers_inactive: timers_inactive,
                 timers_closed: timers_closed,
+                unique_name: unique_name,
                 x_twilio_webhook_enabled: x_twilio_webhook_enabled,
             )
           end

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

@@ -10,8 +10,6 @@ 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 CredentialList < ListResource
           ##
           # Initialize the CredentialList
@@ -151,8 +149,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class CredentialPage < Page
           ##
           # Initialize the CredentialPage
@@ -182,8 +178,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class CredentialContext < InstanceContext
           ##
           # Initialize the CredentialContext
@@ -269,8 +263,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class CredentialInstance < InstanceResource
           ##
           # Initialize the CredentialInstance

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

@@ -10,8 +10,6 @@ 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
@@ -30,13 +28,13 @@ module Twilio
           # @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 [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`.
+          #   {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({
@@ -137,8 +135,6 @@ module Twilio
           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
@@ -168,8 +164,6 @@ module Twilio
           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
@@ -186,8 +180,8 @@ module Twilio
 
           ##
           # 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,
+          # @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
@@ -232,8 +226,6 @@ module Twilio
           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
@@ -304,7 +296,7 @@ module Twilio
           end
 
           ##
-          # @return [String] An array of the permissions the role has been granted
+          # @return [Array[String]] An array of the permissions the role has been granted
           def permissions
             @properties['permissions']
           end
@@ -322,15 +314,15 @@ module Twilio
           end
 
           ##
-          # @return [String] The absolute URL of the Role resource
+          # @return [String] An absolute URL for this user role.
           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,
+          # @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