twilio-ruby 5.44.0 → 5.47.0

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

@@ -296,7 +296,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

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

@@ -302,7 +302,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

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

@@ -297,7 +297,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

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

@@ -0,0 +1,198 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UseCaseList < ListResource
+          ##
+          # Initialize the UseCaseList
+          # @param [Version] version Version that contains the resource
+          # @return [UseCaseList] UseCaseList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/a2p/UseCases"
+          end
+
+          ##
+          # Lists UseCaseInstance 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 UseCaseInstance 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 UseCaseInstance 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 UseCaseInstance 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 UseCaseInstance
+          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)
+
+            UseCasePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of UseCaseInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of UseCaseInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            UseCasePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.UseCaseList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UseCasePage < Page
+          ##
+          # Initialize the UseCasePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UseCasePage] UseCasePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UseCaseInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UseCaseInstance] UseCaseInstance
+          def get_instance(payload)
+            UseCaseInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.UseCasePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UseCaseInstance < InstanceResource
+          ##
+          # Initialize the UseCaseInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [UseCaseInstance] UseCaseInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'name' => payload['name'],
+                'code' => payload['code'],
+                'description' => payload['description'],
+            }
+          end
+
+          ##
+          # @return [String] Human readable name
+          def name
+            @properties['name']
+          end
+
+          ##
+          # @return [String] Unique Use Case code
+          def code
+            @properties['code']
+          end
+
+          ##
+          # @return [String] Description of Use Case
+          def description
+            @properties['description']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Messaging.V1.UseCaseInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Messaging.V1.UseCaseInstance>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/notify/v1/service/binding.rb

@@ -41,8 +41,9 @@ module Twilio
             #   token. For FCM and GCM, the registration token. For SMS, a phone number in E.164
             #   format. For Facebook Messenger, the Messenger ID of the user or a phone number
             #   in E.164 format.
-            # @param [String] tag A tag that can be used to select the Bindings to notify.
-            #   Repeat this parameter to specify more than one tag, up to a total of 20 tags.
+            # @param [Array[String]] tag A tag that can be used to select the Bindings to
+            #   notify. Repeat this parameter to specify more than one tag, up to a total of 20
+            #   tags.
             # @param [String] notification_protocol_version The protocol version to use to
             #   send the notification. This defaults to the value of
             #   `default_xxxx_notification_protocol_version` for the protocol in the
@@ -81,12 +82,12 @@ module Twilio
             #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
             # @param [Date] end_date Only include usage that occurred on or before this date.
             #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [String] identity The
+            # @param [Array[String]] identity The
             #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
             #   of the resources to read.
-            # @param [String] tag Only list Bindings that have all of the specified Tags. The
-            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
-            #   `facebook-messenger`. Up to 5 tags are allowed.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -113,12 +114,12 @@ module Twilio
             #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
             # @param [Date] end_date Only include usage that occurred on or before this date.
             #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [String] identity The
+            # @param [Array[String]] identity The
             #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
             #   of the resources to read.
-            # @param [String] tag Only list Bindings that have all of the specified Tags. The
-            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
-            #   `facebook-messenger`. Up to 5 tags are allowed.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -161,12 +162,12 @@ module Twilio
             #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
             # @param [Date] end_date Only include usage that occurred on or before this date.
             #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [String] identity The
+            # @param [Array[String]] identity The
             #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
             #   of the resources to read.
-            # @param [String] tag Only list Bindings that have all of the specified Tags. The
-            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
-            #   `facebook-messenger`. Up to 5 tags are allowed.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -406,7 +407,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The list of tags associated with this Binding
+            # @return [Array[String]] The list of tags associated with this Binding
             def tags
               @properties['tags']
             end

data/lib/twilio-ruby/rest/notify/v1/service/notification.rb

@@ -107,24 +107,24 @@ module Twilio
             #   FCM also {reserves certain
             #   keys}[https://firebase.google.com/docs/cloud-messaging/http-server-ref], which
             #   cannot be used in that channel.
-            # @param [String] segment The Segment resource is deprecated. Use the `tag`
+            # @param [Array[String]] segment The Segment resource is deprecated. Use the `tag`
             #   parameter, instead.
             # @param [Hash] alexa Deprecated.
-            # @param [String] to_binding The destination address specified as a JSON string.
-            #   Multiple `to_binding` parameters can be included but the total size of the
-            #   request entity should not exceed 1MB. This is typically sufficient for 10,000
-            #   phone numbers.
+            # @param [Array[String]] to_binding The destination address specified as a JSON
+            #   string.  Multiple `to_binding` parameters can be included but the total size of
+            #   the request entity should not exceed 1MB. This is typically sufficient for
+            #   10,000 phone numbers.
             # @param [String] delivery_callback_url URL to send webhooks.
