twilio-ruby 5.56.0 → 5.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80e6c32f919f1a2514aafbbb28a11b07f6099e9ffeca5f95dde586e2a717712d
-  data.tar.gz: '09a90113868ce5fc759734f819b76040c96da3c237657a5159912ecc4bd7a871'
+  metadata.gz: 90245670a85b148807ee4a2be28da950b65530413eef56cf403e16708222a5d4
+  data.tar.gz: e279a65d127e4b629c904a9de0081c03effd7fa76ec73aa945bb52a8f4d32806
 SHA512:
-  metadata.gz: 456c8ac1a992f24200563b2c754b6b9f9259287b4e4042550420218b18850de8c0a6e1c875c83e3e00b1e487f42c0b9c22a36060f95729a390b957cf34171319
-  data.tar.gz: dfb91366c5e2db2c817db0a782ec67c5290892daa430c0f32279ba7b7a8ae5e25fac42f9801952845d47c026603b1a95f29f5312637e283cb957bfb671dcd4cc
+  metadata.gz: f4cf12efd6b9c6b1a8dd4d3239c369e1592cb920e1c2c68451e5e835dcb43a1aa2d914b2fc6eaadd4daa65c09c980278d2fa6fd09723db8ecede21023bc38108
+  data.tar.gz: f92a04a5901154ccdb52b8a79dce167019b61177e90cc050774a2f1bfcb6a3b466b73fe92639363bdc43a697845423fd9d4d00e9ff1cad9fe34c9ae27329c831

data/.gitignore

@@ -12,3 +12,5 @@ bin
 docs/_build
 *.bak
 *.iml
+
+coverage

data/.travis.yml

@@ -3,23 +3,35 @@ cache: bundler
 bundler_args: "--without development"
 rvm:
 - ruby-head
-- 3.0
-- 2.7
-- 2.6
-- 2.5
-- 2.4
 - jruby-9.2
+- 2.4
+- 2.5
+- 2.6
+- 2.7
+- 3.0
 services:
 - docker
 install: make install
-script: make test
+script:
+- make test
+- if [[ "$TRAVIS_BRANCH" == "main"  ||  "$TRAVIS_BRANCH" == "travis" ]] && [ "$TRAVIS_PULL_REQUEST"
+  == "false" ]; then echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}"
+  --password-stdin; fi
 matrix:
+  include:
+    - language: ruby
+      rvm: '3.0'
+      # The below workaround is necessary because of the branch coverage inclusion in simplecov 0.18+
+      # more discussion here - https://community.sonarsource.com/t/ruby-coverage-simplecov-json-file-does-not-work/20909/7
+      after_success:
+        - ruby -rjson -e 'sqube = JSON.load(File.read("coverage/.resultset.json"))["RSpec"]["coverage"].transform_values {|lines| lines["lines"]}; total = { "RSpec" => { "coverage" => sqube, "timestamp" => Time.now.to_i }}; puts JSON.dump(total)' > coverage/.resultset.sonarqube.json
+        - sonar-scanner
   allow_failures:
   - rvm: ruby-head
   fast_finish: true
 deploy:
 - provider: script
-  script: echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin && make docker-build && make docker-push
+  script: make docker-build && make docker-push
   skip_cleanup: true
   on:
     tags: true
@@ -37,3 +49,8 @@ notifications:
     on_failure: change
     rooms:
       secure: HG7rC5VSDOZiLCkpTsC4ZImh1k59OPi6YEjYKhdGXItybLHa6Yh5C42WvSx3kVW3SeyLOm1CiaMv+pbBZUXStXYsl8eH69MbEZimhDWsPs/m+bh+gEISov22WNUs3ZfUqIXMIb6v18oXPp2Qa1gX5LUEAGoSxHWNmCAcHayWl7M=
+addons:
+  sonarcloud:
+    organization: twilio
+    token:
+      secure: OSEahx/yO/r9PdjXbASwJt+ogphxkDDpnlajWNCBTc+hoiEurGP/12CN0oQi7+iishIgIowqo5J9/+m1BQfsAv4fKST+t6mSazx27udiiM9am03lhviW8QSG6STADvtq6uJRqTXMk3WehoSidNRYXamVdCoBbqxCSaMX8MbMsN8=

data/CHANGES.md

@@ -1,6 +1,57 @@
 twilio-ruby changelog
 =====================
 
