twilio-ruby 5.72.0 → 5.77.0

data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb

@@ -33,23 +33,69 @@ module Twilio
             # Create the UsAppToPersonInstance
             # @param [String] brand_registration_sid A2P Brand Registration SID
             # @param [String] description A short description of what this SMS campaign does.
-            # @param [Array[String]] message_samples Message samples, at least 2 and up to 5
-            #   sample messages, <=1024 chars each.
+            #   Min length: 40 characters. Max length: 4096 characters.
+            # @param [String] message_flow Required for all Campaigns. Details around how a
+            #   consumer opts-in to their campaign, therefore giving consent to receive their
+            #   messages. If multiple opt-in methods can be used for the same campaign, they
+            #   must all be listed. 40 character minimum. 2048 character maximum.
+            # @param [Array[String]] message_samples Message samples, at least 1 and up to 5
+            #   sample messages (at least 2 for sole proprietor), >=20 chars, <=1024 chars each.
             # @param [String] us_app_to_person_usecase A2P Campaign Use Case. Examples: [ 2FA,
             #   EMERGENCY, MARKETING..]
             # @param [Boolean] has_embedded_links Indicates that this SMS campaign will send
             #   messages that contain links.
             # @param [Boolean] has_embedded_phone Indicates that this SMS campaign will send
             #   messages that contain phone numbers.
+            # @param [String] opt_in_message If end users can text in a keyword to start
+            #   receiving messages from this campaign, the auto-reply messages sent to the end
+            #   users must be provided. The opt-in response should include the Brand name,
+            #   confirmation of opt-in enrollment to a recurring message campaign, how to get
+            #   help, and clear description of how to opt-out. This field is required if end
+            #   users can text in a keyword to start receiving messages from this campaign. 20
+            #   character minimum. 320 character maximum.
+            # @param [String] opt_out_message Upon receiving the opt-out keywords from the end
+            #   users, Twilio customers are expected to send back an auto-generated response,
+            #   which must provide acknowledgment of the opt-out request and confirmation that
+            #   no further messages will be sent. It is also recommended that these opt-out
+            #   messages include the brand name. This field is required if managing opt out
+            #   keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out
+            #   features). 20 character minimum. 320 character maximum.
+            # @param [String] help_message When customers receive the help keywords from their
+            #   end users, Twilio customers are expected to send back an auto-generated
+            #   response; this may include the brand name and additional support contact
+            #   information. This field is required if managing help keywords yourself (i.e. not
+            #   using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320
+            #   character maximum.
+            # @param [Array[String]] opt_in_keywords If end users can text in a keyword to
+            #   start receiving messages from this campaign, those keywords must be provided.
+            #   This field is required if end users can text in a keyword to start receiving
+            #   messages from this campaign. Values must be alphanumeric. 255 character maximum.
+            # @param [Array[String]] opt_out_keywords End users should be able to text in a
+            #   keyword to stop receiving messages from this campaign. Those keywords must be
+            #   provided. This field is required if managing opt out keywords yourself (i.e. not
+            #   using Twilio's Default or Advanced Opt Out features). Values must be
+            #   alphanumeric. 255 character maximum.
+            # @param [Array[String]] help_keywords End users should be able to text in a
+            #   keyword to receive help. Those keywords must be provided as part of the campaign
+            #   registration request. This field is required if managing help keywords yourself
+            #   (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be
+            #   alphanumeric. 255 character maximum.
             # @return [UsAppToPersonInstance] Created UsAppToPersonInstance
