twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,8 +15,7 @@ module Twilio
             ##
             # Initialize the ChannelList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique id of the [Service][service] this channel
-            #   belongs to.
+            # @param [String] service_sid The service_sid
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -27,16 +26,12 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ChannelInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name A human-readable name for the Channel. Optional.
-            # @param [String] unique_name A unique, addressable name for the Channel. 
-            #   Optional.
-            # @param [String] attributes An optional metadata field you can use to store any
-            #   data you wish. No processing or validation is done on this field.
-            # @param [channel.ChannelType] type The visibility of the channel - `public` or
-            #   `private`. Defaults to `public`.
-            # @return [ChannelInstance] Newly created ChannelInstance
+            # Create the ChannelInstance
+            # @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
+            # @return [ChannelInstance] Created ChannelInstance
             def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
@@ -45,11 +40,7 @@ module Twilio
                   'Type' => type,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -58,7 +49,7 @@ module Twilio
             # 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 type
             # @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 +65,7 @@ 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 type
             # @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
@@ -107,7 +98,7 @@ 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 type
             # @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 +110,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
 
@@ -197,34 +186,26 @@ module Twilio
             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], )
             end
 
             ##
-            # Deletes the ChannelInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ChannelInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name A human-readable name for the Channel. Optional.
-            # @param [String] unique_name A unique, addressable name for the Channel. 
-            #   Optional.
-            # @param [String] attributes An optional metadata field you can use to store any
-            #   data you wish. No processing or validation is done on this field.
+            # @param [String] friendly_name The friendly_name
+            # @param [String] unique_name The unique_name
+            # @param [String] attributes The attributes
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
               data = Twilio::Values.of({
@@ -233,11 +214,7 @@ module Twilio
                   'Attributes' => attributes,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -314,6 +291,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.IpMessaging.V1.ChannelContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.IpMessaging.V1.ChannelContext #{context}>"
+            end
           end
 
           class ChannelInstance < InstanceResource
@@ -321,8 +305,7 @@ 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 unique id of the [Service][service] this channel
-            #   belongs to.
+            # @param [String] service_sid The service_sid
             # @param [String] sid The sid
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -363,61 +346,61 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique id of the [Account][/console] responsible for this channel.
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the [Service][service] this channel belongs to.
+            # @return [String] The service_sid
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The human-readable name of this channel.
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique, addressable name of this channel.
+            # @return [String] The unique_name
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] An optional string metadata field you can use to store any data you wish.
+            # @return [String] The attributes
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [channel.ChannelType] The visibility of this channel - either public or private
+            # @return [channel.ChannelType] The type
             def type
               @properties['type']
             end
 
             ##
-            # @return [Time] The date that this resource was created.
+            # @return [Time] The date_created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date that this resource was last updated.
+            # @return [Time] The date_updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] Identity of the channel's creator.
+            # @return [String] The created_by
             def created_by
               @properties['created_by']
             end
@@ -435,38 +418,36 @@ module Twilio
             end
 
             ##
-            # @return [String] An absolute URL for this channel.
+            # @return [String] The url
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Absolute URLs to access the [Members][members] and [Messages][messages] for this channel.
+            # @return [String] The links
             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
+            # Delete the ChannelInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name A human-readable name for the Channel. Optional.
-            # @param [String] unique_name A unique, addressable name for the Channel. 
-            #   Optional.
-            # @param [String] attributes An optional metadata field you can use to store any
-            #   data you wish. No processing or validation is done on this field.
+            # @param [String] friendly_name The friendly_name
+            # @param [String] unique_name The unique_name
+            # @param [String] attributes The attributes
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
               context.update(friendly_name: friendly_name, unique_name: unique_name, attributes: attributes, )

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,11 +16,8 @@ module Twilio
               ##
               # Initialize the InviteList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service) this member
-              #   belongs to.
-              # @param [String] channel_sid The unique id of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channel) for this member.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
               # @return [InviteList] InviteList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -31,24 +28,14 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of InviteInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] identity A unique string identifier for this
-              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
-              # @param [String] role_sid The
-              #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/role) assigned to this
-              #   member.
-              # @return [InviteInstance] Newly created InviteInstance
+              # Create the InviteInstance
+              # @param [String] identity The identity
+              # @param [String] role_sid The role_sid
+              # @return [InviteInstance] Created InviteInstance
               def create(identity: nil, role_sid: :unset)
                 data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 InviteInstance.new(
                     @version,
@@ -62,10 +49,7 @@ module Twilio
               # Lists InviteInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] identity A unique string identifier for this
-              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
+              # @param [Array[String]] identity The identity
               # @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
@@ -81,10 +65,7 @@ module Twilio
               # Streams InviteInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] identity A unique string identifier for this
-              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
+              # @param [Array[String]] identity The identity
               # @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
@@ -117,10 +98,7 @@ module Twilio
               ##
               # Retrieve a single page of InviteInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity A unique string identifier for this
-              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user) in this
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See the [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
+              # @param [Array[String]] identity The identity
               # @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
@@ -132,11 +110,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 InvitePage.new(@version, response, @solution)
               end
 
@@ -211,16 +187,10 @@ module Twilio
               end
 
               ##
-              # Fetch a InviteInstance
+              # Fetch the InviteInstance
               # @return [InviteInstance] Fetched InviteInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 InviteInstance.new(
                     @version,
@@ -232,10 +202,10 @@ module Twilio
               end
 
               ##
-              # Deletes the InviteInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the InviteInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -244,6 +214,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.IpMessaging.V1.InviteContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.IpMessaging.V1.InviteContext #{context}>"
+              end
             end
 
             class InviteInstance < InstanceResource
@@ -251,11 +228,8 @@ module Twilio
               # Initialize the InviteInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service) this member
-              #   belongs to.
-              # @param [String] channel_sid The unique id of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channel) for this member.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
               # @param [String] sid The sid
               # @return [InviteInstance] InviteInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
@@ -301,49 +275,49 @@ module Twilio
               end
 
               ##
-              # @return [String] A 34 character string that uniquely identifies this resource.
+              # @return [String] The sid
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The unique id of the Account[/console] responsible for this member.
+              # @return [String] The account_sid
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique id of the Channel for this member.
+              # @return [String] The channel_sid
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The unique id of the Service this member belongs to.
+              # @return [String] The service_sid
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] A unique string identifier for this User in this Service.
+              # @return [String] The identity
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [Time] The date that this resource was created.
+              # @return [Time] The date_created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date that this resource was last updated.
+              # @return [Time] The date_updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The Role assigned to this member.
+              # @return [String] The role_sid
               def role_sid
                 @properties['role_sid']
               end
@@ -355,21 +329,21 @@ module Twilio
               end
 
               ##
-              # @return [String] An absolute URL for this member.
+              # @return [String] The url
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a InviteInstance
+              # Fetch the InviteInstance
               # @return [InviteInstance] Fetched InviteInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the InviteInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the InviteInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end