twilio-ruby 5.39.2 → 5.60.0

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

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

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

@@ -18,7 +18,7 @@ module Twilio
             # Initialize the AlphaSenderList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
             #   is associated with.
             # @return [AlphaSenderList] AlphaSenderList
             def initialize(version, service_sid: nil)
@@ -168,7 +168,7 @@ module Twilio
             # Initialize the AlphaSenderContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
             #   resource from.
             # @param [String] sid The SID of the AlphaSender resource to fetch.
             # @return [AlphaSenderContext] AlphaSenderContext
@@ -224,7 +224,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
             #   is associated with.
             # @param [String] sid The SID of the AlphaSender resource to fetch.
             # @return [AlphaSenderInstance] AlphaSenderInstance
@@ -296,7 +296,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

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

@@ -18,7 +18,7 @@ module Twilio
             # Initialize the PhoneNumberList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
             #   is associated with.
             # @return [PhoneNumberList] PhoneNumberList
             def initialize(version, service_sid: nil)
@@ -167,7 +167,7 @@ module Twilio
             # Initialize the PhoneNumberContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
             #   resource from.
             # @param [String] sid The SID of the PhoneNumber resource to fetch.
             # @return [PhoneNumberContext] PhoneNumberContext
@@ -223,7 +223,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
             #   is associated with.
             # @param [String] sid The SID of the PhoneNumber resource to fetch.
             # @return [PhoneNumberInstance] PhoneNumberInstance
@@ -302,7 +302,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

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

@@ -18,7 +18,7 @@ module Twilio
             # Initialize the ShortCodeList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
             #   is associated with.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, service_sid: nil)
@@ -167,7 +167,7 @@ module Twilio
             # Initialize the ShortCodeContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
             #   resource from.
             # @param [String] sid The SID of the ShortCode resource to fetch.
             # @return [ShortCodeContext] ShortCodeContext
@@ -218,7 +218,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
             #   is associated with.
             # @param [String] sid The SID of the ShortCode resource to fetch.
             # @return [ShortCodeInstance] ShortCodeInstance
@@ -297,7 +297,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end