lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb in twilio-ruby-5.77.0 vs lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb in twilio-ruby-6.0.0.pre.rc.1
- old
+ new
@@ -1,408 +1,434 @@
##
-# This code was generated by
-# \ / _ _ _| _ _
-# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# This code was generated by
+# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
+# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
+# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
#
-# frozen_string_literal: true
+# Twilio - Ip_messaging
+# This is the public Twilio REST API.
+#
+# NOTE: This class is auto generated by OpenAPI Generator.
+# https://openapi-generator.tech
+# Do not edit the class manually.
+#
+
module Twilio
- module REST
- class IpMessaging < Domain
- class V1 < Version
- class ServiceContext < InstanceContext
- class ChannelContext < InstanceContext
- class MemberList < ListResource
- ##
- # Initialize the MemberList
- # @param [Version] version Version that contains the resource
- # @param [String] service_sid The service_sid
- # @param [String] channel_sid The channel_sid
- # @return [MemberList] MemberList
- def initialize(version, service_sid: nil, channel_sid: nil)
- super(version)
+ module REST
+ class IpMessaging < IpMessagingBase
+ class V1 < Version
+ class ServiceContext < InstanceContext
+ class ChannelContext < InstanceContext
- # Path Solution
- @solution = {service_sid: service_sid, channel_sid: channel_sid}
- @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members"
- end
+ class MemberList < ListResource
+ ##
+ # Initialize the MemberList
+ # @param [Version] version Version that contains the resource
+ # @return [MemberList] MemberList
+ 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]}/Members"
+
+ end
+ ##
+ # Create the MemberInstance
+ # @param [String] identity
+ # @param [String] role_sid
+ # @return [MemberInstance] Created MemberInstance
+ def create(
+ identity: nil,
+ role_sid: :unset
+ )
- ##
- # Create the MemberInstance
- # @param [String] identity The identity
- # @param [String] role_sid The role_sid
- # @return [MemberInstance] Created MemberInstance
- def create(identity: nil, role_sid: :unset)
- data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
+ data = Twilio::Values.of({
+ 'Identity' => identity,
+ 'RoleSid' => role_sid,
+ })
- payload = @version.create('POST', @uri, data: data)
+ payload = @version.create('POST', @uri, data: data)
+ MemberInstance.new(
+ @version,
+ payload,
+ service_sid: @solution[:service_sid],
+ channel_sid: @solution[:channel_sid],
+ )
+ end
- MemberInstance.new(
- @version,
- payload,
- service_sid: @solution[:service_sid],
- channel_sid: @solution[:channel_sid],
- )
- end
+
+ ##
+ # Lists MemberInstance records from the API as a list.
+ # Unlike stream(), this operation is eager and will load `limit` records into
+ # memory before returning.
+ # @param [Array[String]] identity
+ # @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 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)
+ # @return [Array] Array of up to limit results
+ def list(identity: :unset, limit: nil, page_size: nil)
+ self.stream(
+ identity: identity,
+ limit: limit,
+ page_size: page_size
+ ).entries
+ end
- ##
- # Lists MemberInstance records from the API as a list.
- # Unlike stream(), this operation is eager and will load `limit` records into
- # memory before returning.
- # @param [Array[String]] identity The identity
- # @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 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)
- # @return [Array] Array of up to limit results
- def list(identity: :unset, limit: nil, page_size: nil)
- self.stream(identity: identity, limit: limit, page_size: page_size).entries
- end
+ ##
+ # Streams Instance records from the API as an Enumerable.
+ # This operation lazily loads records as efficiently as possible until the limit
+ # is reached.
+ # @param [Array[String]] identity
+ # @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 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)
+ # @return [Enumerable] Enumerable that will yield up to limit results
+ def stream(identity: :unset, limit: nil, page_size: nil)
+ limits = @version.read_limits(limit, page_size)
- ##
- # Streams MemberInstance records from the API as an Enumerable.
- # This operation lazily loads records as efficiently as possible until the limit
- # is reached.
- # @param [Array[String]] identity The identity
- # @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 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)
- # @return [Enumerable] Enumerable that will yield up to limit results
- 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], )
- page = self.page(identity: identity, page_size: limits[:page_size], )
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+ end
- @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
- end
+ ##
+ # When passed a block, yields MemberInstance records from the API.
+ # This operation lazily loads records as efficiently as possible until the limit
+ # is reached.
+ def each
+ limits = @version.read_limits
- ##
- # When passed a block, yields MemberInstance records from the API.
- # This operation lazily loads records as efficiently as possible until the limit
- # is reached.
- def each
- limits = @version.read_limits
+ page = self.page(page_size: limits[:page_size], )
- page = self.page(page_size: limits[:page_size], )
+ @version.stream(page,
+ limit: limits[:limit],
+ page_limit: limits[:page_limit]).each {|x| yield x}
+ end
- @version.stream(page,
- limit: limits[:limit],
- page_limit: limits[:page_limit]).each {|x| yield x}
- end
+ ##
+ # Retrieve a single page of MemberInstance records from the API.
+ # Request is executed immediately.
+ # @param [Array[String]] identity
+ # @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 MemberInstance
+ def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+ params = Twilio::Values.of({
+
+ 'Identity' => Twilio.serialize_list(identity),
+
+ 'PageToken' => page_token,
+ 'Page' => page_number,
+ 'PageSize' => page_size,
+ })
- ##
- # Retrieve a single page of MemberInstance records from the API.
- # Request is executed immediately.
- # @param [Array[String]] identity The identity
- # @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 MemberInstance
- 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)
- response = @version.page('GET', @uri, params: params)
+ MemberPage.new(@version, response, @solution)
+ end
- MemberPage.new(@version, response, @solution)
- end
+ ##
+ # Retrieve a single page of MemberInstance records from the API.
+ # Request is executed immediately.
+ # @param [String] target_url API-generated URL for the requested results page
+ # @return [Page] Page of MemberInstance
+ def get_page(target_url)
+ response = @version.domain.request(
+ 'GET',
+ target_url
+ )
+ MemberPage.new(@version, response, @solution)
+ end
+
- ##
- # Retrieve a single page of MemberInstance records from the API.
- # Request is executed immediately.
- # @param [String] target_url API-generated URL for the requested results page
- # @return [Page] Page of MemberInstance
- def get_page(target_url)
- response = @version.domain.request(
- 'GET',
- target_url
- )
- MemberPage.new(@version, response, @solution)
- end
- ##
- # Provide a user friendly representation
- def to_s
- '#<Twilio.IpMessaging.V1.MemberList>'
- end
- end
+ # Provide a user friendly representation
+ def to_s
+ '#<Twilio.IpMessaging.V1.MemberList>'
+ end
+ end
- class MemberPage < Page
- ##
- # Initialize the MemberPage
- # @param [Version] version Version that contains the resource
- # @param [Response] response Response from the API
- # @param [Hash] solution Path solution for the resource
- # @return [MemberPage] MemberPage
- def initialize(version, response, solution)
- super(version, response)
- # Path Solution
- @solution = solution
- end
+ class MemberContext < InstanceContext
+ ##
+ # Initialize the MemberContext
+ # @param [Version] version Version that contains the resource
+ # @param [String] service_sid
+ # @param [String] channel_sid
+ # @param [String] sid
+ # @return [MemberContext] MemberContext
+ def initialize(version, service_sid, channel_sid, sid)
+ super(version)
- ##
- # Build an instance of MemberInstance
- # @param [Hash] payload Payload response from the API
- # @return [MemberInstance] MemberInstance
- def get_instance(payload)
- MemberInstance.new(
- @version,
- payload,
- service_sid: @solution[:service_sid],
- channel_sid: @solution[:channel_sid],
- )
- end
+ # Path Solution
+ @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid, }
+ @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members/#{@solution[:sid]}"
- ##
- # Provide a user friendly representation
- def to_s
- '<Twilio.IpMessaging.V1.MemberPage>'
- end
- end
+
+ end
+ ##
+ # Delete the MemberInstance
+ # @return [Boolean] True if delete succeeds, false otherwise
+ def delete
- class MemberContext < InstanceContext
- ##
- # Initialize the MemberContext
- # @param [Version] version Version that contains the resource
- # @param [String] service_sid The service_sid
- # @param [String] channel_sid The channel_sid
- # @param [String] sid The sid
- # @return [MemberContext] MemberContext
- def initialize(version, service_sid, channel_sid, sid)
- super(version)
+ @version.delete('DELETE', @uri)
+ end
- # Path Solution
- @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid, }
- @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members/#{@solution[:sid]}"
- end
+ ##
+ # Fetch the MemberInstance
+ # @return [MemberInstance] Fetched MemberInstance
+ def fetch
- ##
- # Fetch the MemberInstance
- # @return [MemberInstance] Fetched MemberInstance
- def fetch
- payload = @version.fetch('GET', @uri)
+ payload = @version.fetch('GET', @uri)
+ MemberInstance.new(
+ @version,
+ payload,
+ service_sid: @solution[:service_sid],
+ channel_sid: @solution[:channel_sid],
+ sid: @solution[:sid],
+ )
+ end
- MemberInstance.new(
- @version,
- payload,
- service_sid: @solution[:service_sid],
- channel_sid: @solution[:channel_sid],
- sid: @solution[:sid],
- )
- end
+ ##
+ # Update the MemberInstance
+ # @param [String] role_sid
+ # @param [String] last_consumed_message_index
+ # @return [MemberInstance] Updated MemberInstance
+ def update(
+ role_sid: :unset,
+ last_consumed_message_index: :unset
+ )
- ##
- # Delete the MemberInstance
- # @return [Boolean] true if delete succeeds, false otherwise
- def delete
- @version.delete('DELETE', @uri)
- end
+ data = Twilio::Values.of({
+ 'RoleSid' => role_sid,
+ 'LastConsumedMessageIndex' => last_consumed_message_index,
+ })
- ##
- # Update the MemberInstance
- # @param [String] role_sid The role_sid
- # @param [String] last_consumed_message_index The last_consumed_message_index
- # @return [MemberInstance] Updated MemberInstance
- def update(role_sid: :unset, last_consumed_message_index: :unset)
- data = Twilio::Values.of({
- 'RoleSid' => role_sid,
- 'LastConsumedMessageIndex' => last_consumed_message_index,
- })
+ payload = @version.update('POST', @uri, data: data)
+ MemberInstance.new(
+ @version,
+ payload,
+ service_sid: @solution[:service_sid],
+ channel_sid: @solution[:channel_sid],
+ sid: @solution[:sid],
+ )
+ end
- payload = @version.update('POST', @uri, data: data)
- MemberInstance.new(
- @version,
- payload,
- service_sid: @solution[:service_sid],
- channel_sid: @solution[:channel_sid],
- sid: @solution[:sid],
- )
- end
+ ##
+ # Provide a user friendly representation
+ def to_s
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.IpMessaging.V1.MemberContext #{context}>"
+ end
- ##
- # Provide a user friendly representation
- def to_s
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.IpMessaging.V1.MemberContext #{context}>"
- end
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.IpMessaging.V1.MemberContext #{context}>"
+ end
+ end
- ##
- # Provide a detailed, user friendly representation
- def inspect
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.IpMessaging.V1.MemberContext #{context}>"
- end
- end
+ class MemberPage < Page
+ ##
+ # Initialize the MemberPage
+ # @param [Version] version Version that contains the resource
+ # @param [Response] response Response from the API
+ # @param [Hash] solution Path solution for the resource
+ # @return [MemberPage] MemberPage
+ def initialize(version, response, solution)
+ super(version, response)
- class MemberInstance < InstanceResource
- ##
- # Initialize the MemberInstance
- # @param [Version] version Version that contains the resource
- # @param [Hash] payload payload that contains response from Twilio
- # @param [String] service_sid The service_sid
- # @param [String] channel_sid The channel_sid
- # @param [String] sid The sid
- # @return [MemberInstance] MemberInstance
- def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
- super(version)
+ # Path Solution
+ @solution = solution
+ end
- # Marshaled Properties
- @properties = {
- 'sid' => payload['sid'],
- 'account_sid' => payload['account_sid'],
- 'channel_sid' => payload['channel_sid'],
- 'service_sid' => payload['service_sid'],
- 'identity' => payload['identity'],
- 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
- 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
- 'role_sid' => payload['role_sid'],
- 'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
- 'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
- 'url' => payload['url'],
- }
+ ##
+ # Build an instance of MemberInstance
+ # @param [Hash] payload Payload response from the API
+ # @return [MemberInstance] MemberInstance
+ def get_instance(payload)
+ MemberInstance.new(@version, payload, service_sid: @solution[:service_sid], channel_sid: @solution[:channel_sid])
+ end
- # Context
- @instance_context = nil
- @params = {
- 'service_sid' => service_sid,
- 'channel_sid' => channel_sid,
- '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
- # @return [MemberContext] MemberContext for this MemberInstance
- def context
- unless @instance_context
- @instance_context = MemberContext.new(
- @version,
- @params['service_sid'],
- @params['channel_sid'],
- @params['sid'],
- )
+ ##
+ # Provide a user friendly representation
+ def to_s
+ '<Twilio.IpMessaging.V1.MemberPage>'
+ end
end
- @instance_context
- end
+ class MemberInstance < InstanceResource
+ ##
+ # Initialize the MemberInstance
+ # @param [Version] version Version that contains the resource
+ # @param [Hash] payload payload that contains response from Twilio
+ # @param [String] account_sid The SID of the
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Member
+ # resource.
+ # @param [String] sid The SID of the Call resource to fetch.
+ # @return [MemberInstance] MemberInstance
+ def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
+ super(version)
+
+ # Marshaled Properties
+ @properties = {
+ 'sid' => payload['sid'],
+ 'account_sid' => payload['account_sid'],
+ 'channel_sid' => payload['channel_sid'],
+ 'service_sid' => payload['service_sid'],
+ 'identity' => payload['identity'],
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+ 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+ 'role_sid' => payload['role_sid'],
+ 'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
+ 'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
+ 'url' => payload['url'],
+ }
- ##
- # @return [String] The sid
- def sid
- @properties['sid']
- end
+ # Context
+ @instance_context = nil
+ @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'channel_sid' => channel_sid || @properties['channel_sid'] ,'sid' => sid || @properties['sid'] , }
+ end
- ##
- # @return [String] The account_sid
- def account_sid
- @properties['account_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
+ # @return [MemberContext] CallContext for this CallInstance
+ def context
+ unless @instance_context
+ @instance_context = MemberContext.new(@version , @params['service_sid'], @params['channel_sid'], @params['sid'])
+ end
+ @instance_context
+ end
+
+ ##
+ # @return [String]
+ def sid
+ @properties['sid']
+ end
+
+ ##
+ # @return [String]
+ def account_sid
+ @properties['account_sid']
+ end
+
+ ##
+ # @return [String]
+ def channel_sid
+ @properties['channel_sid']
+ end
+
+ ##
+ # @return [String]
+ def service_sid
+ @properties['service_sid']
+ end
+
+ ##
+ # @return [String]
+ def identity
+ @properties['identity']
+ end
+
+ ##
+ # @return [Time]
+ def date_created
+ @properties['date_created']
+ end
+
+ ##
+ # @return [Time]
+ def date_updated
+ @properties['date_updated']
+ end
+
+ ##
+ # @return [String]
+ def role_sid
+ @properties['role_sid']
+ end
+
+ ##
+ # @return [String]
+ def last_consumed_message_index
+ @properties['last_consumed_message_index']
+ end
+
+ ##
+ # @return [Time]
+ def last_consumption_timestamp
+ @properties['last_consumption_timestamp']
+ end
+
+ ##
+ # @return [String]
+ def url
+ @properties['url']
+ end
+
+ ##
+ # Delete the MemberInstance
+ # @return [Boolean] True if delete succeeds, false otherwise
+ def delete
- ##
- # @return [String] The channel_sid
- def channel_sid
- @properties['channel_sid']
- end
+ context.delete
+ end
- ##
- # @return [String] The service_sid
- def service_sid
- @properties['service_sid']
- end
+ ##
+ # Fetch the MemberInstance
+ # @return [MemberInstance] Fetched MemberInstance
+ def fetch
- ##
- # @return [String] The identity
- def identity
- @properties['identity']
- end
+ context.fetch
+ end
- ##
- # @return [Time] The date_created
- def date_created
- @properties['date_created']
- end
+ ##
+ # Update the MemberInstance
+ # @param [String] role_sid
+ # @param [String] last_consumed_message_index
+ # @return [MemberInstance] Updated MemberInstance
+ def update(
+ role_sid: :unset,
+ last_consumed_message_index: :unset
+ )
- ##
- # @return [Time] The date_updated
- def date_updated
- @properties['date_updated']
- end
+ context.update(
+ role_sid: role_sid,
+ last_consumed_message_index: last_consumed_message_index,
+ )
+ end
- ##
- # @return [String] The role_sid
- def role_sid
- @properties['role_sid']
- end
+ ##
+ # Provide a user friendly representation
+ def to_s
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+ "<Twilio.IpMessaging.V1.MemberInstance #{values}>"
+ end
- ##
- # @return [String] The last_consumed_message_index
- def last_consumed_message_index
- @properties['last_consumed_message_index']
- end
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+ "<Twilio.IpMessaging.V1.MemberInstance #{values}>"
+ end
+ end
- ##
- # @return [Time] The last_consumption_timestamp
- def last_consumption_timestamp
- @properties['last_consumption_timestamp']
- end
-
- ##
- # @return [String] The url
- def url
- @properties['url']
- end
-
- ##
- # Fetch the MemberInstance
- # @return [MemberInstance] Fetched MemberInstance
- def fetch
- context.fetch
- end
-
- ##
- # Delete the MemberInstance
- # @return [Boolean] true if delete succeeds, false otherwise
- def delete
- context.delete
- end
-
- ##
- # Update the MemberInstance
- # @param [String] role_sid The role_sid
- # @param [String] last_consumed_message_index The last_consumed_message_index
- # @return [MemberInstance] Updated MemberInstance
- def update(role_sid: :unset, last_consumed_message_index: :unset)
- context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, )
- end
-
- ##
- # Provide a user friendly representation
- def to_s
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.IpMessaging.V1.MemberInstance #{values}>"
- end
-
- ##
- # Provide a detailed, user friendly representation
- def inspect
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.IpMessaging.V1.MemberInstance #{values}>"
- end
+ end
+ end
end
- end
end
- end
end
- end
-end
\ No newline at end of file
+end
+
+