twilio-ruby 5.39.2 → 5.40.3

data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb

@@ -0,0 +1,216 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Events < Domain
+      class V1 < Version
+        class SubscriptionContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SubscribedEventList < ListResource
+            ##
+            # Initialize the SubscribedEventList
+            # @param [Version] version Version that contains the resource
+            # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @return [SubscribedEventList] SubscribedEventList
+            def initialize(version, subscription_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {subscription_sid: subscription_sid}
+              @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents"
+            end
+
+            ##
+            # Lists SubscribedEventInstance 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 SubscribedEventInstance 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 SubscribedEventInstance 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 SubscribedEventInstance 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 SubscribedEventInstance
+            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)
+
+              SubscribedEventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SubscribedEventInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SubscribedEventInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SubscribedEventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Events.V1.SubscribedEventList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SubscribedEventPage < Page
+            ##
+            # Initialize the SubscribedEventPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SubscribedEventPage] SubscribedEventPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SubscribedEventInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SubscribedEventInstance] SubscribedEventInstance
+            def get_instance(payload)
+              SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Events.V1.SubscribedEventPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SubscribedEventInstance < InstanceResource
+            ##
+            # Initialize the SubscribedEventInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @return [SubscribedEventInstance] SubscribedEventInstance
+            def initialize(version, payload, subscription_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'type' => payload['type'],
+                  'version' => payload['version'].to_i,
+                  'subscription_sid' => payload['subscription_sid'],
+                  'url' => payload['url'],
+              }
+            end
+
+            ##
+            # @return [String] Account SID.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] Type of event being subscribed to.
+            def type
+              @properties['type']
+            end
+
+            ##
+            # @return [String] The schema version that the subscription should use.
+            def version
+              @properties['version']
+            end
+
+            ##
+            # @return [String] Subscription SID.
+            def subscription_sid
+              @properties['subscription_sid']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Events.V1.SubscribedEventInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Events.V1.SubscribedEventInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -166,7 +166,8 @@ module Twilio
           #   defaults to `fine`.
           # @param [String] status_callback The URL we should call using the `POST` method
           #   to send [status
-          #   information](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback) to your application when the status of the fax changes.
+          #   information](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback)
+          #   to your application when the status of the fax changes.
           # @param [String] from The number the fax was sent from. Can be the phone number
           #   in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the SIP
           #   `from` value. The caller ID displayed to the recipient uses this value. If this

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

@@ -28,6 +28,12 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @return [Twilio::REST::Messaging::V1::DeactivationsInstance]
+      def deactivations
+        self.v1.deactivations()
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.

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

@@ -15,9 +15,16 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @deactivations = nil
           @services = nil
         end
 
+        ##
+        # @return [Twilio::REST::Messaging::V1::DeactivationsContext]
+        def deactivations
+          @deactivations ||= DeactivationsContext.new self
+        end
+
         ##
         # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.

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

@@ -0,0 +1,164 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        class DeactivationsList < ListResource
+          ##
+          # Initialize the DeactivationsList
+          # @param [Version] version Version that contains the resource
+          # @return [DeactivationsList] DeactivationsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.DeactivationsList>'
+          end
+        end
+
+        class DeactivationsPage < Page
+          ##
+          # Initialize the DeactivationsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DeactivationsPage] DeactivationsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DeactivationsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DeactivationsInstance] DeactivationsInstance
+          def get_instance(payload)
+            DeactivationsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.DeactivationsPage>'
+          end
+        end
+
+        class DeactivationsContext < InstanceContext
+          ##
+          # Initialize the DeactivationsContext
+          # @param [Version] version Version that contains the resource
+          # @return [DeactivationsContext] DeactivationsContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Deactivations"
+          end
+
+          ##
+          # Fetch the DeactivationsInstance
+          # @param [Date] date The request will return a list of all United States Phone
+          #   Numbers that were deactivated on the day specified by this parameter. This date
+          #   should be specified in YYYY-MM-DD format.
+          # @return [DeactivationsInstance] Fetched DeactivationsInstance
+          def fetch(date: :unset)
+            params = Twilio::Values.of({'Date' => Twilio.serialize_iso8601_date(date), })
+
+            payload = @version.fetch('GET', @uri, params: params)
+
+            DeactivationsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DeactivationsContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DeactivationsContext #{context}>"
+          end
+        end
+
+        class DeactivationsInstance < InstanceResource
+          ##
+          # Initialize the DeactivationsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [DeactivationsInstance] DeactivationsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'redirect_to' => payload['redirect_to'], }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          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 [DeactivationsContext] DeactivationsContext for this DeactivationsInstance
+          def context
+            unless @instance_context
+              @instance_context = DeactivationsContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Redirect url to the list of deactivated numbers.
+          def redirect_to
+            @properties['redirect_to']
+          end
+
+          ##
+          # Fetch the DeactivationsInstance
+          # @param [Date] date The request will return a list of all United States Phone
+          #   Numbers that were deactivated on the day specified by this parameter. This date
+          #   should be specified in YYYY-MM-DD format.
+          # @return [DeactivationsInstance] Fetched DeactivationsInstance
+          def fetch(date: :unset)
+            context.fetch(date: date, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DeactivationsInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DeactivationsInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -41,7 +41,8 @@ module Twilio
           # @param [String] fallback_method The HTTP method we should use to call
           #   `fallback_url`. Can be: `GET` or `POST`.
           # @param [String] status_callback The URL we should call to [pass status
-          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
+          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values)
+          #   about message delivery.
           # @param [Boolean] sticky_sender Whether to enable [Sticky
           #   Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service
           #   instance.
@@ -240,7 +241,8 @@ module Twilio
           # @param [String] fallback_method The HTTP method we should use to call
           #   `fallback_url`. Can be: `GET` or `POST`.
           # @param [String] status_callback The URL we should call to [pass status
-          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
+          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values)
+          #   about message delivery.
           # @param [Boolean] sticky_sender Whether to enable [Sticky
           #   Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service
           #   instance.
@@ -557,7 +559,8 @@ module Twilio
           # @param [String] fallback_method The HTTP method we should use to call
           #   `fallback_url`. Can be: `GET` or `POST`.
           # @param [String] status_callback The URL we should call to [pass status
-          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
+          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values)
+          #   about message delivery.
           # @param [Boolean] sticky_sender Whether to enable [Sticky
           #   Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service
           #   instance.