twilio-ruby 5.19.0 → 5.77.0

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

@@ -0,0 +1,111 @@
+##
+# 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 UsecaseList < ListResource
+          ##
+          # Initialize the UsecaseList
+          # @param [Version] version Version that contains the resource
+          # @return [UsecaseList] UsecaseList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Services/Usecases"
+          end
+
+          ##
+          # Fetch the UsecaseInstance
+          # @return [UsecaseInstance] Fetched UsecaseInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            UsecaseInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.UsecaseList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UsecasePage < Page
+          ##
+          # Initialize the UsecasePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UsecasePage] UsecasePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UsecaseInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UsecaseInstance] UsecaseInstance
+          def get_instance(payload)
+            UsecaseInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.UsecasePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UsecaseInstance < InstanceResource
+          ##
+          # Initialize the UsecaseInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [UsecaseInstance] UsecaseInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'usecases' => payload['usecases'], }
+          end
+
+          ##
+          # @return [Array[Hash]] Human readable Messaging Service Use Case details
+          def usecases
+            @properties['usecases']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Messaging.V1.UsecaseInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Messaging.V1.UsecaseInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,23 +15,152 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @brand_registrations = nil
+          @deactivations = nil
+          @domain_certs = nil
+          @domain_config = nil
+          @domain_config_messaging_service = nil
+          @external_campaign = nil
+          @linkshortening_messaging_service = nil
           @services = nil
