twilio-ruby 7.2.1 → 7.3.1

data/lib/twilio-ruby/rest/numbers/v1/porting_port_in_phone_number.rb

@@ -158,6 +158,7 @@ module Twilio
                             'port_out_pin' => payload['port_out_pin'] == nil ? payload['port_out_pin'] : payload['port_out_pin'].to_i,
                             'rejection_reason' => payload['rejection_reason'],
                             'rejection_reason_code' => payload['rejection_reason_code'] == nil ? payload['rejection_reason_code'] : payload['rejection_reason_code'].to_i,
+                            'port_date' => Twilio.deserialize_iso8601_datetime(payload['port_date']),
                         }
 
                         # Context
@@ -177,107 +178,113 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The SID of the Port In request. This is a unique identifier of the port in request.
+                    # @return [String] The unique identifier for the port in request that this phone number is associated with.
                     def port_in_request_sid
                         @properties['port_in_request_sid']
                     end
                     
                     ##
-                    # @return [String] The SID of the Port In request phone number. This is a unique identifier of the phone number.
+                    # @return [String] The unique identifier for this phone number associated with this port in request.
                     def phone_number_sid
                         @properties['phone_number_sid']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] URL reference for this resource.
                     def url
                         @properties['url']
                     end
                     
                     ##
-                    # @return [String] The SID of the account that the phone number belongs to.
+                    # @return [String] Account Sid or subaccount where the phone number(s) will be Ported.
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [String] The type of the phone number.
+                    # @return [String] The number type of the phone number. This can be: toll-free, local, mobile or unknown. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
                     def phone_number_type
                         @properties['phone_number_type']
                     end
                     
                     ##
-                    # @return [Time] The date when the phone number was created.
+                    # @return [Time] The timestamp for when this port in phone number was created.
                     def date_created
                         @properties['date_created']
                     end
                     
                     ##
-                    # @return [String] The country of the phone number.
+                    # @return [String] The ISO country code that this number is associated with. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
                     def country
                         @properties['country']
                     end
                     
                     ##
-                    # @return [Boolean] The phone number is missing required fields.
+                    # @return [Boolean] Indicates if the phone number is missing required fields such as a PIN or account number. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
                     def missing_required_fields
                         @properties['missing_required_fields']
                     end
                     
                     ##
-                    # @return [Time] The timestamp when the status was last updated.
+                    # @return [Time] Timestamp indicating when the Port In Phone Number resource was last modified.
                     def last_updated
                         @properties['last_updated']
                     end
                     
                     ##
-                    # @return [String] The phone number.
+                    # @return [String] Phone number to be ported. This will be in the E164 Format.
                     def phone_number
                         @properties['phone_number']
                     end
                     
                     ##
-                    # @return [Boolean] The phone number is portable.
+                    # @return [Boolean] If the number is portable by Twilio or not. This field may be null if the number portability has not yet been evaluated. If a number is not portable reference the `not_portability_reason_code` and `not_portability_reason` fields for more details
                     def portable
                         @properties['portable']
                     end
                     
                     ##
-                    # @return [String] The reason why the phone number is not portable.
+                    # @return [String] The not portability reason code description. This field may be null if the number is portable or if the portability for a number has not yet been evaluated.
                     def not_portability_reason
                         @properties['not_portability_reason']
                     end
                     
                     ##
-                    # @return [String] The code of the reason why the phone number is not portable.
+                    # @return [String] The not portability reason code. This field may be null if the number is portable or if the portability for a number has not yet been evaluated.
                     def not_portability_reason_code
                         @properties['not_portability_reason_code']
                     end
                     
                     ##
-                    # @return [String] The status of the phone number in the port in request.
+                    # @return [String] The status of the port in phone number.
                     def port_in_phone_number_status
                         @properties['port_in_phone_number_status']
                     end
                     
                     ##
-                    # @return [String] The pin required for the losing carrier to port out the phone number.
+                    # @return [String] The pin required by the losing carrier to do the port out.
                     def port_out_pin
                         @properties['port_out_pin']
                     end
                     
                     ##
-                    # @return [String] The rejection reason returned by the vendor.
+                    # @return [String] The description of the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier.
                     def rejection_reason
                         @properties['rejection_reason']
                     end
                     
                     ##
-                    # @return [String] The rejection reason code returned by the vendor.
+                    # @return [String] The code for the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier.
                     def rejection_reason_code
                         @properties['rejection_reason_code']
                     end
                     
+                    ##
+                    # @return [Time] The timestamp the phone number will be ported. This will only be set once a port date has been confirmed. Not all carriers can guarantee a specific time on the port date. Twilio will try its best to get the port completed by this time on the port date. Please subscribe to webhooks for confirmation on when a port has actually been completed.
+                    def port_date
+                        @properties['port_date']
+                    end
+                    
                     ##
                     # Delete the PortingPortInPhoneNumberInstance
                     # @return [Boolean] True if delete succeeds, false otherwise

data/lib/twilio-ruby/rest/numbers/v1/porting_portability.rb

@@ -44,7 +44,7 @@ module Twilio
                     ##
                     # Initialize the PortingPortabilityContext
                     # @param [Version] version Version that contains the resource
-                    # @param [String] phone_number The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
+                    # @param [String] phone_number Phone number to check portability in e164 format.
                     # @return [PortingPortabilityContext] PortingPortabilityContext
                     def initialize(version, phone_number)
                         super(version)
@@ -57,7 +57,7 @@ module Twilio
                     end
                     ##
                     # Fetch the PortingPortabilityInstance
