twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/rest/chat/v1/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+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.
+          #   -----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,14 @@ 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)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Credentials/#{@solution[:sid]}"
           end
 
@@ -196,17 +212,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+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.
+          #   -----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 +252,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 +268,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Chat.V1.CredentialContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Chat.V1.CredentialContext #{context}>"
+          end
         end
 
         class CredentialInstance < InstanceResource
@@ -247,7 +282,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)
@@ -266,7 +302,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -275,55 +311,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 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
@@ -337,12 +373,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+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.
+          #   -----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 +405,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/v1/service/channel/invite.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,12 @@ module Twilio
               ##
               # Initialize the InviteList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource
+              #   belongs to.
               # @return [InviteList] InviteList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -28,11 +34,17 @@ module Twilio
               ##
               # Retrieve a single page of InviteInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The identity
-              # @param [String] role_sid The role_sid
+              # @param [String] identity The `identity` value that uniquely identifies the new
+              #   resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more
+              #   info.
+              # @param [String] role_sid The SID of the
+              #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new
+              #   member.
               # @return [InviteInstance] Newly created InviteInstance
               def create(identity: nil, role_sid: :unset)
-                data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid})
+                data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
 
                 payload = @version.create(
                     'POST',
@@ -52,7 +64,11 @@ 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 The identity
+              # @param [String] identity The
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of
+              #   the resources to read. See [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/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
@@ -68,7 +84,11 @@ 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 The identity
+              # @param [String] identity The
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of
+              #   the resources to read. See [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/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
@@ -79,7 +99,7 @@ module Twilio
               def stream(identity: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(identity: identity, page_size: limits[:page_size])
+                page = self.page(identity: identity, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -91,7 +111,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],
@@ -101,7 +121,11 @@ module Twilio
               ##
               # Retrieve a single page of InviteInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The identity
+              # @param [String] identity The
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of
+              #   the resources to read. See [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/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
@@ -179,15 +203,20 @@ module Twilio
               ##
               # Initialize the InviteContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+              #   resource from.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to
+              #   fetch belongs to.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Invite resource to fetch.
               # @return [InviteContext] InviteContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid}
+                @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Invites/#{@solution[:sid]}"
               end
 
@@ -214,7 +243,7 @@ module Twilio
 
               ##
               # Deletes the InviteInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -225,6 +254,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V1.InviteContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V1.InviteContext #{context}>"
+              end
             end
 
             class InviteInstance < InstanceResource
@@ -232,9 +268,14 @@ 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 service_sid
-              # @param [String] channel_sid The channel_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource
+              #   belongs to.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Invite resource to fetch.
               # @return [InviteInstance] InviteInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -279,61 +320,61 @@ 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] The channel_sid
+              # @return [String] The SID of the Channel the new resource belongs to
               def channel_sid
                 @properties['channel_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 identity
+              # @return [String] The string that identifies the resource's User
               def identity
                 @properties['identity']
               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 role_sid
+              # @return [String] The SID of the Role assigned to the member
               def role_sid
                 @properties['role_sid']
               end
 
               ##
-              # @return [String] The created_by
+              # @return [String] The identity of the User that created the invite
               def created_by
                 @properties['created_by']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Invite resource
               def url
                 @properties['url']
               end
@@ -347,7 +388,7 @@ module Twilio
 
               ##
               # Deletes the InviteInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end