twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the ConnectAppList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account that created this
-            #   ConnectApp.
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+            #   ConnectApp resource.
             # @return [ConnectAppList] ConnectAppList
             def initialize(version, account_sid: nil)
               super(version)
@@ -53,7 +56,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
@@ -65,7 +68,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],
@@ -132,7 +135,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ConnectAppInstance] ConnectAppInstance
             def get_instance(payload)
-              ConnectAppInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              ConnectAppInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -146,14 +149,17 @@ module Twilio
             ##
             # Initialize the ConnectAppContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The connect-app Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+            #   ConnectApp resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ConnectApp resource to fetch.
             # @return [ConnectAppContext] ConnectAppContext
             def initialize(version, account_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {account_sid: account_sid, sid: sid}
+              @solution = {account_sid: account_sid, sid: sid, }
               @uri = "/Accounts/#{@solution[:account_sid]}/ConnectApps/#{@solution[:sid]}.json"
             end
 
@@ -169,26 +175,31 @@ module Twilio
                   params,
               )
 
-              ConnectAppInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              ConnectAppInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Update the ConnectAppInstance
-            # @param [String] authorize_redirect_url The URL the user's browser will redirect
-            #   to after Twilio authenticates the user and obtains authorization for this
-            #   Connect App.
-            # @param [String] company_name The company name set for this Connect App.
-            # @param [String] deauthorize_callback_method The HTTP method to be used when
-            #   making a request to the `DeauthorizeCallbackUrl`.
-            # @param [String] deauthorize_callback_url The URL to which Twilio will send a
-            #   request when a user de-authorizes this Connect App.
-            # @param [String] description A more detailed human readable description of the
-            #   Connect App.
-            # @param [String] friendly_name A human readable name for the Connect App.
-            # @param [String] homepage_url The public URL where users can obtain more
+            # @param [String] authorize_redirect_url The URL to redirect the user to after we
+            #   authenticate the user and obtain authorization to access the Connect App.
+            # @param [String] company_name The company name to set for the Connect App.
+            # @param [String] deauthorize_callback_method The HTTP method to use when calling
+            #   `deauthorize_callback_url`.
+            # @param [String] deauthorize_callback_url The URL to call using the
+            #   `deauthorize_callback_method` to de-authorize the Connect App.
+            # @param [String] description A description of the Connect App.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] homepage_url A public URL where users can obtain more
             #   information about this Connect App.
-            # @param [connect_app.Permission] permissions The set of permissions that your
-            #   ConnectApp requests.
+            # @param [connect_app.Permission] permissions A comma-separated list of the
+            #   permissions you will request from the users of this ConnectApp.  Can include:
+            #   `get-all` and `post-all`.
             # @return [ConnectAppInstance] Updated ConnectAppInstance
             def update(authorize_redirect_url: :unset, company_name: :unset, deauthorize_callback_method: :unset, deauthorize_callback_url: :unset, description: :unset, friendly_name: :unset, homepage_url: :unset, permissions: :unset)
               data = Twilio::Values.of({
@@ -208,7 +219,19 @@ module Twilio
                   data: data,
               )
 
-              ConnectAppInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              ConnectAppInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Deletes the ConnectAppInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              @version.delete('delete', @uri)
             end
 
             ##
@@ -217,6 +240,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.ConnectAppContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.ConnectAppContext #{context}>"
+            end
           end
 
           class ConnectAppInstance < InstanceResource
@@ -224,9 +254,11 @@ module Twilio
             # Initialize the ConnectAppInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] account_sid The unique id of the Account that created this
-            #   ConnectApp.
-            # @param [String] sid The connect-app Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+            #   ConnectApp resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ConnectApp resource to fetch.
             # @return [ConnectAppInstance] ConnectAppInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -248,7 +280,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -257,49 +289,49 @@ module Twilio
             # @return [ConnectAppContext] ConnectAppContext for this ConnectAppInstance
             def context
               unless @instance_context
-                @instance_context = ConnectAppContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = ConnectAppContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The unique sid that identifies this account
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] URIL Twilio sends requests when users authorize
+            # @return [String] The URL to redirect the user to after authorization
             def authorize_redirect_url
               @properties['authorize_redirect_url']
             end
 
             ##
