twilio-ruby 5.0.0.rc26 → 5.0.0

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

@@ -71,12 +71,6 @@ module Twilio
               # When passed a block, yields UserChannelInstance records from the API.
               # 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)
               def each
                 limits = @version.read_limits
 
@@ -136,8 +130,6 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Response] response Response from the API
               # @param [Hash] solution Path solution for the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid The sid
               # @return [UserChannelPage] UserChannelPage
               def initialize(version, response, solution)
                 super(version, response)
@@ -190,34 +182,50 @@ module Twilio
                 }
               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

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

@@ -26,19 +26,13 @@ module Twilio
         @accounts = nil
         @api = nil
         @chat = nil
-        @fax = nil
         @ip_messaging = nil
         @lookups = nil
         @monitor = nil
-        @notify = nil
-        @preview = nil
         @pricing = nil
         @taskrouter = nil
         @trunking = nil
         @video = nil
-        @messaging = nil
-        @wireless = nil
-        @sync = nil
       end
 
       ##
@@ -98,12 +92,6 @@ module Twilio
         @chat ||= Chat.new self
       end
 
-      ##
-      # Access the Fax Twilio Domain
-      def fax
-        @fax ||= Fax.new self
-      end
-
       ##
       # Access the IpMessaging Twilio Domain
       def ip_messaging
@@ -122,18 +110,6 @@ module Twilio
         @monitor ||= Monitor.new self
       end
 
-      ##
-      # Access the Notify Twilio Domain
-      def notify
-        @notify ||= Notify.new self
-      end
-
-      ##
-      # Access the Preview Twilio Domain
-      def preview
-        @preview ||= Preview.new self
-      end
-
       ##
       # Access the Pricing Twilio Domain
       def pricing
@@ -159,111 +135,184 @@ module Twilio
       end
 
       ##
-      # Access the Messaging Twilio Domain
-      def messaging
-        @messaging ||= Messaging.new self
-      end
-
-      ##
-      # Access the Wireless Twilio Domain
-      def wireless
-        @wireless ||= Wireless.new self
-      end
-
-      ##
-      # Access the Sync Twilio Domain
-      def sync
-        @sync ||= Sync.new self
-      end
-
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Api::V2010::AccountContext::AddressInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::AddressList]
       def addresses(sid=:unset)
         self.api.v2010.account.addresses(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ApplicationInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ApplicationList]
       def applications(sid=:unset)
         self.api.v2010.account.applications(sid)
       end
 
-      def authorized_connect_apps(sid=:unset)
-        self.api.v2010.account.authorized_connect_apps(sid)
+      ##
+      # @param [String] connect_app_sid The unique id of the Connect App that was
+      #   authorized.
+      # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance] if connect_app_sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppList]
+      def authorized_connect_apps(connect_app_sid=:unset)
+        self.api.v2010.account.authorized_connect_apps(connect_app_sid)
       end
 
-      def available_phone_numbers(sid=:unset)
-        self.api.v2010.account.available_phone_numbers(sid)
+      ##
+      # @param [String] country_code The ISO Country code to lookup phone numbers for.
+      # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if country_code was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList]
+      def available_phone_numbers(country_code=:unset)
+        self.api.v2010.account.available_phone_numbers(country_code)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::CallInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::CallList]
       def calls(sid=:unset)
         self.api.v2010.account.calls(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   conference.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ConferenceInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ConferenceList]
       def conferences(sid=:unset)
         self.api.v2010.account.conferences(sid)
       end
 
+      ##
+      # @param [String] sid The unique id of this Connect App.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ConnectAppList]
       def connect_apps(sid=:unset)
         self.api.v2010.account.connect_apps(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList]
       def incoming_phone_numbers(sid=:unset)
         self.api.v2010.account.incoming_phone_numbers(sid)
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
       def keys(sid=:unset)
         self.api.v2010.account.keys(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::MessageList]
       def messages(sid=:unset)
         self.api.v2010.account.messages(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::NewKeyInstance]
       def new_keys
         self.api.v2010.account.new_keys
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::NewSigningKeyInstance]
       def new_signing_keys
         self.api.v2010.account.new_signing_keys
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::NotificationInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::NotificationList]
       def notifications(sid=:unset)
         self.api.v2010.account.notifications(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdList]
       def outgoing_caller_ids(sid=:unset)
         self.api.v2010.account.outgoing_caller_ids(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this queue.
+      # @return [Twilio::REST::Api::V2010::AccountContext::QueueInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::QueueList]
       def queues(sid=:unset)
         self.api.v2010.account.queues(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::RecordingInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::RecordingList]
       def recordings(sid=:unset)
         self.api.v2010.account.recordings(sid)
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Api::V2010::AccountContext::SigningKeyInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::SigningKeyList]
       def signing_keys(sid=:unset)
         self.api.v2010.account.signing_keys(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::SipInstance]
       def sip
         self.api.v2010.account.sip
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ShortCodeInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::ShortCodeList]
       def short_codes(sid=:unset)
         self.api.v2010.account.short_codes(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::TokenInstance]
       def tokens
         self.api.v2010.account.tokens
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionList]
       def transcriptions(sid=:unset)
         self.api.v2010.account.transcriptions(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::UsageInstance]
       def usage
         self.api.v2010.account.usage
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::ValidationRequestInstance]
       def validation_requests
         self.api.v2010.account.validation_requests
       end

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

