twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the ChannelList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel
+            #   resource is associated with.
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -24,17 +28,33 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ChannelInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [channel.ChannelType] type The type
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
-            # @return [ChannelInstance] Newly created ChannelInstance
-            def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
+            # Create the ChannelInstance
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. It can be up to 64 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. It can be used to address the resource in place of the
+            #   Channel resource's `sid` in the URL. This value must be 64 characters or less in
+            #   length and be unique within the Service.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [channel.ChannelType] type The visibility of the channel. Can be:
+            #   `public` or `private` and defaults to `public`.
+            # @param [Time] date_created The date, specified in {ISO
+            #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
+            #   as the date it was created. The default value is the current time set by the
+            #   Chat service.  Note that this should only be used in cases where a Channel is
+            #   being recreated from a backup/separate source.
+            # @param [Time] date_updated The date, specified in {ISO
+            #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
+            #   as the date it was last updated. The default value is `null`. Note that this
+            #   parameter should only be used in cases where a Channel is being recreated from a
+            #   backup/separate source  and where a Message was previously updated.
+            # @param [String] created_by The `identity` of the User that created the channel.
+            #   Default is: `system`.
+            # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [ChannelInstance] Created ChannelInstance
+            def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
                   'UniqueName' => unique_name,
@@ -44,21 +64,19 @@ module Twilio
                   'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                   'CreatedBy' => created_by,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data, headers: headers)
 
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
             # Lists ChannelInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [channel.ChannelType] type The type
+            # @param [Array[channel.ChannelType]] type The visibility of the Channels to read.
+            #   Can be: `public` or `private` and defaults to `public`.
             # @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
@@ -74,7 +92,8 @@ module Twilio
             # Streams ChannelInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [channel.ChannelType] type The type
+            # @param [Array[channel.ChannelType]] type The visibility of the Channels to read.
+            #   Can be: `public` or `private` and defaults to `public`.
             # @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
@@ -85,7 +104,7 @@ module Twilio
             def stream(type: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(type: type, page_size: limits[:page_size])
+              page = self.page(type: type, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -97,7 +116,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -107,7 +126,8 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [channel.ChannelType] type The type
+            # @param [Array[channel.ChannelType]] type The visibility of the Channels to read.
+            #   Can be: `public` or `private` and defaults to `public`.
             # @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
@@ -119,11 +139,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ChannelPage.new(@version, response, @solution)
             end
 
@@ -166,7 +184,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ChannelInstance] ChannelInstance
             def get_instance(payload)
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -180,54 +198,70 @@ module Twilio
             ##
             # Initialize the ChannelContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
+            #   Channel resource from.
+            # @param [String] sid The SID of the Channel resource to fetch. This value can be
+            #   either the `sid` or the `unique_name` of the Channel resource to fetch.
             # @return [ChannelContext] ChannelContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}"
 
               # Dependents
               @members = nil
               @messages = nil
               @invites = nil
+              @webhooks = nil
             end
 
             ##
-            # Fetch a ChannelInstance
+            # Fetch the ChannelInstance
             # @return [ChannelInstance] Fetched ChannelInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the ChannelInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
+            # Delete the ChannelInstance
+            # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete(x_twilio_webhook_enabled: :unset)
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+
+               @version.delete('DELETE', @uri, headers: headers)
             end
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 256 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. It can be used to address the resource in place of the
+            #   resource's `sid` in the URL. This value must be 256 characters or less in length
+            #   and unique within the Service.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [Time] date_created The date, specified in {ISO
+            #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
+            #   as the date it was created. The default value is the current time set by the
+            #   Chat service.  Note that this should only be used in cases where a Channel is
+            #   being recreated from a backup/separate source.
+            # @param [Time] date_updated The date, specified in {ISO
+            #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
+            #   as the date it was last updated.
+            # @param [String] created_by The `identity` of the User that created the channel.
+            #   Default is: `system`.
+            # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [ChannelInstance] Updated ChannelInstance
-            def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
+            def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
                   'UniqueName' => unique_name,
@@ -236,14 +270,11 @@ module Twilio
                   'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                   'CreatedBy' => created_by,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data, headers: headers)
 
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -254,7 +285,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return MemberContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return MemberContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @members
@@ -276,7 +307,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return MessageContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return MessageContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @messages
@@ -298,7 +329,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return InviteContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return InviteContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @invites
@@ -312,12 +343,41 @@ module Twilio
               @invites
             end
 
+            ##
+            # Access the webhooks
+            # @return [WebhookList]
+            # @return [WebhookContext] if sid was passed.
+            def webhooks(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return WebhookContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
+              end
+
+              unless @webhooks
+                @webhooks = WebhookList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    channel_sid: @solution[:sid],
+                )
+              end
+
+              @webhooks
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Chat.V2.ChannelContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V2.ChannelContext #{context}>"
+            end
           end
 
           class ChannelInstance < InstanceResource
@@ -325,8 +385,11 @@ module Twilio
             # Initialize the ChannelInstance
             # @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] sid The sid
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Channel
+            #   resource is associated with.
+            # @param [String] sid The SID of the Channel resource to fetch. This value can be
+            #   either the `sid` or the `unique_name` of the Channel resource to fetch.
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -351,7 +414,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -360,119 +423,135 @@ module Twilio
             # @return [ChannelContext] ChannelContext for this ChannelInstance
             def context
               unless @instance_context
-                @instance_context = ChannelContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = ChannelContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] The JSON string that stores application-specific data
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [channel.ChannelType] The type
+            # @return [channel.ChannelType] The visibility of the channel. Can be: `public` or `private`
             def type
               @properties['type']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The created_by
+            # @return [String] The identity of the User that created the channel
             def created_by
               @properties['created_by']
             end
 
             ##
-            # @return [String] The members_count
+            # @return [String] The number of Members in the Channel
             def members_count
               @properties['members_count']
             end
 
             ##
-            # @return [String] The messages_count
+            # @return [String] The number of Messages that have been passed in the Channel
             def messages_count
               @properties['messages_count']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Channel resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a ChannelInstance
+            # Fetch the ChannelInstance
             # @return [ChannelInstance] Fetched ChannelInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the ChannelInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
+            # Delete the ChannelInstance
+            # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete(x_twilio_webhook_enabled: :unset)
+              context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
             end
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 256 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. It can be used to address the resource in place of the
+            #   resource's `sid` in the URL. This value must be 256 characters or less in length
+            #   and unique within the Service.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [Time] date_created The date, specified in {ISO
+            #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
+            #   as the date it was created. The default value is the current time set by the
+            #   Chat service.  Note that this should only be used in cases where a Channel is
+            #   being recreated from a backup/separate source.
+            # @param [Time] date_updated The date, specified in {ISO
+            #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
+            #   as the date it was last updated.
+            # @param [String] created_by The `identity` of the User that created the channel.
+            #   Default is: `system`.
+            # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [ChannelInstance] Updated ChannelInstance
-            def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
+            def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset)
               context.update(
                   friendly_name: friendly_name,
                   unique_name: unique_name,
@@ -480,6 +559,7 @@ module Twilio
                   date_created: date_created,
                   date_updated: date_updated,
                   created_by: created_by,
+                  x_twilio_webhook_enabled: x_twilio_webhook_enabled,
               )
             end
 
@@ -504,6 +584,13 @@ module Twilio
               context.invites
             end
 
+            ##
+            # Access the webhooks
+            # @return [webhooks] webhooks
+            def webhooks
+              context.webhooks
+            end
+
             ##
             # Provide a user friendly representation
             def to_s