twilio-ruby 5.52.0 → 5.67.3

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

@@ -33,8 +33,8 @@ module Twilio
             # Create the UsAppToPersonInstance
             # @param [String] brand_registration_sid A2P Brand Registration SID
             # @param [String] description A short description of what this SMS campaign does.
-            # @param [Array[String]] message_samples Message samples, up to 5 sample messages,
-            #   <=1024 chars each.
+            # @param [Array[String]] message_samples Message samples, at least 2 and up to 5
+            #   sample messages, <=1024 chars each.
             # @param [String] us_app_to_person_usecase A2P Campaign Use Case. Examples: [ 2FA,
             #   EMERGENCY, MARKETING..]
             # @param [Boolean] has_embedded_links Indicates that this SMS campaign will send
@@ -62,23 +62,83 @@ module Twilio
             end
 
             ##
-            # Delete the UsAppToPersonInstance
-            # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-               @version.delete('DELETE', @uri)
+            # Lists UsAppToPersonInstance 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
 
             ##
-            # Fetch the UsAppToPersonInstance
-            # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
-            def fetch
-              payload = @version.fetch('GET', @uri)
+            # Streams UsAppToPersonInstance 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
 
-              UsAppToPersonInstance.new(
-                  @version,
-                  payload,
-                  messaging_service_sid: @solution[:messaging_service_sid],
+            ##
+            # When passed a block, yields UsAppToPersonInstance 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 UsAppToPersonInstance 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 UsAppToPersonInstance
+            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)
+
+              UsAppToPersonPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of UsAppToPersonInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of UsAppToPersonInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
               )
+              UsAppToPersonPage.new(@version, response, @solution)
             end
 
             ##
@@ -123,6 +183,62 @@ module Twilio
             end
           end
 
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class UsAppToPersonContext < InstanceContext
+            ##
+            # Initialize the UsAppToPersonContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] messaging_service_sid The SID of the {Messaging
+            #   Service}[https://www.twilio.com/docs/messaging/services/api] to fetch the
+            #   resource from.
+            # @param [String] sid The SID of the US A2P Compliance resource to fetch
+            #   `QE2c6890da8086d771620e9b13fadeba0b`.
+            # @return [UsAppToPersonContext] UsAppToPersonContext
+            def initialize(version, messaging_service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {messaging_service_sid: messaging_service_sid, sid: sid, }
+              @uri = "/Services/#{@solution[:messaging_service_sid]}/Compliance/Usa2p/#{@solution[:sid]}"
+            end
+
+            ##
+            # Delete the UsAppToPersonInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Fetch the UsAppToPersonInstance
+            # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              UsAppToPersonInstance.new(
+                  @version,
+                  payload,
+                  messaging_service_sid: @solution[:messaging_service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.UsAppToPersonContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.UsAppToPersonContext #{context}>"
+            end
+          end
+
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UsAppToPersonInstance < InstanceResource
@@ -133,12 +249,15 @@ module Twilio
             # @param [String] messaging_service_sid The SID of the {Messaging
             #   Service}[https://www.twilio.com/docs/messaging/services/api] that the resource
             #   is associated with.
+            # @param [String] sid The SID of the US A2P Compliance resource to fetch
+            #   `QE2c6890da8086d771620e9b13fadeba0b`.
             # @return [UsAppToPersonInstance] UsAppToPersonInstance
-            def initialize(version, payload, messaging_service_sid: nil)
+            def initialize(version, payload, messaging_service_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
+                  'sid' => payload['sid'],
                   'account_sid' => payload['account_sid'],
                   'brand_registration_sid' => payload['brand_registration_sid'],
                   'messaging_service_sid' => payload['messaging_service_sid'],
@@ -147,14 +266,40 @@ module Twilio
                   'us_app_to_person_usecase' => payload['us_app_to_person_usecase'],
                   'has_embedded_links' => payload['has_embedded_links'],
                   'has_embedded_phone' => payload['has_embedded_phone'],
-                  'status' => payload['status'],
+                  'campaign_status' => payload['campaign_status'],
                   'campaign_id' => payload['campaign_id'],
                   'is_externally_registered' => payload['is_externally_registered'],
                   'rate_limits' => payload['rate_limits'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
+                  'mock' => payload['mock'],
               }
+
+              # Context
+              @instance_context = nil
+              @params = {'messaging_service_sid' => messaging_service_sid, '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 [UsAppToPersonContext] UsAppToPersonContext for this UsAppToPersonInstance
+            def context
+              unless @instance_context
+                @instance_context = UsAppToPersonContext.new(
+                    @version,
+                    @params['messaging_service_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies a US A2P Compliance resource
+            def sid
+              @properties['sid']
             end
 
             ##
@@ -207,8 +352,8 @@ module Twilio
 
             ##
             # @return [String] Campaign status
-            def status
-              @properties['status']
+            def campaign_status
+              @properties['campaign_status']
             end
 
             ##
@@ -247,16 +392,38 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [Boolean] A boolean that specifies whether campaign is a mock or not.
+            def mock
+              @properties['mock']
+            end
+
+            ##
+            # Delete the UsAppToPersonInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Fetch the UsAppToPersonInstance
+            # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
+            def fetch
+              context.fetch
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Messaging.V1.UsAppToPersonInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.UsAppToPersonInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Messaging.V1.UsAppToPersonInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.UsAppToPersonInstance #{values}>"
             end
           end
         end

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

@@ -30,9 +30,13 @@ module Twilio
 
             ##
             # Fetch the UsAppToPersonUsecaseInstance
+            # @param [String] brand_registration_sid The unique string to identify the A2P
+            #   brand.
             # @return [UsAppToPersonUsecaseInstance] Fetched UsAppToPersonUsecaseInstance
-            def fetch
-              payload = @version.fetch('GET', @uri)
+            def fetch(brand_registration_sid: :unset)
+              params = Twilio::Values.of({'BrandRegistrationSid' => brand_registration_sid, })
+
+              payload = @version.fetch('GET', @uri, params: params)
 
               UsAppToPersonUsecaseInstance.new(
                   @version,

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

@@ -67,6 +67,9 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..].
           # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
           #   either the webhook url configured on the phone number will be used or
           #   `inbound_request_url`/`fallback_url` url will be called when a message is
@@ -74,7 +77,7 @@ module Twilio
           #   defined on the phone number will override the
           #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Created ServiceInstance
-          def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset)
+          def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'InboundRequestUrl' => inbound_request_url,
@@ -90,6 +93,7 @@ module Twilio
                 'AreaCodeGeomatch' => area_code_geomatch,
                 'ValidityPeriod' => validity_period,
                 'SynchronousValidation' => synchronous_validation,
+                'Usecase' => usecase,
                 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
             })
 
@@ -281,6 +285,9 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..]
           # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
           #   either the webhook url configured on the phone number will be used or
           #   `inbound_request_url`/`fallback_url` url will be called when a message is
@@ -288,7 +295,7 @@ module Twilio
           #   defined on the phone number will override the
           #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset)
+          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'InboundRequestUrl' => inbound_request_url,
@@ -304,6 +311,7 @@ module Twilio
                 'AreaCodeGeomatch' => area_code_geomatch,
                 'ValidityPeriod' => validity_period,
                 'SynchronousValidation' => synchronous_validation,
+                'Usecase' => usecase,
                 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
             })
 