+          @tollfree_verifications = nil
+          @usecases = nil
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Brand Registration resource to fetch.
+        # @return [Twilio::REST::Messaging::V1::BrandRegistrationContext] if sid was passed.
+        # @return [Twilio::REST::Messaging::V1::BrandRegistrationList]
+        def brand_registrations(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @brand_registrations ||= BrandRegistrationList.new self
+          else
+              BrandRegistrationContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Messaging::V1::DeactivationsContext]
+        def deactivations
+          @deactivations ||= DeactivationsContext.new self
+        end
+
+        ##
+        # @param [String] domain_sid Unique string used to identify the domain that this
+        #   certificate should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainCertsContext] if domain_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainCertsList]
+        def domain_certs(domain_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if domain_sid == :unset
+              @domain_certs ||= DomainCertsList.new self
+          else
+              DomainCertsContext.new(self, domain_sid)
+          end
+        end
+
+        ##
+        # @param [String] domain_sid Unique string used to identify the domain that this
+        #   config should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigContext] if domain_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigList]
+        def domain_config(domain_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if domain_sid == :unset
+              @domain_config ||= DomainConfigList.new self
+          else
+              DomainConfigContext.new(self, domain_sid)
+          end
+        end
+
+        ##
+        # @param [String] messaging_service_sid Unique string used to identify the
+        #   Messaging service that this domain should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceContext] if messaging_service_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceList]
+        def domain_config_messaging_service(messaging_service_sid=:unset)
+          if messaging_service_sid.nil?
+              raise ArgumentError, 'messaging_service_sid cannot be nil'
+          end
+          if messaging_service_sid == :unset
+              @domain_config_messaging_service ||= DomainConfigMessagingServiceList.new self
+          else
+              DomainConfigMessagingServiceContext.new(self, messaging_service_sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Messaging::V1::ExternalCampaignContext]
+        def external_campaign
+          @external_campaign ||= ExternalCampaignList.new self
+        end
+
+        ##
+        # @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 [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceContext] if messaging_service_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceList]
+        def linkshortening_messaging_service(domain_sid=:unset, messaging_service_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if messaging_service_sid.nil?
+              raise ArgumentError, 'messaging_service_sid cannot be nil'
+          end
+          if domain_sid == :unset && messaging_service_sid == :unset
+              @linkshortening_messaging_service ||= LinkshorteningMessagingServiceList.new self
+          else
+              LinkshorteningMessagingServiceContext.new(self, domain_sid, messaging_service_sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Messaging::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
+          else
+              ServiceContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The unique string to identify Tollfree Verification.
+        # @return [Twilio::REST::Messaging::V1::TollfreeVerificationContext] if sid was passed.
+        # @return [Twilio::REST::Messaging::V1::TollfreeVerificationList]
+        def tollfree_verifications(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @tollfree_verifications ||= TollfreeVerificationList.new self
           else
-            ServiceContext.new(self, sid)
+              TollfreeVerificationContext.new(self, sid)
           end
         end
 
+        ##
+        # @return [Twilio::REST::Messaging::V1::UsecaseContext]
+        def usecases
+          @usecases ||= UsecaseList.new self
+        end
+
         ##
         # Provide a user friendly representation
         def to_s

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -29,13 +29,84 @@ module Twilio
       end
 
       ##
-      # @param [String] sid Unique 34 character ID of the Service.
+      # @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)
+        self.v1.brand_registrations(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Messaging::V1::DeactivationsInstance]
+      def deactivations
+        self.v1.deactivations()
+      end
+
+      ##
+      # @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)
+        self.v1.domain_certs(domain_sid)
+      end
+
+      ##
+      # @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)
+        self.v1.domain_config(domain_sid)
+      end
+
+      ##
+      # @param [String] messaging_service_sid The unique string that identifies the
+      #   messaging service
+      # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceInstance] if messaging_service_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceList]
+      def domain_config_messaging_service(messaging_service_sid=:unset)
+        self.v1.domain_config_messaging_service(messaging_service_sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Messaging::V1::ExternalCampaignInstance]
+      def external_campaign
+        self.v1.external_campaign()
+      end
+
+      ##
+      # @param [String] messaging_service_sid The unique string that identifies the
+      #   messaging service
+      # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceInstance] if messaging_service_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceList]
+      def linkshortening_messaging_service(domain_sid=:unset, messaging_service_sid=:unset)
+        self.v1.linkshortening_messaging_service(domain_sid, messaging_service_sid)
+      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)
         self.v1.services(sid)
       end
 
+      ##
+      # @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)
+        self.v1.tollfree_verifications(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Messaging::V1::UsecaseInstance]
+      def usecases
+        self.v1.usecases()
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

data/lib/twilio-ruby/rest/microvisor/v1/account_config.rb

@@ -0,0 +1,317 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Microvisor < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class AccountConfigList < ListResource
+          ##
+          # Initialize the AccountConfigList
+          # @param [Version] version Version that contains the resource
+          # @return [AccountConfigList] AccountConfigList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Configs"
+          end
+
+          ##
+          # Lists AccountConfigInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @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(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams AccountConfigInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @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(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields AccountConfigInstance 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 AccountConfigInstance records from the API.
+          # Request is executed immediately.
+          # @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 AccountConfigInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            AccountConfigPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of AccountConfigInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of AccountConfigInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            AccountConfigPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Create the AccountConfigInstance
+          # @param [String] key The config key; up to 100 characters.
+          # @param [String] value The config value; up to 4096 characters.
+          # @return [AccountConfigInstance] Created AccountConfigInstance
+          def create(key: nil, value: nil)
+            data = Twilio::Values.of({'Key' => key, 'Value' => value, })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            AccountConfigInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Microvisor.V1.AccountConfigList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class AccountConfigPage < Page
+          ##
+          # Initialize the AccountConfigPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [AccountConfigPage] AccountConfigPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of AccountConfigInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [AccountConfigInstance] AccountConfigInstance
+          def get_instance(payload)
+            AccountConfigInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Microvisor.V1.AccountConfigPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class AccountConfigContext < InstanceContext
+          ##
+          # Initialize the AccountConfigContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] key The config key; up to 100 characters.
+          # @return [AccountConfigContext] AccountConfigContext
+          def initialize(version, key)
+            super(version)
+
+            # Path Solution
+            @solution = {key: key, }
+            @uri = "/Configs/#{@solution[:key]}"
+          end
+
+          ##
+          # Fetch the AccountConfigInstance
+          # @return [AccountConfigInstance] Fetched AccountConfigInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            AccountConfigInstance.new(@version, payload, key: @solution[:key], )
+          end
+
+          ##
+          # Update the AccountConfigInstance
+          # @param [String] value The config value; up to 4096 characters.
+          # @return [AccountConfigInstance] Updated AccountConfigInstance
+          def update(value: nil)
+            data = Twilio::Values.of({'Value' => value, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            AccountConfigInstance.new(@version, payload, key: @solution[:key], )
+          end
+
+          ##
+          # Delete the AccountConfigInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Microvisor.V1.AccountConfigContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Microvisor.V1.AccountConfigContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class AccountConfigInstance < InstanceResource
+          ##
+          # Initialize the AccountConfigInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] key The config key; up to 100 characters.
+          # @return [AccountConfigInstance] AccountConfigInstance
+          def initialize(version, payload, key: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'key' => payload['key'],
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'value' => payload['value'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'key' => key || @properties['key'], }
+          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 [AccountConfigContext] AccountConfigContext for this AccountConfigInstance
+          def context
+            unless @instance_context
+              @instance_context = AccountConfigContext.new(@version, @params['key'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The config key.
+          def key
+            @properties['key']
+          end
+
+          ##
+          # @return [Time] The date_updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The config value.
+          def value
+            @properties['value']
+          end
+
+          ##
+          # @return [String] The absolute URL of the Config.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the AccountConfigInstance
+          # @return [AccountConfigInstance] Fetched AccountConfigInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the AccountConfigInstance
+          # @param [String] value The config value; up to 4096 characters.
+          # @return [AccountConfigInstance] Updated AccountConfigInstance
+          def update(value: nil)
+            context.update(value: value, )
+          end
+
+          ##
+          # Delete the AccountConfigInstance
+          # @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.Microvisor.V1.AccountConfigInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Microvisor.V1.AccountConfigInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end