Class: Twilio::REST::Trunking::V1::TrunkContext::OriginationUrlList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, trunk_sid: nil) ⇒ OriginationUrlList

Initialize the OriginationUrlList

Parameters:

  • Version that contains the resource



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 28

def initialize(version, trunk_sid: nil)
    super(version)
    # Path Solution
    @solution = { trunk_sid: trunk_sid }
    @uri = "/Trunks/#{@solution[:trunk_sid]}/OriginationUrls"
    
end

Instance Method Details

#create(weight: nil, priority: nil, enabled: nil, friendly_name: nil, sip_url: nil) ⇒ OriginationUrlInstance

Create the OriginationUrlInstance

Parameters:

  • (defaults to: nil)

    The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.

  • (defaults to: nil)

    The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.

  • (defaults to: nil)

    Whether the URL is enabled. The default is ‘true`.

  • (defaults to: nil)

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • (defaults to: nil)

    The SIP address you want Twilio to route your Origination calls to. This must be a ‘sip:` schema.

Returns:

  • Created OriginationUrlInstance



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 43

def create(
    weight: nil, 
    priority: nil, 
    enabled: nil, 
    friendly_name: nil, 
    sip_url: nil
)

    data = Twilio::Values.of({
        'Weight' => weight,
        'Priority' => priority,
        'Enabled' => enabled,
        'FriendlyName' => friendly_name,
        'SipUrl' => sip_url,
    })

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

#each ⇒ Object

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



116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 116

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 OriginationUrlInstance records from the API. Request is executed immediately.

Parameters:

  • API-generated URL for the requested results page

Returns:

  • Page of OriginationUrlInstance



153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 153

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

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

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

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • Array of up to limit results



85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 85

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

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

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

Parameters:

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of OriginationUrlInstance



133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 133

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)

    OriginationUrlPage.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.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • Enumerable that will yield up to limit results



103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 103

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



164
165
166
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 164

def to_s
    '#<Twilio.Trunking.V1.OriginationUrlList>'
end