twilio-ruby 5.33.0 → 5.36.0

data/lib/twilio-ruby/rest/preview/trusted_comms/business/brand/branded_channel/channel.rb

@@ -0,0 +1,197 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class TrustedComms < Version
+        class BusinessContext < InstanceContext
+          class BrandContext < InstanceContext
+            class BrandedChannelContext < InstanceContext
+              ##
+              # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+              class ChannelList < ListResource
+                ##
+                # Initialize the ChannelList
+                # @param [Version] version Version that contains the resource
+                # @param [String] business_sid The unique SID identifier of the Business.
+                # @param [String] brand_sid The unique SID identifier of the Brand.
+                # @param [String] branded_channel_sid The unique SID identifier of the Branded
+                #   Channel.
+                # @return [ChannelList] ChannelList
+                def initialize(version, business_sid: nil, brand_sid: nil, branded_channel_sid: nil)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {
+                      business_sid: business_sid,
+                      brand_sid: brand_sid,
+                      branded_channel_sid: branded_channel_sid
+                  }
+                  @uri = "/Businesses/#{@solution[:business_sid]}/Brands/#{@solution[:brand_sid]}/BrandedChannels/#{@solution[:branded_channel_sid]}/Channels"
+                end
+
+                ##
+                # Retrieve a single page of ChannelInstance records from the API.
+                # Request is executed immediately.
+                # @param [String] phone_number_sid The unique SID identifier of the Phone Number
+                #   of the Phone number to be assigned to the Branded Channel.
+                # @param [String] phone_number The phone number given in [E.164
+                #   format](https://www.twilio.com/docs/glossary/what-e164) to assign to the Branded
+                #   Channel. It must be a Twilio number that from your account.
+                # @return [ChannelInstance] Newly created ChannelInstance
+                def create(phone_number_sid: nil, phone_number: nil)
+                  data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, 'PhoneNumber' => phone_number, })
+
+                  payload = @version.create(
+                      'POST',
+                      @uri,
+                      data: data
+                  )
+
+                  ChannelInstance.new(
+                      @version,
+                      payload,
+                      business_sid: @solution[:business_sid],
+                      brand_sid: @solution[:brand_sid],
+                      branded_channel_sid: @solution[:branded_channel_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '#<Twilio.Preview.TrustedComms.ChannelList>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+              class ChannelPage < Page
+                ##
+                # Initialize the ChannelPage
+                # @param [Version] version Version that contains the resource
+                # @param [Response] response Response from the API
+                # @param [Hash] solution Path solution for the resource
+                # @return [ChannelPage] ChannelPage
+                def initialize(version, response, solution)
+                  super(version, response)
+
+                  # Path Solution
+                  @solution = solution
+                end
+
+                ##
+                # Build an instance of ChannelInstance
+                # @param [Hash] payload Payload response from the API
+                # @return [ChannelInstance] ChannelInstance
+                def get_instance(payload)
+                  ChannelInstance.new(
+                      @version,
+                      payload,
+                      business_sid: @solution[:business_sid],
+                      brand_sid: @solution[:brand_sid],
+                      branded_channel_sid: @solution[:branded_channel_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '<Twilio.Preview.TrustedComms.ChannelPage>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+              class ChannelInstance < InstanceResource
+                ##
+                # Initialize the ChannelInstance
+                # @param [Version] version Version that contains the resource
+                # @param [Hash] payload payload that contains response from Twilio
+                # @param [String] business_sid The unique SID identifier of the Business.
+                # @param [String] brand_sid The unique SID identifier of the Brand.
+                # @param [String] branded_channel_sid The unique SID identifier of the Branded
+                #   Channel.
+                # @return [ChannelInstance] ChannelInstance
+                def initialize(version, payload, business_sid: nil, brand_sid: nil, branded_channel_sid: nil)
+                  super(version)
+
+                  # Marshaled Properties
+                  @properties = {
+                      'account_sid' => payload['account_sid'],
+                      'business_sid' => payload['business_sid'],
+                      'brand_sid' => payload['brand_sid'],
+                      'branded_channel_sid' => payload['branded_channel_sid'],
+                      'phone_number_sid' => payload['phone_number_sid'],
+                      'phone_number' => payload['phone_number'],
+                      'url' => payload['url'],
+                  }
+                end
+
+                ##
+                # @return [String] Account Sid.
+                def account_sid
+                  @properties['account_sid']
+                end
+
+                ##
+                # @return [String] Business Sid.
+                def business_sid
+                  @properties['business_sid']
+                end
+
+                ##
+                # @return [String] Brand Sid.
+                def brand_sid
+                  @properties['brand_sid']
+                end
+
+                ##
+                # @return [String] Branded Channel Sid.
+                def branded_channel_sid
+                  @properties['branded_channel_sid']
+                end
+
+                ##
+                # @return [String] Phone Number Sid to be branded.
+                def phone_number_sid
+                  @properties['phone_number_sid']
+                end
+
+                ##
+                # @return [String] Twilio number to assign to the Branded Channel
+                def phone_number
+                  @properties['phone_number']
+                end
+
+                ##
+                # @return [String] The URL of this resource.
+                def url
+                  @properties['url']
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  "<Twilio.Preview.TrustedComms.ChannelInstance>"
+                end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  "<Twilio.Preview.TrustedComms.ChannelInstance>"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb

@@ -266,6 +266,7 @@ module Twilio
                     'account_sid' => payload['account_sid'],
                     'service_sid' => payload['service_sid'],
                     'environment_sid' => payload['environment_sid'],
+                    'build_sid' => payload['build_sid'],
                     'deployment_sid' => payload['deployment_sid'],
                     'function_sid' => payload['function_sid'],
                     'request_sid' => payload['request_sid'],
@@ -324,6 +325,12 @@ module Twilio
                 @properties['environment_sid']
               end
 
+              ##
+              # @return [String] The SID of the build that corresponds to the log
+              def build_sid
+                @properties['build_sid']
+              end
+
               ##
               # @return [String] The SID of the deployment that corresponds to the log
               def deployment_sid

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

@@ -46,8 +46,8 @@ module Twilio
 
       ##
       # @return [Twilio::REST::Studio::V2::FlowValidateInstance]
-      def flow_valid
-        self.v2.flow_valid()
+      def flow_validate
+        self.v2.flow_validate()
       end
 
       ##

data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb

@@ -245,6 +245,23 @@ module Twilio
               @version.delete('delete', @uri)
             end
 
+            ##
+            # Update the ExecutionInstance
+            # @param [execution.Status] status The status of the Execution. Can only be
+            #   `ended`.
+            # @return [ExecutionInstance] Updated ExecutionInstance
+            def update(status: nil)
+              data = Twilio::Values.of({'Status' => status, })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
+            end
+
             ##
             # Access the steps
             # @return [ExecutionStepList]
@@ -412,6 +429,15 @@ module Twilio
               context.delete
             end
 
+            ##
+            # Update the ExecutionInstance
+            # @param [execution.Status] status The status of the Execution. Can only be
+            #   `ended`.
+            # @return [ExecutionInstance] Updated ExecutionInstance
+            def update(status: nil)
+              context.update(status: status, )
+            end
+
             ##
             # Access the steps
             # @return [steps] steps

data/lib/twilio-ruby/rest/studio/v2.rb

@@ -16,7 +16,7 @@ module Twilio
           super
           @version = 'v2'
           @flows = nil
-          @flow_valid = nil
+          @flow_validate = nil
         end
 
         ##
@@ -35,8 +35,8 @@ module Twilio
 
         ##
         # @return [Twilio::REST::Studio::V2::FlowValidateContext]
-        def flow_valid
-          @flow_valid ||= FlowValidateList.new self
+        def flow_validate
+          @flow_validate ||= FlowValidateList.new self
         end
 
         ##

data/lib/twilio-ruby/rest/studio/v2/flow.rb

@@ -321,6 +321,7 @@ module Twilio
                 'commit_message' => payload['commit_message'],
                 'valid' => payload['valid'],
                 'errors' => payload['errors'],
+                'warnings' => payload['warnings'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'webhook_url' => payload['webhook_url'],
@@ -398,6 +399,12 @@ module Twilio
             @properties['errors']
           end
 
+          ##
+          # @return [Hash] List of warnings in the flow definition
+          def warnings
+            @properties['warnings']
+          end
+
           ##
           # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created

data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb

@@ -17,7 +17,7 @@ module Twilio
             ##
             # Initialize the ExecutionList
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The flow_sid
+            # @param [String] flow_sid The SID of the Flow.
             # @return [ExecutionList] ExecutionList
             def initialize(version, flow_sid: nil)
               super(version)
@@ -31,8 +31,12 @@ module Twilio
             # Lists ExecutionInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Time] date_created_from The date_created_from
-            # @param [Time] date_created_to The date_created_to
+            # @param [Time] date_created_from Only show Execution resources starting on or
+            #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
+            #   as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+            # @param [Time] date_created_to Only show Execution resources starting before this
+            #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
+            #   `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @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
@@ -53,8 +57,12 @@ module Twilio
             # Streams ExecutionInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] date_created_from The date_created_from
-            # @param [Time] date_created_to The date_created_to
+            # @param [Time] date_created_from Only show Execution resources starting on or
+            #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
+            #   as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+            # @param [Time] date_created_to Only show Execution resources starting before this
+            #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
+            #   `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @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
@@ -91,8 +99,12 @@ module Twilio
             ##
             # Retrieve a single page of ExecutionInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] date_created_from The date_created_from
-            # @param [Time] date_created_to The date_created_to
+            # @param [Time] date_created_from Only show Execution resources starting on or
+            #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
+            #   as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+            # @param [Time] date_created_to Only show Execution resources starting before this
+            #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
+            #   `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @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
@@ -129,9 +141,17 @@ module Twilio
             ##
             # Retrieve a single page of ExecutionInstance records from the API.
             # Request is executed immediately.
-            # @param [String] to The to
-            # @param [String] from The from
-            # @param [Hash] parameters The parameters
+            # @param [String] to The Contact phone number to start a Studio Flow Execution,
+            #   available as variable `{{contact.channel.address}}`.
+            # @param [String] from The Twilio phone number to send messages or initiate calls
+            #   from during the Flow's Execution. Available as variable
+            #   `{{flow.channel.address}}`.
+            # @param [Hash] parameters JSON data that will be added to the Flow's context and
+            #   that can be accessed as variables inside your Flow. For example, if you pass in
+            #   `Parameters={"name":"Zeke"}`, a widget in your Flow can reference the variable
+            #   `{{flow.data.name}}`, which returns "Zeke". Note: the JSON value must explicitly
+            #   be passed as a string, not as a hash object. Depending on your particular HTTP
+            #   library, you may need to add quotes or URL encode the JSON string.
             # @return [ExecutionInstance] Newly created ExecutionInstance
             def create(to: nil, from: nil, parameters: :unset)
               data = Twilio::Values.of({
@@ -193,8 +213,9 @@ module Twilio
             ##
             # Initialize the ExecutionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The flow_sid
-            # @param [String] sid The sid
+            # @param [String] flow_sid The SID of the Flow with the Execution resource to
+            #   fetch
+            # @param [String] sid The SID of the Execution resource to fetch.
             # @return [ExecutionContext] ExecutionContext
             def initialize(version, flow_sid, sid)
               super(version)
@@ -230,6 +251,23 @@ module Twilio
               @version.delete('delete', @uri)
             end
 
+            ##
+            # Update the ExecutionInstance
+            # @param [execution.Status] status The status of the Execution. Can only be
+            #   `ended`.
+            # @return [ExecutionInstance] Updated ExecutionInstance
+            def update(status: nil)
+              data = Twilio::Values.of({'Status' => status, })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
+            end
+
             ##
             # Access the steps
             # @return [ExecutionStepList]
@@ -282,8 +320,8 @@ module Twilio
             # Initialize the ExecutionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] flow_sid The flow_sid
-            # @param [String] sid The sid
+            # @param [String] flow_sid The SID of the Flow.
+            # @param [String] sid The SID of the Execution resource to fetch.
             # @return [ExecutionInstance] ExecutionInstance
             def initialize(version, payload, flow_sid: nil, sid: nil)
               super(version)
@@ -319,61 +357,61 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The flow_sid
+            # @return [String] The SID of the Flow
             def flow_sid
               @properties['flow_sid']
             end
 
             ##
-            # @return [String] The contact_channel_address
+            # @return [String] The phone number, SIP address or Client identifier that triggered the Execution
             def contact_channel_address
               @properties['contact_channel_address']
             end
 
             ##
-            # @return [Hash] The context
+            # @return [Hash] The current state of the flow
             def context
               @properties['context']
             end
 
             ##
-            # @return [execution.Status] The status
+            # @return [execution.Status] The status of the Execution
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Nested resource URLs
             def links
               @properties['links']
             end
@@ -392,6 +430,15 @@ module Twilio
               context.delete
             end
 
+            ##
+            # Update the ExecutionInstance
+            # @param [execution.Status] status The status of the Execution. Can only be
+            #   `ended`.
+            # @return [ExecutionInstance] Updated ExecutionInstance
+            def update(status: nil)
+              context.update(status: status, )
+            end
+
             ##
             # Access the steps
             # @return [steps] steps