twilio-ruby 5.74.4 → 7.7.1

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

@@ -0,0 +1,243 @@
+##
+#    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
+
+
+                    ##
+                    # 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 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 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

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

@@ -1,150 +1,171 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    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.
 #
-# 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 ExternalCampaignList < ListResource
-          ##
-          # Initialize the ExternalCampaignList
-          # @param [Version] version Version that contains the resource
-          # @return [ExternalCampaignList] ExternalCampaignList
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-            @uri = "/Services/PreregisteredUsa2p"
-          end
-
-          ##
-          # Create the ExternalCampaignInstance
-          # @param [String] campaign_id ID of the preregistered campaign.
-          # @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.
-          # @return [ExternalCampaignInstance] Created ExternalCampaignInstance
-          def create(campaign_id: nil, messaging_service_sid: nil)
-            data = Twilio::Values.of({
-                'CampaignId' => campaign_id,
-                'MessagingServiceSid' => messaging_service_sid,
-            })
-
-            payload = @version.create('POST', @uri, data: data)
-
-            ExternalCampaignInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '#<Twilio.Messaging.V1.ExternalCampaignList>'
-          end
-        end
-
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class ExternalCampaignPage < Page
-          ##
-          # Initialize the ExternalCampaignPage
-          # @param [Version] version Version that contains the resource
-          # @param [Response] response Response from the API
-          # @param [Hash] solution Path solution for the resource
-          # @return [ExternalCampaignPage] ExternalCampaignPage
-          def initialize(version, response, solution)
-            super(version, response)
-
-            # Path Solution
-            @solution = solution
-          end
-
-          ##
-          # Build an instance of ExternalCampaignInstance
-          # @param [Hash] payload Payload response from the API
-          # @return [ExternalCampaignInstance] ExternalCampaignInstance
-          def get_instance(payload)
-            ExternalCampaignInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '<Twilio.Messaging.V1.ExternalCampaignPage>'
-          end
-        end
-
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class ExternalCampaignInstance < InstanceResource
-          ##
-          # Initialize the ExternalCampaignInstance
-          # @param [Version] version Version that contains the resource
-          # @param [Hash] payload payload that contains response from Twilio
-          # @return [ExternalCampaignInstance] ExternalCampaignInstance
-          def initialize(version, payload)
-            super(version)
-
-            # Marshaled Properties
-            @properties = {
-                'sid' => payload['sid'],
-                'account_sid' => payload['account_sid'],
-                'campaign_id' => payload['campaign_id'],
-                'messaging_service_sid' => payload['messaging_service_sid'],
-                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-            }
-          end
-
-          ##
-          # @return [String] The unique string that identifies a US A2P Compliance resource
-          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] ID of the preregistered campaign.
-          def campaign_id
-            @properties['campaign_id']
-          end
-
-          ##
-          # @return [String] The SID of the Messaging Service the resource is associated with
-          def messaging_service_sid
-            @properties['messaging_service_sid']
-          end
-
-          ##
-          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
-          def date_created
-            @properties['date_created']
-          end
 
-          ##
-          # Provide a user friendly representation
-          def to_s
-            "<Twilio.Messaging.V1.ExternalCampaignInstance>"
-          end
 
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            "<Twilio.Messaging.V1.ExternalCampaignInstance>"
-          end
+module Twilio
+    module REST
+        class Messaging < MessagingBase
+            class V1 < Version
+                class ExternalCampaignList < ListResource
+                
+                    ##
+                    # Initialize the ExternalCampaignList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ExternalCampaignList] ExternalCampaignList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Services/PreregisteredUsa2p"
+                        
+                    end
+                    ##
+                    # Create the ExternalCampaignInstance
+                    # @param [String] campaign_id ID of the preregistered campaign.
+                    # @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.
+                    # @param [Boolean] cnp_migration Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing request, before making this api call.
+                    # @return [ExternalCampaignInstance] Created ExternalCampaignInstance
+                    def create(
+                        campaign_id: nil, 
+                        messaging_service_sid: nil, 
+                        cnp_migration: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'CampaignId' => campaign_id,
+                            'MessagingServiceSid' => messaging_service_sid,
+                            'CnpMigration' => cnp_migration,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        ExternalCampaignInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Messaging.V1.ExternalCampaignList>'
+                    end
+                end
+
+                class ExternalCampaignPage < Page
+                    ##
+                    # Initialize the ExternalCampaignPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ExternalCampaignPage] ExternalCampaignPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ExternalCampaignInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ExternalCampaignInstance] ExternalCampaignInstance
+                    def get_instance(payload)
+                        ExternalCampaignInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Messaging.V1.ExternalCampaignPage>'
+                    end
+                end
+                class ExternalCampaignInstance < InstanceResource
+                    ##
+                    # Initialize the ExternalCampaignInstance
+                    # @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 ExternalCampaign
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ExternalCampaignInstance] ExternalCampaignInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'campaign_id' => payload['campaign_id'],
+                            'messaging_service_sid' => payload['messaging_service_sid'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] ID of the preregistered campaign.
+                    def campaign_id
+                        @properties['campaign_id']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.
+                    def messaging_service_sid
+                        @properties['messaging_service_sid']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Messaging.V1.ExternalCampaignInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Messaging.V1.ExternalCampaignInstance>"
+                    end
+                end
+
+            end
         end
-      end
     end
-  end
-end
+end