twilio-ruby 5.61.0 → 5.61.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f67e55070e1d0eddd733aab27eb25aaac27b3ca
-  data.tar.gz: 8152831ec638b70b0bae3a6596080c1fa6c7ced9
+  metadata.gz: 0744c60bf47ebe5674a6c2ea371fdda3ae937ef4
+  data.tar.gz: a8d42def7f349fb8a99c035f59c3436d8f969fe9
 SHA512:
-  metadata.gz: 4386a3cee85ffba9015d8eb0aba9012fbe5e8465635f96bfe563fafbd2aa6d99c0b4228a6b8dfca7fb958c16175b079eaa44e9c06d1944fdc8fdd630de3f58af
-  data.tar.gz: f57664647dd26b987cd3cc45b6ff2035880bb324acc1b790a9271d66bdbdc7ca12d73164be50fe023e11ece500db1044717db855006791569b903f7d42cdf927
+  metadata.gz: 0b62a9817b86b3f5e03c491072907cf359eff878d21b315f92848e9546a6f1f3664d29c1be464e17444bc15754af6079703f3e46d17f7845d9ed460ae9d8ff44
+  data.tar.gz: 5612432558411b78da25b0b6e1dfcb4edd51ed710c3562cb9174fe6e93bcdc0cd88e55aa02dc19a361534dcbe3e88a52d3ca64ed6032ac42af2045547e30d70e

data/.github/workflows/deploy.yml

@@ -12,6 +12,8 @@ jobs:
     steps:
       - name: Checkout twilio-ruby
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Login to Docker Hub
         uses: docker/login-action@v1

data/.github/workflows/test.yml

@@ -17,6 +17,7 @@ jobs:
     strategy:
       matrix:
         ruby: [2.4, 2.5, 2.6, 2.7, '3.0', ruby-head, jruby-9.2]
+    continue-on-error: ${{ matrix.ruby == 'ruby-head' }}
     steps:
       - name: Checkout twilio-ruby
         uses: actions/checkout@v2

data/.gitignore

@@ -13,5 +13,6 @@ docs/_build
 *.iml
 .bundle
 .rakeTasks
+.yardoc
 
 coverage

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.4
   Exclude:
     - 'lib/twilio-ruby/rest/**/*'
     - 'spec/integration/**/*'

data/CHANGES.md

@@ -1,6 +1,57 @@
 twilio-ruby changelog
 =====================
 
