twilio-ruby 5.0.0.rc26 → 5.0.0

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

@@ -26,6 +26,10 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Taskrouter::V1::WorkspaceInstance] if sid was passed.
+      # @return [Twilio::REST::Taskrouter::V1::WorkspaceList]
       def workspaces(sid=:unset)
         self.v1.workspaces(sid)
       end

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

@@ -16,6 +16,10 @@ module Twilio
           @workspaces = nil
         end
 
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Taskrouter::V1::WorkspaceInstance] if sid was passed.
+        # @return [Twilio::REST::Taskrouter::V1::WorkspaceList]
         def workspaces(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'

data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb

@@ -68,13 +68,6 @@ module Twilio
           # When passed a block, yields WorkspaceInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] friendly_name The friendly_name
-          # @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
 
@@ -282,8 +275,8 @@ module Twilio
 
           ##
           # Access the activities
-          # @return [ActivityList] if a(n) ActivityList object was created.
-          # @return [ActivityContext] if a(n) ActivityContext object was created.
+          # @return [ActivityList]
+          # @return [ActivityContext] if sid was passed.
           def activities(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -307,8 +300,8 @@ module Twilio
 
           ##
           # Access the events
-          # @return [EventList] if a(n) EventList object was created.
-          # @return [EventContext] if a(n) EventContext object was created.
+          # @return [EventList]
+          # @return [EventContext] if sid was passed.
           def events(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -332,8 +325,8 @@ module Twilio
 
           ##
           # Access the tasks
-          # @return [TaskList] if a(n) TaskList object was created.
-          # @return [TaskContext] if a(n) TaskContext object was created.
+          # @return [TaskList]
+          # @return [TaskContext] if sid was passed.
           def tasks(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -357,8 +350,8 @@ module Twilio
 
           ##
           # Access the task_queues
-          # @return [TaskQueueList] if a(n) TaskQueueList object was created.
-          # @return [TaskQueueContext] if a(n) TaskQueueContext object was created.
+          # @return [TaskQueueList]
+          # @return [TaskQueueContext] if sid was passed.
           def task_queues(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -382,8 +375,8 @@ module Twilio
 
           ##
           # Access the workers
-          # @return [WorkerList] if a(n) WorkerList object was created.
-          # @return [WorkerContext] if a(n) WorkerContext object was created.
+          # @return [WorkerList]
+          # @return [WorkerContext] if sid was passed.
           def workers(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -407,8 +400,8 @@ module Twilio
 
           ##
           # Access the workflows
-          # @return [WorkflowList] if a(n) WorkflowList object was created.
-          # @return [WorkflowContext] if a(n) WorkflowContext object was created.
+          # @return [WorkflowList]
+          # @return [WorkflowContext] if sid was passed.
           def workflows(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -432,8 +425,8 @@ module Twilio
 
           ##
           # Access the statistics
-          # @return [WorkspaceStatisticsList] if a(n) WorkspaceStatisticsList object was created.
-          # @return [WorkspaceStatisticsContext] if a(n) WorkspaceStatisticsContext object was created.
+          # @return [WorkspaceStatisticsList]
+          # @return [WorkspaceStatisticsContext]
           def statistics
             WorkspaceStatisticsContext.new(
                 @version,
@@ -443,8 +436,8 @@ module Twilio
 
           ##
           # Access the task_channels
-          # @return [TaskChannelList] if a(n) TaskChannelList object was created.
-          # @return [TaskChannelContext] if a(n) TaskChannelContext object was created.
+          # @return [TaskChannelList]
+          # @return [TaskChannelContext] if sid was passed.
           def task_channels(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -513,7 +506,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 [WorkspaceContext] WorkspaceContext for this WorkspaceInstance
           def context
             unless @instance_context
@@ -525,62 +517,92 @@ module Twilio
             @instance_context
           end
 
+          ##
+          # @return [String] The account_sid
           def account_sid
             @properties['account_sid']
           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_activity_name
           def default_activity_name
             @properties['default_activity_name']
           end
 
+          ##
+          # @return [String] The default_activity_sid
           def default_activity_sid
             @properties['default_activity_sid']
           end
 
+          ##
+          # @return [String] The event_callback_url
           def event_callback_url
             @properties['event_callback_url']
           end
 
+          ##
+          # @return [String] The events_filter
           def events_filter
             @properties['events_filter']
           end
 
+          ##
+          # @return [String] The friendly_name
           def friendly_name
             @properties['friendly_name']
           end
 
+          ##
+          # @return [Boolean] The multi_task_enabled
           def multi_task_enabled
             @properties['multi_task_enabled']
           end
 
+          ##
+          # @return [String] The sid
           def sid
             @properties['sid']
           end
 
+          ##
+          # @return [String] The timeout_activity_name
           def timeout_activity_name
             @properties['timeout_activity_name']
           end
 
+          ##
+          # @return [String] The timeout_activity_sid
           def timeout_activity_sid
             @properties['timeout_activity_sid']
           end
 
+          ##
+          # @return [workspace.QueueOrder] The prioritize_queue_order
           def prioritize_queue_order
             @properties['prioritize_queue_order']
           end
 
+          ##
+          # @return [String] The url
           def url
             @properties['url']
           end
 
+          ##
+          # @return [String] The links
           def links
             @properties['links']
           end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb

@@ -76,14 +76,6 @@ module Twilio
             # When passed a block, yields ActivityInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] available The available
-            # @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
 
@@ -172,7 +164,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] workspace_sid The workspace_sid
             # @return [ActivityPage] ActivityPage
             def initialize(version, response, solution)
               super(version, response)
@@ -310,7 +301,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 [ActivityContext] ActivityContext for this ActivityInstance
             def context
               unless @instance_context
@@ -323,34 +313,50 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [Boolean] The available
             def available
               @properties['available']
             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 friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
+            ##
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] The workspace_sid
             def workspace_sid
               @properties['workspace_sid']
             end
 
+            ##
+            # @return [String] The url
             def url
               @properties['url']
             end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb

@@ -104,21 +104,6 @@ module Twilio
             # When passed a block, yields EventInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] end_date The end_date
-            # @param [String] event_type The event_type
-            # @param [String] minutes The minutes
-            # @param [String] reservation_sid The reservation_sid
-            # @param [Time] start_date The start_date
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_sid The task_sid
-            # @param [String] worker_sid The worker_sid
-            # @param [String] workflow_sid The workflow_sid
-            # @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
 
@@ -196,7 +181,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] workspace_sid The sid
             # @return [EventPage] EventPage
             def initialize(version, response, solution)
               super(version, response)
@@ -311,7 +295,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 [EventContext] EventContext for this EventInstance
             def context
               unless @instance_context
@@ -324,62 +307,92 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The actor_sid
             def actor_sid
               @properties['actor_sid']
             end
 
+            ##
+            # @return [String] The actor_type
             def actor_type
               @properties['actor_type']
             end
 
+            ##
+            # @return [String] The actor_url
             def actor_url
               @properties['actor_url']
             end
 
+            ##
+            # @return [String] The description
             def description
               @properties['description']
             end
 
+            ##
+            # @return [String] The event_data
             def event_data
               @properties['event_data']
             end
 
+            ##
+            # @return [Time] The event_date
             def event_date
               @properties['event_date']
             end
 
+            ##
+            # @return [String] The event_type
             def event_type
               @properties['event_type']
             end
 
+            ##
+            # @return [String] The resource_sid
             def resource_sid
               @properties['resource_sid']
             end
 
+            ##
+            # @return [String] The resource_type
             def resource_type
               @properties['resource_type']
             end
 
+            ##
+            # @return [String] The resource_url
             def resource_url
               @properties['resource_url']
             end
 
+            ##
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] The source
             def source
               @properties['source']
             end
 
+            ##
+            # @return [String] The source_ip_address
             def source_ip_address
               @properties['source_ip_address']
             end
 
+            ##
+            # @return [String] The url
             def url
               @properties['url']
             end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb

@@ -104,21 +104,6 @@ module Twilio
             # When passed a block, yields TaskInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] priority The priority
-            # @param [String] assignment_status The assignment_status
-            # @param [String] workflow_sid The workflow_sid
-            # @param [String] workflow_name The workflow_name
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] evaluate_task_attributes The evaluate_task_attributes
-            # @param [String] ordering The ordering
-            # @param [Boolean] has_addons The has_addons
-            # @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
 
@@ -227,7 +212,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] workspace_sid The workspace_sid
             # @return [TaskPage] TaskPage
             def initialize(version, response, solution)
               super(version, response)
@@ -336,8 +320,8 @@ module Twilio
 
             ##
             # Access the reservations
-            # @return [ReservationList] if a(n) ReservationList object was created.
-            # @return [ReservationContext] if a(n) ReservationContext object was created.
+            # @return [ReservationList]
+            # @return [ReservationContext] if sid was passed.
             def reservations(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -415,7 +399,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 [TaskContext] TaskContext for this TaskInstance
             def context
               unless @instance_context
@@ -428,82 +411,122 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The age
             def age
               @properties['age']
             end
 
+            ##
+            # @return [reservation.Status] The assignment_status
             def assignment_status
               @properties['assignment_status']
             end
 
+            ##
+            # @return [String] The attributes
             def attributes
               @properties['attributes']
             end
 
+            ##
+            # @return [String] The addons
             def addons
               @properties['addons']
             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 priority
             def priority
               @properties['priority']
             end
 
+            ##
+            # @return [String] The reason
             def reason
               @properties['reason']
             end
 
+            ##
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] The task_queue_sid
             def task_queue_sid
               @properties['task_queue_sid']
             end
 
+            ##
+            # @return [String] The task_queue_friendly_name
             def task_queue_friendly_name
               @properties['task_queue_friendly_name']
             end
 
+            ##
+            # @return [String] The task_channel_sid
             def task_channel_sid
               @properties['task_channel_sid']
             end
 
+            ##
+            # @return [String] The task_channel_unique_name
             def task_channel_unique_name
               @properties['task_channel_unique_name']
             end
 
+            ##
+            # @return [String] The timeout
             def timeout
               @properties['timeout']
             end
 
+            ##
+            # @return [String] The workflow_sid
             def workflow_sid
               @properties['workflow_sid']
             end
 
+            ##
+            # @return [String] The workflow_friendly_name
             def workflow_friendly_name
               @properties['workflow_friendly_name']
             end
 
+            ##
+            # @return [String] The workspace_sid
             def workspace_sid
               @properties['workspace_sid']
             end
 
+            ##
+            # @return [String] The url
             def url
               @properties['url']
             end
 
+            ##
+            # @return [String] The links
             def links
               @properties['links']
             end