Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::InviteList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, channel_sid: nil) ⇒ InviteList

Initialize the InviteList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the Service the Invite resource is associated with.

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

    The SID of the Channel the Invite resource belongs to.


26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 26

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

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

Instance Method Details

#create(identity: nil, role_sid: :unset) ⇒ InviteInstance

Create the InviteInstance

Parameters:

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

    The `identity` value that uniquely identifies the new resource's User within the Service. See access tokens for more info.

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

    The SID of the Role assigned to the new member.

Returns:


44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 44

def create(identity: nil, role_sid: :unset)
  data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })

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

  InviteInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      channel_sid: @solution[:channel_sid],
  )
end

#each ⇒ Object

When passed a block, yields InviteInstance 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/chat/v2/service/channel/invite.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 InviteInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of InviteInstance


142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 142

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

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

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

Parameters:

  • identity (Array[String]) (defaults to: :unset) —

    The User[https://www.twilio.com/docs/chat/rest/user-resource]‘s `identity` value of the resources to read. See access tokens for more details.

  • 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


72
73
74
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 72

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

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

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

Parameters:

  • identity (Array[String]) (defaults to: :unset) —

    The User[https://www.twilio.com/docs/chat/rest/user-resource]‘s `identity` value of the resources to read. See access tokens for more details.

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


124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 124

def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Identity' => Twilio.serialize_list(identity) { |e| e },
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

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

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

Parameters:

  • identity (Array[String]) (defaults to: :unset) —

    The User[https://www.twilio.com/docs/chat/rest/user-resource]‘s `identity` value of the resources to read. See access tokens for more details.

  • 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


91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 91

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

  page = self.page(identity: identity, 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/chat/v2/service/channel/invite.rb', line 152

def to_s
  '#<Twilio.Chat.V2.InviteList>'
end