twilio-ruby 5.31.1 → 5.54.0

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

@@ -30,7 +30,7 @@ module Twilio
 
       ##
       # @param [String] phone_number The phone number in
-      #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+      #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
       #   of a + followed by the country code and subscriber number.
       # @return [Twilio::REST::Lookups::V1::PhoneNumberInstance] if phone_number was passed.
       # @return [Twilio::REST::Lookups::V1::PhoneNumberList]

data/lib/twilio-ruby/rest/lookups/v1.rb

@@ -20,17 +20,18 @@ module Twilio
 
         ##
         # @param [String] phone_number The phone number to lookup in
-        #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+        #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
         #   of a + followed by the country code and subscriber number.
         # @return [Twilio::REST::Lookups::V1::PhoneNumberContext] if phone_number was passed.
         # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
         def phone_numbers(phone_number=:unset)
           if phone_number.nil?
-            raise ArgumentError, 'phone_number cannot be nil'
-          elsif phone_number == :unset
-            @phone_numbers ||= PhoneNumberList.new self
+              raise ArgumentError, 'phone_number cannot be nil'
+          end
+          if phone_number == :unset
+              @phone_numbers ||= PhoneNumberList.new self
           else
-            PhoneNumberContext.new(self, phone_number)
+              PhoneNumberContext.new(self, phone_number)
           end
         end
 

data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb

@@ -63,7 +63,7 @@ module Twilio
           # Initialize the PhoneNumberContext
           # @param [Version] version Version that contains the resource
           # @param [String] phone_number The phone number to lookup in
-          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+          #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
           #   of a + followed by the country code and subscriber number.
           # @return [PhoneNumberContext] PhoneNumberContext
           def initialize(version, phone_number)
@@ -75,22 +75,22 @@ module Twilio
           end
 
           ##
-          # Fetch a PhoneNumberInstance
-          # @param [String] country_code The [ISO country
-          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to
+          # Fetch the PhoneNumberInstance
+          # @param [String] country_code The {ISO country
+          #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the phone number to
           #   fetch. This is used to specify the country when the phone number is provided in
           #   a national format.
-          # @param [String] type The type of information to return. Can be: `carrier` or
-          #   `caller-name`. The default is null.  Carrier information costs $0.005 per phone
-          #   number looked up.  Caller Name information is currently available only in the US
-          #   and costs $0.01 per phone number looked up.  To retrieve both types on
+          # @param [Array[String]] type The type of information to return. Can be: `carrier`
+          #   or `caller-name`. The default is null.  Carrier information costs $0.005 per
+          #   phone number looked up.  Caller Name information is currently available only in
+          #   the US and costs $0.01 per phone number looked up.  To retrieve both types on
           #   information, specify this parameter twice; once with `carrier` and once with
           #   `caller-name` as the value.
-          # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke.
-          #   Can be the `unique_name` of an Add-on that is installed on your account. You can
-          #   specify multiple instances of this parameter to invoke multiple Add-ons. For
-          #   more information about  Add-ons, see the [Add-ons
-          #   documentation](https://www.twilio.com/docs/add-ons).
+          # @param [Array[String]] add_ons The `unique_name` of an Add-on you would like to
+          #   invoke. Can be the `unique_name` of an Add-on that is installed on your account.
+          #   You can specify multiple instances of this parameter to invoke multiple Add-ons.
+          #   For more information about  Add-ons, see the {Add-ons
+          #   documentation}[https://www.twilio.com/docs/add-ons].
           # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke.
           #   The content and format of this value depends on the add-on.
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
@@ -100,13 +100,9 @@ module Twilio
                 'Type' => Twilio.serialize_list(type) { |e| e },
                 'AddOns' => Twilio.serialize_list(add_ons) { |e| e },
             })
-
             params.merge!(Twilio.prefixed_collapsible_map(add_ons_data, 'AddOns'))
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+
+            payload = @version.fetch('GET', @uri, params: params)
 
             PhoneNumberInstance.new(@version, payload, phone_number: @solution[:phone_number], )
           end
@@ -132,7 +128,7 @@ module Twilio
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
           # @param [String] phone_number The phone number to lookup in
