twilio-ruby 5.10.7 → 7.6.2

data/lib/twilio-ruby/rest/messaging/v2/channels_sender.rb

@@ -0,0 +1,492 @@
+##
+#    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 V2 < Version
+                class ChannelsSenderList < ListResource
+                
+                    class MessagingV2ChannelsSenderRequestsCreate
+                            # @param [sender_id]: [String] The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+                            # @param [configuration]: [ChannelsSenderList.MessagingV2ChannelsSenderConfiguration] 
+                            # @param [webhook]: [ChannelsSenderList.MessagingV2ChannelsSenderWebhook] 
+                            # @param [profile]: [ChannelsSenderList.MessagingV2ChannelsSenderProfile] 
+                        attr_accessor :sender_id, :configuration, :webhook, :profile
+                        def initialize(payload)
+                                @sender_id = payload["sender_id"]
+                                @configuration = payload["configuration"]
+                                @webhook = payload["webhook"]
+                                @profile = payload["profile"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "sender_id": @sender_id,
+                                "configuration": @configuration,
+                                "webhook": @webhook,
+                                "profile": @profile,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class MessagingV2ChannelsSenderRequestsUpdate
+                            # @param [configuration]: [ChannelsSenderList.MessagingV2ChannelsSenderConfiguration] 
+                            # @param [webhook]: [ChannelsSenderList.MessagingV2ChannelsSenderWebhook] 
+                            # @param [profile]: [ChannelsSenderList.MessagingV2ChannelsSenderProfile] 
+                        attr_accessor :configuration, :webhook, :profile
+                        def initialize(payload)
+                                @configuration = payload["configuration"]
+                                @webhook = payload["webhook"]
+                                @profile = payload["profile"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "configuration": @configuration,
+                                "webhook": @webhook,
+                                "profile": @profile,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class MessagingV2ChannelsSenderRequestsCreate
+                            # @param [sender_id]: [String] The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+                            # @param [configuration]: [ChannelsSenderList.MessagingV2ChannelsSenderConfiguration] 
+                            # @param [webhook]: [ChannelsSenderList.MessagingV2ChannelsSenderWebhook] 
+                            # @param [profile]: [ChannelsSenderList.MessagingV2ChannelsSenderProfile] 
+                        attr_accessor :sender_id, :configuration, :webhook, :profile
+                        def initialize(payload)
+                                @sender_id = payload["sender_id"]
+                                @configuration = payload["configuration"]
+                                @webhook = payload["webhook"]
+                                @profile = payload["profile"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "sender_id": @sender_id,
+                                "configuration": @configuration,
+                                "webhook": @webhook,
+                                "profile": @profile,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class MessagingV2ChannelsSenderRequestsUpdate
+                            # @param [configuration]: [ChannelsSenderList.MessagingV2ChannelsSenderConfiguration] 
+                            # @param [webhook]: [ChannelsSenderList.MessagingV2ChannelsSenderWebhook] 
+                            # @param [profile]: [ChannelsSenderList.MessagingV2ChannelsSenderProfile] 
+                        attr_accessor :configuration, :webhook, :profile
+                        def initialize(payload)
+                                @configuration = payload["configuration"]
+                                @webhook = payload["webhook"]
+                                @profile = payload["profile"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "configuration": @configuration,
+                                "webhook": @webhook,
+                                "profile": @profile,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ChannelsSenderList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ChannelsSenderList] ChannelsSenderList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Channels/Senders"
+                        
+                    end
+                    ##
+                    # Create the ChannelsSenderInstance
+                    # @param [MessagingV2ChannelsSenderRequestsCreate] messaging_v2_channels_sender_requests_create 
+                    # @return [ChannelsSenderInstance] Created ChannelsSenderInstance
+                    def create(messaging_v2_channels_sender_requests_create: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: messaging_v2_channels_sender_requests_create.to_json)
+                        ChannelsSenderInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                
+                    ##
+                    # Lists ChannelsSenderInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] channel 
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(channel: nil, limit: nil, page_size: nil)
+                        self.stream(
+                            channel: channel,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [String] channel 
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(channel: nil, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            channel: channel,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields ChannelsSenderInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of ChannelsSenderInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] channel 
+                    # @param [String] page_token PageToken provided by the API
+                    # @param [Integer] page_number Page Number, this value is simply for client state
+                    # @param [Integer] page_size Number of records to return, defaults to 50
+                    # @return [Page] Page of ChannelsSenderInstance
+                    def page(channel: nil, page_token: :unset, page_number: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'Channel' => channel,
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ChannelsSenderPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ChannelsSenderInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ChannelsSenderInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ChannelsSenderPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Messaging.V2.ChannelsSenderList>'
+                    end
+                end
+
+
+                class ChannelsSenderContext < InstanceContext
+                    ##
+                    # Initialize the ChannelsSenderContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid A 34 character string that uniquely identifies this Sender.
+                    # @return [ChannelsSenderContext] ChannelsSenderContext
+                    def initialize(version, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Channels/Senders/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the ChannelsSenderInstance
+                    # @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
+
+                    ##
+                    # Fetch the ChannelsSenderInstance
+                    # @return [ChannelsSenderInstance] Fetched ChannelsSenderInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ChannelsSenderInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the ChannelsSenderInstance
+                    # @param [MessagingV2ChannelsSenderRequestsUpdate] messaging_v2_channels_sender_requests_update 
+                    # @return [ChannelsSenderInstance] Updated ChannelsSenderInstance
+                    def update(messaging_v2_channels_sender_requests_update: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, headers: headers, data: messaging_v2_channels_sender_requests_update.to_json)
+                        ChannelsSenderInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Messaging.V2.ChannelsSenderContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Messaging.V2.ChannelsSenderContext #{context}>"
+                    end
+                end
+
+                class ChannelsSenderPage < Page
+                    ##
+                    # Initialize the ChannelsSenderPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ChannelsSenderPage] ChannelsSenderPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ChannelsSenderInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ChannelsSenderInstance] ChannelsSenderInstance
+                    def get_instance(payload)
+                        ChannelsSenderInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Messaging.V2.ChannelsSenderPage>'
+                    end
+                end
+                class ChannelsSenderInstance < InstanceResource
+                    ##
+                    # Initialize the ChannelsSenderInstance
+                    # @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 ChannelsSender
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ChannelsSenderInstance] ChannelsSenderInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'status' => payload['status'],
+                            'sender_id' => payload['sender_id'],
+                            'configuration' => payload['configuration'],
+                            'webhook' => payload['webhook'],
+                            'profile' => payload['profile'],
+                            'properties' => payload['properties'],
+                            'offline_reasons' => payload['offline_reasons'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'sid' => sid  || @properties['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 [ChannelsSenderContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ChannelsSenderContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] A 34 character string that uniquely identifies this Sender.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [Status] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+                    def sender_id
+                        @properties['sender_id']
+                    end
+                    
+                    ##
+                    # @return [MessagingV2ChannelsSenderConfiguration] 
+                    def configuration
+                        @properties['configuration']
+                    end
+                    
+                    ##
+                    # @return [MessagingV2ChannelsSenderWebhook] 
+                    def webhook
+                        @properties['webhook']
+                    end
+                    
+                    ##
+                    # @return [MessagingV2ChannelsSenderProfile] 
+                    def profile
+                        @properties['profile']
+                    end
+                    
+                    ##
+                    # @return [MessagingV2ChannelsSenderProperties] 
+                    def properties
+                        @properties['properties']
+                    end
+                    
+                    ##
+                    # @return [Array<MessagingV2ChannelsSenderOfflineReasonsItems>] Reasons why the sender is offline., e.g., [{\"code\": \"21211400\", \"message\": \"Whatsapp business account is banned by provider {provider_name} | Credit line is assigned to another BSP\", \"more_info\": \"https://www.twilio.com/docs/errors/21211400\"}]
+                    def offline_reasons
+                        @properties['offline_reasons']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource, relative to `https://messaging.twilio.com`.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Delete the ChannelsSenderInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the ChannelsSenderInstance
+                    # @return [ChannelsSenderInstance] Fetched ChannelsSenderInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the ChannelsSenderInstance
+                    # @param [MessagingV2ChannelsSenderRequestsUpdate] messaging_v2_channels_sender_requests_update 
+                    # @return [ChannelsSenderInstance] Updated ChannelsSenderInstance
+                    def update(messaging_v2_channels_sender_requests_update: :unset
+                    )
+
+                        context.update(
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Messaging.V2.ChannelsSenderInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Messaging.V2.ChannelsSenderInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/messaging/v2.rb

@@ -0,0 +1,49 @@
+##
+#    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
+            class V2 < Version
+                ##
+                # Initialize the V2 version of Messaging
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @channels_senders = nil
+                end
+
+                ##
+                # @param [String] sid A 34 character string that uniquely identifies this Sender.
+                # @return [Twilio::REST::Messaging::V2::ChannelsSenderContext] if sid was passed.
+                # @return [Twilio::REST::Messaging::V2::ChannelsSenderList]
+                def channels_senders(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @channels_senders ||= ChannelsSenderList.new self
+                    else
+                        ChannelsSenderContext.new(self, sid)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Messaging::V2>';
+                end
+            end
+        end
+    end
+end

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

@@ -1,46 +1,74 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-# 
-# frozen_string_literal: true
-
 module Twilio
   module REST
-    class Messaging < Domain
+    class Messaging < MessagingBase
       ##
-      # Initialize the Messaging Domain
-      def initialize(twilio)
-        super
+      # @param [String] sid The unique string to identify Brand Registration.
+      # @return [Twilio::REST::Messaging::V1::BrandRegistrationInstance] if sid was passed.
+      # @return [Twilio::REST::Messaging::V1::BrandRegistrationList]
+      def brand_registrations(sid=:unset)
+        warn "brand_registrations is deprecated. Use v1.brand_registrations instead."
+        self.v1.brand_registrations(sid)
+      end
 
-        @base_url = 'https://messaging.twilio.com'
-        @host = 'messaging.twilio.com'
-        @port = 443
+      ##
+      # @return [Twilio::REST::Messaging::V1::DeactivationsInstance]
+      def deactivations
+        warn "deactivations is deprecated. Use v1.deactivations instead."
+        self.v1.deactivations()
+      end
 
-        # Versions
-        @v1 = nil
+      ##
+      # @param [String] domain_sid The unique string that we created to identify the
+      #   Domain resource.
+      # @return [Twilio::REST::Messaging::V1::DomainCertsInstance] if domain_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainCertsList]
+      def domain_certs(domain_sid=:unset)
+        warn "domain_certs is deprecated. Use v1.domain_certs instead."
+        self.v1.domain_certs(domain_sid)
       end
 
       ##
-      # Version v1 of messaging
-      def v1
-        @v1 ||= V1.new self
+      # @param [String] domain_sid The unique string that we created to identify the
+      #   Domain resource.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigInstance] if domain_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigList]
+      def domain_config(domain_sid=:unset)
+        warn "domain_config is deprecated. Use v1.domain_config instead."
+        self.v1.domain_config(domain_sid)
       end
 
       ##
-      # @param [String] sid Unique 34 character ID of the Service.
+      # @return [Twilio::REST::Messaging::V1::ExternalCampaignInstance]
+      def external_campaign
+        warn "external_campaign is deprecated. Use v1.external_campaign instead."
+        self.v1.external_campaign()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Service
+      #   resource.
       # @return [Twilio::REST::Messaging::V1::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Messaging::V1::ServiceList]
       def services(sid=:unset)
+        warn "services is deprecated. Use v1.services instead."
         self.v1.services(sid)
       end
 
       ##
-      # Provide a user friendly representation
-      def to_s
-        '#<Twilio::REST::Messaging>'
+      # @param [String] sid The unique string to identify Tollfree Verification.
+      # @return [Twilio::REST::Messaging::V1::TollfreeVerificationInstance] if sid was passed.
+      # @return [Twilio::REST::Messaging::V1::TollfreeVerificationList]
+      def tollfree_verifications(sid=:unset)
+        warn "tollfree_verifications is deprecated. Use v1.tollfree_verifications instead."
+        self.v1.tollfree_verifications(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Messaging::V1::UsecaseInstance]
+      def usecases
+        warn "usecases is deprecated. Use v1.usecases instead."
+        self.v1.usecases()
       end
     end
   end
-end
+end

data/lib/twilio-ruby/rest/messaging_base.rb

@@ -0,0 +1,43 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # 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 MessagingBase < Domain
+      ##
+      # Initialize messaging domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://messaging.twilio.com"
+        @host = "messaging.twilio.com"
+        @port = 443
+        @v1 = nil
+        @v2 = nil
+      end
+
+      def v1
+        @v1 ||= Messaging::V1.new self
+      end
+
+      def v2
+        @v2 ||= Messaging::V2.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Messaging>';
+      end
+    end
+  end
+end