twilio-ruby 3.11.5 → 5.0.0

data/lib/twilio-ruby/rest/trunking/v1/trunk.rb

@@ -0,0 +1,577 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Trunking < Domain
+      class V1 < Version
+        class TrunkList < ListResource
+          ##
+          # Initialize the TrunkList
+          # @param [Version] version Version that contains the resource
+          # @return [TrunkList] TrunkList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Trunks"
+          end
+
+          ##
+          # Retrieve a single page of TrunkInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name The friendly_name
+          # @param [String] domain_name The domain_name
+          # @param [String] disaster_recovery_url The disaster_recovery_url
+          # @param [String] disaster_recovery_method The disaster_recovery_method
+          # @param [String] recording The recording
+          # @param [Boolean] secure The secure
+          # @return [TrunkInstance] Newly created TrunkInstance
+          def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'DomainName' => domain_name,
+                'DisasterRecoveryUrl' => disaster_recovery_url,
+                'DisasterRecoveryMethod' => disaster_recovery_method,
+                'Recording' => recording,
+                'Secure' => secure,
+            })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            TrunkInstance.new(
+                @version,
+                payload,
+            )
+          end
+
+          ##
+          # Lists TrunkInstance 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 TrunkInstance 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 TrunkInstance 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 TrunkInstance 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 TrunkInstance
+          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
+            )
+            TrunkPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of TrunkInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of TrunkInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            TrunkPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Trunking.V1.TrunkList>'
+          end
+        end
+
+        class TrunkPage < Page
+          ##
+          # Initialize the TrunkPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [TrunkPage] TrunkPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of TrunkInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [TrunkInstance] TrunkInstance
+          def get_instance(payload)
+            TrunkInstance.new(
+                @version,
+                payload,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Trunking.V1.TrunkPage>'
+          end
+        end
+
+        class TrunkContext < InstanceContext
+          ##
+          # Initialize the TrunkContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The sid
+          # @return [TrunkContext] TrunkContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {
+                sid: sid,
+            }
+            @uri = "/Trunks/#{@solution[:sid]}"
+
+            # Dependents
+            @origination_urls = nil
+            @credentials_lists = nil
+            @ip_access_control_lists = nil
+            @phone_numbers = nil
+          end
+
+          ##
+          # Fetch a TrunkInstance
+          # @return [TrunkInstance] Fetched TrunkInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            TrunkInstance.new(
+                @version,
+                payload,
+                sid: @solution[:sid],
+            )
+          end
+
+          ##
+          # Deletes the TrunkInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            @version.delete('delete', @uri)
+          end
+
+          ##
+          # Update the TrunkInstance
+          # @param [String] friendly_name The friendly_name
+          # @param [String] domain_name The domain_name
+          # @param [String] disaster_recovery_url The disaster_recovery_url
+          # @param [String] disaster_recovery_method The disaster_recovery_method
+          # @param [String] recording The recording
+          # @param [Boolean] secure The secure
+          # @return [TrunkInstance] Updated TrunkInstance
+          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'DomainName' => domain_name,
+                'DisasterRecoveryUrl' => disaster_recovery_url,
+                'DisasterRecoveryMethod' => disaster_recovery_method,
+                'Recording' => recording,
+                'Secure' => secure,
+            })
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            TrunkInstance.new(
+                @version,
+                payload,
+                sid: @solution[:sid],
+            )
+          end
+
+          ##
+          # Access the origination_urls
+          # @return [OriginationUrlList]
+          # @return [OriginationUrlContext] if sid was passed.
+          def origination_urls(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return OriginationUrlContext.new(
+                  @version,
+                  @solution[:sid],
+                  sid,
+              )
+            end
+
+            unless @origination_urls
+              @origination_urls = OriginationUrlList.new(
+                  @version,
+                  trunk_sid: @solution[:sid],
+              )
+            end
+
+            @origination_urls
+          end
+
+          ##
+          # Access the credentials_lists
+          # @return [CredentialListList]
+          # @return [CredentialListContext] if sid was passed.
+          def credentials_lists(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return CredentialListContext.new(
+                  @version,
+                  @solution[:sid],
+                  sid,
+              )
+            end
+
+            unless @credentials_lists
+              @credentials_lists = CredentialListList.new(
+                  @version,
+                  trunk_sid: @solution[:sid],
+              )
+            end
+
+            @credentials_lists
+          end
+
+          ##
+          # Access the ip_access_control_lists
+          # @return [IpAccessControlListList]
+          # @return [IpAccessControlListContext] if sid was passed.
+          def ip_access_control_lists(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return IpAccessControlListContext.new(
+                  @version,
+                  @solution[:sid],
+                  sid,
+              )
+            end
+
+            unless @ip_access_control_lists
+              @ip_access_control_lists = IpAccessControlListList.new(
+                  @version,
+                  trunk_sid: @solution[:sid],
+              )
+            end
+
+            @ip_access_control_lists
+          end
+
+          ##
+          # Access the phone_numbers
+          # @return [PhoneNumberList]
+          # @return [PhoneNumberContext] if sid was passed.
+          def phone_numbers(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return PhoneNumberContext.new(
+                  @version,
+                  @solution[:sid],
+                  sid,
+              )
+            end
+
+            unless @phone_numbers
+              @phone_numbers = PhoneNumberList.new(
+                  @version,
+                  trunk_sid: @solution[:sid],
+              )
+            end
+
+            @phone_numbers
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Trunking.V1.TrunkContext #{context}>"
+          end
+        end
+
+        class TrunkInstance < InstanceResource
+          ##
+          # Initialize the TrunkInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The sid
+          # @return [TrunkInstance] TrunkInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'domain_name' => payload['domain_name'],
+                'disaster_recovery_method' => payload['disaster_recovery_method'],
+                'disaster_recovery_url' => payload['disaster_recovery_url'],
+                'friendly_name' => payload['friendly_name'],
+                'secure' => payload['secure'],
+                'recording' => payload['recording'],
+                'auth_type' => payload['auth_type'],
+                'auth_type_set' => payload['auth_type_set'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'sid' => payload['sid'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # 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 [TrunkContext] TrunkContext for this TrunkInstance
+          def context
+            unless @instance_context
+              @instance_context = TrunkContext.new(
+                  @version,
+                  @params['sid'],
+              )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The account_sid
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The domain_name
+          def domain_name
+            @properties['domain_name']
+          end
+
+          ##
+          # @return [String] The disaster_recovery_method
+          def disaster_recovery_method
+            @properties['disaster_recovery_method']
+          end
+
+          ##
+          # @return [String] The disaster_recovery_url
+          def disaster_recovery_url
+            @properties['disaster_recovery_url']
+          end
+
+          ##
+          # @return [String] The friendly_name
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [Boolean] The secure
+          def secure
+            @properties['secure']
+          end
+
+          ##
+          # @return [Hash] The recording
+          def recording
+            @properties['recording']
+          end
+
+          ##
+          # @return [String] The auth_type
+          def auth_type
+            @properties['auth_type']
+          end
+
+          ##
+          # @return [String] The auth_type_set
+          def auth_type_set
+            @properties['auth_type_set']
+          end
+
+          ##
+          # @return [Time] The date_created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date_updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The sid
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch a TrunkInstance
+          # @return [TrunkInstance] Fetched TrunkInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Deletes the TrunkInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Update the TrunkInstance
+          # @param [String] friendly_name The friendly_name
+          # @param [String] domain_name The domain_name
+          # @param [String] disaster_recovery_url The disaster_recovery_url
+          # @param [String] disaster_recovery_method The disaster_recovery_method
+          # @param [String] recording The recording
+          # @param [Boolean] secure The secure
+          # @return [TrunkInstance] Updated TrunkInstance
+          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
+            context.update(
+                friendly_name: friendly_name,
+                domain_name: domain_name,
+                disaster_recovery_url: disaster_recovery_url,
+                disaster_recovery_method: disaster_recovery_method,
+                recording: recording,
+                secure: secure,
+            )
+          end
+
+          ##
+          # Access the origination_urls
+          # @return [origination_urls] origination_urls
+          def origination_urls
+            context.origination_urls
+          end
+
+          ##
+          # Access the credentials_lists
+          # @return [credentials_lists] credentials_lists
+          def credentials_lists
+            context.credentials_lists
+          end
+
+          ##
+          # Access the ip_access_control_lists
+          # @return [ip_access_control_lists] ip_access_control_lists
+          def ip_access_control_lists
+            context.ip_access_control_lists
+          end
+
+          ##
+          # Access the phone_numbers
+          # @return [phone_numbers] phone_numbers
+          def phone_numbers
+            context.phone_numbers
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Trunking.V1.TrunkInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Trunking
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Trunking
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @trunks = nil
+        end
+
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Trunking::V1::TrunkInstance] if sid was passed.
+        # @return [Twilio::REST::Trunking::V1::TrunkList]
+        def trunks(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @trunks ||= TrunkList.new self
+          else
+            TrunkContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Trunking::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Trunking < Domain
+      ##
+      # Initialize the Trunking Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://trunking.twilio.com'
+        @host = 'trunking.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of trunking
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Trunking::V1::TrunkInstance] if sid was passed.
+      # @return [Twilio::REST::Trunking::V1::TrunkList]
+      def trunks(sid=:unset)
+        self.v1.trunks(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Trunking>'
+      end
+    end
+  end
+end