twilio-ruby 5.8.1 → 5.9.0

data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,8 @@ module Twilio
             ##
             # Initialize the SyncStreamList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service Instance.
+            # @param [String] service_sid The unique SID identifier of the Service Instance
+            #   that hosts this Message Stream.
             # @return [SyncStreamList] SyncStreamList
             def initialize(version, service_sid: nil)
               super(version)
@@ -30,8 +33,8 @@ module Twilio
             # Request is executed immediately.
             # @param [String] unique_name The unique and addressable name of this Stream.
             #   Optional, up to 256 characters long.
-            # @param [String] ttl Optional time-to-live of this Stream in seconds. In the
-            #   range [1, 31 536 000 (1 year)], or 0 for infinity.
+            # @param [String] ttl (optional) Time-to-live of this Stream in seconds, defaults
+            #   to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
             # @return [SyncStreamInstance] Newly created SyncStreamInstance
             def create(unique_name: :unset, ttl: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -171,7 +174,8 @@ module Twilio
             ##
             # Initialize the SyncStreamContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid Identifier of the Service Instance. Either a SID or
+            #   'default'.
             # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
             # @return [SyncStreamContext] SyncStreamContext
             def initialize(version, service_sid, sid)
@@ -214,8 +218,8 @@ module Twilio
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl Time-to-live of this Stream in seconds. In the range [1, 31
-            #   536 000 (1 year)], or 0 for infinity.
+            # @param [String] ttl New time-to-live of this Stream in seconds. In the range [1,
+            #   31 536 000 (1 year)], or 0 for infinity.
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, })
@@ -265,7 +269,8 @@ module Twilio
             # Initialize the SyncStreamInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique SID identifier of the Service Instance.
