twilio-ruby 5.0.0.rc18 → 5.0.0.rc19

data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb

@@ -2,7 +2,7 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /       
+#       /       /
 
 module Twilio
   module REST
@@ -17,20 +17,20 @@ module Twilio
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
-              
+
               # Path Solution
               @solution = {
                   service_sid: service_sid
               }
               @uri = "/Services/#{@solution[:service_sid]}/Channels"
             end
-            
+
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
             # @param [String] friendly_name The friendly_name
             # @param [String] unique_name The unique_name
-            # @param [Hash] attributes The attributes
+            # @param [String] attributes The attributes
             # @param [channel.ChannelType] type The type
             # @return [ChannelInstance] Newly created ChannelInstance
             def create(friendly_name: nil, unique_name: nil, attributes: nil, type: nil)
@@ -40,24 +40,25 @@ module Twilio
                   'Attributes' => attributes,
                   'Type' => type,
               }
-              
+
               payload = @version.create(
                   'POST',
                   @uri,
                   data: data
               )
-              
+
               return ChannelInstance.new(
                   @version,
                   payload,
                   service_sid: @solution[:service_sid],
               )
             end
-            
+
             ##
             # Lists ChannelInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
+            # @param [channel.ChannelType] type The type
             # @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
@@ -65,17 +66,19 @@ module Twilio
             #  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)
+            def list(type: nil, limit: nil, page_size: nil)
               self.stream(
+                  type: type,
                   limit: limit,
                   page_size: page_size
               ).entries
             end
-            
+
             ##
             # Streams ChannelInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
+            # @param [channel.ChannelType] type The type
             # @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
@@ -83,20 +86,22 @@ module Twilio
             #                       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)
+            def stream(type: nil, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
-              
+
               page = self.page(
+                  type: type,
                   page_size: limits[:page_size],
               )
-              
+
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
-            
+
             ##
             # When passed a block, yields ChannelInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
+            # @param [channel.ChannelType] type The type
             # @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
@@ -105,25 +110,27 @@ module Twilio
             #                       limit with the most efficient page size, i.e. min(limit, 1000)
             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 ChannelInstance records from the API.
             # Request is executed immediately.
+            # @param [channel.ChannelType] type The type
             # @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 ChannelInstance
-            def page(page_token: nil, page_number: nil, page_size: nil)
+            def page(type: nil, page_token: nil, page_number: nil, page_size: nil)
               params = {
+                  'Type' => type,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
@@ -135,14 +142,14 @@ module Twilio
               )
               return ChannelPage.new(@version, response, @solution)
             end
-            
+
             ##
             # Provide a user friendly representation
             def to_s
               '#<Twilio.IpMessaging.V1.ChannelList>'
             end
           end
-        
+
           class ChannelPage < Page
             ##
             # Initialize the ChannelPage
@@ -153,11 +160,11 @@ module Twilio
             # @return [ChannelPage] ChannelPage
             def initialize(version, response, solution)
               super(version, response)
-              
+
               # Path Solution
               @solution = solution
             end
-            
+
             ##
             # Build an instance of ChannelInstance
             # @param [Hash] payload Payload response from the API
@@ -169,14 +176,14 @@ module Twilio
                   service_sid: @solution[:service_sid],
               )
             end
-            
+
             ##
             # Provide a user friendly representation
             def to_s
               '<Twilio.IpMessaging.V1.ChannelPage>'
             end
           end
-        
+
           class ChannelContext < InstanceContext
             ##
             # Initialize the ChannelContext
@@ -186,31 +193,32 @@ module Twilio
             # @return [ChannelContext] ChannelContext
             def initialize(version, service_sid, sid)
               super(version)
-              
+
               # Path Solution
               @solution = {
                   service_sid: service_sid,
                   sid: sid,
               }
               @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}"
-              
+
               # Dependents
               @members = nil
               @messages = nil
+              @invites = nil
             end
-            
+
             ##
             # Fetch a ChannelInstance
             # @return [ChannelInstance] Fetched ChannelInstance
             def fetch
               params = {}
-              
+
               payload = @version.fetch(
                   'GET',
                   @uri,
                   params,
               )
-              
+
               return ChannelInstance.new(
                   @version,
                   payload,
@@ -218,35 +226,33 @@ module Twilio
                   sid: @solution[:sid],
               )
             end
-            
+
             ##
             # Deletes the ChannelInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
               return @version.delete('delete', @uri)
             end
-            
+
             ##
             # Update the ChannelInstance
             # @param [String] friendly_name The friendly_name
             # @param [String] unique_name The unique_name
-            # @param [Hash] attributes The attributes
-            # @param [channel.ChannelType] type The type
+            # @param [String] attributes The attributes
             # @return [ChannelInstance] Updated ChannelInstance
