twilio-ruby 5.49.0 → 5.54.0

data/lib/twilio-ruby/rest/events/v1/sink.rb

@@ -50,6 +50,10 @@ module Twilio
           # Lists SinkInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
+          # @param [Boolean] in_use A boolean query parameter filtering the results to
+          #   return sinks used/not used by a subscription.
+          # @param [String] status A String query parameter filtering the results by status
+          #   `initialized`, `validating`, `active` or `failed`.
           # @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
@@ -57,14 +61,18 @@ module Twilio
           #    but a limit is defined, stream() will attempt to read the limit with the most
           #    efficient page size, i.e. min(limit, 1000)
           # @return [Array] Array of up to limit results
-          def list(limit: nil, page_size: nil)
-            self.stream(limit: limit, page_size: page_size).entries
+          def list(in_use: :unset, status: :unset, limit: nil, page_size: nil)
+            self.stream(in_use: in_use, status: status, limit: limit, page_size: page_size).entries
           end
 
           ##
           # Streams SinkInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
+          # @param [Boolean] in_use A boolean query parameter filtering the results to
+          #   return sinks used/not used by a subscription.
+          # @param [String] status A String query parameter filtering the results by status
+          #   `initialized`, `validating`, `active` or `failed`.
           # @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
@@ -72,10 +80,10 @@ module Twilio
           #    but a limit is defined, stream() will attempt to read the limit with the most
           #    efficient page size, i.e. min(limit, 1000)
           # @return [Enumerable] Enumerable that will yield up to limit results