+            # @param [String] service_sid The unique SID identifier of the Service Instance
+            #   that hosts this Message Stream.
             # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
             # @return [SyncStreamInstance] SyncStreamInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -377,8 +382,8 @@ module Twilio
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl Time-to-live of this Stream in seconds. In the range [1, 31
-            #   536 000 (1 year)], or 0 for infinity.
+            # @param [String] ttl New time-to-live of this Stream in seconds. In the range [1,
+            #   31 536 000 (1 year)], or 0 for infinity.
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
               context.update(ttl: ttl, )

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -26,10 +28,17 @@ module Twilio
           ##
           # Retrieve a single page of ServiceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
-          # @param [String] webhook_url The webhook_url
-          # @param [Boolean] reachability_webhooks_enabled The reachability_webhooks_enabled
-          # @param [Boolean] acl_enabled The acl_enabled
+          # @param [String] friendly_name (optional) Human-readable name for this service
+          #   instance
+          # @param [String] webhook_url (optional) A URL that will receive event updates
+          #   when objects are manipulated.
+          # @param [Boolean] reachability_webhooks_enabled (optional) `true` or `false` -
+          #   controls whether this instance fires webhooks when client endpoints connect to
+          #   Sync Defaults to false.
+          # @param [Boolean] acl_enabled (optional) `true` or `false` - determines whether
+          #   token identities must be granted access to Sync objects via the [Permissions
+          #   API](https://www.twilio.com/docs/api/sync/rest/sync-rest-api-permissions) in
+          #   this Service.
           # @return [ServiceInstance] Newly created ServiceInstance
           def create(friendly_name: :unset, webhook_url: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
             data = Twilio::Values.of({
@@ -214,10 +223,17 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @param [String] webhook_url The webhook_url
-          # @param [String] friendly_name The friendly_name
-          # @param [Boolean] reachability_webhooks_enabled The reachability_webhooks_enabled
-          # @param [Boolean] acl_enabled The acl_enabled
+          # @param [String] webhook_url (optional) A URL that will receive event updates
+          #   when objects are manipulated.
+          # @param [String] friendly_name (optional) Human-readable name for this service
+          #   instance
+          # @param [Boolean] reachability_webhooks_enabled (optional) True or false -
+          #   controls whether this instance fires webhooks when client endpoints connect to
+          #   Sync Defaults to false.
+          # @param [Boolean] acl_enabled (optional) `true` or `false` - determines whether
+          #   token identities must be granted access to Sync objects via the [Permissions
+          #   API](https://www.twilio.com/docs/api/sync/rest/sync-rest-api-permissions) in
+          #   this Service.
           # @return [ServiceInstance] Updated ServiceInstance
           def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
             data = Twilio::Values.of({
@@ -378,7 +394,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] Human-readable name for this service instance
           def friendly_name
             @properties['friendly_name']
           end
@@ -402,19 +418,19 @@ module Twilio
           end
 
           ##
-          # @return [String] The webhook_url
+          # @return [String] A URL that will receive event updates when objects are manipulated.
           def webhook_url
             @properties['webhook_url']
           end
 
           ##
-          # @return [Boolean] The reachability_webhooks_enabled
+          # @return [Boolean] true or false - controls whether this instance fires webhooks when client endpoints connect to Sync
           def reachability_webhooks_enabled
             @properties['reachability_webhooks_enabled']
           end
 
           ##
-          # @return [Boolean] The acl_enabled
+          # @return [Boolean] true or false - determines whether token identities must be granted access to Sync objects via the Permissions API in this Service.
           def acl_enabled
             @properties['acl_enabled']
           end
@@ -441,10 +457,17 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @param [String] webhook_url The webhook_url
-          # @param [String] friendly_name The friendly_name
-          # @param [Boolean] reachability_webhooks_enabled The reachability_webhooks_enabled
-          # @param [Boolean] acl_enabled The acl_enabled
+          # @param [String] webhook_url (optional) A URL that will receive event updates
+          #   when objects are manipulated.
+          # @param [String] friendly_name (optional) Human-readable name for this service
+          #   instance
+          # @param [Boolean] reachability_webhooks_enabled (optional) True or false -
+          #   controls whether this instance fires webhooks when client endpoints connect to
+          #   Sync Defaults to false.
+          # @param [Boolean] acl_enabled (optional) `true` or `false` - determines whether
+          #   token identities must be granted access to Sync objects via the [Permissions
+          #   API](https://www.twilio.com/docs/api/sync/rest/sync-rest-api-permissions) in
+          #   this Service.
           # @return [ServiceInstance] Updated ServiceInstance
           def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
             context.update(

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the ActivityList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The unique ID of the Workspace that this Activity
+            #   belongs to.
             # @return [ActivityList] ActivityList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -27,8 +30,10 @@ module Twilio
             # Lists ActivityInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] available The available
+            # @param [String] friendly_name Filter by an Activity's friendly name
+            # @param [String] available Filter by activities that are available or
+            #   unavailable. (Note: This can be 'true', '1'' or 'yes' to indicate a true value.
+            #   All other values will represent false)
             # @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
@@ -49,8 +54,10 @@ module Twilio
             # Streams ActivityInstance records from the API as an Enumerable.
             # 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 [String] friendly_name Filter by an Activity's friendly name
+            # @param [String] available Filter by activities that are available or
+            #   unavailable. (Note: This can be 'true', '1'' or 'yes' to indicate a true value.
+            #   All other values will represent false)
             # @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
@@ -83,8 +90,10 @@ module Twilio
             ##
             # Retrieve a single page of ActivityInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] available The available
+            # @param [String] friendly_name Filter by an Activity's friendly name
+            # @param [String] available Filter by activities that are available or
+            #   unavailable. (Note: This can be 'true', '1'' or 'yes' to indicate a true value.
+            #   All other values will represent false)
             # @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
@@ -121,8 +130,15 @@ module Twilio
             ##
             # Retrieve a single page of ActivityInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [Boolean] available The available
+            # @param [String] friendly_name A human-readable name for the Activity, such as
+            #   'On Call', 'Break', 'Email', etc. Must be unique in this Workspace. These names
+            #   will be used to calculate and expose statistics about workers, and give you
+            #   visibility into the state of each of your workers.
+            # @param [Boolean] available Boolean value indicating whether the worker should be
+            #   eligible to receive a Task when they occupy this Activity. For example, a call
+            #   center might have an activity named 'On Call' with an availability set to
+            #   'false'. Note: This can be 'true', '1' or 'yes' to indicate a true value. All
+            #   other values will represent false. Defaults to false.
             # @return [ActivityInstance] Newly created ActivityInstance
             def create(friendly_name: nil, available: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Available' => available, })
@@ -209,7 +225,10 @@ module Twilio
 
             ##
             # Update the ActivityInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A human-readable name for the Activity, such as
+            #   'on-call', 'break', 'email', etc. These names will be used to calculate and
+            #   expose statistics about workers, and give you visibility into the state of each
+            #   of your workers.
             # @return [ActivityInstance] Updated ActivityInstance
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -248,7 +267,8 @@ module Twilio
             # Initialize the ActivityInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The unique ID of the Workspace that this Activity
+            #   belongs to.
             # @param [String] sid The sid
             # @return [ActivityInstance] ActivityInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
@@ -283,43 +303,43 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique ID of the Account that owns this Activity.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Boolean] The available
+            # @return [Boolean] Filter by activities that are available or unavailable.
             def available
               @properties['available']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date this Activity was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date this Activity was updated.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] Filter by an Activity's friendly name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique ID for this Activity.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The unique ID of the Workspace that this Activity belongs to.
             def workspace_sid
               @properties['workspace_sid']
             end
@@ -339,7 +359,10 @@ module Twilio
 
             ##
             # Update the ActivityInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A human-readable name for the Activity, such as
+            #   'on-call', 'break', 'email', etc. These names will be used to calculate and
+            #   expose statistics about workers, and give you visibility into the state of each
+            #   of your workers.
             # @return [ActivityInstance] Updated ActivityInstance
             def update(friendly_name: :unset)
               context.update(friendly_name: friendly_name, )

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the EventList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The sid
+            # @param [String] workspace_sid The unique ID of the Workspace
             # @return [EventList] EventList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -27,14 +29,21 @@ module Twilio
             # Lists EventInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @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 [Time] end_date Filter events by an end date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] event_type Filter events by those of a certain event type
+            # @param [String] minutes Filter events by up to ‘x’ minutes in the past. This is
+            #   helpful for events for the last 15 minutes, 240 minutes (4 hours), and 480
+            #   minutes (8 hours) to see trends. Defaults to 15 minutes.
+            # @param [String] reservation_sid Filter events by those pertaining to a
+            #   particular reservation
+            # @param [Time] start_date Filter events by a start date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] task_queue_sid Filter events by those pertaining to a particular
+            #   queue
+            # @param [String] task_sid Filter events by those pertaining to a particular task
+            # @param [String] worker_sid Filter events by those pertaining to a particular
+            #   worker
             # @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
@@ -63,14 +72,21 @@ module Twilio
             # Streams EventInstance records from the API as an Enumerable.
             # 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 [Time] end_date Filter events by an end date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] event_type Filter events by those of a certain event type
+            # @param [String] minutes Filter events by up to ‘x’ minutes in the past. This is
+            #   helpful for events for the last 15 minutes, 240 minutes (4 hours), and 480
+            #   minutes (8 hours) to see trends. Defaults to 15 minutes.
+            # @param [String] reservation_sid Filter events by those pertaining to a
+            #   particular reservation
+            # @param [Time] start_date Filter events by a start date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] task_queue_sid Filter events by those pertaining to a particular
+            #   queue
+            # @param [String] task_sid Filter events by those pertaining to a particular task
+            # @param [String] worker_sid Filter events by those pertaining to a particular
+            #   worker
             # @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.
@@ -115,14 +131,21 @@ module Twilio
             ##
             # Retrieve a single page of EventInstance records from the API.
             # Request is executed immediately.
-            # @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 [Time] end_date Filter events by an end date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] event_type Filter events by those of a certain event type
+            # @param [String] minutes Filter events by up to ‘x’ minutes in the past. This is
+            #   helpful for events for the last 15 minutes, 240 minutes (4 hours), and 480
+            #   minutes (8 hours) to see trends. Defaults to 15 minutes.
+            # @param [String] reservation_sid Filter events by those pertaining to a
+            #   particular reservation
+            # @param [Time] start_date Filter events by a start date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] task_queue_sid Filter events by those pertaining to a particular
+            #   queue
+            # @param [String] task_sid Filter events by those pertaining to a particular task
+            # @param [String] worker_sid Filter events by those pertaining to a particular
+            #   worker
             # @param [String] workflow_sid The workflow_sid
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
@@ -243,7 +266,7 @@ module Twilio
             # Initialize the EventInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] workspace_sid The sid
+            # @param [String] workspace_sid The unique ID of the Workspace
             # @param [String] sid The sid
             # @return [EventInstance] EventInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
@@ -285,7 +308,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The account owning this event
             def account_sid
               @properties['account_sid']
             end
@@ -309,37 +332,37 @@ module Twilio
             end
 
             ##
-            # @return [String] The description
+            # @return [String] A description of the event
             def description
               @properties['description']
             end
 
             ##
-            # @return [String] The event_data
+            # @return [String] Data about this specific event.
             def event_data
               @properties['event_data']
             end
 
             ##
-            # @return [Time] The event_date
+            # @return [Time] The time this event was sent
             def event_date
               @properties['event_date']
             end
 
             ##
-            # @return [String] The event_type
+            # @return [String] An identifier for this event
             def event_type
               @properties['event_type']
             end
 
             ##
-            # @return [String] The resource_sid
+            # @return [String] The sid of the object this event is most relevant to
             def resource_sid
               @properties['resource_sid']
             end
 
             ##
-            # @return [String] The resource_type
+            # @return [String] The type of object this event is most relevant to
             def resource_type
               @properties['resource_type']
             end