Class: Twilio::REST::Trusthub::V1::CustomerProfilesContext::CustomerProfilesChannelEndpointAssignmentList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, customer_profile_sid: nil) ⇒ CustomerProfilesChannelEndpointAssignmentList

Initialize the CustomerProfilesChannelEndpointAssignmentList

Parameters:

  • version (Version) —

    Version that contains the resource

  • customer_profile_sid (String) (defaults to: nil) —

    The unique string that we created to identify the CustomerProfile resource.


21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 21

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

  # Path Solution
  @solution = {customer_profile_sid: customer_profile_sid}
  @uri = "/CustomerProfiles/#{@solution[:customer_profile_sid]}/ChannelEndpointAssignments"
end

Instance Method Details

#create(channel_endpoint_type: nil, channel_endpoint_sid: nil) ⇒ CustomerProfilesChannelEndpointAssignmentInstance

Create the CustomerProfilesChannelEndpointAssignmentInstance

Parameters:

  • channel_endpoint_type (String) (defaults to: nil) —

    The type of channel endpoint. eg: phone-number

  • channel_endpoint_sid (String) (defaults to: nil) —

    The SID of an channel endpoint

Returns:


35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 35

def create(channel_endpoint_type: nil, channel_endpoint_sid: nil)
  data = Twilio::Values.of({
      'ChannelEndpointType' => channel_endpoint_type,
      'ChannelEndpointSid' => channel_endpoint_sid,
  })

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

  CustomerProfilesChannelEndpointAssignmentInstance.new(
      @version,
      payload,
      customer_profile_sid: @solution[:customer_profile_sid],
  )
end

#each ⇒ Object

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


103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 103

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CustomerProfilesChannelEndpointAssignmentInstance


142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 142

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

#list(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    The SID of an channel endpoint

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

    comma separated list of channel endpoint sids

  • 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


64
65
66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 64

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

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

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

Parameters:

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

    The SID of an channel endpoint

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

    comma separated list of channel endpoint sids

  • 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 CustomerProfilesChannelEndpointAssignmentInstance


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 123

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

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

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

#stream(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The SID of an channel endpoint

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

    comma separated list of channel endpoint sids

  • 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


87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 87

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

  page = self.page(
      channel_endpoint_sid: channel_endpoint_sid,
      channel_endpoint_sids: channel_endpoint_sids,
      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


152
153
154
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb', line 152

def to_s
  '#<Twilio.Trusthub.V1.CustomerProfilesChannelEndpointAssignmentList>'
end