twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/notify/v1/service/binding.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,9 @@ module Twilio
             ##
             # Initialize the BindingList
             # @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/notify/api/service-resource] the resource
+            #   is associated with.
             # @return [BindingList] BindingList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,16 +30,34 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of BindingInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [binding.BindingType] binding_type The binding_type
-            # @param [String] address The address
-            # @param [String] tag The tag
-            # @param [String] notification_protocol_version The notification_protocol_version
-            # @param [String] credential_sid The credential_sid
-            # @param [String] endpoint The endpoint
-            # @return [BindingInstance] Newly created BindingInstance
+            # Create the BindingInstance
+            # @param [String] identity The `identity` value that uniquely identifies the new
+            #   resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within
+            #   the {Service}[https://www.twilio.com/docs/notify/api/service-resource]. Up to 20
+            #   Bindings can be created for the same Identity in a given Service.
+            # @param [binding.BindingType] binding_type The transport technology to use for
+            #   the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.
+            # @param [String] address The channel-specific address. For APNS, the device
+            #   token. For FCM and GCM, the registration token. For SMS, a phone number in E.164
+            #   format. For Facebook Messenger, the Messenger ID of the user or a phone number
+            #   in E.164 format.
+            # @param [Array[String]] tag A tag that can be used to select the Bindings to
+            #   notify. Repeat this parameter to specify more than one tag, up to a total of 20
+            #   tags.
+            # @param [String] notification_protocol_version The protocol version to use to
+            #   send the notification. This defaults to the value of
+            #   `default_xxxx_notification_protocol_version` for the protocol in the
+            #   {Service}[https://www.twilio.com/docs/notify/api/service-resource]. The current
+            #   version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not
+            #   applicable to `sms` and `facebook-messenger` type Bindings as the data format is
+            #   fixed.
+            # @param [String] credential_sid The SID of the
+            #   {Credential}[https://www.twilio.com/docs/notify/api/credential-resource]
+            #   resource to be used to send notifications to this Binding. If present, this
+            #   overrides the Credential specified in the Service resource. Applies to only
+            #   `apn`, `fcm`, and `gcm` type Bindings.
+            # @param [String] endpoint Deprecated.
+            # @return [BindingInstance] Created BindingInstance
             def create(identity: nil, binding_type: nil, address: nil, tag: :unset, notification_protocol_version: :unset, credential_sid: :unset, endpoint: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
@@ -47,23 +69,25 @@ module Twilio
                   'Endpoint' => endpoint,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
             # 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 [Date] start_date The start_date
-            # @param [Date] end_date The end_date
-            # @param [String] identity The identity
-            # @param [String] tag The tag
+            # @param [Date] start_date Only include usage that has occurred on or after this
+            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Date] end_date Only include usage that occurred on or before this date.
+            #   Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Array[String]] identity The
+            #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
+            #   of the resources to read.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -86,10 +110,16 @@ 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 [Date] start_date The start_date
-            # @param [Date] end_date The end_date
-            # @param [String] identity The identity
-            # @param [String] tag The tag
+            # @param [Date] start_date Only include usage that has occurred on or after this
+            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Date] end_date Only include usage that occurred on or before this date.
+            #   Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Array[String]] identity The
+            #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
+            #   of the resources to read.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -118,7 +148,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],
@@ -128,10 +158,16 @@ module Twilio
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [Date] start_date The start_date
-            # @param [Date] end_date The end_date
-            # @param [String] identity The identity
-            # @param [String] tag The tag
+            # @param [Date] start_date Only include usage that has occurred on or after this
+            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Date] end_date Only include usage that occurred on or before this date.
+            #   Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Array[String]] identity The
+            #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
+            #   of the resources to read.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -146,11 +182,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
 
@@ -195,7 +229,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [BindingInstance] BindingInstance
             def get_instance(payload)
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -211,37 +245,34 @@ module Twilio
             ##
             # Initialize the BindingContext
             # @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/notify/api/service-resource] to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Binding resource to fetch.
             # @return [BindingContext] BindingContext
             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]}/Bindings/#{@solution[:sid]}"
             end
 
             ##
-            # Fetch a BindingInstance
+            # Fetch the BindingInstance
             # @return [BindingInstance] Fetched BindingInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
-
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              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
 
             ##
@@ -250,6 +281,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Notify.V1.BindingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Notify.V1.BindingContext #{context}>"
+            end
           end
 
           ##
@@ -259,8 +297,11 @@ 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 service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/notify/api/service-resource] the resource
+            #   is associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Binding resource to fetch.
             # @return [BindingInstance] BindingInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -285,7 +326,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
 
             ##
@@ -294,105 +335,105 @@ module Twilio
             # @return [BindingContext] BindingContext for this BindingInstance
             def context
               unless @instance_context
-                @instance_context = BindingContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = BindingContext.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 credential_sid
+            # @return [String] The SID of the Credential resource to be used to send notifications to this Binding
             def credential_sid
               @properties['credential_sid']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 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 RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The notification_protocol_version
+            # @return [String] The protocol version to use to send the notification
             def notification_protocol_version
               @properties['notification_protocol_version']
             end
 
             ##
-            # @return [String] The endpoint
+            # @return [String] Deprecated
             def endpoint
               @properties['endpoint']
             end
 
             ##
-            # @return [String] The identity
+            # @return [String] The `identity` value that identifies the new resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [String] The binding_type
+            # @return [String] The type of the Binding
             def binding_type
               @properties['binding_type']
             end
 
             ##
-            # @return [String] The address
+            # @return [String] The channel-specific address
             def address
               @properties['address']
             end
 
             ##
-            # @return [String] The tags
+            # @return [Array[String]] The list of tags associated with this Binding
             def tags
               @properties['tags']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Binding resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             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