twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -16,10 +18,11 @@ module Twilio
               ##
               # Initialize the AssignedAddOnList
               # @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] 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.
               # @return [AssignedAddOnList] AssignedAddOnList
               def initialize(version, account_sid: nil, resource_sid: nil)
                 super(version)
@@ -58,7 +61,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
@@ -70,7 +73,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],
@@ -90,11 +93,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 AssignedAddOnPage.new(@version, response, @solution)
               end
 
@@ -112,19 +113,14 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of AssignedAddOnInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] installed_add_on_sid A 34 character string that uniquely
-              #   identifies the Add-on installation.
-              # @return [AssignedAddOnInstance] Newly created AssignedAddOnInstance
+              # Create the AssignedAddOnInstance
+              # @param [String] installed_add_on_sid The SID that identifies the Add-on
+              #   installation.
+              # @return [AssignedAddOnInstance] Created AssignedAddOnInstance
               def create(installed_add_on_sid: nil)
-                data = Twilio::Values.of({'InstalledAddOnSid' => installed_add_on_sid})
+                data = Twilio::Values.of({'InstalledAddOnSid' => installed_add_on_sid, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 AssignedAddOnInstance.new(
                     @version,
@@ -183,16 +179,19 @@ module Twilio
               ##
               # Initialize the AssignedAddOnContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] resource_sid The resource_sid
-              # @param [String] sid The Installed Add-on Sid that uniquely identifies the
-              #   assignment
+              # @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] sid The Twilio-provided string that uniquely identifies the
+              #   resource to fetch.
               # @return [AssignedAddOnContext] AssignedAddOnContext
               def initialize(version, account_sid, resource_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, resource_sid: resource_sid, sid: sid}
+                @solution = {account_sid: account_sid, resource_sid: resource_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:resource_sid]}/AssignedAddOns/#{@solution[:sid]}.json"
 
                 # Dependents
@@ -200,16 +199,10 @@ module Twilio
               end
 
               ##
-              # Fetch a AssignedAddOnInstance
+              # Fetch the AssignedAddOnInstance
               # @return [AssignedAddOnInstance] Fetched AssignedAddOnInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 AssignedAddOnInstance.new(
                     @version,
@@ -221,10 +214,10 @@ module Twilio
               end
 
               ##
-              # Deletes the AssignedAddOnInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the AssignedAddOnInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -262,6 +255,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.AssignedAddOnContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.AssignedAddOnContext #{context}>"
+              end
             end
 
             ##
@@ -271,12 +271,13 @@ module Twilio
               # Initialize the AssignedAddOnInstance
               # @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] sid The Installed Add-on Sid that uniquely identifies the
-              #   assignment
+              # @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] sid The Twilio-provided string that uniquely identifies the
+              #   resource to fetch.
               # @return [AssignedAddOnInstance] AssignedAddOnInstance
               def initialize(version, payload, account_sid: nil, resource_sid: nil, sid: nil)
                 super(version)
@@ -322,25 +323,25 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this assigned Add-on installation
+              # @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 that installed this Add-on
               def resource_sid
                 @properties['resource_sid']
               end
 
               ##
-              # @return [String] A description of this Add-on installation
+              # @return [String] The string that you assigned to describe the resource
               def friendly_name
                 @properties['friendly_name']
               end
@@ -352,51 +353,51 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The JSON object representing the current configuration
+              # @return [Hash] A JSON string that represents the current configuration
               def configuration
                 @properties['configuration']
               end
 
               ##
-              # @return [String] The string that uniquely identifies this Add-on installation
+              # @return [String] An application-defined string that uniquely identifies the resource
               def unique_name
                 @properties['unique_name']
               end
 
               ##
-              # @return [Time] The date this Add-on was installed
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this Add-on installation was last updated
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The uri
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
-              # @return [String] The subresource_uris
+              # @return [String] A list of related resources identified by their relative URIs
               def subresource_uris
                 @properties['subresource_uris']
               end
 
               ##
-              # Fetch a AssignedAddOnInstance
+              # Fetch the AssignedAddOnInstance
               # @return [AssignedAddOnInstance] Fetched AssignedAddOnInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the AssignedAddOnInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the AssignedAddOnInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end