-            def update(friendly_name: nil, unique_name: nil, attributes: nil, type: nil)
+            def update(friendly_name: nil, unique_name: nil, attributes: nil)
               data = {
                   'FriendlyName' => friendly_name,
                   'UniqueName' => unique_name,
                   'Attributes' => attributes,
-                  'Type' => type,
               }
-              
+
               payload = @version.update(
                   'POST',
                   @uri,
                   data: data,
               )
-              
+
               return ChannelInstance.new(
                   @version,
                   payload,
@@ -254,7 +260,7 @@ module Twilio
                   sid: @solution[:sid],
               )
             end
-            
+
             ##
             # Access the members
             # @return [MemberList] MemberList
@@ -267,7 +273,7 @@ module Twilio
                     sid,
                 )
               end
-              
+
               unless @members
                 @members = MemberList.new(
                     @version,
@@ -275,10 +281,10 @@ module Twilio
                     channel_sid: @solution[:sid],
                 )
               end
-              
+
               @members
             end
-            
+
             ##
             # Access the messages
             # @return [MessageList] MessageList
@@ -291,7 +297,7 @@ module Twilio
                     sid,
                 )
               end
-              
+
               unless @messages
                 @messages = MessageList.new(
                     @version,
@@ -299,10 +305,34 @@ module Twilio
                     channel_sid: @solution[:sid],
                 )
               end
-              
+
               @messages
             end
-            
+
+            ##
+            # Access the invites
+            # @return [InviteList] InviteList
+            def invites(sid=:unset)
+              if sid != :unset
+                return InviteContext.new(
+                    @version,
+                    @solution[:service_sid],
+                    @solution[:sid],
+                    sid,
+                )
+              end
+
+              unless @invites
+                @invites = InviteList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    channel_sid: @solution[:sid],
+                )
+              end
+
+              @invites
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -310,7 +340,7 @@ module Twilio
               "#<Twilio.IpMessaging.V1.ChannelContext #{context}>"
             end
           end
-        
+
           class ChannelInstance < InstanceResource
             ##
             # Initialize the ChannelInstance
@@ -321,7 +351,7 @@ module Twilio
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
-              
+
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
@@ -334,10 +364,12 @@ module Twilio
                   'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
                   'created_by' => payload['created_by'],
+                  'members_count' => payload['members_count'].to_i,
+                  'messages_count' => payload['messages_count'].to_i,
                   'url' => payload['url'],
                   'links' => payload['links'],
               }
-              
+
               # Context
               @instance_context = nil
               @params = {
@@ -345,7 +377,7 @@ module Twilio
                   '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
@@ -361,99 +393,112 @@ module Twilio
               end
               @instance_context
             end
-            
+
             def sid
               @properties['sid']
             end
-            
+
             def account_sid
               @properties['account_sid']
             end
-            
+
             def service_sid
               @properties['service_sid']
             end
-            
+
             def friendly_name
               @properties['friendly_name']
             end
-            
+
             def unique_name
               @properties['unique_name']
             end
-            
+
             def attributes
               @properties['attributes']
             end
-            
+
             def type
               @properties['type']
             end
-            
+
             def date_created
               @properties['date_created']
             end
-            
+
             def date_updated
               @properties['date_updated']
             end
-            
+
             def created_by
               @properties['created_by']
             end
-            
+
+            def members_count
+              @properties['members_count']
+            end
+
+            def messages_count
+              @properties['messages_count']
+            end
+
             def url
               @properties['url']
             end
-            
+
             def links
               @properties['links']
             end
-            
+
             ##
             # Fetch a ChannelInstance
             # @return [ChannelInstance] Fetched ChannelInstance
             def fetch
               context.fetch
             end
-            
+
             ##
             # Deletes the ChannelInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
               context.delete
             end
-            
+
             ##
             # Update the ChannelInstance
             # @param [String] friendly_name The friendly_name
             # @param [String] unique_name The unique_name
-            # @param [Hash] attributes The attributes
-            # @param [channel.ChannelType] type The type
+            # @param [String] attributes The attributes
             # @return [ChannelInstance] Updated ChannelInstance
-            def update(friendly_name: nil, unique_name: nil, attributes: nil, type: nil)
+            def update(friendly_name: nil, unique_name: nil, attributes: nil)
               context.update(
                   friendly_name: friendly_name,
                   unique_name: unique_name,
                   attributes: attributes,
-                  type: type,
               )
             end
-            
+
             ##
             # Access the members
             # @return [members] members
             def members
               context.members
             end
-            
+
             ##
             # Access the messages
             # @return [messages] messages
             def messages
               context.messages
             end
-            
+
+            ##
+            # Access the invites
+            # @return [invites] invites
+            def invites
+              context.invites
+            end
+
             ##
             # Provide a user friendly representation
             def to_s