+[2021-12-01] Version 5.61.2
+---------------------------
+**Library - Chore**
+- [PR #579](https://github.com/twilio/twilio-ruby/pull/579): make ruby-head test optional. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Conversations**
+- Add `Service Webhook Configuration` resource
+
+**Flex**
+- Adding `flex_insights_drilldown` and `flex_url` objects to Flex Configuration
+
+**Messaging**
+- Update us_app_to_person endpoints to remove beta feature flag based access
+
+**Supersim**
+- Add IP Commands resource
+
+**Verify**
+- Add optional `factor_friendly_name` parameter to the create access token endpoint.
+
+**Video**
+- Add maxParticipantDuration param to Rooms
+
+**Twiml**
+- Unrevert Add supported SSML children to `<emphasis>`, `<lang>`, `<p>`, `<prosody>`, `<s>`, and `<w>`.
+- Revert Add supported SSML children to `<emphasis>`, `<lang>`, `<p>`, `<prosody>`, `<s>`, and `<w>`.
+
+
+[2021-11-17] Version 5.61.1
+---------------------------
+**Library - Chore**
+- [PR #578](https://github.com/twilio/twilio-ruby/pull/578): remove yardoc files. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Library - Fix**
+- [PR #576](https://github.com/twilio/twilio-ruby/pull/576): git log retrieval issues. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Frontline**
+- Added `is_available` to User's resource
+
+**Messaging**
+- Added GET vetting API
+
+**Verify**
+- Add `WHATSAPP` to the attempts API.
+- Allow to update `config.notification_platform` from `none` to `apn` or `fcm` and viceversa for Verify Push
+- Add `none` as a valid `config.notification_platform` value for Verify Push
+
+**Twiml**
+- Add supported SSML children to `<emphasis>`, `<lang>`, `<p>`, `<prosody>`, `<s>`, and `<w>`.
+
+
 [2021-11-03] Version 5.61.0
 ---------------------------
 **Library - Chore**

data/Makefile

@@ -10,7 +10,7 @@ test: lint
 	bundle exec rake spec
 
 lint:
-	bundle exec rubocop --cache true --parallel
+	bundle exec rubocop -d --cache true --parallel
 
 docs:
 	yard doc --output-dir ./doc

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.61.0'
+gem 'twilio-ruby', '~> 5.61.2'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.61.0
+gem install twilio-ruby -v 5.61.2
 ```
 
 To build and install the development branch yourself from the latest source:

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

@@ -144,9 +144,9 @@ module Twilio
             #   Calls Beta)
             # @param [String] call_token A token string needed to invoke a forwarded call. A
             #   call_token is generated when an incoming call is received on a Twilio number.
-            #   this field should be populated by the incoming call's call_token to make this
-            #   outgoing call as a forwarded call of incoming call. A forwarded call should bear
-            #   the same caller-id of incoming call.
+            #   Pass an incoming call's call_token value to a forwarded call via the call_token
+            #   parameter when creating a new call. A forwarded call should bear the same
+            #   CallerID of the original incoming call.
             # @param [String] recording_track The audio track to record for the call. Can be:
             #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
             #   audio that is received by Twilio. `outbound` records the audio that is generated

data/lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb

@@ -0,0 +1,269 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          class ConfigurationContext < InstanceContext
+            class WebhookList < ListResource
+              ##
+              # Initialize the WebhookList
+              # @param [Version] version Version that contains the resource
+              # @param [String] chat_service_sid The unique string that we created to identify
+              #   the Service configuration resource.
+              # @return [WebhookList] WebhookList
+              def initialize(version, chat_service_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {chat_service_sid: chat_service_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Conversations.V1.WebhookList>'
+              end
+            end
+
+            class WebhookPage < Page
+              ##
+              # Initialize the WebhookPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [WebhookPage] WebhookPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of WebhookInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [WebhookInstance] WebhookInstance
+              def get_instance(payload)
+                WebhookInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Conversations.V1.WebhookPage>'
+              end
+            end
+
+            class WebhookContext < InstanceContext
+              ##
+              # Initialize the WebhookContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] chat_service_sid The unique ID of the {Conversation
+              #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] this
+              #   conversation belongs to.
+              # @return [WebhookContext] WebhookContext
+              def initialize(version, chat_service_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {chat_service_sid: chat_service_sid, }
+                @uri = "/Services/#{@solution[:chat_service_sid]}/Configuration/Webhooks"
+              end
+
+              ##
+              # Update the WebhookInstance
+              # @param [String] pre_webhook_url The absolute url the pre-event webhook request
+              #   should be sent to.
+              # @param [String] post_webhook_url The absolute url the post-event webhook request
+              #   should be sent to.
+              # @param [Array[String]] filters The list of webhook event triggers that are
+              #   enabled for this Service. Possible values are `onParticipantAdd`,
+              #   `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`,
+              #   `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`,
+              #   `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`,
+              #   `onConversationAdded`, `onMessageAdded`, `onConversationAdd`,
+              #   `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`,
+              #   `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or
+              #   `onConversationStateUpdated`.
+              # @param [String] method The HTTP method to be used when sending a webhook
+              #   request. One of `GET` or `POST`.
+              # @return [WebhookInstance] Updated WebhookInstance
+              def update(pre_webhook_url: :unset, post_webhook_url: :unset, filters: :unset, method: :unset)
+                data = Twilio::Values.of({
+                    'PreWebhookUrl' => pre_webhook_url,
+                    'PostWebhookUrl' => post_webhook_url,
+                    'Filters' => Twilio.serialize_list(filters) { |e| e },
+                    'Method' => method,
+                })
+
+                payload = @version.update('POST', @uri, data: data)
+
+                WebhookInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+              end
+
+              ##
+              # Fetch the WebhookInstance
+              # @return [WebhookInstance] Fetched WebhookInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                WebhookInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+              end
+            end
+
+            class WebhookInstance < InstanceResource
+              ##
+              # Initialize the WebhookInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] chat_service_sid The unique string that we created to identify
+              #   the Service configuration resource.
+              # @return [WebhookInstance] WebhookInstance
+              def initialize(version, payload, chat_service_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'chat_service_sid' => payload['chat_service_sid'],
+                    'pre_webhook_url' => payload['pre_webhook_url'],
+                    'post_webhook_url' => payload['post_webhook_url'],
+                    'filters' => payload['filters'],
+                    'method' => payload['method'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'chat_service_sid' => chat_service_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 [WebhookContext] WebhookContext for this WebhookInstance
+              def context
+                unless @instance_context
+                  @instance_context = WebhookContext.new(@version, @params['chat_service_sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The unique ID of the Account responsible for this service.
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The chat_service_sid
+              def chat_service_sid
+                @properties['chat_service_sid']
+              end
+
+              ##
+              # @return [String] The absolute url the pre-event webhook request should be sent to.
+              def pre_webhook_url
+                @properties['pre_webhook_url']
+              end
+
+              ##
+              # @return [String] The absolute url the post-event webhook request should be sent to.
+              def post_webhook_url
+                @properties['post_webhook_url']
+              end
+
+              ##
+              # @return [Array[String]] The list of webhook event triggers that are enabled for this Service.
+              def filters
+                @properties['filters']
+              end
+
+              ##
+              # @return [webhook.Method] The HTTP method to be used when sending a webhook request
+              def method
+                @properties['method']
+              end
+
+              ##
+              # @return [String] An absolute URL for this webhook.
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Update the WebhookInstance
+              # @param [String] pre_webhook_url The absolute url the pre-event webhook request
+              #   should be sent to.
+              # @param [String] post_webhook_url The absolute url the post-event webhook request
+              #   should be sent to.
+              # @param [Array[String]] filters The list of webhook event triggers that are
+              #   enabled for this Service. Possible values are `onParticipantAdd`,
+              #   `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`,
+              #   `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`,
+              #   `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`,
+              #   `onConversationAdded`, `onMessageAdded`, `onConversationAdd`,
+              #   `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`,
+              #   `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or
+              #   `onConversationStateUpdated`.
+              # @param [String] method The HTTP method to be used when sending a webhook
+              #   request. One of `GET` or `POST`.
+              # @return [WebhookInstance] Updated WebhookInstance
+              def update(pre_webhook_url: :unset, post_webhook_url: :unset, filters: :unset, method: :unset)
+                context.update(
+                    pre_webhook_url: pre_webhook_url,
+                    post_webhook_url: post_webhook_url,
+                    filters: filters,
+                    method: method,
+                )
+              end
+
+              ##
+              # Fetch the WebhookInstance
+              # @return [WebhookInstance] Fetched WebhookInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -77,6 +77,7 @@ module Twilio
 
               # Components
               @notifications = nil
+              @webhooks = nil
             end
 
             ##
@@ -127,6 +128,13 @@ module Twilio
               return NotificationContext.new(@version, @solution[:chat_service_sid], )
             end
 
+            ##
+            # Access the webhooks
+            # @return [WebhookContext] WebhookContext
+            def webhooks
+              return WebhookContext.new(@version, @solution[:chat_service_sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb

@@ -168,6 +168,8 @@ module Twilio
                 'markdown' => payload['markdown'],
                 'url' => payload['url'],
                 'flex_insights_hr' => payload['flex_insights_hr'],
+                'flex_insights_drilldown' => payload['flex_insights_drilldown'],
+                'flex_url' => payload['flex_url'],
             }
 
             # Context
@@ -426,6 +428,18 @@ module Twilio
             @properties['flex_insights_hr']
           end
 
+          ##
+          # @return [Boolean] Setting to enable Flex UI redirection
+          def flex_insights_drilldown
+            @properties['flex_insights_drilldown']
+          end
+
+          ##
+          # @return [String] URL to redirect to in case drilldown is enabled.
+          def flex_url
+            @properties['flex_url']
+          end
+
           ##
           # Fetch the ConfigurationInstance
           # @param [String] ui_version The Pinned UI version of the Configuration resource

data/lib/twilio-ruby/rest/frontline_api/v1/user.rb

@@ -94,10 +94,19 @@ module Twilio
           # @param [String] avatar The avatar URL which will be shown in Frontline
           #   application.
           # @param [user.StateType] state Current state of this user. Can be either `active`
-          #   or `deactivated` and defaults to `active`
+          #   or `deactivated`.
+          # @param [Boolean] is_available Whether the User is available for new
+          #   conversations. Set to `false` to prevent User from receiving new inbound
+          #   conversations if you are using {Pool
+          #   Routing}[https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing].
           # @return [UserInstance] Updated UserInstance
-          def update(friendly_name: :unset, avatar: :unset, state: :unset)
-            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Avatar' => avatar, 'State' => state, })
+          def update(friendly_name: :unset, avatar: :unset, state: :unset, is_available: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Avatar' => avatar,
+                'State' => state,
+                'IsAvailable' => is_available,
+            })
 
             payload = @version.update('POST', @uri, data: data)
 
@@ -139,6 +148,7 @@ module Twilio
                 'friendly_name' => payload['friendly_name'],
                 'avatar' => payload['avatar'],
                 'state' => payload['state'],
+                'is_available' => payload['is_available'],
                 'url' => payload['url'],
             }
 
@@ -188,6 +198,12 @@ module Twilio
             @properties['state']
           end
 
+          ##
+          # @return [Boolean] Whether the User is available for new conversations
+          def is_available
+            @properties['is_available']
+          end
+
           ##
           # @return [String] An absolute URL for this user.
           def url
@@ -207,10 +223,19 @@ module Twilio
           # @param [String] avatar The avatar URL which will be shown in Frontline
           #   application.
           # @param [user.StateType] state Current state of this user. Can be either `active`
-          #   or `deactivated` and defaults to `active`
+          #   or `deactivated`.
+          # @param [Boolean] is_available Whether the User is available for new
+          #   conversations. Set to `false` to prevent User from receiving new inbound
+          #   conversations if you are using {Pool
+          #   Routing}[https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing].
           # @return [UserInstance] Updated UserInstance
-          def update(friendly_name: :unset, avatar: :unset, state: :unset)
-            context.update(friendly_name: friendly_name, avatar: avatar, state: state, )
+          def update(friendly_name: :unset, avatar: :unset, state: :unset, is_available: :unset)
+            context.update(
+                friendly_name: friendly_name,
+                avatar: avatar,
+                state: state,
+                is_available: is_available,
+            )
           end
 
           ##

data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb

@@ -166,6 +166,54 @@ module Twilio
             end
           end
 
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class BrandVettingContext < InstanceContext
+            ##
+            # Initialize the BrandVettingContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] brand_sid The SID of the Brand Registration resource of the
+            #   vettings to read .
+            # @param [String] brand_vetting_sid The Twilio SID of the third-party vetting
+            #   record.
+            # @return [BrandVettingContext] BrandVettingContext
+            def initialize(version, brand_sid, brand_vetting_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {brand_sid: brand_sid, brand_vetting_sid: brand_vetting_sid, }
+              @uri = "/a2p/BrandRegistrations/#{@solution[:brand_sid]}/Vettings/#{@solution[:brand_vetting_sid]}"
+            end
+
+            ##
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              BrandVettingInstance.new(
+                  @version,
+                  payload,
+                  brand_sid: @solution[:brand_sid],
+                  brand_vetting_sid: @solution[:brand_vetting_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.BrandVettingContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.BrandVettingContext #{context}>"
+            end
+          end
+
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class BrandVettingInstance < InstanceResource
@@ -174,8 +222,10 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] brand_sid The unique string to identify Brand Registration.
+            # @param [String] brand_vetting_sid The Twilio SID of the third-party vetting
+            #   record.
             # @return [BrandVettingInstance] BrandVettingInstance
-            def initialize(version, payload, brand_sid: nil)
+            def initialize(version, payload, brand_sid: nil, brand_vetting_sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -191,6 +241,28 @@ module Twilio
                   'vetting_provider' => payload['vetting_provider'],
                   'url' => payload['url'],
               }
+
+              # Context
+              @instance_context = nil
+              @params = {
+                  'brand_sid' => brand_sid,
+                  'brand_vetting_sid' => brand_vetting_sid || @properties['brand_vetting_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 [BrandVettingContext] BrandVettingContext for this BrandVettingInstance
+            def context
+              unless @instance_context
+                @instance_context = BrandVettingContext.new(
+                    @version,
+                    @params['brand_sid'],
+                    @params['brand_vetting_sid'],
+                )
+              end
+              @instance_context
             end
 
             ##
@@ -253,16 +325,25 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
+            def fetch
+              context.fetch
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Messaging.V1.BrandVettingInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Messaging.V1.BrandVettingInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
             end
           end
         end

data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb

@@ -201,8 +201,14 @@ module Twilio
           ##
           # Access the brand_vettings
           # @return [BrandVettingList]
-          # @return [BrandVettingContext]
-          def brand_vettings
+          # @return [BrandVettingContext] if brand_vetting_sid was passed.
+          def brand_vettings(brand_vetting_sid=:unset)
+            raise ArgumentError, 'brand_vetting_sid cannot be nil' if brand_vetting_sid.nil?
+
+            if brand_vetting_sid != :unset
+              return BrandVettingContext.new(@version, @solution[:sid], brand_vetting_sid, )
+            end
+
             unless @brand_vettings
               @brand_vettings = BrandVettingList.new(@version, brand_sid: @solution[:sid], )
             end