twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -18,7 +20,8 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The Twilio-provided string that uniquely identifies the
+        #   Credential resource to fetch.
         # @return [Twilio::REST::Chat::V1::CredentialContext] if sid was passed.
         # @return [Twilio::REST::Chat::V1::CredentialList]
         def credentials(sid=:unset)
@@ -32,7 +35,8 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The Twilio-provided string that uniquely identifies the
+        #   Service resource to fetch.
         # @return [Twilio::REST::Chat::V1::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Chat::V1::ServiceList]
         def services(sid=:unset)

data/lib/twilio-ruby/rest/chat/v2/credential.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -50,7 +52,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -62,7 +64,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],
@@ -106,13 +108,26 @@ module Twilio
           ##
           # Retrieve a single page of CredentialInstance records from the API.
           # Request is executed immediately.
-          # @param [credential.PushService] type The type
-          # @param [String] friendly_name The friendly_name
-          # @param [String] certificate The certificate
-          # @param [String] private_key The private_key
-          # @param [Boolean] sandbox The sandbox
-          # @param [String] api_key The api_key
-          # @param [String] secret The secret
+          # @param [credential.PushService] type The type of push-notification service the
+          #   credential is for. Can be: `gcm`, `fcm`, or `apn`.
+          # @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] certificate [APN only] The URL encoded representation of the
+          #   certificate. For example,
+          #   `-----BEGIN CERTIFICATE-----
+          #   MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...
+          #   -----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The API key for the project that was obtained
+          #   from the Google Developer console for your GCM Service application credential.
+          # @param [String] secret [FCM only] The **Server key** of your project from the
+          #   Firebase console, found under Settings / Cloud messaging.
           # @return [CredentialInstance] Newly created CredentialInstance
           def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             data = Twilio::Values.of({
@@ -131,7 +146,7 @@ module Twilio
                 data: data
             )
 
-            CredentialInstance.new(@version, payload)
+            CredentialInstance.new(@version, payload, )
           end
 
           ##
@@ -160,7 +175,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [CredentialInstance] CredentialInstance
           def get_instance(payload)
-            CredentialInstance.new(@version, payload)
+            CredentialInstance.new(@version, payload, )
           end
 
           ##
@@ -174,13 +189,13 @@ module Twilio
           ##
           # Initialize the CredentialContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Credential resource to fetch.
           # @return [CredentialContext] CredentialContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Credentials/#{@solution[:sid]}"
           end
 
@@ -196,17 +211,29 @@ module Twilio
                 params,
             )
 
