twilio-ruby 5.0.0.rc20 → 5.0.0.rc21

data/lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb

@@ -0,0 +1,409 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Proxy < Version
+        class ServiceContext < InstanceContext
+          class SessionContext < InstanceContext
+            class ParticipantContext < InstanceContext
+              class MessageInteractionList < ListResource
+                ##
+                # Initialize the MessageInteractionList
+                # @param [Version] version Version that contains the resource
+                # @param [String] service_sid The unique SID identifier of the Service.
+                # @param [String] session_sid The unique SID identifier of the Session.
+                # @param [String] participant_sid The participant_sid
+                # @return [MessageInteractionList] MessageInteractionList
+                def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {
+                      service_sid: service_sid,
+                      session_sid: session_sid,
+                      participant_sid: participant_sid
+                  }
+                  @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:participant_sid]}/MessageInteractions"
+                end
+
+                ##
+                # Retrieve a single page of MessageInteractionInstance records from the API.
+                # Request is executed immediately.
+                # @param [String] body The text body of the message to send to the Participant. Up
+                #   to 1600 characters long.
+                # @param [String] media_url The public url of an image or video to send to the
+                #   Participant.
+                # @return [MessageInteractionInstance] Newly created MessageInteractionInstance
+                def create(body: nil, media_url: nil)
+                  data = {
+                      'Body' => body,
+                      'MediaUrl' => media_url,
+                  }
+
+                  payload = @version.create(
+                      'POST',
+                      @uri,
+                      data: data
+                  )
+
+                  return MessageInteractionInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      session_sid: @solution[:session_sid],
+                      participant_sid: @solution[:participant_sid],
+                  )
+                end
+
+                ##
+                # Lists MessageInteractionInstance records from the API as a list.
+                # Unlike stream(), this operation is eager and will load `limit` records into
+                # memory before returning.
+                # @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(limit: nil, page_size: nil)
+                  self.stream(
+                      limit: limit,
+                      page_size: page_size
+                  ).entries
+                end
+
+                ##
+                # Streams MessageInteractionInstance records from the API as an Enumerable.
+                # This operation lazily loads records as efficiently as possible until the limit
+                # is reached.
+                # @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(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
+
+                ##
+                # When passed a block, yields MessageInteractionInstance records from the API.
+                # This operation lazily loads records as efficiently as possible until the limit
+                # is reached.
+                # @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)
+                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 MessageInteractionInstance records from the API.
+                # Request is executed immediately.
+                # @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 MessageInteractionInstance
+                def page(page_token: nil, page_number: nil, page_size: nil)
+                  params = {
+                      'PageToken' => page_token,
+                      'Page' => page_number,
+                      'PageSize' => page_size,
+                  }
+                  response = @version.page(
+                      'GET',
+                      @uri,
+                      params
+                  )
+                  return MessageInteractionPage.new(@version, response, @solution)
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '#<Twilio.Preview.Proxy.MessageInteractionList>'
+                end
+              end
+
+              class MessageInteractionPage < Page
+                ##
+                # Initialize the MessageInteractionPage
+                # @param [Version] version Version that contains the resource
+                # @param [Response] response Response from the API
+                # @param [Hash] solution Path solution for the resource
+                # @param [String] service_sid The unique SID identifier of the Service.
+                # @param [String] session_sid The unique SID identifier of the Session.
+                # @param [String] participant_sid The participant_sid
+                # @return [MessageInteractionPage] MessageInteractionPage
+                def initialize(version, response, solution)
+                  super(version, response)
+
+                  # Path Solution
+                  @solution = solution
+                end
+
+                ##
+                # Build an instance of MessageInteractionInstance
+                # @param [Hash] payload Payload response from the API
+                # @return [MessageInteractionInstance] MessageInteractionInstance
+                def get_instance(payload)
+                  return MessageInteractionInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      session_sid: @solution[:session_sid],
+                      participant_sid: @solution[:participant_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '<Twilio.Preview.Proxy.MessageInteractionPage>'
+                end
+              end
+
+              class MessageInteractionContext < InstanceContext
+                ##
+                # Initialize the MessageInteractionContext
+                # @param [Version] version Version that contains the resource
+                # @param [String] service_sid The unique SID identifier of the Service.
+                # @param [String] session_sid The unique SID identifier of the Session.
+                # @param [String] participant_sid The unique SID identifier of the Participant.
+                # @param [String] sid A 34 character string that uniquely identifies this
+                #   Interaction.
+                # @return [MessageInteractionContext] MessageInteractionContext
+                def initialize(version, service_sid, session_sid, participant_sid, sid)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {
+                      service_sid: service_sid,
+                      session_sid: session_sid,
+                      participant_sid: participant_sid,
+                      sid: sid,
+                  }
+                  @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:participant_sid]}/MessageInteractions/#{@solution[:sid]}"
+                end
+
+                ##
+                # Fetch a MessageInteractionInstance
+                # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
+                def fetch
+                  params = {}
+
+                  payload = @version.fetch(
+                      'GET',
+                      @uri,
+                      params,
+                  )
+
+                  return MessageInteractionInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      session_sid: @solution[:session_sid],
+                      participant_sid: @solution[:participant_sid],
+                      sid: @solution[:sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Preview.Proxy.MessageInteractionContext #{context}>"
+                end
+              end
+
+              class MessageInteractionInstance < InstanceResource
+                ##
+                # Initialize the MessageInteractionInstance
+                # @param [Version] version Version that contains the resource
+                # @param [Hash] payload payload that contains response from Twilio
+                # @param [String] service_sid The unique SID identifier of the Service.
+                # @param [String] session_sid The unique SID identifier of the Session.
+                # @param [String] participant_sid The participant_sid
+                # @param [String] sid A 34 character string that uniquely identifies this
+                #   Interaction.
+                # @return [MessageInteractionInstance] MessageInteractionInstance
+                def initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil)
+                  super(version)
+
+                  # Marshaled Properties
+                  @properties = {
+                      'sid' => payload['sid'],
+                      'session_sid' => payload['session_sid'],
+                      'service_sid' => payload['service_sid'],
+                      'account_sid' => payload['account_sid'],
+                      'data' => payload['data'],
+                      'status' => payload['status'],
+                      'participant_sid' => payload['participant_sid'],
+                      'inbound_participant_sid' => payload['inbound_participant_sid'],
+                      'inbound_resource_sid' => payload['inbound_resource_sid'],
+                      'inbound_resource_status' => payload['inbound_resource_status'],
+                      'inbound_resource_type' => payload['inbound_resource_type'],
+                      'inbound_resource_url' => payload['inbound_resource_url'],
+                      'outbound_participant_sid' => payload['outbound_participant_sid'],
+                      'outbound_resource_sid' => payload['outbound_resource_sid'],
+                      'outbound_resource_status' => payload['outbound_resource_status'],
+                      'outbound_resource_type' => payload['outbound_resource_type'],
+                      'outbound_resource_url' => payload['outbound_resource_url'],
+                      'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                      'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                      'url' => payload['url'],
+                  }
+
+                  # Context
+                  @instance_context = nil
+                  @params = {
+                      'service_sid' => service_sid,
+                      'session_sid' => session_sid,
+                      'participant_sid' => participant_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
+                # @param [Version] version Version that contains the resource
+                # @return [MessageInteractionContext] MessageInteractionContext for this MessageInteractionInstance
+                def context
+                  unless @instance_context
+                    @instance_context = MessageInteractionContext.new(
+                        @version,
+                        @params['service_sid'],
+                        @params['session_sid'],
+                        @params['participant_sid'],
+                        @params['sid'],
+                    )
+                  end
+                  @instance_context
+                end
+
+                def sid
+                  @properties['sid']
+                end
+
+                def session_sid
+                  @properties['session_sid']
+                end
+
+                def service_sid
+                  @properties['service_sid']
+                end
+
+                def account_sid
+                  @properties['account_sid']
+                end
+
+                def data
+                  @properties['data']
+                end
+
+                def status
+                  @properties['status']
+                end
+
+                def participant_sid
+                  @properties['participant_sid']
+                end
+
+                def inbound_participant_sid
+                  @properties['inbound_participant_sid']
+                end
+
+                def inbound_resource_sid
+                  @properties['inbound_resource_sid']
+                end
+
+                def inbound_resource_status
+                  @properties['inbound_resource_status']
+                end
+
+                def inbound_resource_type
+                  @properties['inbound_resource_type']
+                end
+
+                def inbound_resource_url
+                  @properties['inbound_resource_url']
+                end
+
+                def outbound_participant_sid
+                  @properties['outbound_participant_sid']
+                end
+
+                def outbound_resource_sid
+                  @properties['outbound_resource_sid']
+                end
+
+                def outbound_resource_status
+                  @properties['outbound_resource_status']
+                end
+
+                def outbound_resource_type
+                  @properties['outbound_resource_type']
+                end
+
+                def outbound_resource_url
+                  @properties['outbound_resource_url']
+                end
+
+                def date_created
+                  @properties['date_created']
+                end
+
+                def date_updated
+                  @properties['date_updated']
+                end
+
+                def url
+                  @properties['url']
+                end
+
+                ##
+                # Fetch a MessageInteractionInstance
+                # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
+                def fetch
+                  context.fetch
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                  "<Twilio.Preview.Proxy.MessageInteractionInstance #{values}>"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb

@@ -0,0 +1,479 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Proxy < Version
+        class ServiceContext < InstanceContext
+          class SessionContext < InstanceContext
+            class ParticipantList < ListResource
+              ##
+              # Initialize the ParticipantList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The unique SID identifier of the Service.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @return [ParticipantList] ParticipantList
+              def initialize(version, service_sid: nil, session_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    session_sid: session_sid
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants"
+              end
+
+              ##
+              # Lists ParticipantInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @param [String] identifier The Participant's contact identifier, normally a
+              #   phone number.
+              # @param [participant.ParticipantType] participant_type The Type of this
+              #   Participant. One of `sms`, `voice` or `phone`.
+              # @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(identifier: nil, participant_type: nil, limit: nil, page_size: nil)
+                self.stream(
+                    identifier: identifier,
+                    participant_type: participant_type,
+                    limit: limit,
+                    page_size: page_size
+                ).entries
+              end
+
+              ##
+              # Streams ParticipantInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [String] identifier The Participant's contact identifier, normally a
+              #   phone number.
+              # @param [participant.ParticipantType] participant_type The Type of this
+              #   Participant. One of `sms`, `voice` or `phone`.
+              # @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(identifier: nil, participant_type: nil, limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(
+                    identifier: identifier,
+                    participant_type: participant_type,
+                    page_size: limits[:page_size],
+                )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields ParticipantInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [String] identifier The Participant's contact identifier, normally a
+              #   phone number.
+              # @param [participant.ParticipantType] participant_type The Type of this
+              #   Participant. One of `sms`, `voice` or `phone`.
+              # @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)
+              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 ParticipantInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] identifier The Participant's contact identifier, normally a
+              #   phone number.
+              # @param [participant.ParticipantType] participant_type The Type of this
+              #   Participant. One of `sms`, `voice` or `phone`.
+              # @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 ParticipantInstance
+              def page(identifier: nil, participant_type: nil, page_token: nil, page_number: nil, page_size: nil)
+                params = {
+                    'Identifier' => identifier,
+                    'ParticipantType' => participant_type,
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                }
+                response = @version.page(
+                    'GET',
+                    @uri,
+                    params
+                )
+                return ParticipantPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of ParticipantInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] identifier The Participant's contact identifier, normally a
+              #   phone number.
+              # @param [String] friendly_name A human readable description of this resource, up
+              #   to 64 characters.
+              # @param [participant.ParticipantType] participant_type The Type of this
+              #   Participant. One of `sms`, `voice` or `phone`.
+              # @return [ParticipantInstance] Newly created ParticipantInstance
+              def create(identifier: nil, friendly_name: nil, participant_type: nil)
+                data = {
+                    'Identifier' => identifier,
+                    'FriendlyName' => friendly_name,
+                    'ParticipantType' => participant_type,
+                }
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                return ParticipantInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    session_sid: @solution[:session_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Preview.Proxy.ParticipantList>'
+              end
+            end
+
+            class ParticipantPage < Page
+              ##
+              # Initialize the ParticipantPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @param [String] service_sid The unique SID identifier of the Service.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @return [ParticipantPage] ParticipantPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of ParticipantInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [ParticipantInstance] ParticipantInstance
+              def get_instance(payload)
+                return ParticipantInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    session_sid: @solution[:session_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Preview.Proxy.ParticipantPage>'
+              end
+            end
+
+            class ParticipantContext < InstanceContext
+              ##
+              # Initialize the ParticipantContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The unique SID identifier of the Service.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   Participant.
+              # @return [ParticipantContext] ParticipantContext
+              def initialize(version, service_sid, session_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    session_sid: session_sid,
+                    sid: sid,
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:sid]}"
+
+                # Dependents
+                @message_interactions = nil
+              end
+
+              ##
+              # Fetch a ParticipantInstance
+              # @return [ParticipantInstance] Fetched ParticipantInstance
+              def fetch
+                params = {}
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                return ParticipantInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    session_sid: @solution[:session_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Deletes the ParticipantInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                return @version.delete('delete', @uri)
+              end
+
+              ##
+              # Update the ParticipantInstance
+              # @param [participant.ParticipantType] participant_type The Type of this
+              #   Participant. One of `sms`, `voice` or `phone`.
+              # @param [String] identifier The Participant's contact identifier, normally a
+              #   phone number.
+              # @param [String] friendly_name A human readable description of this resource, up
+              #   to 64 characters.
+              # @return [ParticipantInstance] Updated ParticipantInstance
+              def update(participant_type: nil, identifier: nil, friendly_name: nil)
+                data = {
+                    'ParticipantType' => participant_type,
+                    'Identifier' => identifier,
+                    'FriendlyName' => friendly_name,
+                }
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                return ParticipantInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    session_sid: @solution[:session_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Access the message_interactions
+              # @return [MessageInteractionList] MessageInteractionList
+              def message_interactions(sid=:unset)
+                if sid != :unset
+                  return MessageInteractionContext.new(
+                      @version,
+                      @solution[:service_sid],
+                      @solution[:session_sid],
+                      @solution[:sid],
+                      sid,
+                  )
+                end
+
+                unless @message_interactions
+                  @message_interactions = MessageInteractionList.new(
+                      @version,
+                      service_sid: @solution[:service_sid],
+                      session_sid: @solution[:session_sid],
+                      participant_sid: @solution[:sid],
+                  )
+                end
+
+                @message_interactions
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.Proxy.ParticipantContext #{context}>"
+              end
+            end
+
+            class ParticipantInstance < InstanceResource
+              ##
+              # Initialize the ParticipantInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] service_sid The unique SID identifier of the Service.
+              # @param [String] session_sid The unique SID identifier of the Session.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   Participant.
+              # @return [ParticipantInstance] ParticipantInstance
+              def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'session_sid' => payload['session_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'account_sid' => payload['account_sid'],
+                    'friendly_name' => payload['friendly_name'],
+                    'participant_type' => payload['participant_type'],
+                    'identifier' => payload['identifier'],
+                    'proxy_identifier' => payload['proxy_identifier'],
+                    'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                    'url' => payload['url'],
+                    'links' => payload['links'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {
+                    'service_sid' => service_sid,
+                    'session_sid' => session_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
+              # @param [Version] version Version that contains the resource
+              # @return [ParticipantContext] ParticipantContext for this ParticipantInstance
+              def context
+                unless @instance_context
+                  @instance_context = ParticipantContext.new(
+                      @version,
+                      @params['service_sid'],
+                      @params['session_sid'],
+                      @params['sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              def sid
+                @properties['sid']
+              end
+
+              def session_sid
+                @properties['session_sid']
+              end
+
+              def service_sid
+                @properties['service_sid']
+              end
+
+              def account_sid
+                @properties['account_sid']
+              end
+
+              def friendly_name
+                @properties['friendly_name']
+              end
+
+              def participant_type
+                @properties['participant_type']
+              end
+
+              def identifier
+                @properties['identifier']
+              end
+
+              def proxy_identifier
+                @properties['proxy_identifier']
+              end
+
+              def date_created
+                @properties['date_created']
+              end
+
+              def date_updated
+                @properties['date_updated']
+              end
+
+              def url
+                @properties['url']
+              end
+
+              def links
+                @properties['links']
+              end
+
+              ##
+              # Fetch a ParticipantInstance
+              # @return [ParticipantInstance] Fetched ParticipantInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Deletes the ParticipantInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Update the ParticipantInstance
+              # @param [participant.ParticipantType] participant_type The Type of this
+              #   Participant. One of `sms`, `voice` or `phone`.
+              # @param [String] identifier The Participant's contact identifier, normally a
+              #   phone number.
+              # @param [String] friendly_name A human readable description of this resource, up
+              #   to 64 characters.
+              # @return [ParticipantInstance] Updated ParticipantInstance
+              def update(participant_type: nil, identifier: nil, friendly_name: nil)
+                context.update(
+                    participant_type: participant_type,
+                    identifier: identifier,
+                    friendly_name: friendly_name,
+                )
+              end
+
+              ##
+              # Access the message_interactions
+              # @return [message_interactions] message_interactions
+              def message_interactions
+                context.message_interactions
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Preview.Proxy.ParticipantInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end