+[2021-08-11] Version 5.58.0
+---------------------------
+**Library - Chore**
+- [PR #566](https://github.com/twilio/twilio-ruby/pull/566): integrate sonarcloud. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Library - Docs**
+- [PR #565](https://github.com/twilio/twilio-ruby/pull/565): update mms example to use media_url. Thanks to [@cnorm35](https://github.com/cnorm35)!
+
+**Api**
+- Corrected the `price`, `call_sid_to_coach`, and `uri` data types for Conference, Participant, and Recording **(breaking change)**
+- Made documentation for property `time_limit` in the call api public. **(breaking change)**
+- Added `domain_sid` in sip_credential_list_mapping and sip_ip_access_control_list_mapping APIs **(breaking change)**
+
+**Insights**
+- Added new endpoint to fetch Call Summaries
+
+**Messaging**
+- Add brand_type field to a2p brand_registration api
+- Revert brand registration api update to add brand_type field
+- Add brand_type field to a2p brand_registration api
+
+**Taskrouter**
+- Add `X-Rate-Limit-Limit`, `X-Rate-Limit-Remaining`, and `X-Rate-Limit-Config` as Response Headers to all TaskRouter endpoints
+
+**Verify**
+- Add `TemplateSid` optional parameter on Verification creation.
+- Include `whatsapp` as a channel type in the verifications API.
+
+
+[2021-07-28] Version 5.57.1
+---------------------------
+**Conversations**
+- Expose ParticipantConversations resource
+
+**Taskrouter**
+- Adding `links` to the activity resource
+
+**Verify**
+- Added a `Version` to Verify Factors `Webhooks` to add new fields without breaking old Webhooks.
+
+
+[2021-07-14] Version 5.57.0
+---------------------------
+**Conversations**
+- Changed `last_read_message_index` and `unread_messages_count` type in User Conversation's resource **(breaking change)**
+- Expose UserConversations resource
+
+**Messaging**
+- Add brand_score field to brand registration responses
+
+
 [2021-06-30] Version 5.56.0
 ---------------------------
 **Library - Feature**

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
+gem 'simplecov', require: false, group: :test
 gemspec

data/README.md

@@ -35,13 +35,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.56.0'
+gem 'twilio-ruby', '~> 5.58.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.56.0
+gem install twilio-ruby -v 5.58.0
 ```
 
 To build and install the development branch yourself from the latest source:

data/examples/examples.rb

@@ -69,7 +69,7 @@ puts @client.messages('SMXXXXXXXX').fetch.body
 @client.messages.create(
   from: '+14159341234',
   to: '+16105557069',
-  media_urls: 'http://example.com/media.png'
+  media_url: 'http://example.com/media.png'
 )
 
 ################ PHONE NUMBERS ################

data/lib/twilio-ruby/rest/api/v2010/account/call.rb

@@ -151,6 +151,8 @@ module Twilio
             #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
             #   audio that is received by Twilio. `outbound` records the audio that is generated
             #   from Twilio. `both` records the audio that is received and generated by Twilio.
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @param [String] url The absolute URL that returns the TwiML instructions for the
             #   call. We will call this URL using the `method` when the call connects. For more
             #   information, see the {Url
@@ -162,7 +164,7 @@ module Twilio
             # @param [String] application_sid The SID of the Application resource that will
             #   handle the call, if the call will be handled by an application.
             # @return [CallInstance] Created CallInstance
-            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, call_token: :unset, recording_track: :unset, url: :unset, twiml: :unset, application_sid: :unset)
+            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, call_token: :unset, recording_track: :unset, time_limit: :unset, url: :unset, twiml: :unset, application_sid: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -198,6 +200,7 @@ module Twilio
                   'CallReason' => call_reason,
                   'CallToken' => call_token,
                   'RecordingTrack' => recording_track,
+                  'TimeLimit' => time_limit,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -488,8 +491,10 @@ module Twilio
             #   `POST`. If an `application_sid` parameter is present, this parameter is ignored.
             # @param [String] twiml TwiML instructions for the call Twilio will use without
             #   fetching Twiml from url. Twiml and url parameters are mutually exclusive
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @return [CallInstance] Updated CallInstance
-            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset)
+            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :unset)
               data = Twilio::Values.of({
                   'Url' => url,
                   'Method' => method,
@@ -499,6 +504,7 @@ module Twilio
                   'StatusCallback' => status_callback,
                   'StatusCallbackMethod' => status_callback_method,
                   'Twiml' => twiml,
+                  'TimeLimit' => time_limit,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -874,8 +880,10 @@ module Twilio
             #   `POST`. If an `application_sid` parameter is present, this parameter is ignored.
             # @param [String] twiml TwiML instructions for the call Twilio will use without
             #   fetching Twiml from url. Twiml and url parameters are mutually exclusive
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @return [CallInstance] Updated CallInstance
-            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset)
+            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :unset)
               context.update(
                   url: url,
                   method: method,
@@ -885,6 +893,7 @@ module Twilio
                   status_callback: status_callback,
                   status_callback_method: status_callback_method,
                   twiml: twiml,
+                  time_limit: time_limit,
               )
             end
 

data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb

@@ -167,8 +167,10 @@ module Twilio
               #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
               #   audio that is received by Twilio. `outbound` records the audio that is sent from
               #   Twilio. `both` records the audio that is received and sent by Twilio.
+              # @param [String] time_limit The maximum duration of the call in seconds.
+              #   Constraints depend on account and configuration.
               # @return [ParticipantInstance] Created ParticipantInstance
-              def create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, label: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset, coaching: :unset, call_sid_to_coach: :unset, jitter_buffer_size: :unset, byoc: :unset, caller_id: :unset, call_reason: :unset, recording_track: :unset)
+              def create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, label: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset, coaching: :unset, call_sid_to_coach: :unset, jitter_buffer_size: :unset, byoc: :unset, caller_id: :unset, call_reason: :unset, recording_track: :unset, time_limit: :unset)
                 data = Twilio::Values.of({
                     'From' => from,
                     'To' => to,
@@ -208,6 +210,7 @@ module Twilio
                     'CallerId' => caller_id,
                     'CallReason' => call_reason,
                     'RecordingTrack' => recording_track,
+                    'TimeLimit' => time_limit,
                 })
 
                 payload = @version.create('POST', @uri, data: data)

data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb

@@ -282,7 +282,7 @@ module Twilio
                     'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
                     'duration' => payload['duration'],
                     'sid' => payload['sid'],
-                    'price' => payload['price'].to_f,
+                    'price' => payload['price'],
                     'price_unit' => payload['price_unit'],
                     'status' => payload['status'],
                     'channels' => payload['channels'].to_i,

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb

@@ -19,8 +19,8 @@ module Twilio
                 # @param [Version] version Version that contains the resource
                 # @param [String] account_sid The unique id of the Account that is responsible for
                 #   this resource.
-                # @param [String] domain_sid The unique string that that we created to identify
-                #   the SipDomain resource.
+                # @param [String] domain_sid The unique string that is created to identify the
+                #   SipDomain resource.
                 # @return [CredentialListMappingList] CredentialListMappingList
                 def initialize(version, account_sid: nil, domain_sid: nil)
                   super(version)
@@ -233,8 +233,8 @@ module Twilio
                 # @param [Hash] payload payload that contains response from Twilio
                 # @param [String] account_sid The unique id of the Account that is responsible for
                 #   this resource.
-                # @param [String] domain_sid The unique string that that we created to identify
-                #   the SipDomain resource.
+                # @param [String] domain_sid The unique string that is created to identify the
+                #   SipDomain resource.
                 # @param [String] sid A 34 character string that uniquely identifies the resource
                 #   to fetch.
                 # @return [CredentialListMappingInstance] CredentialListMappingInstance
@@ -246,10 +246,10 @@ module Twilio
                       'account_sid' => payload['account_sid'],
                       'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                       'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                      'domain_sid' => payload['domain_sid'],
                       'friendly_name' => payload['friendly_name'],
                       'sid' => payload['sid'],
                       'uri' => payload['uri'],
-                      'subresource_uris' => payload['subresource_uris'],
                   }
 
                   # Context
@@ -295,6 +295,12 @@ module Twilio
                   @properties['date_updated']
                 end
 
+                ##
+                # @return [String] The unique string that identifies the SipDomain resource.
+                def domain_sid
+                  @properties['domain_sid']
+                end
+
                 ##
                 # @return [String] A human readable descriptive text for this resource, up to 64 characters long.
                 def friendly_name
@@ -313,12 +319,6 @@ module Twilio
                   @properties['uri']
                 end
 
-                ##
-                # @return [String] The credentials associated with this resource.
-                def subresource_uris
-                  @properties['subresource_uris']
-                end
-
                 ##
                 # Fetch the CredentialListMappingInstance
                 # @return [CredentialListMappingInstance] Fetched CredentialListMappingInstance

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb

@@ -19,8 +19,8 @@ module Twilio
                 # @param [Version] version Version that contains the resource
                 # @param [String] account_sid The unique id of the Account that is responsible for
                 #   this resource.
-                # @param [String] domain_sid The unique string that that we created to identify
-                #   the SipDomain resource.
+                # @param [String] domain_sid The unique string that is created to identify the
+                #   SipDomain resource.
                 # @return [IpAccessControlListMappingList] IpAccessControlListMappingList
                 def initialize(version, account_sid: nil, domain_sid: nil)
                   super(version)
@@ -232,8 +232,8 @@ module Twilio
                 # @param [Hash] payload payload that contains response from Twilio
                 # @param [String] account_sid The unique id of the Account that is responsible for
                 #   this resource.
-                # @param [String] domain_sid The unique string that that we created to identify
-                #   the SipDomain resource.
+                # @param [String] domain_sid The unique string that is created to identify the
+                #   SipDomain resource.
                 # @param [String] sid A 34 character string that uniquely identifies the resource
                 #   to fetch.
                 # @return [IpAccessControlListMappingInstance] IpAccessControlListMappingInstance
@@ -245,10 +245,10 @@ module Twilio
                       'account_sid' => payload['account_sid'],
                       'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                       'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                      'domain_sid' => payload['domain_sid'],
                       'friendly_name' => payload['friendly_name'],
                       'sid' => payload['sid'],
                       'uri' => payload['uri'],
-                      'subresource_uris' => payload['subresource_uris'],
                   }
 
                   # Context
@@ -294,6 +294,12 @@ module Twilio
                   @properties['date_updated']
                 end
 
+                ##
+                # @return [String] The unique string that identifies the SipDomain resource.
+                def domain_sid
+                  @properties['domain_sid']
+                end
+
                 ##
                 # @return [String] A human readable descriptive text for this resource, up to 64 characters long.
                 def friendly_name
@@ -312,12 +318,6 @@ module Twilio
                   @properties['uri']
                 end
 
-                ##
-                # @return [String] The list of IP addresses associated with this domain.
-                def subresource_uris
-                  @properties['subresource_uris']
-                end
-
                 ##
                 # Fetch the IpAccessControlListMappingInstance
                 # @return [IpAccessControlListMappingInstance] Fetched IpAccessControlListMappingInstance

data/lib/twilio-ruby/rest/conversations.rb

@@ -52,6 +52,12 @@ module Twilio
         self.v1.credentials(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Conversations::V1::ParticipantConversationInstance]
+      def participant_conversations
+        self.v1.participant_conversations()
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Role
       #   resource.

data/lib/twilio-ruby/rest/conversations/v1.rb

@@ -18,6 +18,7 @@ module Twilio
           @configuration = nil
           @conversations = nil
           @credentials = nil
+          @participant_conversations = nil
           @roles = nil
           @services = nil
           @users = nil
@@ -61,6 +62,12 @@ module Twilio
           end
         end
 
+        ##
+        # @return [Twilio::REST::Conversations::V1::ParticipantConversationContext]
+        def participant_conversations
+          @participant_conversations ||= ParticipantConversationList.new self
+        end
+
         ##
         # @param [String] sid The SID of the Role resource to fetch.
         # @return [Twilio::REST::Conversations::V1::RoleContext] if sid was passed.

data/lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb

@@ -0,0 +1,312 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class ParticipantConversationList < ListResource
+          ##
+          # Initialize the ParticipantConversationList
+          # @param [Version] version Version that contains the resource
+          # @return [ParticipantConversationList] ParticipantConversationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/ParticipantConversations"
+          end
+
+          ##
+          # Lists ParticipantConversationInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] identity A unique string identifier for the conversation
+          #   participant as {Conversation
+          #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
+          #   parameter is non-null if (and only if) the participant is using the
+          #   Conversations SDK to communicate. Limited to 256 characters.
+          # @param [String] address A unique string identifier for the conversation
+          #   participant who's not a Conversation User. This parameter could be found in
+          #   messaging_binding.address field of Participant resource. It should be
+          #   url-encoded.
+          # @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, address: :unset, limit: nil, page_size: nil)
+            self.stream(identity: identity, address: address, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams ParticipantConversationInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] identity A unique string identifier for the conversation
+          #   participant as {Conversation
+          #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
+          #   parameter is non-null if (and only if) the participant is using the
+          #   Conversations SDK to communicate. Limited to 256 characters.
+          # @param [String] address A unique string identifier for the conversation
+          #   participant who's not a Conversation User. This parameter could be found in
+          #   messaging_binding.address field of Participant resource. It should be
+          #   url-encoded.
+          # @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, address: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(identity: identity, address: address, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields ParticipantConversationInstance 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], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of ParticipantConversationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] identity A unique string identifier for the conversation
+          #   participant as {Conversation
+          #   User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
+          #   parameter is non-null if (and only if) the participant is using the
+          #   Conversations SDK to communicate. Limited to 256 characters.
+          # @param [String] address A unique string identifier for the conversation
+          #   participant who's not a Conversation User. This parameter could be found in
+          #   messaging_binding.address field of Participant resource. It should be
+          #   url-encoded.
+          # @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 ParticipantConversationInstance
+          def page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'Identity' => identity,
+                'Address' => address,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            ParticipantConversationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ParticipantConversationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of ParticipantConversationInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            ParticipantConversationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.ParticipantConversationList>'
+          end
+        end
+
+        class ParticipantConversationPage < Page
+          ##
+          # Initialize the ParticipantConversationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ParticipantConversationPage] ParticipantConversationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ParticipantConversationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ParticipantConversationInstance] ParticipantConversationInstance
+          def get_instance(payload)
+            ParticipantConversationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.ParticipantConversationPage>'
+          end
+        end
+
+        class ParticipantConversationInstance < InstanceResource
+          ##
+          # Initialize the ParticipantConversationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [ParticipantConversationInstance] ParticipantConversationInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'chat_service_sid' => payload['chat_service_sid'],
+                'participant_sid' => payload['participant_sid'],
+                'participant_user_sid' => payload['participant_user_sid'],
+                'participant_identity' => payload['participant_identity'],
+                'participant_messaging_binding' => payload['participant_messaging_binding'],
+                'conversation_sid' => payload['conversation_sid'],
+                'conversation_unique_name' => payload['conversation_unique_name'],
+                'conversation_friendly_name' => payload['conversation_friendly_name'],
+                'conversation_attributes' => payload['conversation_attributes'],
+                'conversation_date_created' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_created']),
+                'conversation_date_updated' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_updated']),
+                'conversation_created_by' => payload['conversation_created_by'],
+                'conversation_state' => payload['conversation_state'],
+                'conversation_timers' => payload['conversation_timers'],
+                'links' => payload['links'],
+            }
+          end
+
+          ##
+          # @return [String] The unique ID of the Account responsible for this conversation.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The unique ID of the Conversation Service this conversation belongs to.
+          def chat_service_sid
+            @properties['chat_service_sid']
+          end
+
+          ##
+          # @return [String] The unique ID of the Participant.
+          def participant_sid
+            @properties['participant_sid']
+          end
+
+          ##
+          # @return [String] The unique ID for the conversation participant as Conversation User.
+          def participant_user_sid
+            @properties['participant_user_sid']
+          end
+
+          ##
+          # @return [String] A unique string identifier for the conversation participant as Conversation User.
+          def participant_identity
+            @properties['participant_identity']
+          end
+
+          ##
+          # @return [Hash] Information about how this participant exchanges messages with the conversation.
+          def participant_messaging_binding
+            @properties['participant_messaging_binding']
+          end
+
+          ##
+          # @return [String] The unique ID of the Conversation this Participant belongs to.
+          def conversation_sid
+            @properties['conversation_sid']
+          end
+
+          ##
+          # @return [String] An application-defined string that uniquely identifies the Conversation resource
+          def conversation_unique_name
+            @properties['conversation_unique_name']
+          end
+
+          ##
+          # @return [String] The human-readable name of this conversation.
+          def conversation_friendly_name
+            @properties['conversation_friendly_name']
+          end
+
+          ##
+          # @return [String] An optional string metadata field you can use to store any data you wish.
+          def conversation_attributes
+            @properties['conversation_attributes']
+          end
+
+          ##
+          # @return [Time] The date that this conversation was created.
+          def conversation_date_created
+            @properties['conversation_date_created']
+          end
+
+          ##
+          # @return [Time] The date that this conversation was last updated.
+          def conversation_date_updated
+            @properties['conversation_date_updated']
+          end
+
+          ##
+          # @return [String] Creator of this conversation.
+          def conversation_created_by
+            @properties['conversation_created_by']
+          end
+
+          ##
+          # @return [participant_conversation.State] The current state of this User Conversation
+          def conversation_state
+            @properties['conversation_state']
+          end
+
+          ##
+          # @return [Hash] Timer date values for this conversation.
+          def conversation_timers
+            @properties['conversation_timers']
+          end
+
+          ##
+          # @return [String] Absolute URLs to access the participant and conversation of this Participant Conversation.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Conversations.V1.ParticipantConversationInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Conversations.V1.ParticipantConversationInstance>"
+          end
+        end
+      end
+    end
+  end
+end