twilio-ruby 5.19.0 → 5.74.2

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -20,30 +20,32 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Alert resource to fetch.
         # @return [Twilio::REST::Monitor::V1::AlertContext] if sid was passed.
         # @return [Twilio::REST::Monitor::V1::AlertList]
         def alerts(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @alerts ||= AlertList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @alerts ||= AlertList.new self
           else
-            AlertContext.new(self, sid)
+              AlertContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid A 34 character string that uniquely identifies this event.
+        # @param [String] sid The SID of the Event resource to fetch.
         # @return [Twilio::REST::Monitor::V1::EventContext] if sid was passed.
         # @return [Twilio::REST::Monitor::V1::EventList]
         def events(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @events ||= EventList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @events ||= EventList.new self
           else
-            EventContext.new(self, sid)
+              EventContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/monitor.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -29,7 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this Alert.
+      # @param [String] sid The unique string that we created to identify the Alert
+      #   resource.
       # @return [Twilio::REST::Monitor::V1::AlertInstance] if sid was passed.
       # @return [Twilio::REST::Monitor::V1::AlertList]
       def alerts(sid=:unset)
@@ -37,7 +38,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this event.
+      # @param [String] sid The unique string that we created to identify the Event
+      #   resource.
       # @return [Twilio::REST::Monitor::V1::EventInstance] if sid was passed.
       # @return [Twilio::REST::Monitor::V1::EventList]
       def events(sid=:unset)

data/lib/twilio-ruby/rest/notify/v1/credential.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -86,11 +86,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             CredentialPage.new(@version, response, @solution)
           end
 
@@ -108,25 +106,27 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CredentialInstance records from the API.
-          # Request is executed immediately.
-          # @param [credential.PushService] type Credential type, one of "gcm", "fcm", or
-          #   "apn"
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
+          # Create the CredentialInstance
+          # @param [credential.PushService] type The Credential type. Can be: `gcm`, `fcm`,
+          #   or `apn`.
+          # @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. Strip everything outside of the headers, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "Server key" of your project from
-          #   Firebase console under Settings / Cloud messaging. Yes, you can use the server
-          #   key from the Firebase console for GCM.
-          # @param [String] secret [FCM only] This is the "Server key" of your project from
+          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END
+          #   CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL-encoded representation of the
+          #   private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
+          #   PRIVATE
+          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----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 `Server key` of your project from
           #   Firebase console under Settings / Cloud messaging.
-          # @return [CredentialInstance] Newly created CredentialInstance
+          # @param [String] secret [FCM only] The `Server key` of your project from Firebase
+          #   console under Settings / Cloud messaging.
+          # @return [CredentialInstance] 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({
                 'Type' => type,
@@ -138,11 +138,7 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, )
           end
@@ -191,7 +187,8 @@ module Twilio
           ##
           # Initialize the CredentialContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Credential resource to fetch.
           # @return [CredentialContext] CredentialContext
           def initialize(version, sid)
             super(version)
@@ -202,36 +199,33 @@ module Twilio
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
+          # @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. Strip everything outside of the headers, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "Server key" of your project from
-          #   Firebase console under Settings / Cloud messaging. Yes, you can use the server
-          #   key from the Firebase console for GCM.
-          # @param [String] secret [FCM only] This is the "Server key" of your project from
+          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END
+          #   CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL-encoded representation of the
+          #   private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
+          #   PRIVATE
+          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----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 `Server key` of your project from
           #   Firebase console under Settings / Cloud messaging.
+          # @param [String] secret [FCM only] The `Server key` of your project from Firebase
+          #   console 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({
@@ -243,20 +237,16 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CredentialInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -265,6 +255,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Notify.V1.CredentialContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Notify.V1.CredentialContext #{context}>"
+          end
         end
 
         ##
@@ -274,7 +271,8 @@ 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 Twilio-provided string that uniquely identifies the
+          #   Credential resource to fetch.
           # @return [CredentialInstance] CredentialInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -308,55 +306,55 @@ module Twilio
           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] Friendly name for stored credential
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [credential.PushService] Credential type, one of "gcm", "fcm", or "apn"
+          # @return [credential.PushService] The Credential type, one of `gcm`, `fcm`, or `apn`
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] [APN only] use this credential for sending to production or sandbox APNs
+          # @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 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 url
+          # @return [String] The absolute URL of the Credential resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
             context.fetch
@@ -364,20 +362,23 @@ module Twilio
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
+          # @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. Strip everything outside of the headers, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "Server key" of your project from
-          #   Firebase console under Settings / Cloud messaging. Yes, you can use the server
-          #   key from the Firebase console for GCM.
-          # @param [String] secret [FCM only] This is the "Server key" of your project from
+          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END
+          #   CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL-encoded representation of the
+          #   private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
+          #   PRIVATE
+          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----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 `Server key` of your project from
           #   Firebase console under Settings / Cloud messaging.
+          # @param [String] secret [FCM only] The `Server key` of your project from Firebase
+          #   console 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(
@@ -391,8 +392,8 @@ module Twilio
           end
 
           ##
-          # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CredentialInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end