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/sms_verification.rb,
lib/twilio-ruby/rest/numbers/v1/voice_verification.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/sms_verification_check.rb,
lib/twilio-ruby/rest/numbers/v1/voice_verification_check.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, SmsVerificationCheckInstance, SmsVerificationCheckList, SmsVerificationCheckListResponse, SmsVerificationCheckPage, SmsVerificationCheckPageMetadata, SmsVerificationInstance, SmsVerificationList, SmsVerificationListResponse, SmsVerificationPage, SmsVerificationPageMetadata, VoiceVerificationCheckInstance, VoiceVerificationCheckList, VoiceVerificationCheckListResponse, VoiceVerificationCheckPage, VoiceVerificationCheckPageMetadata, VoiceVerificationInstance, VoiceVerificationList, VoiceVerificationListResponse, VoiceVerificationPage, VoiceVerificationPageMetadata, 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
37
38
39
40
 
# 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
    @sms_verifications = nil
    @sms_verification_checks = nil
    @voice_verifications = nil
    @voice_verification_checks = 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:



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 46

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:



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

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

#embedded_sessions(bundle_sid = :unset) ⇒ Twilio::REST::Numbers::V1::EmbeddedSessionList

Parameters:

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

    The unique identifier of the registration (BU-prefixed).

Returns:



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 65

def embedded_sessions(bundle_sid=:unset)
    if bundle_sid.nil?
        raise ArgumentError, 'bundle_sid cannot be nil'
    end

    if bundle_sid == :unset
        @embedded_sessions ||= EmbeddedSessionList.new self
    else
        EmbeddedSessionList.new(self, bundle_sid: bundle_sid)
    end
end

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

Returns:



78
79
80
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 78

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:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 101

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
    elsif port_in_request_sid != :unset && phone_number_sid == :unset
        PortingPortInPhoneNumberList.new(self, port_in_request_sid: port_in_request_sid)
    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:



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

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:



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

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:



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

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:



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 162

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:



175
176
177
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 175

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

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

Returns:



180
181
182
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 180

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

#sms_verification_checks ⇒ Twilio::REST::Numbers::V1::SmsVerificationCheckList

Returns:



190
191
192
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 190

def sms_verification_checks
    @sms_verification_checks ||= SmsVerificationCheckList.new self
end

#sms_verifications ⇒ Twilio::REST::Numbers::V1::SmsVerificationList

Returns:



185
186
187
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 185

def sms_verifications
    @sms_verifications ||= SmsVerificationList.new self
end

#to_s ⇒ Object

Provide a user friendly representation



210
211
212
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 210

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

#voice_verification_checks ⇒ Twilio::REST::Numbers::V1::VoiceVerificationCheckList

Returns:



200
201
202
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 200

def voice_verification_checks
    @voice_verification_checks ||= VoiceVerificationCheckList.new self
end

#voice_verifications ⇒ Twilio::REST::Numbers::V1::VoiceVerificationList

Returns:



195
196
197
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 195

def voice_verifications
    @voice_verifications ||= VoiceVerificationList.new self
end

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

Returns:



205
206
207
 
# File 'lib/twilio-ruby/rest/numbers/v1.rb', line 205

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