@@ -385,8 +393,14 @@ module Twilio
           ##
           # Access the us_app_to_person
           # @return [UsAppToPersonList]
-          # @return [UsAppToPersonContext]
-          def us_app_to_person
+          # @return [UsAppToPersonContext] if sid was passed.
+          def us_app_to_person(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return UsAppToPersonContext.new(@version, @solution[:sid], sid, )
+            end
+
             unless @us_app_to_person
               @us_app_to_person = UsAppToPersonList.new(@version, messaging_service_sid: @solution[:sid], )
             end
@@ -458,6 +472,8 @@ module Twilio
                 'validity_period' => payload['validity_period'].to_i,
                 'url' => payload['url'],
                 'links' => payload['links'],
+                'usecase' => payload['usecase'],
+                'us_app_to_person_registered' => payload['us_app_to_person_registered'],
                 'use_inbound_webhook_on_number' => payload['use_inbound_webhook_on_number'],
             }
 
@@ -597,6 +613,18 @@ module Twilio
             @properties['links']
           end
 
+          ##
+          # @return [String] A string describing the scenario in which the Messaging Service will be used
+          def usecase
+            @properties['usecase']
+          end
+
+          ##
+          # @return [Boolean] Whether US A2P campaign is registered for this Service.
+          def us_app_to_person_registered
+            @properties['us_app_to_person_registered']
+          end
+
           ##
           # @return [Boolean] If enabled, the webhook url configured on the phone number will be used and will override the `inbound_request_url`/`fallback_url` url called when an inbound message is received.
           def use_inbound_webhook_on_number
@@ -645,6 +673,9 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..]
           # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
           #   either the webhook url configured on the phone number will be used or
           #   `inbound_request_url`/`fallback_url` url will be called when a message is
@@ -652,7 +683,7 @@ module Twilio
           #   defined on the phone number will override the
           #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset)
+          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             context.update(
                 friendly_name: friendly_name,
                 inbound_request_url: inbound_request_url,
@@ -668,6 +699,7 @@ module Twilio
                 area_code_geomatch: area_code_geomatch,
                 validity_period: validity_period,
                 synchronous_validation: synchronous_validation,
+                usecase: usecase,
                 use_inbound_webhook_on_number: use_inbound_webhook_on_number,
             )
           end