twilio-ruby 5.50.0 → 5.54.1

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/subscribed_event.rb

@@ -110,10 +110,11 @@ module Twilio
             ##
             # Create the SubscribedEventInstance
             # @param [String] type Type of event being subscribed to.
-            # @param [String] version The schema version that the subscription should use.
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
             # @return [SubscribedEventInstance] Created SubscribedEventInstance
-            def create(type: nil, version: :unset)
-              data = Twilio::Values.of({'Type' => type, 'Version' => version, })
+            def create(type: nil, schema_version: :unset)
+              data = Twilio::Values.of({'Type' => type, 'SchemaVersion' => schema_version, })
 
               payload = @version.create('POST', @uri, data: data)
 
@@ -191,10 +192,11 @@ module Twilio
 
             ##
             # Update the SubscribedEventInstance
-            # @param [String] version The schema version that the subscription should use.
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
             # @return [SubscribedEventInstance] Updated SubscribedEventInstance
-            def update(version: :unset)
-              data = Twilio::Values.of({'Version' => version, })
+            def update(schema_version: :unset)
+              data = Twilio::Values.of({'SchemaVersion' => schema_version, })
 
               payload = @version.update('POST', @uri, data: data)
 
@@ -245,7 +247,7 @@ module Twilio
               @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'],
               }
@@ -284,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
 
             ##
@@ -309,10 +311,11 @@ module Twilio
 
             ##
             # Update the SubscribedEventInstance
-            # @param [String] version The schema version that the subscription should use.
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
             # @return [SubscribedEventInstance] Updated SubscribedEventInstance
-            def update(version: :unset)
-              context.update(version: version, )
+            def update(schema_version: :unset)
+              context.update(schema_version: schema_version, )
             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

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

@@ -17,7 +17,9 @@ module Twilio
           @version = 'v1'
           @brand_registrations = nil
           @deactivations = nil
+          @external_campaign = nil
           @services = nil
+          @usecases = nil
         end
 
         ##
@@ -41,6 +43,12 @@ module Twilio
           @deactivations ||= DeactivationsContext.new self
         end
 
+        ##
+        # @return [Twilio::REST::Messaging::V1::ExternalCampaignContext]
+        def external_campaign
+          @external_campaign ||= ExternalCampaignList.new self
+        end
+
         ##
         # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
@@ -56,6 +64,12 @@ module Twilio
           end
         end
 
+        ##
+        # @return [Twilio::REST::Messaging::V1::UsecaseContext]
+        def usecases
+          @usecases ||= UsecaseList.new self
+        end
+
         ##
         # Provide a user friendly representation
         def to_s

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

@@ -0,0 +1,150 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ExternalCampaignList < ListResource
+          ##
+          # Initialize the ExternalCampaignList
+          # @param [Version] version Version that contains the resource
+          # @return [ExternalCampaignList] ExternalCampaignList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Services/PreregisteredUsa2p"
+          end
+
+          ##
+          # Create the ExternalCampaignInstance
+          # @param [String] campaign_id ID of the preregistered campaign.
+          # @param [String] messaging_service_sid The SID of the {Messaging
+          #   Service}[https://www.twilio.com/docs/messaging/services/api] that the resource
+          #   is associated with.
+          # @return [ExternalCampaignInstance] Created ExternalCampaignInstance
+          def create(campaign_id: nil, messaging_service_sid: nil)
+            data = Twilio::Values.of({
+                'CampaignId' => campaign_id,
+                'MessagingServiceSid' => messaging_service_sid,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            ExternalCampaignInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.ExternalCampaignList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ExternalCampaignPage < Page
+          ##
+          # Initialize the ExternalCampaignPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ExternalCampaignPage] ExternalCampaignPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ExternalCampaignInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ExternalCampaignInstance] ExternalCampaignInstance
+          def get_instance(payload)
+            ExternalCampaignInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.ExternalCampaignPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ExternalCampaignInstance < InstanceResource
+          ##
+          # Initialize the ExternalCampaignInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [ExternalCampaignInstance] ExternalCampaignInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'campaign_id' => payload['campaign_id'],
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+            }
+          end
+
+          ##
+          # @return [String] The unique string that identifies a US A2P Compliance resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] ID of the preregistered campaign.
+          def campaign_id
+            @properties['campaign_id']
+          end
+
+          ##
+          # @return [String] The SID of the Messaging Service the resource is associated with
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Messaging.V1.ExternalCampaignInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Messaging.V1.ExternalCampaignInstance>"
+          end
+        end
+      end
+    end
+  end
+end