-          def stream(limit: nil, page_size: nil)
+          def stream(in_use: :unset, status: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size], )
+            page = self.page(in_use: in_use, status: status, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -97,12 +105,18 @@ module Twilio
           ##
           # Retrieve a single page of SinkInstance records from the API.
           # Request is executed immediately.
+          # @param [Boolean] in_use A boolean query parameter filtering the results to
+          #   return sinks used/not used by a subscription.
+          # @param [String] status A String query parameter filtering the results by status
+          #   `initialized`, `validating`, `active` or `failed`.
           # @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 SinkInstance
-          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+          def page(in_use: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
+                'InUse' => in_use,
+                'Status' => status,
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,
@@ -200,6 +214,19 @@ module Twilio
              @version.delete('DELETE', @uri)
           end
 
+          ##
+          # Update the SinkInstance
+          # @param [String] description A human readable description for the Sink **This
+          #   value should not contain PII.**
+          # @return [SinkInstance] Updated SinkInstance
+          def update(description: nil)
+            data = Twilio::Values.of({'Description' => description, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            SinkInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
           ##
           # Access the sink_test
           # @return [SinkTestList]
@@ -348,6 +375,15 @@ module Twilio
             context.delete
           end
 
+          ##
+          # Update the SinkInstance
+          # @param [String] description A human readable description for the Sink **This
+          #   value should not contain PII.**
+          # @return [SinkInstance] Updated SinkInstance
+          def update(description: nil)
+            context.update(description: description, )
+          end
+
           ##
           # Access the sink_test
           # @return [sink_test] sink_test

data/lib/twilio-ruby/rest/events/v1/subscription.rb

@@ -226,8 +226,14 @@ module Twilio
           ##
           # Access the subscribed_events
           # @return [SubscribedEventList]
-          # @return [SubscribedEventContext]
-          def subscribed_events
+          # @return [SubscribedEventContext] if type was passed.
+          def subscribed_events(type=:unset)
+            raise ArgumentError, 'type cannot be nil' if type.nil?
+
+            if type != :unset
+              return SubscribedEventContext.new(@version, @solution[:sid], type, )
+            end
+
             unless @subscribed_events
               @subscribed_events = SubscribedEventList.new(@version, subscription_sid: @solution[:sid], )
             end

data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb

@@ -107,6 +107,20 @@ module Twilio
               SubscribedEventPage.new(@version, response, @solution)
             end
 
+            ##
+            # Create the SubscribedEventInstance
+            # @param [String] type Type of event being subscribed to.
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
+            # @return [SubscribedEventInstance] Created SubscribedEventInstance
+            def create(type: nil, schema_version: :unset)
+              data = Twilio::Values.of({'Type' => type, 'SchemaVersion' => schema_version, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -145,6 +159,77 @@ module Twilio
             end
           end
 
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SubscribedEventContext < InstanceContext
+            ##
+            # Initialize the SubscribedEventContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @param [String] type Type of event being subscribed to.
+            # @return [SubscribedEventContext] SubscribedEventContext
+            def initialize(version, subscription_sid, type)
+              super(version)
+
+              # Path Solution
+              @solution = {subscription_sid: subscription_sid, type: type, }
+              @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents/#{@solution[:type]}"
+            end
+
+            ##
+            # Fetch the SubscribedEventInstance
+            # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              SubscribedEventInstance.new(
+                  @version,
+                  payload,
+                  subscription_sid: @solution[:subscription_sid],
+                  type: @solution[:type],
+              )
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(schema_version: :unset)
+              data = Twilio::Values.of({'SchemaVersion' => schema_version, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(
+                  @version,
+                  payload,
+                  subscription_sid: @solution[:subscription_sid],
+                  type: @solution[:type],
+              )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+          end
+
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SubscribedEventInstance < InstanceResource
@@ -153,18 +238,38 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @param [String] type Type of event being subscribed to.
             # @return [SubscribedEventInstance] SubscribedEventInstance
-            def initialize(version, payload, subscription_sid: nil)
+            def initialize(version, payload, subscription_sid: nil, type: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'account_sid' => payload['account_sid'],
                   'type' => payload['type'],
-                  'version' => payload['version'].to_i,
+                  'schema_version' => payload['schema_version'].to_i,
                   'subscription_sid' => payload['subscription_sid'],
                   'url' => payload['url'],
               }
+
+              # Context
+              @instance_context = nil
+              @params = {'subscription_sid' => subscription_sid, 'type' => type || @properties['type'], }
+            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 [SubscribedEventContext] SubscribedEventContext for this SubscribedEventInstance
+            def context
+              unless @instance_context
+                @instance_context = SubscribedEventContext.new(
+                    @version,
+                    @params['subscription_sid'],
+                    @params['type'],
+                )
+              end
+              @instance_context
             end
 
             ##
@@ -181,8 +286,8 @@ module Twilio
 
             ##
             # @return [String] The schema version that the subscription should use.
-            def version
-              @properties['version']
+            def schema_version
+              @properties['schema_version']
             end
 
             ##
@@ -197,16 +302,41 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # Fetch the SubscribedEventInstance
+            # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(schema_version: :unset)
+              context.update(schema_version: schema_version, )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Events.V1.SubscribedEventInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Events.V1.SubscribedEventInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
             end
           end
         end

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

@@ -119,8 +119,10 @@ module Twilio
           #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
           # @param [String] contact_identity The channel contact's Identity.
           # @param [Boolean] enabled Whether the new Flex Flow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
+          # @param [flex_flow.IntegrationType] integration_type The software that will
+          #   handle inbound messages. {Integration
+          #   Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
+          #   can be: `studio`, `external`, or `task`.
           # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
           #   `integrationType` is `studio`.
           # @param [String] integration_url The URL of the external webhook. Required when
@@ -129,9 +131,9 @@ module Twilio
           #   Required when `integrationType` is `task`.
           # @param [String] integration_workflow_sid The Workflow SID for a new Task.
           #   Required when `integrationType` is `task`.
-          # @param [String] integration_channel The Task Channel for the TaskRouter Task
-          #   that will be created. Applicable and required when integrationType is `task`.
-          #   Set to `sms` for SMS, and to `chat` otherwise. The default value is `default`
+          # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
+          #   (e.g., `sms`) to use for the Task that will be created. Applicable and required
+          #   when `integrationType` is `task`. The default value is `default`.
           # @param [String] integration_timeout The Task timeout in seconds for a new Task.
           #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
           #   not applicable otherwise.
@@ -150,8 +152,8 @@ module Twilio
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3 (included),
-          #   default is 0. Optional when integrationType is `external`, not applicable
+          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
+          #   default is 3. Optional when `integrationType` is `external`, not applicable
           #   otherwise.
           # @return [FlexFlowInstance] Created FlexFlowInstance
           def create(friendly_name: nil, chat_service_sid: nil, channel_type: nil, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
@@ -248,8 +250,10 @@ module Twilio
           #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
           # @param [String] contact_identity The channel contact's Identity.
           # @param [Boolean] enabled Whether the new Flex Flow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
+          # @param [flex_flow.IntegrationType] integration_type The software that will
+          #   handle inbound messages. {Integration
+          #   Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
+          #   can be: `studio`, `external`, or `task`.
           # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
           #   `integrationType` is `studio`.
           # @param [String] integration_url The URL of the external webhook. Required when
@@ -258,9 +262,9 @@ module Twilio
           #   Required when `integrationType` is `task`.
           # @param [String] integration_workflow_sid The Workflow SID for a new Task.
           #   Required when `integrationType` is `task`.
-          # @param [String] integration_channel The Task Channel for the TaskRouter Task
-          #   that will be created. Applicable and required when integrationType is `task`.
-          #   Set to `sms` for SMS, and to `chat` otherwise. The default value is `default`
+          # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
+          #   (e.g., `sms`) to use for the Task that will be created. Applicable and required
+          #   when `integrationType` is `task`. The default value is `default`.
           # @param [String] integration_timeout The Task timeout in seconds for a new Task.
           #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
           #   not applicable otherwise.
@@ -279,8 +283,8 @@ module Twilio
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3 (included),
-          #   default is 0. Optional when integrationType is `external`, not applicable
+          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
+          #   default is 3. Optional when `integrationType` is `external`, not applicable
           #   otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
@@ -430,7 +434,7 @@ module Twilio
           end
 
           ##
-          # @return [flex_flow.IntegrationType] The integration type
+          # @return [flex_flow.IntegrationType] The software that will handle inbound messages.
           def integration_type
             @properties['integration_type']
           end
@@ -475,8 +479,10 @@ module Twilio
           #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
           # @param [String] contact_identity The channel contact's Identity.
           # @param [Boolean] enabled Whether the new Flex Flow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
+          # @param [flex_flow.IntegrationType] integration_type The software that will
+          #   handle inbound messages. {Integration
+          #   Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
+          #   can be: `studio`, `external`, or `task`.
           # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
           #   `integrationType` is `studio`.
           # @param [String] integration_url The URL of the external webhook. Required when
@@ -485,9 +491,9 @@ module Twilio
           #   Required when `integrationType` is `task`.
           # @param [String] integration_workflow_sid The Workflow SID for a new Task.
           #   Required when `integrationType` is `task`.
-          # @param [String] integration_channel The Task Channel for the TaskRouter Task
-          #   that will be created. Applicable and required when integrationType is `task`.
-          #   Set to `sms` for SMS, and to `chat` otherwise. The default value is `default`
+          # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
+          #   (e.g., `sms`) to use for the Task that will be created. Applicable and required
+          #   when `integrationType` is `task`. The default value is `default`.
           # @param [String] integration_timeout The Task timeout in seconds for a new Task.
           #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
           #   not applicable otherwise.
@@ -506,8 +512,8 @@ module Twilio
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3 (included),
-          #   default is 0. Optional when integrationType is `external`, not applicable
+          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
+          #   default is 3. Optional when `integrationType` is `external`, not applicable
           #   otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)

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

@@ -42,6 +42,12 @@ module Twilio
         self.v1.deactivations()
       end
 
+      ##
+      # @return [Twilio::REST::Messaging::V1::ExternalCampaignInstance]
+      def external_campaign
+        self.v1.external_campaign()
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.
@@ -51,6 +57,12 @@ module Twilio
         self.v1.services(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Messaging::V1::UsecaseInstance]
+      def usecases
+        self.v1.usecases()
+      end
+
       ##
       # Provide a user friendly representation
       def to_s