twilio-ruby 5.20.0 → 5.47.0

data/lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,7 @@ module Twilio
             ##
             # Initialize the BindingList
             # @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/services) this binding
-            #   belongs to.
+            # @param [String] service_sid The service_sid
             # @return [BindingList] BindingList
             def initialize(version, service_sid: nil)
               super(version)
@@ -31,12 +29,8 @@ module Twilio
             # Lists BindingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [binding.BindingType] binding_type The push technology used for the
-            #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-            #   notification
-            #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-            #   for more information.
-            # @param [String] identity The identity
+            # @param [Array[binding.BindingType]] binding_type The binding_type
+            # @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
@@ -57,12 +51,8 @@ module Twilio
             # Streams BindingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [binding.BindingType] binding_type The push technology used for the
-            #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-            #   notification
-            #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-            #   for more information.
-            # @param [String] identity The identity
+            # @param [Array[binding.BindingType]] binding_type The binding_type
+            # @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
@@ -95,12 +85,8 @@ module Twilio
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [binding.BindingType] binding_type The push technology used for the
-            #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-            #   notification
-            #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-            #   for more information.
-            # @param [String] identity The identity
+            # @param [Array[binding.BindingType]] binding_type The binding_type
+            # @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
@@ -113,11 +99,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               BindingPage.new(@version, response, @solution)
             end
 
@@ -186,25 +170,19 @@ module Twilio
             end
 
             ##
-            # Fetch a BindingInstance
+            # Fetch the BindingInstance
             # @return [BindingInstance] Fetched BindingInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the BindingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the BindingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -213,6 +191,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.IpMessaging.V2.BindingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.IpMessaging.V2.BindingContext #{context}>"
+            end
           end
 
           class BindingInstance < InstanceResource
@@ -220,9 +205,7 @@ module Twilio
             # Initialize the BindingInstance
             # @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/services) this binding
-            #   belongs to.
+            # @param [String] service_sid The service_sid
             # @param [String] sid The sid
             # @return [BindingInstance] BindingInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -261,87 +244,87 @@ 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 responsible for this binding.
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Service this binding belongs to.
+            # @return [String] The service_sid
             def service_sid
               @properties['service_sid']
             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 unique endpoint identifier for this Binding.
+            # @return [String] The endpoint
             def endpoint
               @properties['endpoint']
             end
 
             ##
-            # @return [String] A unique string identifier for the Binding for this User in this Service.
+            # @return [String] The identity
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [String] The unique id of the Credential for this binding.
+            # @return [String] The credential_sid
             def credential_sid
               @properties['credential_sid']
             end
 
             ##
-            # @return [binding.BindingType] The push technology to use for this binding.
+            # @return [binding.BindingType] The binding_type
             def binding_type
               @properties['binding_type']
             end
 
             ##
-            # @return [String] List of message types for this binding.
+            # @return [Array[String]] The message_types
             def message_types
               @properties['message_types']
             end
 
             ##
-            # @return [String] An absolute URL for this binding.
+            # @return [String] The url
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Absolute URLs to access the Users for this Binding.
+            # @return [String] The links
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a BindingInstance
+            # Fetch the BindingInstance
             # @return [BindingInstance] Fetched BindingInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the BindingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the BindingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +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](https://www.twilio.com/docs/chat/api/services) this channel belongs
-            #   to.
+            # @param [String] service_sid The service_sid
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,30 +26,18 @@ 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 string metadata field you can use to
-            #   store any data you wish. The string value must contain structurally valid JSON
-            #   if specified.  **Note** that if the attributes are not set "{}" will be
-            #   returned.
-            # @param [channel.ChannelType] type The visibility of the channel - `public` or
-            #   `private`. Defaults to `public`.
-            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
-            #   Channel should be set as being created.  Will be set to the current time by the
-            #   Chat service if not specified.  Note that this should only be used in cases
-            #   where a a Channel is being recreated from a backup/separate source
-            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
-            #   Channel should be set as having been last updated.  Will be set to the `null` by
-            #   the Chat service if not specified.  Note that this 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 Optional field to specify the Identity of the User
-            #   that created the Channel.  Will be set to "system" if not specified.
-            # @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 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
+            # @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,
@@ -61,12 +47,9 @@ 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], )
             end
@@ -75,8 +58,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 visibility of the channel - `public` or
-            #   `private`. Defaults to `public`.
+            # @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
@@ -92,8 +74,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 visibility of the channel - `public` or
-            #   `private`. Defaults to `public`.
+            # @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
@@ -126,8 +107,7 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [channel.ChannelType] type The visibility of the channel - `public` or
-            #   `private`. Defaults to `public`.
+            # @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
@@ -139,11 +119,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
 
@@ -200,11 +178,8 @@ module Twilio
             ##
             # Initialize the ChannelContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid Sid of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) channel belongs
-            #   to.
-            # @param [String] sid Key that uniquely defines the channel to fetch. Could be Sid
-            #   or UniqueName.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [ChannelContext] ChannelContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -221,44 +196,37 @@ 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
-            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 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 string metadata field you can use to
-            #   store any data you wish. The string value must contain structurally valid JSON
-            #   if specified.  **Note** that if the attributes are not set "{}" will be
-            #   returned.
-            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
-            #   Channel should be set as being created.
-            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
-            #   Channel should be set as having been last updated.
-            # @param [String] created_by Optional field to specify the Identity of the User
-            #   that created the Channel.
+            # @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 [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,
@@ -267,12 +235,9 @@ 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], )
             end
@@ -371,6 +336,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.IpMessaging.V2.ChannelContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.IpMessaging.V2.ChannelContext #{context}>"
+            end
           end
 
           class ChannelInstance < InstanceResource
@@ -378,11 +350,8 @@ 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](https://www.twilio.com/docs/chat/api/services) this channel belongs
-            #   to.
-            # @param [String] sid Key that uniquely defines the channel to fetch. Could be Sid
-            #   or UniqueName.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -422,120 +391,117 @@ 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 responsible for this channel.
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the 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
 
             ##
-            # @return [String] The number of Members in the Channel
+            # @return [String] The members_count
             def members_count
               @properties['members_count']
             end
 
             ##
-            # @return [String] The number of Messages in the Channel
+            # @return [String] The messages_count
             def messages_count
               @properties['messages_count']
             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, Messages , Invites and, if it exists the last Message 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
-            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 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 string metadata field you can use to
-            #   store any data you wish. The string value must contain structurally valid JSON
-            #   if specified.  **Note** that if the attributes are not set "{}" will be
-            #   returned.
-            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
-            #   Channel should be set as being created.
-            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
-            #   Channel should be set as having been last updated.
-            # @param [String] created_by Optional field to specify the Identity of the User
-            #   that created the Channel.
+            # @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 [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,
@@ -543,6 +509,7 @@ module Twilio
                   date_created: date_created,
                   date_updated: date_updated,
                   created_by: created_by,
+                  x_twilio_webhook_enabled: x_twilio_webhook_enabled,
               )
             end