twilio-ruby 5.0.0.rc26 → 5.0.0

data/lib/twilio-ruby/jwt/jwt.rb

@@ -21,36 +21,30 @@ module Twilio
       end
 
       def _generate_payload
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def headers
-        headers = self._generate_headers.clone()
+        headers = _generate_headers.clone
         headers['typ'] = 'JWT'
         headers['alg'] = @algorithm
         headers
       end
 
       def payload
-        payload = self._generate_payload.clone()
+        payload = _generate_payload.clone
 
         payload[:iss] = @issuer
         payload[:nbf] = @nbf || Time.now.to_i
-
-        if @valid_until.nil?
-          payload[:exp] = Time.now.to_i + @ttl
-        else
-          payload[:exp] = @valid_until
-        end
-
+        payload[:exp] = @valid_until.nil? ? Time.now.to_i + @ttl : @valid_until
         payload[:sub] = @subject unless @subject.nil?
+        
         payload
       end
 
       def to_jwt
-        ::JWT.encode self.payload, @secret_key, @algorithm, self.headers
+        ::JWT.encode payload, @secret_key, @algorithm, headers
       end
-
     end
   end
-end
+end

data/lib/twilio-ruby/jwt/task_router.rb

@@ -1,7 +1,7 @@
 module Twilio
   module JWT
     class TaskRouterCapability < BaseJWT
