Class: Twilio::REST::Numbers::V1

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v1.rb,
lib/twilio-ruby/rest/numbers/v1/eligibility.rb,
lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb,
lib/twilio-ruby/rest/numbers/v1/bulk_eligibility.rb,
lib/twilio-ruby/rest/numbers/v1/porting_portability.rb,
lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb,
lib/twilio-ruby/rest/numbers/v1/porting_bulk_portability.rb

Defined Under Namespace

Classes: BulkEligibilityContext, BulkEligibilityInstance, BulkEligibilityList, BulkEligibilityPage, EligibilityInstance, EligibilityList, EligibilityPage, PortingBulkPortabilityContext, PortingBulkPortabilityInstance, PortingBulkPortabilityList, PortingBulkPortabilityPage, PortingPortInFetchContext, PortingPortInFetchInstance, PortingPortInFetchList, PortingPortInFetchPage, PortingPortInInstance, PortingPortInList, PortingPortInPage, PortingPortabilityContext, PortingPortabilityInstance, PortingPortabilityList, PortingPortabilityPage

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) ⇒ V1

Initialize the V1 version of Numbers



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

def initialize(domain)
    super
    @version = 'v1'
    @bulk_eligibilities = nil
    @eligibilities = nil
    @porting_bulk_portabilities = nil
    @porting_port_ins = nil
    @porting_port_ins_fetch = nil
    @porting_portabilities = nil
end

Instance Method Details

#bulk_eligibilities(request_id = :unset) ⇒ Twilio::REST::Numbers::V1::BulkEligibilityContext, Twilio::REST::Numbers::V1::BulkEligibilityList

Parameters:

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

    The SID of the bulk eligibility check that you want to know about.

Returns:



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 36

def bulk_eligibilities(request_id=:unset)
    if request_id.nil?
        raise ArgumentError, 'request_id cannot be nil'
    end
    if request_id == :unset
        @bulk_eligibilities ||= BulkEligibilityList.new self
    else
        BulkEligibilityContext.new(self, request_id)
    end
end

#eligibilities ⇒ Twilio::REST::Numbers::V1::EligibilityList

Returns:



48
49
50
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 48

def eligibilities
    @eligibilities ||= EligibilityList.new self
end

#porting_bulk_portabilities(sid = :unset) ⇒ Twilio::REST::Numbers::V1::PortingBulkPortabilityContext, Twilio::REST::Numbers::V1::PortingBulkPortabilityList

Parameters:

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

    A 34 character string that uniquely identifies the Portability check.

Returns:



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 55

def porting_bulk_portabilities(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end
    if sid == :unset
        @porting_bulk_portabilities ||= PortingBulkPortabilityList.new self
    else
        PortingBulkPortabilityContext.new(self, sid)
    end
end

#porting_port_ins ⇒ Twilio::REST::Numbers::V1::PortingPortInList

Returns:



67
68
69
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 67

def porting_port_ins
    @porting_port_ins ||= PortingPortInList.new self
end

#porting_port_ins_fetch(port_in_request_sid = :unset) ⇒ Twilio::REST::Numbers::V1::PortingPortInFetchContext, Twilio::REST::Numbers::V1::PortingPortInFetchList

Parameters:

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

    The SID of the Port In request. This is a unique identifier of the port in request.

Returns:



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 74

def porting_port_ins_fetch(port_in_request_sid=:unset)
    if port_in_request_sid.nil?
        raise ArgumentError, 'port_in_request_sid cannot be nil'
    end
    if port_in_request_sid == :unset
        @porting_port_ins_fetch ||= PortingPortInFetchList.new self
    else
        PortingPortInFetchContext.new(self, port_in_request_sid)
    end
end

#porting_portabilities(phone_number = :unset) ⇒ Twilio::REST::Numbers::V1::PortingPortabilityContext, Twilio::REST::Numbers::V1::PortingPortabilityList

Parameters:

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

    The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).

Returns:



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 88

def porting_portabilities(phone_number=:unset)
    if phone_number.nil?
        raise ArgumentError, 'phone_number cannot be nil'
    end
    if phone_number == :unset
        @porting_portabilities ||= PortingPortabilityList.new self
    else
        PortingPortabilityContext.new(self, phone_number)
    end
end

#to_s ⇒ Object

Provide a user friendly representation



100
101
102
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 100

def to_s
    '<Twilio::REST::Numbers::V1>';
end