-          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+          #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
           #   of a + followed by the country code and subscriber number.
           # @return [PhoneNumberInstance] PhoneNumberInstance
           def initialize(version, payload, phone_number: nil)
@@ -208,22 +204,22 @@ module Twilio
           end
 
           ##
-          # Fetch a PhoneNumberInstance
-          # @param [String] country_code The [ISO country
-          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to
+          # Fetch the PhoneNumberInstance
+          # @param [String] country_code The {ISO country
+          #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the phone number to
           #   fetch. This is used to specify the country when the phone number is provided in
           #   a national format.
-          # @param [String] type The type of information to return. Can be: `carrier` or
-          #   `caller-name`. The default is null.  Carrier information costs $0.005 per phone
-          #   number looked up.  Caller Name information is currently available only in the US
-          #   and costs $0.01 per phone number looked up.  To retrieve both types on
+          # @param [Array[String]] type The type of information to return. Can be: `carrier`
+          #   or `caller-name`. The default is null.  Carrier information costs $0.005 per
+          #   phone number looked up.  Caller Name information is currently available only in
+          #   the US and costs $0.01 per phone number looked up.  To retrieve both types on
           #   information, specify this parameter twice; once with `carrier` and once with
           #   `caller-name` as the value.
-          # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke.
-          #   Can be the `unique_name` of an Add-on that is installed on your account. You can
-          #   specify multiple instances of this parameter to invoke multiple Add-ons. For
-          #   more information about  Add-ons, see the [Add-ons
-          #   documentation](https://www.twilio.com/docs/add-ons).
+          # @param [Array[String]] add_ons The `unique_name` of an Add-on you would like to
+          #   invoke. Can be the `unique_name` of an Add-on that is installed on your account.
+          #   You can specify multiple instances of this parameter to invoke multiple Add-ons.
+          #   For more information about  Add-ons, see the {Add-ons
+          #   documentation}[https://www.twilio.com/docs/add-ons].
           # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke.
           #   The content and format of this value depends on the add-on.
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance

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

@@ -28,6 +28,26 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [String] sid The unique string to identify Brand Registration.
+      # @return [Twilio::REST::Messaging::V1::BrandRegistrationInstance] if sid was passed.
+      # @return [Twilio::REST::Messaging::V1::BrandRegistrationList]
+      def brand_registrations(sid=:unset)
+        self.v1.brand_registrations(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Messaging::V1::DeactivationsInstance]
+      def deactivations
+        self.v1.deactivations()
+      end
+
+      ##
+      # @return [Twilio::REST::Messaging::V1::ExternalCampaignInstance]
+      def external_campaign
+        self.v1.external_campaign()
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.
@@ -38,18 +58,9 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique string that we created to identify the Session
-      #   resource.
-      # @return [Twilio::REST::Messaging::V1::SessionInstance] if sid was passed.
-      # @return [Twilio::REST::Messaging::V1::SessionList]
-      def sessions(sid=:unset)
-        self.v1.sessions(sid)
-      end
-
-      ##
-      # @return [Twilio::REST::Messaging::V1::WebhookInstance]
-      def webhooks
-        self.v1.webhooks()
+      # @return [Twilio::REST::Messaging::V1::UsecaseInstance]
+      def usecases
+        self.v1.usecases()
       end
 
       ##

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

@@ -15,43 +15,59 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @brand_registrations = nil
+          @deactivations = nil
+          @external_campaign = nil
           @services = nil
-          @sessions = nil
-          @webhooks = nil
+          @usecases = nil
         end
 
         ##
