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/webhook.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/embedded_session.rb,
lib/twilio-ruby/rest/numbers/v1/porting_all_port_in.rb,
lib/twilio-ruby/rest/numbers/v1/porting_portability.rb,
lib/twilio-ruby/rest/numbers/v1/sender_id_registration.rb,
lib/twilio-ruby/rest/numbers/v1/porting_port_in_phone_number.rb,
lib/twilio-ruby/rest/numbers/v1/porting_webhook_configuration.rb,
lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb,
lib/twilio-ruby/rest/numbers/v1/porting_webhook_configuration_delete.rb

Defined Under Namespace

Classes: BulkEligibilityContext, BulkEligibilityInstance, BulkEligibilityInstanceMetadata, BulkEligibilityList, BulkEligibilityListResponse, BulkEligibilityPage, BulkEligibilityPageMetadata, EligibilityInstance, EligibilityList, EligibilityListResponse, EligibilityPage, EligibilityPageMetadata, EmbeddedSessionInstance, EmbeddedSessionList, EmbeddedSessionListResponse, EmbeddedSessionPage, EmbeddedSessionPageMetadata, PortingAllPortInInstance, PortingAllPortInList, PortingAllPortInListResponse, PortingAllPortInPage, PortingAllPortInPageMetadata, PortingPortInContext, PortingPortInInstance, PortingPortInInstanceMetadata, PortingPortInList, PortingPortInListResponse, PortingPortInPage, PortingPortInPageMetadata, PortingPortInPhoneNumberContext, PortingPortInPhoneNumberInstance, PortingPortInPhoneNumberInstanceMetadata, PortingPortInPhoneNumberList, PortingPortInPhoneNumberListResponse, PortingPortInPhoneNumberPage, PortingPortInPhoneNumberPageMetadata, PortingPortabilityContext, PortingPortabilityInstance, PortingPortabilityInstanceMetadata, PortingPortabilityList, PortingPortabilityListResponse, PortingPortabilityPage, PortingPortabilityPageMetadata, PortingWebhookConfigurationDeleteContext, PortingWebhookConfigurationDeleteInstance, PortingWebhookConfigurationDeleteInstanceMetadata, PortingWebhookConfigurationDeleteList, PortingWebhookConfigurationDeleteListResponse, PortingWebhookConfigurationDeletePage, PortingWebhookConfigurationDeletePageMetadata, PortingWebhookConfigurationInstance, PortingWebhookConfigurationList, PortingWebhookConfigurationListResponse, PortingWebhookConfigurationPage, PortingWebhookConfigurationPageMetadata, SenderIdRegistrationInstance, SenderIdRegistrationList, SenderIdRegistrationListResponse, SenderIdRegistrationPage, SenderIdRegistrationPageMetadata, SigningRequestConfigurationInstance, SigningRequestConfigurationList, SigningRequestConfigurationListResponse, SigningRequestConfigurationPage, SigningRequestConfigurationPageMetadata, WebhookInstance, WebhookList, WebhookListResponse, WebhookPage, WebhookPageMetadata

Instance Attribute Summary

Attributes inherited from Version

#domain, #version

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #create_with_metadata, #delete, #delete_with_metadata, #exception, #fetch, #fetch_with_metadata, #page, #patch, #read_limits, #relative_uri, #request, #stream, #stream_with_metadata, #update, #update_with_metadata

Constructor Details

#initialize(domain) ⇒ V1

Initialize the V1 version of Numbers



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

def initialize(domain)
    super
    @version = 'v1'
    @bulk_eligibilities = nil
    @eligibilities = nil
    @embedded_sessions = nil
    @porting_all_port_ins = nil
    @porting_port_ins = nil
    @porting_port_in_phone_number = nil
    @porting_portabilities = nil
    @porting_webhook_configurations = nil
    @porting_webhook_configurations_delete = nil
    @sender_id_registrations = nil
    @signing_request_configurations = nil
    @webhook = 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:



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 42

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:



54
55
56
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 54

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

#embedded_sessions ⇒ Twilio::REST::Numbers::V1::EmbeddedSessionList

Returns:



59
60
61
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 59

def embedded_sessions
    @embedded_sessions ||= EmbeddedSessionList.new self
end

#porting_all_port_ins ⇒ Twilio::REST::Numbers::V1::PortingAllPortInList

Returns:



64
65
66
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 64

def porting_all_port_ins
    @porting_all_port_ins ||= PortingAllPortInList.new self
end

#porting_port_in_phone_number(port_in_request_sid = :unset, phone_number_sid = :unset) ⇒ Twilio::REST::Numbers::V1::PortingPortInPhoneNumberContext, Twilio::REST::Numbers::V1::PortingPortInPhoneNumberList

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.

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

    The SID of the Phone number. This is a unique identifier of the phone number.

Returns:



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

def porting_port_in_phone_number(port_in_request_sid=:unset, phone_number_sid=:unset)
    if port_in_request_sid.nil?
        raise ArgumentError, 'port_in_request_sid cannot be nil'
    end
    if phone_number_sid.nil?
        raise ArgumentError, 'phone_number_sid cannot be nil'
    end
    if port_in_request_sid == :unset && phone_number_sid == :unset
        @porting_port_in_phone_number ||= PortingPortInPhoneNumberList.new self
    else
        PortingPortInPhoneNumberContext.new(self, port_in_request_sid, phone_number_sid)
    end
end

#porting_port_ins(port_in_request_sid = :unset) ⇒ Twilio::REST::Numbers::V1::PortingPortInContext, Twilio::REST::Numbers::V1::PortingPortInList

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:



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 71

def porting_port_ins(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 ||= PortingPortInList.new self
    else
        PortingPortInContext.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) —

    Phone number to check portability in e164 format.

Returns:



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 121

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

#porting_webhook_configurations ⇒ Twilio::REST::Numbers::V1::PortingWebhookConfigurationList

Returns:



133
134
135
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 133

def porting_webhook_configurations
    @porting_webhook_configurations ||= PortingWebhookConfigurationList.new self
end

#porting_webhook_configurations_delete(webhook_type = :unset) ⇒ Twilio::REST::Numbers::V1::PortingWebhookConfigurationDeleteContext, Twilio::REST::Numbers::V1::PortingWebhookConfigurationDeleteList

Parameters:

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

    The webhook type for the configuration to be delete. ‘PORT_IN`, `PORT_OUT`

Returns:



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 140

def porting_webhook_configurations_delete(webhook_type=:unset)
    if webhook_type.nil?
        raise ArgumentError, 'webhook_type cannot be nil'
    end
    if webhook_type == :unset
        @porting_webhook_configurations_delete ||= PortingWebhookConfigurationDeleteList.new self
    else
        PortingWebhookConfigurationDeleteContext.new(self, webhook_type)
    end
end

#sender_id_registrations ⇒ Twilio::REST::Numbers::V1::SenderIdRegistrationList

Returns:



152
153
154
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 152

def sender_id_registrations
    @sender_id_registrations ||= SenderIdRegistrationList.new self
end

#signing_request_configurations ⇒ Twilio::REST::Numbers::V1::SigningRequestConfigurationList

Returns:



157
158
159
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 157

def signing_request_configurations
    @signing_request_configurations ||= SigningRequestConfigurationList.new self
end

#to_s ⇒ Object

Provide a user friendly representation



167
168
169
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 167

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

#webhook ⇒ Twilio::REST::Numbers::V1::WebhookList

Returns:



162
163
164
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 162

def webhook
    @webhook ||= WebhookList.new self
end