lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb in twilio-ruby-5.25.4 vs lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb in twilio-ruby-5.26.0
- old
+ new
@@ -15,14 +15,15 @@
class InviteList < ListResource
##
# Initialize the InviteList
# @param [Version] version Version that contains the resource
# @param [String] service_sid The SID of the
- # [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+ # [Service](https://www.twilio.com/docs/chat/rest/services) the Invite resource is
# associated with.
# @param [String] channel_sid The SID of the
- # [Channel](https://www.twilio.com/docs/chat/channels) the resource belongs to.
+ # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs
+ # to.
# @return [InviteList] InviteList
def initialize(version, service_sid: nil, channel_sid: nil)
super(version)
# Path Solution
@@ -196,17 +197,17 @@
class InviteContext < InstanceContext
##
# Initialize the InviteContext
# @param [Version] version Version that contains the resource
# @param [String] service_sid The SID of the
- # [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the resource
- # from.
+ # [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the Invite
+ # resource from.
# @param [String] channel_sid The SID of the
- # [Channel](https://www.twilio.com/docs/chat/channels) the resource to fetch
- # belongs to.
- # @param [String] sid The Twilio-provided string that uniquely identifies the
- # Invite resource to fetch.
+ # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to
+ # fetch belongs to. This value can be the Channel resource's `sid` or
+ # `unique_name`.
+ # @param [String] sid The SID of the Invite resource to fetch.
# @return [InviteContext] InviteContext
def initialize(version, service_sid, channel_sid, sid)
super(version)
# Path Solution
@@ -235,11 +236,11 @@
)
end
##
# Deletes the InviteInstance
- # @return [Boolean] true if delete succeeds, true otherwise
+ # @return [Boolean] true if delete succeeds, false otherwise
def delete
@version.delete('delete', @uri)
end
##
@@ -261,16 +262,16 @@
##
# Initialize the InviteInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] service_sid The SID of the
- # [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+ # [Service](https://www.twilio.com/docs/chat/rest/services) the Invite resource is
# associated with.
# @param [String] channel_sid The SID of the
- # [Channel](https://www.twilio.com/docs/chat/channels) the resource belongs to.
- # @param [String] sid The Twilio-provided string that uniquely identifies the
- # Invite resource to fetch.
+ # [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs
+ # to.
+ # @param [String] sid The SID of the Invite resource to fetch.
# @return [InviteInstance] InviteInstance
def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
super(version)
# Marshaled Properties
@@ -341,17 +342,17 @@
def identity
@properties['identity']
end
##
- # @return [Time] The RFC 2822 date and time in GMT when the resource was created
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
def date_created
@properties['date_created']
end
##
- # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
def date_updated
@properties['date_updated']
end
##
@@ -379,10 +380,10 @@
context.fetch
end
##
# Deletes the InviteInstance
- # @return [Boolean] true if delete succeeds, true otherwise
+ # @return [Boolean] true if delete succeeds, false otherwise
def delete
context.delete
end
##
\ No newline at end of file