twilio-ruby 7.3.3 → 7.10.1

data/lib/twilio-ruby/rest/lookups/v2/query.rb

@@ -0,0 +1,351 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Lookups
+#    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 Lookups < LookupsBase
+            class V2 < Version
+                class QueryList < ListResource
+                
+                    class IdentityMatchParameters
+                            # @param [first_name]: [String] 
+                            # @param [last_name]: [String] 
+                            # @param [address_line1]: [String] 
+                            # @param [address_line2]: [String] 
+                            # @param [city]: [String] 
+                            # @param [state]: [String] 
+                            # @param [postal_code]: [String] 
+                            # @param [address_country_code]: [String] 
+                            # @param [national_id]: [String] 
+                            # @param [date_of_birth]: [String] 
+                        attr_accessor :first_name, :last_name, :address_line1, :address_line2, :city, :state, :postal_code, :address_country_code, :national_id, :date_of_birth
+                        def initialize(payload)
+                                @first_name = payload["first_name"]
+                                @last_name = payload["last_name"]
+                                @address_line1 = payload["address_line1"]
+                                @address_line2 = payload["address_line2"]
+                                @city = payload["city"]
+                                @state = payload["state"]
+                                @postal_code = payload["postal_code"]
+                                @address_country_code = payload["address_country_code"]
+                                @national_id = payload["national_id"]
+                                @date_of_birth = payload["date_of_birth"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "first_name": @first_name,
+                                "last_name": @last_name,
+                                "address_line1": @address_line1,
+                                "address_line2": @address_line2,
+                                "city": @city,
+                                "state": @state,
+                                "postal_code": @postal_code,
+                                "address_country_code": @address_country_code,
+                                "national_id": @national_id,
+                                "date_of_birth": @date_of_birth,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class LastSimSwapInfo
+                            # @param [last_sim_swap_date]: [Time] 
+                            # @param [swapped_period]: [String] 
+                            # @param [swapped_in_period]: [Boolean] 
+                        attr_accessor :last_sim_swap_date, :swapped_period, :swapped_in_period
+                        def initialize(payload)
+                                @last_sim_swap_date = payload["last_sim_swap_date"]
+                                @swapped_period = payload["swapped_period"]
+                                @swapped_in_period = payload["swapped_in_period"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "last_sim_swap_date": @last_sim_swap_date,
+                                "swapped_period": @swapped_period,
+                                "swapped_in_period": @swapped_in_period,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class LookupBatchRequest
+                            # @param [correlation_id]: [String] Unique identifier used to match request with response
+                            # @param [phone_number]: [String] 
+                            # @param [fields]: [Array<String>] 
+                            # @param [country_code]: [String] 
+                            # @param [identity_match]: [QueryList.IdentityMatchParameters] 
+                            # @param [reassigned_number]: [QueryList.ReassignedNumberParameters] 
+                            # @param [sms_pumping_risk]: [QueryList.RiskParameters] 
+                        attr_accessor :correlation_id, :phone_number, :fields, :country_code, :identity_match, :reassigned_number, :sms_pumping_risk
+                        def initialize(payload)
+                                @correlation_id = payload["correlation_id"]
+                                @phone_number = payload["phone_number"]
+                                @fields = payload["fields"]
+                                @country_code = payload["country_code"]
+                                @identity_match = payload["identity_match"]
+                                @reassigned_number = payload["reassigned_number"]
+                                @sms_pumping_risk = payload["sms_pumping_risk"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "correlation_id": @correlation_id,
+                                "phone_number": @phone_number,
+                                "fields": @fields,
+                                "country_code": @country_code,
+                                "identity_match": @identity_match,
+                                "reassigned_number": @reassigned_number,
+                                "sms_pumping_risk": @sms_pumping_risk,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class LookupRequest
+                            # @param [phone_numbers]: [Array<QueryList.LookupBatchRequest>] 
+                        attr_accessor :phone_numbers
+                        def initialize(payload)
+                                @phone_numbers = payload["phone_numbers"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "phone_numbers": @phone_numbers,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ReassignedNumberParameters
+                            # @param [last_verified_date]: [String] 
+                        attr_accessor :last_verified_date
+                        def initialize(payload)
+                                @last_verified_date = payload["last_verified_date"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "last_verified_date": @last_verified_date,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class RiskParameters
+                            # @param [partner_sub_id]: [String] 
+                        attr_accessor :partner_sub_id
+                        def initialize(payload)
+                                @partner_sub_id = payload["partner_sub_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "partner_sub_id": @partner_sub_id,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the QueryList
+                    # @param [Version] version Version that contains the resource
+                    # @return [QueryList] QueryList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/batch/query"
+                        
+                    end
+                    ##
+                    # Create the QueryInstance
+                    # @param [LookupRequest] lookup_request 
+                    # @return [QueryInstance] Created QueryInstance
+                    def create(lookup_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: lookup_request.to_json)
+                        QueryInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the QueryInstanceMetadata
+                    # @param [LookupRequest] lookup_request 
+                    # @return [QueryInstance] Created QueryInstance
+                    def create_with_metadata(lookup_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: lookup_request.to_json)
+                        query_instance = QueryInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        QueryInstanceMetadata.new(
+                            @version,
+                            query_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Lookups.V2.QueryList>'
+                    end
+                end
+
+                class QueryPage < Page
+                    ##
+                    # Initialize the QueryPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [QueryPage] QueryPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of QueryInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [QueryInstance] QueryInstance
+                    def get_instance(payload)
+                        QueryInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Lookups.V2.QueryPage>'
+                    end
+                end
+
+                class QueryPageMetadata < PageMetadata
+                    attr_reader :query_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @query_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @query_page << QueryListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @query_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Lookups::V2PageMetadata>';
+                    end
+                end
+                class QueryListResponse < InstanceListResource
+
+                    # @param [Array<QueryInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @query = data_list.map do |data|
+                        QueryInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def query
+                        @query
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class QueryInstance < InstanceResource
+                    ##
+                    # Initialize the QueryInstance
+                    # @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 Query
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [QueryInstance] QueryInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'phone_numbers' => payload['phone_numbers'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Array<LookupBatchResponse>] 
+                    def phone_numbers
+                        @properties['phone_numbers']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Lookups.V2.QueryInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Lookups.V2.QueryInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/lookups/v2/rate_limit.rb

@@ -0,0 +1,229 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Lookups
+#    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 Lookups < LookupsBase
+            class V2 < Version
+                class RateLimitList < ListResource
+                
+                    ##
+                    # Initialize the RateLimitList
+                    # @param [Version] version Version that contains the resource
+                    # @return [RateLimitList] RateLimitList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/RateLimits"
+                        
+                    end
+                    ##
+                    # Fetch the RateLimitInstance
+                    # @param [Array[String]] fields 
+                    # @return [RateLimitInstance] Fetched RateLimitInstance
+                    def fetch(
+                        fields: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Fields' => Twilio.serialize_list(fields) { |e| e },
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        RateLimitInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the RateLimitInstanceMetadata
+                    # @param [Array[String]] fields 
+                    # @return [RateLimitInstance] Fetched RateLimitInstance
+                    def fetch_with_metadata(
+                      fields: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Fields' => Twilio.serialize_list(fields) { |e| e },
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        rate_limit_instance = RateLimitInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        RateLimitInstanceMetadata.new(
+                            @version,
+                            rate_limit_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Lookups.V2.RateLimitList>'
+                    end
+                end
+
+                class RateLimitPage < Page
+                    ##
+                    # Initialize the RateLimitPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [RateLimitPage] RateLimitPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of RateLimitInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [RateLimitInstance] RateLimitInstance
+                    def get_instance(payload)
+                        RateLimitInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Lookups.V2.RateLimitPage>'
+                    end
+                end
+
+                class RateLimitPageMetadata < PageMetadata
+                    attr_reader :rate_limit_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @rate_limit_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @rate_limit_page << RateLimitListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @rate_limit_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Lookups::V2PageMetadata>';
+                    end
+                end
+                class RateLimitListResponse < InstanceListResource
+
+                    # @param [Array<RateLimitInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @rate_limit = data_list.map do |data|
+                        RateLimitInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def rate_limit
+                        @rate_limit
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class RateLimitInstance < InstanceResource
+                    ##
+                    # Initialize the RateLimitInstance
+                    # @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 RateLimit
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [RateLimitInstance] RateLimitInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'rate_limits' => payload['rate_limits'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Array<RateLimitResponse>] 
+                    def rate_limits
+                        @properties['rate_limits']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Lookups.V2.RateLimitInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Lookups.V2.RateLimitInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -21,9 +21,85 @@ module Twilio
                 def initialize(domain)
                     super
                     @version = 'v2'
+                    @bucket = nil
+                    @lookup_overrides = nil
                     @phone_numbers = nil
+                    @query = nil
+                    @rate_limits = nil
                 end
 
+                ##
+                # @param [String] field bucket name
+                # @param [String] bucket bucket name
+                # @return [Twilio::REST::Lookups::V2::BucketContext] if field was passed.
+                # @return [Twilio::REST::Lookups::V2::BucketList]
+                def bucket(field=:unset, bucket=:unset)
+                    if field.nil?
+                        raise ArgumentError, 'field cannot be nil'
+                    end
+                    if bucket.nil?
+                        raise ArgumentError, 'bucket cannot be nil'
+                    end
+                    if field == :unset && bucket == :unset
+                        @bucket ||= BucketList.new self
+                    else
+                        BucketContext.new(self, field, bucket)
+                    end
+                end
+                ##
+                # @param [String] field bucket name
+                # @param [String] bucket bucket name
+                # @return [Twilio::REST::Lookups::V2::BucketContext] if bucket was passed.
+                # @return [Twilio::REST::Lookups::V2::BucketList]
+                def bucket(field=:unset, bucket=:unset)
+                    if field.nil?
+                        raise ArgumentError, 'field cannot be nil'
+                    end
+                    if bucket.nil?
+                        raise ArgumentError, 'bucket cannot be nil'
+                    end
+                    if field == :unset && bucket == :unset
+                        @bucket ||= BucketList.new self
+                    else
+                        BucketContext.new(self, field, bucket)
+                    end
+                end
+                ##
+                # @param [String] field 
+                # @param [String] phone_number 
+                # @return [Twilio::REST::Lookups::V2::LookupOverrideContext] if field was passed.
+                # @return [Twilio::REST::Lookups::V2::LookupOverrideList]
+                def lookup_overrides(field=:unset, phone_number=:unset)
+                    if field.nil?
+                        raise ArgumentError, 'field cannot be nil'
+                    end
+                    if phone_number.nil?
+                        raise ArgumentError, 'phone_number cannot be nil'
+                    end
+                    if field == :unset && phone_number == :unset
+                        @lookup_overrides ||= LookupOverrideList.new self
+                    else
+                        LookupOverrideContext.new(self, field, phone_number)
+                    end
+                end
+                ##
+                # @param [String] field 
+                # @param [String] phone_number 
+                # @return [Twilio::REST::Lookups::V2::LookupOverrideContext] if phoneNumber was passed.
+                # @return [Twilio::REST::Lookups::V2::LookupOverrideList]
+                def lookup_overrides(field=:unset, phone_number=:unset)
+                    if field.nil?
+                        raise ArgumentError, 'field cannot be nil'
+                    end
+                    if phone_number.nil?
+                        raise ArgumentError, 'phone_number cannot be nil'
+                    end
+                    if field == :unset && phone_number == :unset
+                        @lookup_overrides ||= LookupOverrideList.new self
+                    else
+                        LookupOverrideContext.new(self, field, phone_number)
+                    end
+                end
                 ##
                 # @param [String] phone_number The phone number to lookup in E.164 or national format. Default country code is +1 (North America).
                 # @return [Twilio::REST::Lookups::V2::PhoneNumberContext] if phoneNumber was passed.
@@ -39,6 +115,16 @@ module Twilio
                     end
                 end
                 ##
+                # @return [Twilio::REST::Lookups::V2::QueryList]
+                def query
+                    @query ||= QueryList.new self
+                end
+                ##
+                # @return [Twilio::REST::Lookups::V2::RateLimitList]
+                def rate_limits
+                    @rate_limits ||= RateLimitList.new self
+                end
+                ##
                 # Provide a user friendly representation
                 def to_s
                     '<Twilio::REST::Lookups::V2>';