-                    # @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
+                    # @param [String] target_account_sid Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
                     # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
                     def fetch(
                         target_account_sid: :unset
@@ -169,19 +169,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The target account sid to which the number will be ported
+                    # @return [String] Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [Boolean] Boolean flag specifying if phone number is portable or not.
+                    # @return [Boolean] Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.
                     def portable
                         @properties['portable']
                     end
                     
                     ##
-                    # @return [Boolean] Boolean flag specifying if PIN and account number is required for the phone number.
+                    # @return [Boolean] Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.
                     def pin_and_account_number_required
                         @properties['pin_and_account_number_required']
                     end
@@ -193,7 +193,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`.
+                    # @return [String] The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise.
                     def not_portable_reason_code
                         @properties['not_portable_reason_code']
                     end
@@ -218,7 +218,7 @@ module Twilio
                     
                     ##
                     # Fetch the PortingPortabilityInstance
-                    # @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
+                    # @param [String] target_account_sid Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
                     # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
                     def fetch(
                         target_account_sid: :unset

data/lib/twilio-ruby/rest/numbers/v1/porting_webhook_configuration.rb

@@ -113,19 +113,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] Webhook URL to send a request when a port in request or port in phone number event happens
+                    # @return [String] The complete webhook url that will be called when a notification event for port in request or port in phone number happens
                     def port_in_target_url
                         @properties['port_in_target_url']
                     end
                     
                     ##
-                    # @return [String] Webhook URL to send a request when a port out phone number event happens
+                    # @return [String] The complete webhook url that will be called when a notification event for a port out phone number happens.
                     def port_out_target_url
                         @properties['port_out_target_url']
                     end
                     
                     ##
-                    # @return [Array<String>] List of notification events to send a request to the webhook URL
+                    # @return [Array<String>] A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent.
                     def notifications_of
                         @properties['notifications_of']
                     end

data/lib/twilio-ruby/rest/numbers/v1/porting_webhook_configuration_delete.rb

@@ -44,7 +44,7 @@ module Twilio
                     ##
                     # Initialize the PortingWebhookConfigurationDeleteContext
                     # @param [Version] version Version that contains the resource
-                    # @param [WebhookType] webhook_type The of the webhook type of the configuration to be deleted
+                    # @param [WebhookType] webhook_type The webhook type for the configuration to be delete. `PORT_IN`, `PORT_OUT`
                     # @return [PortingWebhookConfigurationDeleteContext] PortingWebhookConfigurationDeleteContext
                     def initialize(version, webhook_type)
                         super(version)

data/lib/twilio-ruby/rest/numbers/v1/porting_webhook_configuration_fetch.rb

@@ -113,19 +113,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] Webhook URL to send a request when a port in request or port in phone number event happens
+                    # @return [String] The complete webhook url that will be called when a notification event for port in request or port in phone number happens
                     def port_in_target_url
                         @properties['port_in_target_url']
                     end
                     
                     ##
-                    # @return [String] Webhook URL to send a request when a port out phone number event happens
+                    # @return [String] The complete webhook url that will be called when a notification event for a port out phone number happens.
                     def port_out_target_url
                         @properties['port_out_target_url']
                     end
                     
                     ##
-                    # @return [Array<String>] List of notification events to send a request to the webhook URL
+                    # @return [Array<String>] A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent.
                     def notifications_of
                         @properties['notifications_of']
                     end

data/lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb

@@ -47,6 +47,102 @@ module Twilio
                     end
 
                 
+                    ##
+                    # Lists SigningRequestConfigurationInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] country The country ISO code to apply this configuration, this is an optional field, Example: US, MX
+                    # @param [String] product The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting
+                    # @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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(country: :unset, product: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            country: country,
+                            product: product,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [String] country The country ISO code to apply this configuration, this is an optional field, Example: US, MX
+                    # @param [String] product The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting
+                    # @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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(country: :unset, product: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            country: country,
+                            product: product,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields SigningRequestConfigurationInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of SigningRequestConfigurationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] country The country ISO code to apply this configuration, this is an optional field, Example: US, MX
+                    # @param [String] product The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting
+                    # @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
+                    # @return [Page] Page of SigningRequestConfigurationInstance
+                    def page(country: :unset, product: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'Country' => country,
+                            'Product' => product,
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+
+                        response = @version.page('GET', @uri, params: params)
+
+                        SigningRequestConfigurationPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of SigningRequestConfigurationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of SigningRequestConfigurationInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    SigningRequestConfigurationPage.new(@version, response, @solution)
+                    end
+                    
 
 
                     # Provide a user friendly representation

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

@@ -102,7 +102,7 @@ module Twilio
                     end
                 end
                 ##
-                # @param [String] phone_number The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
+                # @param [String] phone_number Phone number to check portability in e164 format.
                 # @return [Twilio::REST::Numbers::V1::PortingPortabilityContext] if phoneNumber was passed.
                 # @return [Twilio::REST::Numbers::V1::PortingPortabilityList]
                 def porting_portabilities(phone_number=:unset)
@@ -121,7 +121,7 @@ module Twilio
                     @porting_webhook_configurations ||= PortingWebhookConfigurationList.new self
                 end
                 ##
-                # @param [String] webhook_type The of the webhook type of the configuration to be deleted
+                # @param [String] webhook_type The webhook type for the configuration to be delete. `PORT_IN`, `PORT_OUT`
                 # @return [Twilio::REST::Numbers::V1::PortingWebhookConfigurationDeleteContext] if webhookType was passed.
                 # @return [Twilio::REST::Numbers::V1::PortingWebhookConfigurationDeleteList]
                 def porting_webhook_configurations_delete(webhook_type=:unset)