Class: Twilio::REST::Voice::V1::ConnectionPolicyContext::ConnectionPolicyTargetList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, connection_policy_sid: nil) ⇒ ConnectionPolicyTargetList

Initialize the ConnectionPolicyTargetList

Parameters:

  • version (Version)

    Version that contains the resource

  • connection_policy_sid (String) (defaults to: nil)

    The SID of the Connection Policy that owns the Target.


21
22
23
24
25
26
27
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 21

def initialize(version, connection_policy_sid: nil)
  super(version)

  # Path Solution
  @solution = {connection_policy_sid: connection_policy_sid}
  @uri = "/ConnectionPolicies/#{@solution[:connection_policy_sid]}/Targets"
end

Instance Method Details

#create(target: nil, friendly_name: :unset, priority: :unset, weight: :unset, enabled: :unset) ⇒ ConnectionPolicyTargetInstance

Create the ConnectionPolicyTargetInstance

Parameters:

  • target (String) (defaults to: nil)

    The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported.

  • friendly_name (String) (defaults to: :unset)

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

  • priority (String) (defaults to: :unset)

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

  • weight (String) (defaults to: :unset)

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

  • enabled (Boolean) (defaults to: :unset)

    Whether the Target is enabled. The default is `true`.

Returns:


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 45

def create(target: nil, friendly_name: :unset, priority: :unset, weight: :unset, enabled: :unset)
  data = Twilio::Values.of({
      'Target' => target,
      'FriendlyName' => friendly_name,
      'Priority' => priority,
      'Weight' => weight,
      'Enabled' => enabled,
  })

  payload = @version.create('POST', @uri, data: data)

  ConnectionPolicyTargetInstance.new(
      @version,
      payload,
      connection_policy_sid: @solution[:connection_policy_sid],
  )
end

#eachObject

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


101
102
103
104
105
106
107
108
109
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 101

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

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of ConnectionPolicyTargetInstance


135
136
137
138
139
140
141
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 135

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

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

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

Parameters:

  • limit (Integer) (defaults to: nil)

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

  • page_size (Integer) (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)

    Array of up to limit results


74
75
76
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 74

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

Parameters:

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of ConnectionPolicyTargetInstance


118
119
120
121
122
123
124
125
126
127
128
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 118

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)

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

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

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

Parameters:

  • limit (Integer) (defaults to: nil)

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

  • page_size (Integer) (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)

    Enumerable that will yield up to limit results


89
90
91
92
93
94
95
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 89

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_sObject

Provide a user friendly representation


145
146
147
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 145

def to_s
  '#<Twilio.Voice.V1.ConnectionPolicyTargetList>'
end