-            # @return [String] The company name set for this Connect App.
+            # @return [String] The company name set for the Connect App
             def company_name
               @properties['company_name']
             end
 
             ##
-            # @return [String] HTTP method Twilio WIll use making requests to the url
+            # @return [String] The HTTP method we use to call deauthorize_callback_url
             def deauthorize_callback_method
               @properties['deauthorize_callback_method']
             end
 
             ##
-            # @return [String] URL Twilio will send a request when a user de-authorizes this app
+            # @return [String] The URL we call to de-authorize the Connect App
             def deauthorize_callback_url
               @properties['deauthorize_callback_url']
             end
 
             ##
-            # @return [String] A more detailed human readable description
+            # @return [String] The description of the Connect App
             def description
               @properties['description']
             end
 
             ##
-            # @return [String] A human readable name for the Connect App.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
@@ -311,19 +343,19 @@ module Twilio
             end
 
             ##
-            # @return [connect_app.Permission] The set of permissions that your ConnectApp requests.
+            # @return [connect_app.Permission] The set of permissions that your ConnectApp requests
             def permissions
               @properties['permissions']
             end
 
             ##
-            # @return [String] A string that uniquely identifies this connect-apps
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The URI for this resource
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
@@ -337,21 +369,21 @@ module Twilio
 
             ##
             # Update the ConnectAppInstance
-            # @param [String] authorize_redirect_url The URL the user's browser will redirect
-            #   to after Twilio authenticates the user and obtains authorization for this
-            #   Connect App.
-            # @param [String] company_name The company name set for this Connect App.
-            # @param [String] deauthorize_callback_method The HTTP method to be used when
-            #   making a request to the `DeauthorizeCallbackUrl`.
-            # @param [String] deauthorize_callback_url The URL to which Twilio will send a
-            #   request when a user de-authorizes this Connect App.
-            # @param [String] description A more detailed human readable description of the
-            #   Connect App.
-            # @param [String] friendly_name A human readable name for the Connect App.
-            # @param [String] homepage_url The public URL where users can obtain more
+            # @param [String] authorize_redirect_url The URL to redirect the user to after we
+            #   authenticate the user and obtain authorization to access the Connect App.
+            # @param [String] company_name The company name to set for the Connect App.
+            # @param [String] deauthorize_callback_method The HTTP method to use when calling
+            #   `deauthorize_callback_url`.
+            # @param [String] deauthorize_callback_url The URL to call using the
+            #   `deauthorize_callback_method` to de-authorize the Connect App.
+            # @param [String] description A description of the Connect App.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] homepage_url A public URL where users can obtain more
             #   information about this Connect App.
-            # @param [connect_app.Permission] permissions The set of permissions that your
-            #   ConnectApp requests.
+            # @param [connect_app.Permission] permissions A comma-separated list of the
+            #   permissions you will request from the users of this ConnectApp.  Can include:
+            #   `get-all` and `post-all`.
             # @return [ConnectAppInstance] Updated ConnectAppInstance
             def update(authorize_redirect_url: :unset, company_name: :unset, deauthorize_callback_method: :unset, deauthorize_callback_url: :unset, description: :unset, friendly_name: :unset, homepage_url: :unset, permissions: :unset)
               context.update(
@@ -366,6 +398,13 @@ module Twilio
               )
             end
 
+            ##
+            # Deletes the ConnectAppInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,12 +19,13 @@ module Twilio
                 ##
                 # Initialize the AssignedAddOnExtensionList
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The unique id of the Account that has installed this
-                #   Add-on.
-                # @param [String] resource_sid The unique id of the Phone Number to which the
-                #   Add-on is assigned.
-                # @param [String] assigned_add_on_sid A 34 character string that uniquely
-                #   identifies the assigned Add-on installation.
+                # @param [String] account_sid The SID of the
+                #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+                #   resource.
+                # @param [String] resource_sid The SID of the Phone Number to which the Add-on is
+                #   assigned.
+                # @param [String] assigned_add_on_sid The SID that uniquely identifies the
+                #   assigned Add-on installation.
                 # @return [AssignedAddOnExtensionList] AssignedAddOnExtensionList
                 def initialize(version, account_sid: nil, resource_sid: nil, assigned_add_on_sid: nil)
                   super(version)