@@ -33,10 +33,18 @@ module Twilio
         @v2 ||= V2.new self
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Chat::V2::CredentialInstance] if sid was passed.
+      # @return [Twilio::REST::Chat::V2::CredentialList]
       def credentials(sid=:unset)
         self.v2.credentials(sid)
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Chat::V2::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Chat::V2::ServiceList]
       def services(sid=:unset)
         self.v2.services(sid)
       end

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

@@ -17,6 +17,10 @@ module Twilio
           @services = nil
         end
 
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Chat::V1::CredentialInstance] if sid was passed.
+        # @return [Twilio::REST::Chat::V1::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
@@ -27,6 +31,10 @@ module Twilio
           end
         end
 
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Chat::V1::ServiceInstance] if sid was passed.
+        # @return [Twilio::REST::Chat::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'

data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb

@@ -64,12 +64,6 @@ module Twilio
           # When passed a block, yields CredentialInstance records from the API.
           # 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)
           def each
             limits = @version.read_limits
 
@@ -303,7 +297,6 @@ module Twilio
           ##
           # Generate an instance context for the instance, the context is capable of
           # performing various actions.  All instance actions are proxied to the context
-          # @param [Version] version Version that contains the resource
           # @return [CredentialContext] CredentialContext for this CredentialInstance
           def context
             unless @instance_context
@@ -315,34 +308,50 @@ module Twilio
             @instance_context
           end
 
+          ##
+          # @return [String] The sid
           def sid
             @properties['sid']
           end
 
+          ##
+          # @return [String] The account_sid
           def account_sid
             @properties['account_sid']
           end
 
+          ##
+          # @return [String] The friendly_name
           def friendly_name
             @properties['friendly_name']
           end
 
+          ##
+          # @return [credential.PushService] The type
           def type
             @properties['type']
           end
 
+          ##
+          # @return [String] The sandbox
           def sandbox
             @properties['sandbox']
           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 url
           def url
             @properties['url']
           end

data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb

@@ -86,12 +86,6 @@ module Twilio
           # When passed a block, yields ServiceInstance records from the API.
           # 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)
           def each
             limits = @version.read_limits
 
@@ -434,8 +428,8 @@ module Twilio
 
           ##
           # Access the channels
-          # @return [ChannelList] if a(n) ChannelList object was created.
-          # @return [ChannelContext] if a(n) ChannelContext object was created.
+          # @return [ChannelList]
+          # @return [ChannelContext] if sid was passed.
           def channels(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -459,8 +453,8 @@ module Twilio
 
           ##
           # Access the roles
-          # @return [RoleList] if a(n) RoleList object was created.
-          # @return [RoleContext] if a(n) RoleContext object was created.
+          # @return [RoleList]
+          # @return [RoleContext] if sid was passed.
           def roles(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -484,8 +478,8 @@ module Twilio
 
           ##
           # Access the users
-          # @return [UserList] if a(n) UserList object was created.
-          # @return [UserContext] if a(n) UserContext object was created.
+          # @return [UserList]
+          # @return [UserContext] if sid was passed.
           def users(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -560,7 +554,6 @@ module Twilio
           ##
           # Generate an instance context for the instance, the context is capable of
           # performing various actions.  All instance actions are proxied to the context
-          # @param [Version] version Version that contains the resource
           # @return [ServiceContext] ServiceContext for this ServiceInstance
           def context
             unless @instance_context
@@ -572,86 +565,128 @@ module Twilio
             @instance_context
           end
 
+          ##
+          # @return [String] The sid
           def sid
             @properties['sid']
           end
 
+          ##
+          # @return [String] The account_sid
           def account_sid
             @properties['account_sid']
           end
 
+          ##
+          # @return [String] The friendly_name
           def friendly_name
             @properties['friendly_name']
           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 default_service_role_sid
           def default_service_role_sid
             @properties['default_service_role_sid']
           end
 
+          ##
+          # @return [String] The default_channel_role_sid
           def default_channel_role_sid
             @properties['default_channel_role_sid']
           end
 
+          ##
+          # @return [String] The default_channel_creator_role_sid
           def default_channel_creator_role_sid
             @properties['default_channel_creator_role_sid']
           end
 
+          ##
+          # @return [Boolean] The read_status_enabled
           def read_status_enabled
             @properties['read_status_enabled']
           end
 
+          ##
+          # @return [Boolean] The reachability_enabled
           def reachability_enabled
             @properties['reachability_enabled']
           end
 
+          ##
+          # @return [String] The typing_indicator_timeout
           def typing_indicator_timeout
             @properties['typing_indicator_timeout']
           end
 
+          ##
+          # @return [String] The consumption_report_interval
           def consumption_report_interval
             @properties['consumption_report_interval']
           end
 
+          ##
+          # @return [Hash] The limits
           def limits
             @properties['limits']
           end
 
+          ##
+          # @return [Hash] The webhooks
           def webhooks
             @properties['webhooks']
           end
 
+          ##
+          # @return [String] The pre_webhook_url
           def pre_webhook_url
             @properties['pre_webhook_url']
           end
 
+          ##
+          # @return [String] The post_webhook_url
           def post_webhook_url
             @properties['post_webhook_url']
           end
 
+          ##
+          # @return [String] The webhook_method
           def webhook_method
             @properties['webhook_method']
           end
 
+          ##
+          # @return [String] The webhook_filters
           def webhook_filters
             @properties['webhook_filters']
           end
 
+          ##
+          # @return [Hash] The notifications
           def notifications
             @properties['notifications']
           end
 
+          ##
+          # @return [String] The url
           def url
             @properties['url']
           end
 
+          ##
+          # @return [String] The links
           def links
             @properties['links']
           end