twilio-ruby 5.31.1 → 7.3.0

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

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

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

@@ -0,0 +1,217 @@
+##
+#    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 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
+
+
+                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
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        payload = @version.create('POST', @uri, headers: headers)
+                        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
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        @version.delete('DELETE', @uri, headers: headers)
+                    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
+
+                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
+                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] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this LinkshorteningMessagingService
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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] CallContext for this CallInstance
+                    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 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] 
+                    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

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

@@ -0,0 +1,197 @@
+##
+#    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 LinkshorteningMessagingServiceDomainAssociationList < ListResource
+                
+                    ##
+                    # Initialize the LinkshorteningMessagingServiceDomainAssociationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [LinkshorteningMessagingServiceDomainAssociationList] LinkshorteningMessagingServiceDomainAssociationList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Messaging.V1.LinkshorteningMessagingServiceDomainAssociationList>'
+                    end
+                end
+
+
+                class LinkshorteningMessagingServiceDomainAssociationContext < InstanceContext
+                    ##
+                    # Initialize the LinkshorteningMessagingServiceDomainAssociationContext
+                    # @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 [LinkshorteningMessagingServiceDomainAssociationContext] LinkshorteningMessagingServiceDomainAssociationContext
+                    def initialize(version, messaging_service_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { messaging_service_sid: messaging_service_sid,  }
+                        @uri = "/LinkShortening/MessagingServices/#{@solution[:messaging_service_sid]}/Domain"
+
+                        
+                    end
+                    ##
+                    # Fetch the LinkshorteningMessagingServiceDomainAssociationInstance
+                    # @return [LinkshorteningMessagingServiceDomainAssociationInstance] Fetched LinkshorteningMessagingServiceDomainAssociationInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        LinkshorteningMessagingServiceDomainAssociationInstance.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.LinkshorteningMessagingServiceDomainAssociationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Messaging.V1.LinkshorteningMessagingServiceDomainAssociationContext #{context}>"
+                    end
+                end
+
+                class LinkshorteningMessagingServiceDomainAssociationPage < Page
+                    ##
+                    # Initialize the LinkshorteningMessagingServiceDomainAssociationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [LinkshorteningMessagingServiceDomainAssociationPage] LinkshorteningMessagingServiceDomainAssociationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of LinkshorteningMessagingServiceDomainAssociationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [LinkshorteningMessagingServiceDomainAssociationInstance] LinkshorteningMessagingServiceDomainAssociationInstance
+                    def get_instance(payload)
+                        LinkshorteningMessagingServiceDomainAssociationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Messaging.V1.LinkshorteningMessagingServiceDomainAssociationPage>'
+                    end
+                end
+                class LinkshorteningMessagingServiceDomainAssociationInstance < InstanceResource
+                    ##
+                    # Initialize the LinkshorteningMessagingServiceDomainAssociationInstance
+                    # @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 LinkshorteningMessagingServiceDomainAssociation
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [LinkshorteningMessagingServiceDomainAssociationInstance] LinkshorteningMessagingServiceDomainAssociationInstance
+                    def initialize(version, payload , 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 = { '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 [LinkshorteningMessagingServiceDomainAssociationContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = LinkshorteningMessagingServiceDomainAssociationContext.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 identifies the messaging service
+                    def messaging_service_sid
+                        @properties['messaging_service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the LinkshorteningMessagingServiceDomainAssociationInstance
+                    # @return [LinkshorteningMessagingServiceDomainAssociationInstance] Fetched LinkshorteningMessagingServiceDomainAssociationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Messaging.V1.LinkshorteningMessagingServiceDomainAssociationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Messaging.V1.LinkshorteningMessagingServiceDomainAssociationInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end