@@ -65,7 +68,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
@@ -77,7 +80,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],
@@ -168,10 +171,15 @@ module Twilio
                 ##
                 # Initialize the AssignedAddOnExtensionContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The account_sid
-                # @param [String] resource_sid The resource_sid
-                # @param [String] assigned_add_on_sid The assigned_add_on_sid
-                # @param [String] sid The Extension Sid that uniquely identifies this resource
+                # @param [String] account_sid The SID of the
+                #   [Account](https://www.twilio.com/docs/iam/api/account) that created the resource
+                #   to fetch.
+                # @param [String] resource_sid The SID of the Phone Number to which the Add-on is
+                #   assigned.
+                # @param [String] assigned_add_on_sid The SID that uniquely identifies the
+                #   assigned Add-on installation.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   resource to fetch.
                 # @return [AssignedAddOnExtensionContext] AssignedAddOnExtensionContext
                 def initialize(version, account_sid, resource_sid, assigned_add_on_sid, sid)
                   super(version)
@@ -214,6 +222,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Api.V2010.AssignedAddOnExtensionContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Api.V2010.AssignedAddOnExtensionContext #{context}>"
+                end
               end
 
               ##
@@ -223,13 +238,15 @@ module Twilio
                 # Initialize the AssignedAddOnExtensionInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] account_sid The unique id of the Account that has installed this
-                #   Add-on.
-                # @param [String] resource_sid The unique id of the Phone Number to which the
-                #   Add-on is assigned.
-                # @param [String] assigned_add_on_sid A 34 character string that uniquely
-                #   identifies the assigned Add-on installation.
-                # @param [String] sid The Extension Sid that uniquely identifies this resource
+                # @param [String] account_sid The SID of the
+                #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+                #   resource.
+                # @param [String] resource_sid The SID of the Phone Number to which the Add-on is
+                #   assigned.
+                # @param [String] assigned_add_on_sid The SID that uniquely identifies the
+                #   assigned Add-on installation.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   resource to fetch.
                 # @return [AssignedAddOnExtensionInstance] AssignedAddOnExtensionInstance
                 def initialize(version, payload, account_sid: nil, resource_sid: nil, assigned_add_on_sid: nil, sid: nil)
                   super(version)
@@ -275,55 +292,55 @@ module Twilio
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies this Extension
+                # @return [String] The unique string that identifies the resource
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] The Account id that has installed this Add-on
+                # @return [String] The SID of the Account that created the resource
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] The Phone Number id that has installed this Add-on
+                # @return [String] The SID of the Phone Number to which the Add-on is assigned
                 def resource_sid
                   @properties['resource_sid']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the assigned Add-on installation
+                # @return [String] The SID that uniquely identifies the assigned Add-on installation
                 def assigned_add_on_sid
                   @properties['assigned_add_on_sid']
                 end
 
                 ##
-                # @return [String] A human-readable description of this Extension
+                # @return [String] The string that you assigned to describe the resource
                 def friendly_name
                   @properties['friendly_name']
                 end
 
                 ##
-                # @return [String] A human-readable description of the Extension's Product
+                # @return [String] A string that you assigned to describe the Product this Extension is used within
                 def product_name
                   @properties['product_name']
                 end
 
                 ##
-                # @return [String] The string that uniquely identifies this Extension
+                # @return [String] An application-defined string that uniquely identifies the resource
                 def unique_name
                   @properties['unique_name']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI of the resource, relative to `https://api.twilio.com`
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [Boolean] A Boolean indicating if the Extension will be invoked
+                # @return [Boolean] Whether the Extension will be invoked
                 def enabled
                   @properties['enabled']
                 end