-        # @param [String] sid The SID of the Service resource to fetch.
-        # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
-        # @return [Twilio::REST::Messaging::V1::ServiceList]
-        def services(sid=:unset)
+        # @param [String] sid The SID of the Brand Registration resource to fetch.
+        # @return [Twilio::REST::Messaging::V1::BrandRegistrationContext] if sid was passed.
+        # @return [Twilio::REST::Messaging::V1::BrandRegistrationList]
+        def brand_registrations(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @brand_registrations ||= BrandRegistrationList.new self
           else
-            ServiceContext.new(self, sid)
+              BrandRegistrationContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The SID of the Session resource to fetch.
-        # @return [Twilio::REST::Messaging::V1::SessionContext] if sid was passed.
-        # @return [Twilio::REST::Messaging::V1::SessionList]
-        def sessions(sid=:unset)
+        # @return [Twilio::REST::Messaging::V1::DeactivationsContext]
+        def deactivations
+          @deactivations ||= DeactivationsContext.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Messaging::V1::ExternalCampaignContext]
+        def external_campaign
+          @external_campaign ||= ExternalCampaignList.new self
+        end
+
+        ##
+        # @param [String] sid The SID of the Service resource to fetch.
+        # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Messaging::V1::ServiceList]
+        def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @sessions ||= SessionList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            SessionContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 
         ##
-        # @return [Twilio::REST::Messaging::V1::WebhookContext]
-        def webhooks
-          @webhooks ||= WebhookContext.new self
+        # @return [Twilio::REST::Messaging::V1::UsecaseContext]
+        def usecases
+          @usecases ||= UsecaseList.new self
         end
 
         ##

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

@@ -0,0 +1,328 @@
+##
+# 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 BrandRegistrationList < ListResource
+          ##
+          # Initialize the BrandRegistrationList
+          # @param [Version] version Version that contains the resource
+          # @return [BrandRegistrationList] BrandRegistrationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/a2p/BrandRegistrations"
+          end
+
+          ##
+          # Lists BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance
+          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)
+
+            BrandRegistrationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of BrandRegistrationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of BrandRegistrationInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            BrandRegistrationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Create the BrandRegistrationInstance
+          # @param [String] customer_profile_bundle_sid Customer Profile Bundle Sid.
+          # @param [String] a2p_profile_bundle_sid A2P Messaging Profile Bundle Sid.
+          # @return [BrandRegistrationInstance] Created BrandRegistrationInstance
+          def create(customer_profile_bundle_sid: nil, a2p_profile_bundle_sid: nil)
+            data = Twilio::Values.of({
+                'CustomerProfileBundleSid' => customer_profile_bundle_sid,
+                'A2PProfileBundleSid' => a2p_profile_bundle_sid,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            BrandRegistrationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.BrandRegistrationList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationPage < Page
+          ##
+          # Initialize the BrandRegistrationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BrandRegistrationPage] BrandRegistrationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandRegistrationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandRegistrationInstance] BrandRegistrationInstance
+          def get_instance(payload)
+            BrandRegistrationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.BrandRegistrationPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationContext < InstanceContext
+          ##
+          # Initialize the BrandRegistrationContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the Brand Registration resource to fetch.
+          # @return [BrandRegistrationContext] BrandRegistrationContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/a2p/BrandRegistrations/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            BrandRegistrationInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationInstance < InstanceResource
+          ##
+          # Initialize the BrandRegistrationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the Brand Registration resource to fetch.
+          # @return [BrandRegistrationInstance] BrandRegistrationInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'customer_profile_bundle_sid' => payload['customer_profile_bundle_sid'],
+                'a2p_profile_bundle_sid' => payload['a2p_profile_bundle_sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'status' => payload['status'],
+                'tcr_id' => payload['tcr_id'],
+                'failure_reason' => payload['failure_reason'],
+                '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 [BrandRegistrationContext] BrandRegistrationContext for this BrandRegistrationInstance
+          def context
+            unless @instance_context
+              @instance_context = BrandRegistrationContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A2P BrandRegistration Sid
+          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] A2P Messaging Profile Bundle BundleSid
+          def customer_profile_bundle_sid
+            @properties['customer_profile_bundle_sid']
+          end
+
+          ##
+          # @return [String] A2P Messaging Profile Bundle BundleSid
+          def a2p_profile_bundle_sid
+            @properties['a2p_profile_bundle_sid']
+          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 [brand_registration.Status] Brand Registration status
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [String] Campaign Registry (TCR) Brand ID
+          def tcr_id
+            @properties['tcr_id']
+          end
+
+          ##
+          # @return [String] A reason why brand registration has failed
+          def failure_reason
+            @properties['failure_reason']
+          end
+
+          ##
+          # @return [String] The absolute URL of the Brand Registration
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end