twilio-ruby 5.72.0 → 5.77.0

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

@@ -0,0 +1,242 @@
+##
+# 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 DomainConfigList < ListResource
+          ##
+          # Initialize the DomainConfigList
+          # @param [Version] version Version that contains the resource
+          # @return [DomainConfigList] DomainConfigList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.DomainConfigList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigPage < Page
+          ##
+          # Initialize the DomainConfigPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DomainConfigPage] DomainConfigPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DomainConfigInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DomainConfigInstance] DomainConfigInstance
+          def get_instance(payload)
+            DomainConfigInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.DomainConfigPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigContext < InstanceContext
+          ##
+          # Initialize the DomainConfigContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] domain_sid Unique string used to identify the domain that this
+          #   config should be associated with.
+          # @return [DomainConfigContext] DomainConfigContext
+          def initialize(version, domain_sid)
+            super(version)
+
+            # Path Solution
+            @solution = {domain_sid: domain_sid, }
+            @uri = "/LinkShortening/Domains/#{@solution[:domain_sid]}/Config"
+          end
+
+          ##
+          # Update the DomainConfigInstance
+          # @param [String] fallback_url Any requests we receive to this domain that do not
+          #   match an existing shortened message will be redirected to the fallback url.
+          #   These will likely be either expired messages, random misdirected traffic, or
+          #   intentional scraping.
+          # @param [String] callback_url URL to receive click events to your webhook
+          #   whenever the recipients click on the shortened links
+          # @return [DomainConfigInstance] Updated DomainConfigInstance
+          def update(fallback_url: :unset, callback_url: :unset)
+            data = Twilio::Values.of({'FallbackUrl' => fallback_url, 'CallbackUrl' => callback_url, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            DomainConfigInstance.new(@version, payload, domain_sid: @solution[:domain_sid], )
+          end
+
+          ##
+          # Fetch the DomainConfigInstance
+          # @return [DomainConfigInstance] Fetched DomainConfigInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            DomainConfigInstance.new(@version, payload, domain_sid: @solution[:domain_sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigInstance < InstanceResource
+          ##
+          # Initialize the DomainConfigInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] domain_sid Unique string used to identify the domain that this
+          #   config should be associated with.
+          # @return [DomainConfigInstance] DomainConfigInstance
+          def initialize(version, payload, domain_sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'domain_sid' => payload['domain_sid'],
+                'config_sid' => payload['config_sid'],
+                'fallback_url' => payload['fallback_url'],
+                'callback_url' => payload['callback_url'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'domain_sid' => domain_sid || @properties['domain_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 [DomainConfigContext] DomainConfigContext for this DomainConfigInstance
+          def context
+            unless @instance_context
+              @instance_context = DomainConfigContext.new(@version, @params['domain_sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain resource.
+          def domain_sid
+            @properties['domain_sid']
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain config (prefix ZK).
+          def config_sid
+            @properties['config_sid']
+          end
+
+          ##
+          # @return [String] We will redirect requests to urls we are unable to identify to this url.
+          def fallback_url
+            @properties['fallback_url']
+          end
+
+          ##
+          # @return [String] URL to receive click events to your webhook whenever the recipients click on the shortened links.
+          def callback_url
+            @properties['callback_url']
+          end
+
+          ##
+          # @return [Time] Date this Domain Config was created.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] Date that this Domain Config was last updated.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the DomainConfigInstance
+          # @param [String] fallback_url Any requests we receive to this domain that do not
+          #   match an existing shortened message will be redirected to the fallback url.
+          #   These will likely be either expired messages, random misdirected traffic, or
+          #   intentional scraping.
+          # @param [String] callback_url URL to receive click events to your webhook
+          #   whenever the recipients click on the shortened links
+          # @return [DomainConfigInstance] Updated DomainConfigInstance
+          def update(fallback_url: :unset, callback_url: :unset)
+            context.update(fallback_url: fallback_url, callback_url: callback_url, )
+          end
+
+          ##
+          # Fetch the DomainConfigInstance
+          # @return [DomainConfigInstance] Fetched DomainConfigInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,226 @@
+##
+# 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 DomainConfigMessagingServiceList < ListResource
+          ##
+          # Initialize the DomainConfigMessagingServiceList
+          # @param [Version] version Version that contains the resource
+          # @return [DomainConfigMessagingServiceList] DomainConfigMessagingServiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.DomainConfigMessagingServiceList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigMessagingServicePage < Page
+          ##
+          # Initialize the DomainConfigMessagingServicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DomainConfigMessagingServicePage] DomainConfigMessagingServicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DomainConfigMessagingServiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DomainConfigMessagingServiceInstance] DomainConfigMessagingServiceInstance
+          def get_instance(payload)
+            DomainConfigMessagingServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.DomainConfigMessagingServicePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigMessagingServiceContext < InstanceContext
+          ##
+          # Initialize the DomainConfigMessagingServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] messaging_service_sid Unique string used to identify the
+          #   Messaging service that this domain should be associated with.
+          # @return [DomainConfigMessagingServiceContext] DomainConfigMessagingServiceContext
+          def initialize(version, messaging_service_sid)
+            super(version)
+
+            # Path Solution
+            @solution = {messaging_service_sid: messaging_service_sid, }
+            @uri = "/LinkShortening/MessagingService/#{@solution[:messaging_service_sid]}/DomainConfig"
+          end
+
+          ##
+          # Fetch the DomainConfigMessagingServiceInstance
+          # @return [DomainConfigMessagingServiceInstance] Fetched DomainConfigMessagingServiceInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            DomainConfigMessagingServiceInstance.new(
+                @version,
+                payload,
+                messaging_service_sid: @solution[:messaging_service_sid],
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigMessagingServiceContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigMessagingServiceContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigMessagingServiceInstance < InstanceResource
+          ##
+          # Initialize the DomainConfigMessagingServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] messaging_service_sid Unique string used to identify the
+          #   Messaging service that this domain should be associated with.
+          # @return [DomainConfigMessagingServiceInstance] DomainConfigMessagingServiceInstance
+          def initialize(version, payload, messaging_service_sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'domain_sid' => payload['domain_sid'],
+                'config_sid' => payload['config_sid'],
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'fallback_url' => payload['fallback_url'],
+                'callback_url' => payload['callback_url'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'messaging_service_sid' => messaging_service_sid || @properties['messaging_service_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 [DomainConfigMessagingServiceContext] DomainConfigMessagingServiceContext for this DomainConfigMessagingServiceInstance
+          def context
+            unless @instance_context
+              @instance_context = DomainConfigMessagingServiceContext.new(
+                  @version,
+                  @params['messaging_service_sid'],
+              )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain resource.
+          def domain_sid
+            @properties['domain_sid']
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain config (prefix ZK).
+          def config_sid
+            @properties['config_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the messaging service
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [String] We will redirect requests to urls we are unable to identify to this url.
+          def fallback_url
+            @properties['fallback_url']
+          end
+
+          ##
+          # @return [String] URL to receive click events to your webhook whenever the recipients click on the shortened links.
+          def callback_url
+            @properties['callback_url']
+          end
+
+          ##
+          # @return [Time] Date this Domain Config was created.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] Date that this Domain Config was last updated.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the DomainConfigMessagingServiceInstance
+          # @return [DomainConfigMessagingServiceInstance] Fetched DomainConfigMessagingServiceInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigMessagingServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigMessagingServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,218 @@
+##
+# 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 LinkshorteningMessagingServiceList < ListResource
+          ##
+          # Initialize the LinkshorteningMessagingServiceList
+          # @param [Version] version Version that contains the resource
+          # @return [LinkshorteningMessagingServiceList] LinkshorteningMessagingServiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.LinkshorteningMessagingServiceList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class LinkshorteningMessagingServicePage < Page
+          ##
+          # Initialize the LinkshorteningMessagingServicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [LinkshorteningMessagingServicePage] LinkshorteningMessagingServicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of LinkshorteningMessagingServiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [LinkshorteningMessagingServiceInstance] LinkshorteningMessagingServiceInstance
+          def get_instance(payload)
+            LinkshorteningMessagingServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.LinkshorteningMessagingServicePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class LinkshorteningMessagingServiceContext < InstanceContext
+          ##
+          # Initialize the LinkshorteningMessagingServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] domain_sid The domain SID to dissociate from a messaging
+          #   service. With URL shortening enabled, links in messages sent with the associated
+          #   messaging service will be shortened to the provided domain
+          # @param [String] messaging_service_sid A messaging service SID to dissociate from
+          #   a domain. With URL shortening enabled, links in messages sent with the provided
+          #   messaging service will be shortened to the associated domain
+          # @return [LinkshorteningMessagingServiceContext] LinkshorteningMessagingServiceContext
+          def initialize(version, domain_sid, messaging_service_sid)
+            super(version)
+
+            # Path Solution
+            @solution = {domain_sid: domain_sid, messaging_service_sid: messaging_service_sid, }
+            @uri = "/LinkShortening/Domains/#{@solution[:domain_sid]}/MessagingServices/#{@solution[:messaging_service_sid]}"
+          end
+
+          ##
+          # Create the LinkshorteningMessagingServiceInstance
+          # @return [LinkshorteningMessagingServiceInstance] Created LinkshorteningMessagingServiceInstance
+          def create
+            payload = @version.create('POST', @uri)
+
+            LinkshorteningMessagingServiceInstance.new(
+                @version,
+                payload,
+                domain_sid: @solution[:domain_sid],
+                messaging_service_sid: @solution[:messaging_service_sid],
+            )
+          end
+
+          ##
+          # Delete the LinkshorteningMessagingServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.LinkshorteningMessagingServiceContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.LinkshorteningMessagingServiceContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class LinkshorteningMessagingServiceInstance < InstanceResource
+          ##
+          # Initialize the LinkshorteningMessagingServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] domain_sid The domain SID to dissociate from a messaging
+          #   service. With URL shortening enabled, links in messages sent with the associated
+          #   messaging service will be shortened to the provided domain
+          # @param [String] messaging_service_sid A messaging service SID to dissociate from
+          #   a domain. With URL shortening enabled, links in messages sent with the provided
+          #   messaging service will be shortened to the associated domain
+          # @return [LinkshorteningMessagingServiceInstance] LinkshorteningMessagingServiceInstance
+          def initialize(version, payload, domain_sid: nil, messaging_service_sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'domain_sid' => payload['domain_sid'],
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {
+                'domain_sid' => domain_sid || @properties['domain_sid'],
+                'messaging_service_sid' => messaging_service_sid || @properties['messaging_service_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 [LinkshorteningMessagingServiceContext] LinkshorteningMessagingServiceContext for this LinkshorteningMessagingServiceInstance
+          def context
+            unless @instance_context
+              @instance_context = LinkshorteningMessagingServiceContext.new(
+                  @version,
+                  @params['domain_sid'],
+                  @params['messaging_service_sid'],
+              )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the domain resource
+          def domain_sid
+            @properties['domain_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the messaging service
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Create the LinkshorteningMessagingServiceInstance
+          # @return [LinkshorteningMessagingServiceInstance] Created LinkshorteningMessagingServiceInstance
+          def create
+            context.create
+          end
+
+          ##
+          # Delete the LinkshorteningMessagingServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.LinkshorteningMessagingServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.LinkshorteningMessagingServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end