twilio-ruby 4.13.0 → 5.0.0.alpha1

data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb

@@ -0,0 +1,244 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class IpMessaging < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          class UserContext < InstanceContext
+            class UserChannelList < ListResource
+              ##
+              # Initialize the UserChannelList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The sid
+              # @return [UserChannelList] UserChannelList
+              def initialize(version, service_sid: nil, user_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    user_sid: user_sid
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels"
+              end
+
+              ##
+              # Lists UserChannelInstance 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 UserChannelInstance 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 UserChannelInstance 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 UserChannelInstance 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 UserChannelInstance
+              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
+                )
+                UserChannelPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of UserChannelInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of UserChannelInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                UserChannelPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.IpMessaging.V2.UserChannelList>'
+              end
+            end
+
+            class UserChannelPage < Page
+              ##
+              # Initialize the UserChannelPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [UserChannelPage] UserChannelPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of UserChannelInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [UserChannelInstance] UserChannelInstance
+              def get_instance(payload)
+                UserChannelInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.IpMessaging.V2.UserChannelPage>'
+              end
+            end
+
+            class UserChannelInstance < InstanceResource
+              ##
+              # Initialize the UserChannelInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The sid
+              # @return [UserChannelInstance] UserChannelInstance
+              def initialize(version, payload, service_sid: nil, user_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'channel_sid' => payload['channel_sid'],
+                    'member_sid' => payload['member_sid'],
+                    'status' => payload['status'],
+                    'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
+                    'unread_messages_count' => payload['unread_messages_count'] == nil ? payload['unread_messages_count'] : payload['unread_messages_count'].to_i,
+                    'links' => payload['links'],
+                }
+              end
+
+              ##
+              # @return [String] The account_sid
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The service_sid
+              def service_sid
+                @properties['service_sid']
+              end
+
+              ##
+              # @return [String] The channel_sid
+              def channel_sid
+                @properties['channel_sid']
+              end
+
+              ##
+              # @return [String] The member_sid
+              def member_sid
+                @properties['member_sid']
+              end
+
+              ##
+              # @return [user_channel.ChannelStatus] The status
+              def status
+                @properties['status']
+              end
+
+              ##
+              # @return [String] The last_consumed_message_index
+              def last_consumed_message_index
+                @properties['last_consumed_message_index']
+              end
+
+              ##
+              # @return [String] The unread_messages_count
+              def unread_messages_count
+                @properties['unread_messages_count']
+              end
+
+              ##
+              # @return [String] The links
+              def links
+                @properties['links']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.IpMessaging.V2.UserChannelInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb

@@ -0,0 +1,224 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Lookups < Domain
+      class V1 < Version
+        class PhoneNumberList < ListResource
+          ##
+          # Initialize the PhoneNumberList
+          # @param [Version] version Version that contains the resource
+          # @return [PhoneNumberList] PhoneNumberList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Lookups.V1.PhoneNumberList>'
+          end
+        end
+
+        class PhoneNumberPage < Page
+          ##
+          # Initialize the PhoneNumberPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [PhoneNumberPage] PhoneNumberPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of PhoneNumberInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [PhoneNumberInstance] PhoneNumberInstance
+          def get_instance(payload)
+            PhoneNumberInstance.new(
+                @version,
+                payload,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Lookups.V1.PhoneNumberPage>'
+          end
+        end
+
+        class PhoneNumberContext < InstanceContext
+          ##
+          # Initialize the PhoneNumberContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] phone_number The phone_number
+          # @return [PhoneNumberContext] PhoneNumberContext
+          def initialize(version, phone_number)
+            super(version)
+
+            # Path Solution
+            @solution = {
+                phone_number: phone_number,
+            }
+            @uri = "/PhoneNumbers/#{@solution[:phone_number]}"
+          end
+
+          ##
+          # Fetch a PhoneNumberInstance
+          # @param [String] country_code The country_code
+          # @param [String] type The type
+          # @param [String] add_ons The add_ons
+          # @param [Hash] add_ons_data The add_ons_data
+          # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+          def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
+            params = Twilio::Values.of({
+                'CountryCode' => country_code,
+                'Type' => type,
+                'AddOns' => add_ons,
+            })
+
+            params.merge!(Twilio.prefixed_collapsible_map(add_ons_data, 'AddOns'))
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            PhoneNumberInstance.new(
+                @version,
+                payload,
+                phone_number: @solution[:phone_number],
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Lookups.V1.PhoneNumberContext #{context}>"
+          end
+        end
+
+        class PhoneNumberInstance < InstanceResource
+          ##
+          # Initialize the PhoneNumberInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] phone_number The phone_number
+          # @return [PhoneNumberInstance] PhoneNumberInstance
+          def initialize(version, payload, phone_number: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'caller_name' => payload['caller_name'],
+                'country_code' => payload['country_code'],
+                'phone_number' => payload['phone_number'],
+                'national_format' => payload['national_format'],
+                'carrier' => payload['carrier'],
+                'add_ons' => payload['add_ons'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {
+                'phone_number' => phone_number || @properties['phone_number'],
+            }
+          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 [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
+          def context
+            unless @instance_context
+              @instance_context = PhoneNumberContext.new(
+                  @version,
+                  @params['phone_number'],
+              )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The caller_name
+          def caller_name
+            @properties['caller_name']
+          end
+
+          ##
+          # @return [String] The country_code
+          def country_code
+            @properties['country_code']
+          end
+
+          ##
+          # @return [String] The phone_number
+          def phone_number
+            @properties['phone_number']
+          end
+
+          ##
+          # @return [String] The national_format
+          def national_format
+            @properties['national_format']
+          end
+
+          ##
+          # @return [String] The carrier
+          def carrier
+            @properties['carrier']
+          end
+
+          ##
+          # @return [Hash] The add_ons
+          def add_ons
+            @properties['add_ons']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch a PhoneNumberInstance
+          # @param [String] country_code The country_code
+          # @param [String] type The type
+          # @param [String] add_ons The add_ons
+          # @param [Hash] add_ons_data The add_ons_data
+          # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+          def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
+            context.fetch(
+                country_code: country_code,
+                type: type,
+                add_ons: add_ons,
+                add_ons_data: add_ons_data,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Lookups.V1.PhoneNumberInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end