Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ DomainList

Initialize the DomainList



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 29

def initialize(version, account_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { account_sid:  }
    @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains.json"
    
end

Instance Method Details

#create(domain_name: nil, friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset) ⇒ DomainInstance

Create the DomainInstance



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 53

def create(
    domain_name: nil, 
    friendly_name: :unset, 
    voice_url: :unset, 
    voice_method: :unset, 
    voice_fallback_url: :unset, 
    voice_fallback_method: :unset, 
    voice_status_callback_url: :unset, 
    voice_status_callback_method: :unset, 
    sip_registration: :unset, 
    emergency_calling_enabled: :unset, 
    secure: :unset, 
    byoc_trunk_sid: :unset, 
    emergency_caller_sid: :unset
)

    data = Twilio::Values.of({
        'DomainName' => domain_name,
        'FriendlyName' => friendly_name,
        'VoiceUrl' => voice_url,
        'VoiceMethod' => voice_method,
        'VoiceFallbackUrl' => voice_fallback_url,
        'VoiceFallbackMethod' => voice_fallback_method,
        'VoiceStatusCallbackUrl' => voice_status_callback_url,
        'VoiceStatusCallbackMethod' => voice_status_callback_method,
        'SipRegistration' => sip_registration,
        'EmergencyCallingEnabled' => emergency_calling_enabled,
        'Secure' => secure,
        'ByocTrunkSid' => byoc_trunk_sid,
        'EmergencyCallerSid' => emergency_caller_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    DomainInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
    )
end

#create_with_metadata(domain_name: nil, friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset) ⇒ DomainInstance

Create the DomainInstanceMetadata



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 115

def create_with_metadata(
  domain_name: nil, 
  friendly_name: :unset, 
  voice_url: :unset, 
  voice_method: :unset, 
  voice_fallback_url: :unset, 
  voice_fallback_method: :unset, 
  voice_status_callback_url: :unset, 
  voice_status_callback_method: :unset, 
  sip_registration: :unset, 
  emergency_calling_enabled: :unset, 
  secure: :unset, 
  byoc_trunk_sid: :unset, 
  emergency_caller_sid: :unset
)

    data = Twilio::Values.of({
        'DomainName' => domain_name,
        'FriendlyName' => friendly_name,
        'VoiceUrl' => voice_url,
        'VoiceMethod' => voice_method,
        'VoiceFallbackUrl' => voice_fallback_url,
        'VoiceFallbackMethod' => voice_fallback_method,
        'VoiceStatusCallbackUrl' => voice_status_callback_url,
        'VoiceStatusCallbackMethod' => voice_status_callback_method,
        'SipRegistration' => sip_registration,
        'EmergencyCallingEnabled' => emergency_calling_enabled,
        'Secure' => secure,
        'ByocTrunkSid' => byoc_trunk_sid,
        'EmergencyCallerSid' => emergency_caller_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    domain_instance = DomainInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
    )
    DomainInstanceMetadata.new(
        @version,
        domain_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields DomainInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



232
233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 232

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of DomainInstance records from the API. Request is executed immediately.



269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 269

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
DomainPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists DomainInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.



179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 179

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(limit: nil, page_size: nil) ⇒ Array

Lists DomainPageMetadata records from the API as a list.



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 215

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    DomainPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of DomainInstance records from the API. Request is executed immediately.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 249

def page(page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    DomainPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 197

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



280
281
282
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 280

def to_s
    '#<Twilio.Api.V2010.DomainList>'
end