Class: Twilio::REST::Lookups::V2

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/lookups/v2.rb,
lib/twilio-ruby/rest/lookups/v2/query.rb,
lib/twilio-ruby/rest/lookups/v2/bucket.rb,
lib/twilio-ruby/rest/lookups/v2/rate_limit.rb,
lib/twilio-ruby/rest/lookups/v2/phone_number.rb,
lib/twilio-ruby/rest/lookups/v2/lookup_override.rb

Defined Under Namespace

Classes: BucketContext, BucketInstance, BucketList, BucketPage, LookupOverrideContext, LookupOverrideInstance, LookupOverrideList, LookupOverridePage, PhoneNumberContext, PhoneNumberInstance, PhoneNumberList, PhoneNumberPage, QueryInstance, QueryList, QueryPage, RateLimitInstance, RateLimitList, RateLimitPage

Instance Attribute Summary

Attributes inherited from Version

#domain

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #delete, #exception, #fetch, #page, #read_limits, #relative_uri, #request, #stream, #update

Constructor Details

#initialize(domain) ⇒ V2

Initialize the V2 version of Lookups



21
22
23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/lookups/v2.rb', line 21

def initialize(domain)
    super
    @version = 'v2'
    @bucket = nil
    @lookup_overrides = nil
    @phone_numbers = nil
    @query = nil
    @rate_limits = nil
end

Instance Method Details

#bucket(field = :unset, bucket = :unset) ⇒ Twilio::REST::Lookups::V2::BucketContext, Twilio::REST::Lookups::V2::BucketList

Parameters:

  • field (String) (defaults to: :unset) —

    bucket name

  • bucket (String) (defaults to: :unset) —

    bucket name

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/lookups/v2.rb', line 36

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

#lookup_overrides(field = :unset, phone_number = :unset) ⇒ Twilio::REST::Lookups::V2::LookupOverrideContext, Twilio::REST::Lookups::V2::LookupOverrideList

Parameters:

  • field (String) (defaults to: :unset)
  • phone_number (String) (defaults to: :unset)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/lookups/v2.rb', line 72

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

#phone_numbers(phone_number = :unset) ⇒ Twilio::REST::Lookups::V2::PhoneNumberContext, Twilio::REST::Lookups::V2::PhoneNumberList

Parameters:

  • phone_number (String) (defaults to: :unset) —

    The phone number to lookup in E.164 or national format. Default country code is +1 (North America).

Returns:



107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/lookups/v2.rb', line 107

def phone_numbers(phone_number=:unset)
    if phone_number.nil?
        raise ArgumentError, 'phone_number cannot be nil'
    end
    if phone_number == :unset
        @phone_numbers ||= PhoneNumberList.new self
    else
        PhoneNumberContext.new(self, phone_number)
    end
end

#query ⇒ Twilio::REST::Lookups::V2::QueryList

Returns:



119
120
121
 
# File 'lib/twilio-ruby/rest/lookups/v2.rb', line 119

def query
    @query ||= QueryList.new self
end

#rate_limits ⇒ Twilio::REST::Lookups::V2::RateLimitList

Returns:



124
125
126
 
# File 'lib/twilio-ruby/rest/lookups/v2.rb', line 124

def rate_limits
    @rate_limits ||= RateLimitList.new self
end

#to_s ⇒ Object

Provide a user friendly representation



129
130
131
 
# File 'lib/twilio-ruby/rest/lookups/v2.rb', line 129

def to_s
    '<Twilio::REST::Lookups::V2>';
end