Class: Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelContext::InteractionChannelInviteList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, interaction_sid: nil, channel_sid: nil) ⇒ InteractionChannelInviteList

Initialize the InteractionChannelInviteList

Parameters:

  • version (Version)

    Version that contains the resource

  • interaction_sid (String) (defaults to: nil)

    The Interaction SID for this Channel.

  • channel_sid (String) (defaults to: nil)

    The Channel SID for this Invite.


22
23
24
25
26
27
28
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 22

def initialize(version, interaction_sid: nil, channel_sid: nil)
  super(version)

  # Path Solution
  @solution = {interaction_sid: interaction_sid, channel_sid: channel_sid}
  @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels/#{@solution[:channel_sid]}/Invites"
end

Instance Method Details

#create(routing: nil) ⇒ InteractionChannelInviteInstance

Create the InteractionChannelInviteInstance

Parameters:

  • routing (Hash) (defaults to: nil)

    The Interaction's routing logic.

Returns:


34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 34

def create(routing: nil)
  data = Twilio::Values.of({'Routing' => Twilio.serialize_object(routing), })

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

  InteractionChannelInviteInstance.new(
      @version,
      payload,
      interaction_sid: @solution[:interaction_sid],
      channel_sid: @solution[:channel_sid],
  )
end

#eachObject

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


85
86
87
88
89
90
91
92
93
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 85

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

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of InteractionChannelInviteInstance


119
120
121
122
123
124
125
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 119

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

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

Lists InteractionChannelInviteInstance 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


58
59
60
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 58

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 InteractionChannelInviteInstance 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 InteractionChannelInviteInstance


102
103
104
105
106
107
108
109
110
111
112
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 102

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)

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

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

Streams InteractionChannelInviteInstance 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


73
74
75
76
77
78
79
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 73

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


129
130
131
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 129

def to_s
  '#<Twilio.FlexApi.V1.InteractionChannelInviteList>'
end