-      TASK_ROUTER_VERSION = 'v1'
+      TASK_ROUTER_VERSION = 'v1'.freeze
       def initialize(account_sid, auth_token, workspace_sid, channel_id, nbf: nil, ttl: 3600, valid_until: nil)
         super(secret_key: auth_token,
               issuer: account_sid,
@@ -25,17 +25,20 @@ module Twilio
       end
 
       protected
+
       def _generate_payload
-        Twilio::JWT::TaskRouterCapability::TaskRouterUtils.web_socket_policies(@account_sid, @channel_id).each {|policy| self.add_policy(policy)}
-        policies = @policies.map{ |policy| policy._generate_payload}
+        Twilio::JWT::TaskRouterCapability::TaskRouterUtils
+          .web_socket_policies(@account_sid, @channel_id)
+          .each { |policy| add_policy(policy) }
+        policies = @policies.map(&:_generate_payload)
 
         payload = {
-            account_sid: @account_sid,
-            workspace_sid: @workspace_sid,
-            channel: @channel_id,
-            version: TASK_ROUTER_VERSION,
-            friendly_name: @channel_id,
-            policies: policies
+          account_sid: @account_sid,
+          workspace_sid: @workspace_sid,
+          channel: @channel_id,
+          version: TASK_ROUTER_VERSION,
+          friendly_name: @channel_id,
+          policies: policies
         }
 
         if @channel_id[0..1] == 'WK'
@@ -54,7 +57,7 @@ module Twilio
                       :post_filters,
                       :query_filters
 
-        def initialize(url, method, allowed, post_filters={}, query_filters={})
+        def initialize(url, method, allowed, post_filters = {}, query_filters = {})
           @url = url
           @method = method
           @allowed = allowed
@@ -64,21 +67,20 @@ module Twilio
 
         def _generate_payload
           policy = {
-              url: @url,
-              method: @method,
-              query_filter: @query_filters,
-              post_filter: @post_filters,
-              allow: @allowed
+            url: @url,
+            method: @method,
+            query_filter: @query_filters,
+            post_filter: @post_filters,
+            allow: @allowed
           }
           policy
         end
-
       end
 
       class TaskRouterUtils
-        TASK_ROUTER_VERSION = 'v1'
-        TASK_ROUTER_BASE_URL = 'https://taskrouter.twilio.com'
-        TASK_ROUTER_WEBSOCKET_BASE_URL = 'https://event-bridge.twilio.com/v1/wschannels'
+        TASK_ROUTER_VERSION = 'v1'.freeze
+        TASK_ROUTER_BASE_URL = 'https://taskrouter.twilio.com'.freeze
+        TASK_ROUTER_WEBSOCKET_BASE_URL = 'https://event-bridge.twilio.com/v1/wschannels'.freeze
 
         def self.workspaces
           [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces'].join('/')
@@ -93,63 +95,63 @@ module Twilio
         end
 
         def self.tasks(workspace_sid)
-          [self.workspace(workspace_sid), 'Tasks'].join('/')
+          [workspace(workspace_sid), 'Tasks'].join('/')
         end
 
         def self.task(workspace_sid, tasks_sid)
-          [self.workspace(workspace_sid), 'Tasks', tasks_sid].join('/')
+          [workspace(workspace_sid), 'Tasks', tasks_sid].join('/')
         end
 
         def self.all_tasks(workspace_sid)
-          [self.workspace(workspace_sid), 'Tasks', '**'].join('/')
+          [workspace(workspace_sid), 'Tasks', '**'].join('/')
         end
 
         def self.task_queues(workspace_sid)
-          [self.workspace(workspace_sid), 'TaskQueues'].join('/')
+          [workspace(workspace_sid), 'TaskQueues'].join('/')
         end
 
         def self.task_queue(workspace_sid, taskqueue_sid)
-          [self.workspace(workspace_sid), 'TaskQueues', taskqueue_sid].join('/')
+          [workspace(workspace_sid), 'TaskQueues', taskqueue_sid].join('/')
         end
 
         def self.all_task_queues(workspace_sid)
-          [self.workspace(workspace_sid), 'TaskQueues', '**'].join('/')
+          [workspace(workspace_sid), 'TaskQueues', '**'].join('/')
         end
 
         def self.activities(workspace_sid)
-          [self.workspace(workspace_sid), 'Activities'].join('/')
+          [workspace(workspace_sid), 'Activities'].join('/')
         end
 
         def self.activity(workspace_sid, activity_sid)
-          [self.workspace(workspace_sid), 'Activities', activity_sid].join('/')
+          [workspace(workspace_sid), 'Activities', activity_sid].join('/')
         end
 
         def self.all_activities(workspace_sid)
-          [self.workspace(workspace_sid), 'Activities', '**'].join('/')
+          [workspace(workspace_sid), 'Activities', '**'].join('/')
         end
 
         def self.workers(workspace_sid)
-          [self.workspace(workspace_sid), 'Workers'].join('/')
+          [workspace(workspace_sid), 'Workers'].join('/')
         end
 
         def self.worker(workspace_sid, worker_sid)
-          [self.workspace(workspace_sid), 'Workers', worker_sid].join('/')
+          [workspace(workspace_sid), 'Workers', worker_sid].join('/')
         end
 
         def self.all_workers(workspace_sid)
-          [self.workspace(workspace_sid), 'Workers', '**'].join('/')
+          [workspace(workspace_sid), 'Workers', '**'].join('/')
         end
 
         def self.reservations(workspace_sid, worker_sid)
-          [self.worker(workspace_sid, worker_sid), 'Reservations'].join('/')
+          [worker(workspace_sid, worker_sid), 'Reservations'].join('/')
         end
 
         def self.reservation(workspace_sid, worker_sid, reservation_sid)
-          [self.worker(workspace_sid, worker_sid), 'Reservations', reservation_sid].join('/')
+          [worker(workspace_sid, worker_sid), 'Reservations', reservation_sid].join('/')
         end
 
         def self.all_reservations(workspace_sid, worker_sid)
-          [self.worker(workspace_sid, worker_sid), 'Reservations', '**'].join('/')
+          [worker(workspace_sid, worker_sid), 'Reservations', '**'].join('/')
         end
 
         def self.web_socket_policies(account_sid, channel_sid)
@@ -161,12 +163,12 @@ module Twilio
 
         def self.worker_policies(workspace_sid, worker_sid)
           activities = Policy.new(self.activities(workspace_sid), 'GET', true)
-          tasks = Policy.new(self.all_tasks(workspace_sid), 'GET', true)
-          reservations = Policy.new(self.all_reservations(workspace_sid, worker_sid), 'GET', true)
-          fetch = Policy.new(self.worker(workspace_sid, worker_sid), 'GET', true)
+          tasks = Policy.new(all_tasks(workspace_sid), 'GET', true)
+          reservations = Policy.new(all_reservations(workspace_sid, worker_sid), 'GET', true)
+          fetch = Policy.new(worker(workspace_sid, worker_sid), 'GET', true)
           [activities, tasks, reservations, fetch]
         end
       end
     end
   end
-end
+end

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

@@ -26,6 +26,8 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @return [Twilio::REST::Accounts::V1::CredentialInstance]
       def credentials
         self.v1.credentials()
       end

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

@@ -16,6 +16,8 @@ module Twilio
           @credentials = nil
         end
 
+        ##
+        # @return [Twilio::REST::Accounts::V1::CredentialInstance]
         def credentials(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'

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

@@ -27,8 +27,8 @@ module Twilio
           # Access the public_key
           # @param [String] sid The Credential Sid that uniquely identifies the Credential
           #   to fetch
-          # @return [PublicKeyList] if a(n) PublicKeyList object was created.
-          # @return [PublicKeyContext] if a(n) PublicKeyContext object was created.
+          # @return [PublicKeyList]
+          # @return [PublicKeyContext] if sid was passed.
           def public_key(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 

data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

@@ -65,12 +65,6 @@ module Twilio
             # When passed a block, yields PublicKeyInstance 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
 
@@ -290,7 +284,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 [PublicKeyContext] PublicKeyContext for this PublicKeyInstance
             def context
               unless @instance_context
@@ -302,26 +295,38 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] AccountSid the Credential resource belongs to
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] A human readable description of this resource
             def friendly_name
               @properties['friendly_name']
             end
 
+            ##
+            # @return [Time] The date this resource was created
             def date_created
               @properties['date_created']
             end
 
+            ##
+            # @return [Time] The date this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
+            ##
+            # @return [String] The URI for this resource, relative to `https://accounts.twilio.com`
             def url
               @properties['url']
             end

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

@@ -32,98 +32,194 @@ module Twilio
         self.v2010.account
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Api::V2010::AccountInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountList]
       def accounts(sid=:unset)
         self.v2010.accounts(sid)
       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.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.account.applications(sid)
       end
 
+      ##
+      # @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.account.authorized_connect_apps(connect_app_sid)
       end
 
+      ##
+      # @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.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.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.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.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.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.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.account.messages(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::NewKeyInstance]
       def new_keys
         self.account.new_keys()
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::NewSigningKeyInstance]
       def new_signing_keys
         self.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.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.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.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.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.account.signing_keys(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::SipInstance]
       def sip
         self.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.account.short_codes(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::TokenInstance]
       def tokens
         self.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.account.transcriptions(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::UsageInstance]
       def usage
         self.account.usage()
       end
 
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::ValidationRequestInstance]
       def validation_requests
         self.account.validation_requests()
       end