twilio-ruby 5.74.0 → 7.10.1

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

@@ -0,0 +1,379 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Messaging
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Messaging < MessagingBase
+            class V1 < Version
+                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
+
+
+                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
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        DomainConfigMessagingServiceInstance.new(
+                            @version,
+                            payload,
+                            messaging_service_sid: @solution[:messaging_service_sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the DomainConfigMessagingServiceInstanceMetadata
+                    # @return [DomainConfigMessagingServiceInstance] Fetched DomainConfigMessagingServiceInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        domain_config_messaging_service_instance = DomainConfigMessagingServiceInstance.new(
+                            @version,
+                            response.body,
+                            messaging_service_sid: @solution[:messaging_service_sid],
+                        )
+                        DomainConfigMessagingServiceInstanceMetadata.new(
+                            @version,
+                            domain_config_messaging_service_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    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
+
+                class DomainConfigMessagingServiceInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DomainConfigMessagingServiceInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DomainConfigMessagingServiceInstance] domain_config_messaging_service_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [DomainConfigMessagingServiceInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, domain_config_messaging_service_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @domain_config_messaging_service_instance = domain_config_messaging_service_instance
+                    end
+
+                    def domain_config_messaging_service
+                        @domain_config_messaging_service_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DomainConfigMessagingServiceInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DomainConfigMessagingServiceListResponse < InstanceListResource
+                    # @param [Array<DomainConfigMessagingServiceInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @domain_config_messaging_service_instance = payload.body[key].map do |data|
+                        DomainConfigMessagingServiceInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def domain_config_messaging_service_instance
+                          @instance
+                      end
+                  end
+
+                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
+
+                class DomainConfigMessagingServicePageMetadata < PageMetadata
+                    attr_reader :domain_config_messaging_service_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @domain_config_messaging_service_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @domain_config_messaging_service_page << DomainConfigMessagingServiceListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @domain_config_messaging_service_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class DomainConfigMessagingServiceListResponse < InstanceListResource
+
+                    # @param [Array<DomainConfigMessagingServiceInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @domain_config_messaging_service = data_list.map do |data|
+                        DomainConfigMessagingServiceInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def domain_config_messaging_service
+                        @domain_config_messaging_service
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                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] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this DomainConfigMessagingService
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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'],
+                            'continue_on_failure' => payload['continue_on_failure'],
+                            '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] CallContext for this CallInstance
+                    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] 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.
+                    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 [Boolean] Boolean field to set customer delivery preference when there is a failure in linkShortening service
+                    def continue_on_failure
+                        @properties['continue_on_failure']
+                    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] 
+                    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