twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,123 @@
+##
+#    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 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
+
+                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
+                class UsecaseInstance < InstanceResource
+                    ##
+                    # Initialize the UsecaseInstance
+                    # @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 Usecase
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [UsecaseInstance] UsecaseInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'usecases' => payload['usecases'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Array<Hash>] Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases.
+                    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

@@ -0,0 +1,194 @@
+##
+#    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 V1 < Version
+                ##
+                # Initialize the V1 version of Messaging
+                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
+                    @linkshortening_messaging_service_domain_association = nil
+                    @services = nil
+                    @tollfree_verifications = nil
+                    @usecases = nil
+                end
+
+                ##
+                # @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 domainSid 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 domainSid 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 messagingServiceSid 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::ExternalCampaignList]
+                def external_campaign
+                    @external_campaign ||= ExternalCampaignList.new self
+                end
+                ##
+                # @param [String] domain_sid The domain SID to associate with 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 associate with 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 domainSid 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] domain_sid The domain SID to associate with 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 associate with 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 messagingServiceSid 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] messaging_service_sid Unique string used to identify the Messaging service that this domain should be associated with.
+                # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceDomainAssociationContext] if messagingServiceSid was passed.
+                # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceDomainAssociationList]
+                def linkshortening_messaging_service_domain_association(messaging_service_sid=:unset)
+                    if messaging_service_sid.nil?
+                        raise ArgumentError, 'messaging_service_sid cannot be nil'
+                    end
+                    if messaging_service_sid == :unset
+                        @linkshortening_messaging_service_domain_association ||= LinkshorteningMessagingServiceDomainAssociationList.new self
+                    else
+                        LinkshorteningMessagingServiceDomainAssociationContext.new(self, 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'
+                    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
+                        TollfreeVerificationContext.new(self, sid)
+                    end
+                end
+                ##
+                # @return [Twilio::REST::Messaging::V1::UsecaseList]
+                def usecases
+                    @usecases ||= UsecaseList.new self
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Messaging::V1>';
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,74 @@
+module Twilio
+  module REST
+    class Messaging < MessagingBase
+      ##
+      # @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
+
+      ##
+      # @return [Twilio::REST::Messaging::V1::DeactivationsInstance]
+      def deactivations
+        warn "deactivations is deprecated. Use v1.deactivations instead."
+        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)
+        warn "domain_certs is deprecated. Use v1.domain_certs instead."
+        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)
+        warn "domain_config is deprecated. Use v1.domain_config instead."
+        self.v1.domain_config(domain_sid)
+      end
+
+      ##
+      # @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
+
+      ##
+      # @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

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

@@ -0,0 +1,38 @@
+##
+ # 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
+      end
+
+      def v1
+        @v1 ||= Messaging::V1.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Messaging::V1>';
+      end
+    end
+  end
+end