-            # @param [String] identity The `identity` value that uniquely identifies the new
-            #   resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within
-            #   the {Service}[https://www.twilio.com/docs/notify/api/service-resource]. Delivery
-            #   will be attempted only to Bindings with an Identity in this list. No more than
-            #   20 items are allowed in this list.
-            # @param [String] tag A tag that selects the Bindings to notify. Repeat this
-            #   parameter to specify more than one tag, up to a total of 5 tags. The implicit
-            #   tag `all` is available to notify all Bindings in a Service instance. Similarly,
-            #   the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are
-            #   available to notify all Bindings in a specific channel.
+            # @param [Array[String]] identity The `identity` value that uniquely identifies
+            #   the new resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource]
+            #   within the {Service}[https://www.twilio.com/docs/notify/api/service-resource].
+            #   Delivery will be attempted only to Bindings with an Identity in this list. No
+            #   more than 20 items are allowed in this list.
+            # @param [Array[String]] tag A tag that selects the Bindings to notify. Repeat
+            #   this parameter to specify more than one tag, up to a total of 5 tags. The
+            #   implicit tag `all` is available to notify all Bindings in a Service instance.
+            #   Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger`
+            #   are available to notify all Bindings in a specific channel.
             # @return [NotificationInstance] Created NotificationInstance
             def create(body: :unset, priority: :unset, ttl: :unset, title: :unset, sound: :unset, action: :unset, data: :unset, apn: :unset, gcm: :unset, sms: :unset, facebook_messenger: :unset, fcm: :unset, segment: :unset, alexa: :unset, to_binding: :unset, delivery_callback_url: :unset, identity: :unset, tag: :unset)
               data = Twilio::Values.of({
@@ -255,19 +255,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The list of identity values of the Users to notify
+            # @return [Array[String]] The list of identity values of the Users to notify
             def identities
               @properties['identities']
             end
 
             ##
-            # @return [String] The tags that select the Bindings to notify
+            # @return [Array[String]] The tags that select the Bindings to notify
             def tags
               @properties['tags']
             end
 
             ##
-            # @return [String] The list of Segments to notify
+            # @return [Array[String]] The list of Segments to notify
             def segments
               @properties['segments']
             end

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb

@@ -263,7 +263,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The results of the Evaluation resource
+              # @return [Array[Hash]] The results of the Evaluation resource
               def results
                 @properties['results']
               end

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb

@@ -234,7 +234,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] The required information for creating an End-User.
+            # @return [Array[Hash]] The required information for creating an End-User.
             def fields
               @properties['fields']
             end

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb

@@ -234,7 +234,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] The required information for creating a Supporting Document
+            # @return [Array[Hash]] The required information for creating a Supporting Document
             def fields
               @properties['fields']
             end

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

@@ -78,7 +78,8 @@ module Twilio
       end
 
       ##
-      # @param [String] resource_type The type of communication – Messages, Calls
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
       # @return [Twilio::REST::Preview::BulkExports::ExportInstance] if resource_type was passed.
       # @return [Twilio::REST::Preview::BulkExports::ExportList]
       def exports(resource_type=:unset)
@@ -86,7 +87,8 @@ module Twilio
       end
 
       ##
-      # @param [String] resource_type The type of communication – Messages, Calls
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
       # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationInstance] if resource_type was passed.
       # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationList]
       def export_configuration(resource_type=:unset)
@@ -180,12 +182,6 @@ module Twilio
         self.wireless.sims(sid)
       end
 
-      ##
-      # @return [Twilio::REST::Preview::TrustedComms::BrandedCallInstance]
-      def branded_calls
-        self.trusted_comms.branded_calls()
-      end
-
       ##
       # @param [String] sid The unique SID identifier of the Branded Channel.
       # @return [Twilio::REST::Preview::TrustedComms::BrandedChannelInstance] if sid was passed.
@@ -200,15 +196,6 @@ module Twilio
         self.trusted_comms.brands_information()
       end
 
-      ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   Business.
-      # @return [Twilio::REST::Preview::TrustedComms::BusinessInstance] if sid was passed.
-      # @return [Twilio::REST::Preview::TrustedComms::BusinessList]
-      def businesses(sid=:unset)
-        self.trusted_comms.businesses(sid)
-      end
-
       ##
       # @return [Twilio::REST::Preview::TrustedComms::CpsInstance]
       def cps
@@ -221,12 +208,6 @@ module Twilio
         self.trusted_comms.current_calls()
       end
 
-      ##
-      # @return [Twilio::REST::Preview::TrustedComms::PhoneCallInstance]
-      def phone_calls
-        self.trusted_comms.phone_calls()
-      end
-
       ##
       # Provide a user friendly representation
       def to_s