-            CredentialInstance.new(@version, payload, sid: @solution[:sid])
+            CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name The friendly_name
-          # @param [String] certificate The certificate
-          # @param [String] private_key The private_key
-          # @param [Boolean] sandbox The sandbox
-          # @param [String] api_key The api_key
-          # @param [String] secret The secret
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL encoded representation of the
+          #   certificate. For example,
+          #   `-----BEGIN CERTIFICATE-----
+          #   MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...
+          #   -----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The API key for the project that was obtained
+          #   from the Google Developer console for your GCM Service application credential.
+          # @param [String] secret [FCM only] The **Server key** of your project from the
+          #   Firebase console, found under Settings / Cloud messaging.
           # @return [CredentialInstance] Updated CredentialInstance
           def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             data = Twilio::Values.of({
@@ -224,12 +251,12 @@ module Twilio
                 data: data,
             )
 
-            CredentialInstance.new(@version, payload, sid: @solution[:sid])
+            CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -240,6 +267,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Chat.V2.CredentialContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Chat.V2.CredentialContext #{context}>"
+          end
         end
 
         class CredentialInstance < InstanceResource
@@ -247,7 +281,7 @@ module Twilio
           # Initialize the CredentialInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Credential resource to fetch.
           # @return [CredentialInstance] CredentialInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -266,7 +300,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -275,55 +309,55 @@ module Twilio
           # @return [CredentialContext] CredentialContext for this CredentialInstance
           def context
             unless @instance_context
-              @instance_context = CredentialContext.new(@version, @params['sid'])
+              @instance_context = CredentialContext.new(@version, @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 friendly_name
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [credential.PushService] The type
+          # @return [credential.PushService] The type of push-notification service the credential is for
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] The sandbox
+          # @return [String] [APN only] Whether to send the credential to sandbox APNs
           def sandbox
             @properties['sandbox']
           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 url
+          # @return [String] The absolute URL of the Credential resource
           def url
             @properties['url']
           end
@@ -337,12 +371,24 @@ module Twilio
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name The friendly_name
-          # @param [String] certificate The certificate
-          # @param [String] private_key The private_key
-          # @param [Boolean] sandbox The sandbox
-          # @param [String] api_key The api_key
-          # @param [String] secret The secret
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL encoded representation of the
+          #   certificate. For example,
+          #   `-----BEGIN CERTIFICATE-----
+          #   MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...
+          #   -----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The API key for the project that was obtained
+          #   from the Google Developer console for your GCM Service application credential.
+          # @param [String] secret [FCM only] The **Server key** of your project from the
+          #   Firebase console, found under Settings / Cloud messaging.
           # @return [CredentialInstance] Updated CredentialInstance
           def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             context.update(
@@ -357,7 +403,7 @@ module Twilio
 
           ##
           # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,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/chat/rest/service-resource) the Binding
+            #   resource is associated with.
             # @return [BindingList] BindingList
             def initialize(version, service_sid: nil)
               super(version)
@@ -27,8 +31,15 @@ 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 binding_type
-            # @param [String] identity The identity
+            # @param [binding.BindingType] binding_type The push technology used by the
+            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
+            #   notification
+            #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
+            #   for more info.
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
+            #   of the resources to read. See [access
+            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
             # @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
@@ -37,15 +48,27 @@ module Twilio
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Array] Array of up to limit results
             def list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
-              self.stream(binding_type: binding_type, identity: identity, limit: limit, page_size: page_size).entries
+              self.stream(
+                  binding_type: binding_type,
+                  identity: identity,
+                  limit: limit,
+                  page_size: page_size
+              ).entries
             end
 
             ##
             # 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 binding_type
-            # @param [String] identity The identity
+            # @param [binding.BindingType] binding_type The push technology used by the
+            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
+            #   notification
+            #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
+            #   for more info.
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
+            #   of the resources to read. See [access
+            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
             # @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
@@ -56,7 +79,7 @@ module Twilio
             def stream(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(binding_type: binding_type, identity: identity, page_size: limits[:page_size])
+              page = self.page(binding_type: binding_type, identity: identity, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -68,7 +91,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],
@@ -78,8 +101,15 @@ module Twilio
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [binding.BindingType] binding_type The binding_type
-            # @param [String] identity The identity
+            # @param [binding.BindingType] binding_type The push technology used by the
+            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
+            #   notification
+            #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
+            #   for more info.
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
+            #   of the resources to read. See [access
+            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
             # @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,7 +169,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
 
             ##
@@ -153,14 +183,16 @@ 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/chat/rest/service-resource) to fetch the
+            #   Binding resource from.
+            # @param [String] sid The SID of 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
 
@@ -176,12 +208,12 @@ module Twilio
                   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
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -192,6 +224,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Chat.V2.BindingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V2.BindingContext #{context}>"
+            end
           end
 
           class BindingInstance < InstanceResource
@@ -199,8 +238,10 @@ 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/chat/rest/service-resource) the Binding
+            #   resource is associated with.
+            # @param [String] sid The SID of the Binding resource to fetch.
             # @return [BindingInstance] BindingInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -223,7 +264,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
 
             ##
@@ -232,79 +273,79 @@ 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 Binding resource is associated with
             def service_sid
               @properties['service_sid']
             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 endpoint
+            # @return [String] The unique endpoint identifier for the Binding
             def endpoint
               @properties['endpoint']
             end
 
             ##
-            # @return [String] The identity
+            # @return [String] The string that identifies the resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [String] The credential_sid
+            # @return [String] The SID of the Credential for the binding
             def credential_sid
               @properties['credential_sid']
             end
 
             ##
-            # @return [binding.BindingType] The binding_type
+            # @return [binding.BindingType] The push technology to use for the binding
             def binding_type
               @properties['binding_type']
             end
 
             ##
-            # @return [String] The message_types
+            # @return [String] The Programmable Chat message types the binding is subscribed to
             def message_types
               @properties['message_types']
             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 absolute URLs of the Binding's User
             def links
               @properties['links']
             end
@@ -318,7 +359,7 @@ module Twilio
 
             ##
             # Deletes the BindingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end