twilio-ruby 7.8.1 → 7.8.3

data/lib/twilio-ruby/rest/messaging/v2.rb

@@ -22,6 +22,7 @@ module Twilio
                     super
                     @version = 'v2'
                     @channels_senders = nil
+                    @typing_indicator = nil
                 end
 
                 ##
@@ -39,6 +40,11 @@ module Twilio
                     end
                 end
                 ##
+                # @return [Twilio::REST::Messaging::V2::TypingIndicatorList]
+                def typing_indicator
+                    @typing_indicator ||= TypingIndicatorList.new self
+                end
+                ##
                 # Provide a user friendly representation
                 def to_s
                     '<Twilio::REST::Messaging::V2>';

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

@@ -0,0 +1,270 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Numbers < NumbersBase
+            class V1 < Version
+                class PortingAllPortInList < ListResource
+                
+                    ##
+                    # Initialize the PortingAllPortInList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PortingAllPortInList] PortingAllPortInList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Porting/PortIn/PortInRequests"
+                        
+                    end
+                
+                    ##
+                    # Lists PortingAllPortInInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] token Page start token, if null then it will start from the beginning
+                    # @param [String] size Number of items per page
+                    # @param [String] port_in_request_sid Filter by Port in request SID, supports multiple values separated by comma
+                    # @param [String] port_in_request_status Filter by Port In request status
+                    # @param [Time] created_before Find all created before a certain date
+                    # @param [Time] created_after Find all created after a certain date
+                    # @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(token: :unset, size: :unset, port_in_request_sid: :unset, port_in_request_status: :unset, created_before: :unset, created_after: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            token: token,
+                            size: size,
+                            port_in_request_sid: port_in_request_sid,
+                            port_in_request_status: port_in_request_status,
+                            created_before: created_before,
+                            created_after: created_after,
+                            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] token Page start token, if null then it will start from the beginning
+                    # @param [String] size Number of items per page
+                    # @param [String] port_in_request_sid Filter by Port in request SID, supports multiple values separated by comma
+                    # @param [String] port_in_request_status Filter by Port In request status
+                    # @param [Time] created_before Find all created before a certain date
+                    # @param [Time] created_after Find all created after a certain date
+                    # @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(token: :unset, size: :unset, port_in_request_sid: :unset, port_in_request_status: :unset, created_before: :unset, created_after: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            token: token,
+                            size: size,
+                            port_in_request_sid: port_in_request_sid,
+                            port_in_request_status: port_in_request_status,
+                            created_before: created_before,
+                            created_after: created_after,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields PortingAllPortInInstance 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 PortingAllPortInInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] token Page start token, if null then it will start from the beginning
+                    # @param [String] size Number of items per page
+                    # @param [String] port_in_request_sid Filter by Port in request SID, supports multiple values separated by comma
+                    # @param [String] port_in_request_status Filter by Port In request status
+                    # @param [Time] created_before Find all created before a certain date
+                    # @param [Time] created_after Find all created after a certain date
+                    # @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 PortingAllPortInInstance
+                    def page(token: :unset, size: :unset, port_in_request_sid: :unset, port_in_request_status: :unset, created_before: :unset, created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'Token' => token,
+                            'Size' => size,
+                            'PortInRequestSid' => port_in_request_sid,
+                            'PortInRequestStatus' => port_in_request_status,
+                            'CreatedBefore' =>  Twilio.serialize_iso8601_datetime(created_before),
+                            'CreatedAfter' =>  Twilio.serialize_iso8601_datetime(created_after),
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        PortingAllPortInPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of PortingAllPortInInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of PortingAllPortInInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    PortingAllPortInPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.PortingAllPortInList>'
+                    end
+                end
+
+                class PortingAllPortInPage < Page
+                    ##
+                    # Initialize the PortingAllPortInPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PortingAllPortInPage] PortingAllPortInPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PortingAllPortInInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PortingAllPortInInstance] PortingAllPortInInstance
+                    def get_instance(payload)
+                        PortingAllPortInInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.PortingAllPortInPage>'
+                    end
+                end
+                class PortingAllPortInInstance < InstanceResource
+                    ##
+                    # Initialize the PortingAllPortInInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this PortingAllPortIn
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PortingAllPortInInstance] PortingAllPortInInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'port_in_request_sid' => payload['port_in_request_sid'],
+                            'port_in_request_status' => payload['port_in_request_status'],
+                            'status_last_updated_timestamp' => payload['status_last_updated_timestamp'],
+                            'phone_numbers_requested' => payload['phone_numbers_requested'] == nil ? payload['phone_numbers_requested'] : payload['phone_numbers_requested'].to_i,
+                            'phone_numbers_ported' => payload['phone_numbers_ported'] == nil ? payload['phone_numbers_ported'] : payload['phone_numbers_ported'].to_i,
+                            'suggested_action' => payload['suggested_action'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The SID of the Port-in request
+                    def port_in_request_sid
+                        @properties['port_in_request_sid']
+                    end
+                    
+                    ##
+                    # @return [String] Status of the Port In Request
+                    def port_in_request_status
+                        @properties['port_in_request_status']
+                    end
+                    
+                    ##
+                    # @return [String] The last updated timestamp of the request
+                    def status_last_updated_timestamp
+                        @properties['status_last_updated_timestamp']
+                    end
+                    
+                    ##
+                    # @return [String] Amount of phone numbers requested
+                    def phone_numbers_requested
+                        @properties['phone_numbers_requested']
+                    end
+                    
+                    ##
+                    # @return [String] Amount of phone numbers ported
+                    def phone_numbers_ported
+                        @properties['phone_numbers_ported']
+                    end
+                    
+                    ##
+                    # @return [String] Suggested action on this ticket
+                    def suggested_action
+                        @properties['suggested_action']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Numbers.V1.PortingAllPortInInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Numbers.V1.PortingAllPortInInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -19,6 +19,94 @@ module Twilio
             class V1 < Version
                 class PortingPortInList < ListResource
                 
+                    class NumbersV1PortingAddress
+                            # @param [street]: [String] The street address, ex: 101 Spear St
+                            # @param [street_2]: [String] The building information, ex : 5th floor.
+                            # @param [city]: [String] The city name, ex: San Francisco.
+                            # @param [state]: [String] The state name, ex: CA or California. Note this should match the losing carrier’s information exactly. So if they spell out the entire state’s name instead of abbreviating it, please do so.
+                            # @param [zip]: [String] The zip code, ex: 94105.
+                            # @param [country]: [String] The country, ex: USA.
+                        attr_accessor :street, :street_2, :city, :state, :zip, :country
+                        def initialize(payload)
+                                @street = payload["street"]
+                                @street_2 = payload["street_2"]
+                                @city = payload["city"]
+                                @state = payload["state"]
+                                @zip = payload["zip"]
+                                @country = payload["country"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "street": @street,
+                                "street_2": @street_2,
+                                "city": @city,
+                                "state": @state,
+                                "zip": @zip,
+                                "country": @country,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class NumbersV1PortingPortInCreate
+                            # @param [account_sid]: [String] Account Sid or subaccount where the phone number(s) will be Ported
+                            # @param [documents]: [Array<String>] List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.
+                            # @param [phone_numbers]: [Array<PortingPortInList.NumbersV1PortingPortInCreatePhoneNumbers>] List of phone numbers to be ported. Maximum of 1,000 phone numbers per request.
+                            # @param [losing_carrier_information]: [PortingPortInList.NumbersV1PortingLosingCarrierInformation] 
+                            # @param [notification_emails]: [Array<String>] Additional emails to send a copy of the signed LOA to.
+                            # @param [target_port_in_date]: [Date] Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. We can't guarantee the exact date and time, as this depends on the losing carrier
+                            # @param [target_port_in_time_range_start]: [String] The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier
+                            # @param [target_port_in_time_range_end]: [String] The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier
+                            # @param [bundle_sid]: [String] The bundle sid is an optional identifier to reference a group of regulatory documents for a port request.
+                            # @param [portability_advance_carrier]: [String] A field only required for Japan port in requests. It is a unique identifier for the donor carrier service the line is being ported from.
+                            # @param [auto_cancel_approval_numbers]: [String] Japan specific field, indicates the number of phone numbers to automatically approve for cancellation.
+                        attr_accessor :account_sid, :documents, :phone_numbers, :losing_carrier_information, :notification_emails, :target_port_in_date, :target_port_in_time_range_start, :target_port_in_time_range_end, :bundle_sid, :portability_advance_carrier, :auto_cancel_approval_numbers
+                        def initialize(payload)
+                                @account_sid = payload["account_sid"]
+                                @documents = payload["documents"]
+                                @phone_numbers = payload["phone_numbers"]
+                                @losing_carrier_information = payload["losing_carrier_information"]
+                                @notification_emails = payload["notification_emails"]
+                                @target_port_in_date = payload["target_port_in_date"]
+                                @target_port_in_time_range_start = payload["target_port_in_time_range_start"]
+                                @target_port_in_time_range_end = payload["target_port_in_time_range_end"]
+                                @bundle_sid = payload["bundle_sid"]
+                                @portability_advance_carrier = payload["portability_advance_carrier"]
+                                @auto_cancel_approval_numbers = payload["auto_cancel_approval_numbers"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "account_sid": @account_sid,
+                                "documents": @documents,
+                                "phone_numbers": @phone_numbers,
+                                "losing_carrier_information": @losing_carrier_information,
+                                "notification_emails": @notification_emails,
+                                "target_port_in_date": @target_port_in_date,
+                                "target_port_in_time_range_start": @target_port_in_time_range_start,
+                                "target_port_in_time_range_end": @target_port_in_time_range_end,
+                                "bundle_sid": @bundle_sid,
+                                "portability_advance_carrier": @portability_advance_carrier,
+                                "auto_cancel_approval_numbers": @auto_cancel_approval_numbers,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class NumbersV1PortingPortInCreatePhoneNumbers
+                            # @param [phone_number]: [String] Phone number to be ported. This must be in the E164 Format.
+                            # @param [pin]: [String] Some losing carriers require a PIN to authorize the port of a phone number. If the phone number is a US mobile phone number, the PIN is mandatory to process a porting request. Other carriers and number types may also require a PIN, you'll need to contact the losing carrier to determine what your phone number's PIN is.
+                        attr_accessor :phone_number, :pin
+                        def initialize(payload)
+                                @phone_number = payload["phone_number"]
+                                @pin = payload["pin"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "phone_number": @phone_number,
+                                "pin": @pin,
+                        }.to_json(options)
+                        end
+                    end
+
+
                     ##
                     # Initialize the PortingPortInList
                     # @param [Version] version Version that contains the resource
@@ -32,9 +120,9 @@ module Twilio
                     end
                     ##
                     # Create the PortingPortInInstance
-                    # @param [Object] body 
+                    # @param [NumbersV1PortingPortInCreate] numbers_v1_porting_port_in_create 
                     # @return [PortingPortInInstance] Created PortingPortInInstance
-                    def create(body: :unset
+                    def create(numbers_v1_porting_port_in_create: nil
                     )
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
@@ -43,7 +131,7 @@ module Twilio
                         
                         
                         
-                        payload = @version.create('POST', @uri, headers: headers, data: body.to_json)
+                        payload = @version.create('POST', @uri, headers: headers, data: numbers_v1_porting_port_in_create.to_json)
                         PortingPortInInstance.new(
                             @version,
                             payload,
@@ -173,6 +261,7 @@ module Twilio
                             'target_port_in_time_range_start' => payload['target_port_in_time_range_start'],
                             'target_port_in_time_range_end' => payload['target_port_in_time_range_end'],
                             'port_in_request_status' => payload['port_in_request_status'],
+                            'order_cancellation_reason' => payload['order_cancellation_reason'],
                             'losing_carrier_information' => payload['losing_carrier_information'],
                             'phone_numbers' => payload['phone_numbers'],
                             'bundle_sid' => payload['bundle_sid'],
@@ -247,13 +336,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] Details regarding the customer’s information with the losing carrier. These values will be used to generate the letter of authorization and should match the losing carrier’s data as closely as possible to ensure the port is accepted.
+                    # @return [String] If the order is cancelled this field will provide further context on the cause of the cancellation.
+                    def order_cancellation_reason
+                        @properties['order_cancellation_reason']
+                    end
+                    
+                    ##
+                    # @return [NumbersV1PortingLosingCarrierInformation] 
                     def losing_carrier_information
                         @properties['losing_carrier_information']
                     end
                     
                     ##
-                    # @return [Array<Hash>] 
+                    # @return [Array<NumbersV1PortingPortInPhoneNumberResult>] 
                     def phone_numbers
                         @properties['phone_numbers']
                     end

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

@@ -23,6 +23,7 @@ module Twilio
                     @version = 'v1'
                     @bulk_eligibilities = nil
                     @eligibilities = nil
+                    @porting_all_port_ins = nil
                     @porting_port_ins = nil
                     @porting_port_in_phone_number = nil
                     @porting_portabilities = nil
@@ -52,6 +53,11 @@ module Twilio
                     @eligibilities ||= EligibilityList.new self
                 end
                 ##
+                # @return [Twilio::REST::Numbers::V1::PortingAllPortInList]
+                def porting_all_port_ins
+                    @porting_all_port_ins ||= PortingAllPortInList.new self
+                end
+                ##
                 # @param [String] port_in_request_sid The SID of the Port In request. This is a unique identifier of the port in request.
                 # @return [Twilio::REST::Numbers::V1::PortingPortInContext] if portInRequestSid was passed.
                 # @return [Twilio::REST::Numbers::V1::PortingPortInList]

data/lib/twilio-ruby/rest/oauth/v2/token.rb

@@ -42,8 +42,8 @@ module Twilio
                     # @param [String] scope The scope of token
                     # @return [TokenInstance] Created TokenInstance
                     def create(
-                        grant_type: nil, 
-                        client_id: nil, 
+                        grant_type: :unset, 
+                        client_id: :unset, 
                         client_secret: :unset, 
                         code: :unset, 
                         redirect_uri: :unset,