## # This code was generated by # ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ # | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ # | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ # # Twilio - Trunking # This is the public Twilio REST API. # # NOTE: This class is auto generated by OpenAPI Generator. # https://openapi-generator.tech # Do not edit the class manually. # module Twilio module REST class Trunking < TrunkingBase class V1 < Version class TrunkContext < InstanceContext class OriginationUrlList < ListResource ## # Initialize the OriginationUrlList # @param [Version] version Version that contains the resource # @return [OriginationUrlList] OriginationUrlList def initialize(version, trunk_sid: nil) super(version) # Path Solution @solution = { trunk_sid: trunk_sid } @uri = "/Trunks/#{@solution[:trunk_sid]}/OriginationUrls" end ## # Create the OriginationUrlInstance # @param [String] weight 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. # @param [String] priority 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. # @param [Boolean] enabled Whether the URL is enabled. The default is `true`. # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long. # @param [String] sip_url The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. # @return [OriginationUrlInstance] Created OriginationUrlInstance 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, }) payload = @version.create('POST', @uri, data: data) OriginationUrlInstance.new( @version, payload, trunk_sid: @solution[:trunk_sid], ) end ## # Lists OriginationUrlInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size 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) # @return [Array] Array of up to limit results def list(limit: nil, page_size: nil) self.stream( limit: limit, page_size: page_size ).entries end ## # Streams Instance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size 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) # @return [Enumerable] Enumerable that will yield up to limit results 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 ## # When passed a block, yields OriginationUrlInstance records from the API. # This operation lazily loads records as efficiently as possible until the limit # is reached. 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 ## # Retrieve a single page of OriginationUrlInstance records from the API. # Request is executed immediately. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 # @return [Page] Page of OriginationUrlInstance def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) OriginationUrlPage.new(@version, response, @solution) end ## # Retrieve a single page of OriginationUrlInstance records from the API. # Request is executed immediately. # @param [String] target_url API-generated URL for the requested results page # @return [Page] Page of OriginationUrlInstance def get_page(target_url) response = @version.domain.request( 'GET', target_url ) OriginationUrlPage.new(@version, response, @solution) end # Provide a user friendly representation def to_s '#' end end class OriginationUrlContext < InstanceContext ## # Initialize the OriginationUrlContext # @param [Version] version Version that contains the resource # @param [String] trunk_sid The SID of the Trunk from which to update the OriginationUrl. # @param [String] sid The unique string that we created to identify the OriginationUrl resource to update. # @return [OriginationUrlContext] OriginationUrlContext def initialize(version, trunk_sid, sid) super(version) # Path Solution @solution = { trunk_sid: trunk_sid, sid: sid, } @uri = "/Trunks/#{@solution[:trunk_sid]}/OriginationUrls/#{@solution[:sid]}" end ## # Delete the OriginationUrlInstance # @return [Boolean] True if delete succeeds, false otherwise def delete @version.delete('DELETE', @uri) end ## # Fetch the OriginationUrlInstance # @return [OriginationUrlInstance] Fetched OriginationUrlInstance def fetch payload = @version.fetch('GET', @uri) OriginationUrlInstance.new( @version, payload, trunk_sid: @solution[:trunk_sid], sid: @solution[:sid], ) end ## # Update the OriginationUrlInstance # @param [String] weight 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. # @param [String] priority 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. # @param [Boolean] enabled Whether the URL is enabled. The default is `true`. # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long. # @param [String] sip_url The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported. # @return [OriginationUrlInstance] Updated OriginationUrlInstance def update( weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset ) data = Twilio::Values.of({ 'Weight' => weight, 'Priority' => priority, 'Enabled' => enabled, 'FriendlyName' => friendly_name, 'SipUrl' => sip_url, }) payload = @version.update('POST', @uri, data: data) OriginationUrlInstance.new( @version, payload, trunk_sid: @solution[:trunk_sid], sid: @solution[:sid], ) end ## # Provide a user friendly representation def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end ## # Provide a detailed, user friendly representation def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end end class OriginationUrlPage < Page ## # Initialize the OriginationUrlPage # @param [Version] version Version that contains the resource # @param [Response] response Response from the API # @param [Hash] solution Path solution for the resource # @return [OriginationUrlPage] OriginationUrlPage def initialize(version, response, solution) super(version, response) # Path Solution @solution = solution end ## # Build an instance of OriginationUrlInstance # @param [Hash] payload Payload response from the API # @return [OriginationUrlInstance] OriginationUrlInstance def get_instance(payload) OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid]) end ## # Provide a user friendly representation def to_s '' end end class OriginationUrlInstance < InstanceResource ## # Initialize the OriginationUrlInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio # @param [String] account_sid The SID of the # {Account}[https://www.twilio.com/docs/iam/api/account] that created this OriginationUrl # resource. # @param [String] sid The SID of the Call resource to fetch. # @return [OriginationUrlInstance] OriginationUrlInstance def initialize(version, payload , trunk_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'sid' => payload['sid'], 'trunk_sid' => payload['trunk_sid'], 'weight' => payload['weight'] == nil ? payload['weight'] : payload['weight'].to_i, 'enabled' => payload['enabled'], 'sip_url' => payload['sip_url'], 'friendly_name' => payload['friendly_name'], 'priority' => payload['priority'] == nil ? payload['priority'] : payload['priority'].to_i, 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'url' => payload['url'], } # Context @instance_context = nil @params = { 'trunk_sid' => trunk_sid || @properties['trunk_sid'] ,'sid' => sid || @properties['sid'] , } end ## # Generate an instance context for the instance, the context is capable of # performing various actions. All instance actions are proxied to the context # @return [OriginationUrlContext] CallContext for this CallInstance def context unless @instance_context @instance_context = OriginationUrlContext.new(@version , @params['trunk_sid'], @params['sid']) end @instance_context end ## # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OriginationUrl resource. def account_sid @properties['account_sid'] end ## # @return [String] The unique string that we created to identify the OriginationUrl resource. def sid @properties['sid'] end ## # @return [String] The SID of the Trunk that owns the Origination URL. def trunk_sid @properties['trunk_sid'] end ## # @return [String] 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. def weight @properties['weight'] end ## # @return [Boolean] Whether the URL is enabled. The default is `true`. def enabled @properties['enabled'] end ## # @return [String] The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. def sip_url @properties['sip_url'] end ## # @return [String] The string that you assigned to describe the resource. def friendly_name @properties['friendly_name'] end ## # @return [String] 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. def priority @properties['priority'] end ## # @return [Time] The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. def date_created @properties['date_created'] end ## # @return [Time] The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. def date_updated @properties['date_updated'] end ## # @return [String] The absolute URL of the resource. def url @properties['url'] end ## # Delete the OriginationUrlInstance # @return [Boolean] True if delete succeeds, false otherwise def delete context.delete end ## # Fetch the OriginationUrlInstance # @return [OriginationUrlInstance] Fetched OriginationUrlInstance def fetch context.fetch end ## # Update the OriginationUrlInstance # @param [String] weight 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. # @param [String] priority 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. # @param [Boolean] enabled Whether the URL is enabled. The default is `true`. # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long. # @param [String] sip_url The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported. # @return [OriginationUrlInstance] Updated OriginationUrlInstance def update( weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset ) context.update( weight: weight, priority: priority, enabled: enabled, friendly_name: friendly_name, sip_url: sip_url, ) end ## # Provide a user friendly representation def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "" end ## # Provide a detailed, user friendly representation def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "" end end end end end end end