-            def create(brand_registration_sid: nil, description: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil)
+            def create(brand_registration_sid: nil, description: nil, message_flow: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset)
               data = Twilio::Values.of({
                   'BrandRegistrationSid' => brand_registration_sid,
                   'Description' => description,
+                  'MessageFlow' => message_flow,
                   'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
                   'UsAppToPersonUsecase' => us_app_to_person_usecase,
                   'HasEmbeddedLinks' => has_embedded_links,
                   'HasEmbeddedPhone' => has_embedded_phone,
+                  'OptInMessage' => opt_in_message,
+                  'OptOutMessage' => opt_out_message,
+                  'HelpMessage' => help_message,
+                  'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e },
+                  'OptOutKeywords' => Twilio.serialize_list(opt_out_keywords) { |e| e },
+                  'HelpKeywords' => Twilio.serialize_list(help_keywords) { |e| e },
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -270,6 +316,13 @@ module Twilio
                   'campaign_id' => payload['campaign_id'],
                   'is_externally_registered' => payload['is_externally_registered'],
                   'rate_limits' => payload['rate_limits'],
+                  'message_flow' => payload['message_flow'],
+                  'opt_in_message' => payload['opt_in_message'],
+                  'opt_out_message' => payload['opt_out_message'],
+                  'help_message' => payload['help_message'],
+                  'opt_in_keywords' => payload['opt_in_keywords'],
+                  'opt_out_keywords' => payload['opt_out_keywords'],
+                  'help_keywords' => payload['help_keywords'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
@@ -374,6 +427,48 @@ module Twilio
               @properties['rate_limits']
             end
 
+            ##
+            # @return [String] Consumer opt-in flow
+            def message_flow
+              @properties['message_flow']
+            end
+
+            ##
+            # @return [String] Opt In Message
+            def opt_in_message
+              @properties['opt_in_message']
+            end
+
+            ##
+            # @return [String] Opt Out Message
+            def opt_out_message
+              @properties['opt_out_message']
+            end
+
+            ##
+            # @return [String] Help Message
+            def help_message
+              @properties['help_message']
+            end
+
+            ##
+            # @return [Array[String]] Opt In Keywords
+            def opt_in_keywords
+              @properties['opt_in_keywords']
+            end
+
+            ##
+            # @return [Array[String]] Opt Out Keywords
+            def opt_out_keywords
+              @properties['opt_out_keywords']
+            end
+
+            ##
+            # @return [Array[String]] Help Keywords
+            def help_keywords
+              @properties['help_keywords']
+            end
+
             ##
             # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created

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

@@ -469,7 +469,7 @@ module Twilio
                 'fallback_to_long_code' => payload['fallback_to_long_code'],
                 'area_code_geomatch' => payload['area_code_geomatch'],
                 'synchronous_validation' => payload['synchronous_validation'],
-                'validity_period' => payload['validity_period'].to_i,
+                'validity_period' => payload['validity_period'] == nil ? payload['validity_period'] : payload['validity_period'].to_i,
                 'url' => payload['url'],
                 'links' => payload['links'],
                 'usecase' => payload['usecase'],

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

@@ -173,8 +173,10 @@ module Twilio
           #   business or organization using the Tollfree number.
           # @param [String] business_contact_phone The phone number of the contact for the
           #   business or organization using the Tollfree number.
+          # @param [String] external_reference_id An optional external reference ID supplied
+          #   by customer and echoed back on status retrieval.
           # @return [TollfreeVerificationInstance] Created TollfreeVerificationInstance
-          def create(business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset)
+          def create(business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, external_reference_id: :unset)
             data = Twilio::Values.of({
                 'BusinessName' => business_name,
                 'BusinessWebsite' => business_website,
@@ -198,6 +200,7 @@ module Twilio
                 'BusinessContactLastName' => business_contact_last_name,
                 'BusinessContactEmail' => business_contact_email,
                 'BusinessContactPhone' => business_contact_phone,
+                'ExternalReferenceId' => external_reference_id,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -268,6 +271,78 @@ module Twilio
             TollfreeVerificationInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
+          ##
+          # Update the TollfreeVerificationInstance
+          # @param [String] business_name The name of the business or organization using the
+          #   Tollfree number.
+          # @param [String] business_website The website of the business or organization
+          #   using the Tollfree number.
+          # @param [String] notification_email The email address to receive the notification
+          #   about the verification result. .
+          # @param [Array[String]] use_case_categories The category of the use case for the
+          #   Tollfree Number. List as many are applicable..
+          # @param [String] use_case_summary Use this to further explain how messaging is
+          #   used by the business or organization.
+          # @param [String] production_message_sample An example of message content, i.e. a
+          #   sample message.
+          # @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in
+          #   workflow. Multiple images allowed and must be a publicly hosted URL.
+          # @param [tollfree_verification.OptInType] opt_in_type Describe how a user opts-in
+          #   to text messages.
+          # @param [String] message_volume Estimate monthly volume of messages from the
+          #   Tollfree Number.
+          # @param [String] business_street_address The address of the business or
+          #   organization using the Tollfree number.
+          # @param [String] business_street_address2 The address of the business or
+          #   organization using the Tollfree number.
+          # @param [String] business_city The city of the business or organization using the
+          #   Tollfree number.
+          # @param [String] business_state_province_region The state/province/region of the
+          #   business or organization using the Tollfree number.
+          # @param [String] business_postal_code The postal code of the business or
+          #   organization using the Tollfree number.
+          # @param [String] business_country The country of the business or organization
+          #   using the Tollfree number.
+          # @param [String] additional_information Additional information to be provided for
+          #   verification.
+          # @param [String] business_contact_first_name The first name of the contact for
+          #   the business or organization using the Tollfree number.
+          # @param [String] business_contact_last_name The last name of the contact for the
+          #   business or organization using the Tollfree number.
+          # @param [String] business_contact_email The email address of the contact for the
+          #   business or organization using the Tollfree number.
+          # @param [String] business_contact_phone The phone number of the contact for the
+          #   business or organization using the Tollfree number.
+          # @return [TollfreeVerificationInstance] Updated TollfreeVerificationInstance
+          def update(business_name: :unset, business_website: :unset, notification_email: :unset, use_case_categories: :unset, use_case_summary: :unset, production_message_sample: :unset, opt_in_image_urls: :unset, opt_in_type: :unset, message_volume: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset)
+            data = Twilio::Values.of({
+                'BusinessName' => business_name,
+                'BusinessWebsite' => business_website,
+                'NotificationEmail' => notification_email,
+                'UseCaseCategories' => Twilio.serialize_list(use_case_categories) { |e| e },
+                'UseCaseSummary' => use_case_summary,
+                'ProductionMessageSample' => production_message_sample,
+                'OptInImageUrls' => Twilio.serialize_list(opt_in_image_urls) { |e| e },
+                'OptInType' => opt_in_type,
+                'MessageVolume' => message_volume,
+                'BusinessStreetAddress' => business_street_address,
+                'BusinessStreetAddress2' => business_street_address2,
+                'BusinessCity' => business_city,
+                'BusinessStateProvinceRegion' => business_state_province_region,
+                'BusinessPostalCode' => business_postal_code,
+                'BusinessCountry' => business_country,
+                'AdditionalInformation' => additional_information,
+                'BusinessContactFirstName' => business_contact_first_name,
+                'BusinessContactLastName' => business_contact_last_name,
+                'BusinessContactEmail' => business_contact_email,
+                'BusinessContactPhone' => business_contact_phone,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            TollfreeVerificationInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -327,7 +402,10 @@ module Twilio
                 'tollfree_phone_number_sid' => payload['tollfree_phone_number_sid'],
                 'status' => payload['status'],
                 'url' => payload['url'],
+                'rejection_reason' => payload['rejection_reason'],
+                'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
                 'resource_links' => payload['resource_links'],
+                'external_reference_id' => payload['external_reference_id'],
             }
 
             # Context
@@ -526,12 +604,30 @@ module Twilio
             @properties['url']
           end
 
+          ##
+          # @return [String] The rejection reason given when a Tollfree Verification has been rejected.
+          def rejection_reason
+            @properties['rejection_reason']
+          end
+
+          ##
+          # @return [String] The error code given when a Tollfree Verification has been rejected.
+          def error_code
+            @properties['error_code']
+          end
+
           ##
           # @return [Hash] The URLs of the documents associated with the Tollfree Verification resource
           def resource_links
             @properties['resource_links']
           end
 
+          ##
+          # @return [String] An optional external reference ID supplied by customer and echoed back on status retrieval
+          def external_reference_id
+            @properties['external_reference_id']
+          end
+
           ##
           # Fetch the TollfreeVerificationInstance
           # @return [TollfreeVerificationInstance] Fetched TollfreeVerificationInstance
@@ -539,6 +635,74 @@ module Twilio
             context.fetch
           end
 
+          ##
+          # Update the TollfreeVerificationInstance
+          # @param [String] business_name The name of the business or organization using the
+          #   Tollfree number.
+          # @param [String] business_website The website of the business or organization
+          #   using the Tollfree number.
+          # @param [String] notification_email The email address to receive the notification
+          #   about the verification result. .
+          # @param [Array[String]] use_case_categories The category of the use case for the
+          #   Tollfree Number. List as many are applicable..
+          # @param [String] use_case_summary Use this to further explain how messaging is
+          #   used by the business or organization.
+          # @param [String] production_message_sample An example of message content, i.e. a
+          #   sample message.
+          # @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in
+          #   workflow. Multiple images allowed and must be a publicly hosted URL.
+          # @param [tollfree_verification.OptInType] opt_in_type Describe how a user opts-in
+          #   to text messages.
+          # @param [String] message_volume Estimate monthly volume of messages from the
+          #   Tollfree Number.
+          # @param [String] business_street_address The address of the business or
+          #   organization using the Tollfree number.
+          # @param [String] business_street_address2 The address of the business or
+          #   organization using the Tollfree number.
+          # @param [String] business_city The city of the business or organization using the
+          #   Tollfree number.
+          # @param [String] business_state_province_region The state/province/region of the
+          #   business or organization using the Tollfree number.
+          # @param [String] business_postal_code The postal code of the business or
+          #   organization using the Tollfree number.
+          # @param [String] business_country The country of the business or organization
+          #   using the Tollfree number.
+          # @param [String] additional_information Additional information to be provided for
+          #   verification.
+          # @param [String] business_contact_first_name The first name of the contact for
+          #   the business or organization using the Tollfree number.
+          # @param [String] business_contact_last_name The last name of the contact for the
+          #   business or organization using the Tollfree number.
+          # @param [String] business_contact_email The email address of the contact for the
+          #   business or organization using the Tollfree number.
+          # @param [String] business_contact_phone The phone number of the contact for the
+          #   business or organization using the Tollfree number.
+          # @return [TollfreeVerificationInstance] Updated TollfreeVerificationInstance
+          def update(business_name: :unset, business_website: :unset, notification_email: :unset, use_case_categories: :unset, use_case_summary: :unset, production_message_sample: :unset, opt_in_image_urls: :unset, opt_in_type: :unset, message_volume: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset)
+            context.update(
+                business_name: business_name,
+                business_website: business_website,
+                notification_email: notification_email,
+                use_case_categories: use_case_categories,
+                use_case_summary: use_case_summary,
+                production_message_sample: production_message_sample,
+                opt_in_image_urls: opt_in_image_urls,
+                opt_in_type: opt_in_type,
+                message_volume: message_volume,
+                business_street_address: business_street_address,
+                business_street_address2: business_street_address2,
+                business_city: business_city,
+                business_state_province_region: business_state_province_region,
+                business_postal_code: business_postal_code,
+                business_country: business_country,
+                additional_information: additional_information,
+                business_contact_first_name: business_contact_first_name,
+                business_contact_last_name: business_contact_last_name,
+                business_contact_email: business_contact_email,
+                business_contact_phone: business_contact_phone,
+            )
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

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

@@ -17,7 +17,11 @@ module Twilio
           @version = 'v1'
           @brand_registrations = nil
           @deactivations = nil
+          @domain_certs = nil
+          @domain_config = nil
+          @domain_config_messaging_service = nil
           @external_campaign = nil
+          @linkshortening_messaging_service = nil
           @services = nil
           @tollfree_verifications = nil
           @usecases = nil
@@ -44,12 +48,83 @@ module Twilio
           @deactivations ||= DeactivationsContext.new self
         end
 
+        ##
+        # @param [String] domain_sid Unique string used to identify the domain that this
+        #   certificate should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainCertsContext] if domain_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainCertsList]
+        def domain_certs(domain_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if domain_sid == :unset
+              @domain_certs ||= DomainCertsList.new self
+          else
+              DomainCertsContext.new(self, domain_sid)
+          end
+        end
+
+        ##
+        # @param [String] domain_sid Unique string used to identify the domain that this
+        #   config should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigContext] if domain_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigList]
+        def domain_config(domain_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if domain_sid == :unset
+              @domain_config ||= DomainConfigList.new self
+          else
+              DomainConfigContext.new(self, domain_sid)
+          end
+        end
+
+        ##
+        # @param [String] messaging_service_sid Unique string used to identify the
+        #   Messaging service that this domain should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceContext] if messaging_service_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceList]
+        def domain_config_messaging_service(messaging_service_sid=:unset)
+          if messaging_service_sid.nil?
+              raise ArgumentError, 'messaging_service_sid cannot be nil'
+          end
+          if messaging_service_sid == :unset
+              @domain_config_messaging_service ||= DomainConfigMessagingServiceList.new self
+          else
+              DomainConfigMessagingServiceContext.new(self, messaging_service_sid)
+          end
+        end
+
         ##
         # @return [Twilio::REST::Messaging::V1::ExternalCampaignContext]
         def external_campaign
           @external_campaign ||= ExternalCampaignList.new self
         end
 
+        ##
+        # @param [String] domain_sid The domain SID to dissociate from a messaging
+        #   service. With URL shortening enabled, links in messages sent with the associated
+        #   messaging service will be shortened to the provided domain
+        # @param [String] messaging_service_sid A messaging service SID to dissociate from
+        #   a domain. With URL shortening enabled, links in messages sent with the provided
+        #   messaging service will be shortened to the associated domain
+        # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceContext] if messaging_service_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceList]
+        def linkshortening_messaging_service(domain_sid=:unset, messaging_service_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if messaging_service_sid.nil?
+              raise ArgumentError, 'messaging_service_sid cannot be nil'
+          end
+          if domain_sid == :unset && messaging_service_sid == :unset
+              @linkshortening_messaging_service ||= LinkshorteningMessagingServiceList.new self
+          else
+              LinkshorteningMessagingServiceContext.new(self, domain_sid, messaging_service_sid)
+          end
+        end
+
         ##
         # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.

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

@@ -42,12 +42,48 @@ module Twilio
         self.v1.deactivations()
       end
 
+      ##
+      # @param [String] domain_sid The unique string that we created to identify the
+      #   Domain resource.
+      # @return [Twilio::REST::Messaging::V1::DomainCertsInstance] if domain_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainCertsList]
+      def domain_certs(domain_sid=:unset)
+        self.v1.domain_certs(domain_sid)
+      end
+
+      ##
+      # @param [String] domain_sid The unique string that we created to identify the
+      #   Domain resource.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigInstance] if domain_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigList]
+      def domain_config(domain_sid=:unset)
+        self.v1.domain_config(domain_sid)
+      end
+
+      ##
+      # @param [String] messaging_service_sid The unique string that identifies the
+      #   messaging service
+      # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceInstance] if messaging_service_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigMessagingServiceList]
+      def domain_config_messaging_service(messaging_service_sid=:unset)
+        self.v1.domain_config_messaging_service(messaging_service_sid)
+      end
+
       ##
       # @return [Twilio::REST::Messaging::V1::ExternalCampaignInstance]
       def external_campaign
         self.v1.external_campaign()
       end
 
+      ##
+      # @param [String] messaging_service_sid The unique string that identifies the
+      #   messaging service
+      # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceInstance] if messaging_service_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceList]
+      def linkshortening_messaging_service(domain_sid=:unset, messaging_service_sid=:unset)
+        self.v1.linkshortening_messaging_service(domain_sid, messaging_service_sid)
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.