twilio-ruby 5.53.0 → 5.56.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,

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

@@ -0,0 +1,47 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi < Domain
+      ##
+      # Initialize the FrontlineApi Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://frontline-api.twilio.com'
+        @host = 'frontline-api.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of frontline_api
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the User
+      #   resource.
+      # @return [Twilio::REST::Frontline_api::V1::UserInstance] if sid was passed.
+      # @return [Twilio::REST::Frontline_api::V1::UserList]
+      def users(sid=:unset)
+        self.v1.users(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::FrontlineApi>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi
+      class V1 < Version
+        ##
+        # Initialize the V1 version of FrontlineApi
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @users = nil
+        end
+
+        ##
+        # @param [String] sid The SID of the User resource to fetch. This value can be
+        #   either the `sid` or the `identity` of the User resource to fetch.
+        # @return [Twilio::REST::Frontline_api::V1::UserContext] if sid was passed.
+        # @return [Twilio::REST::Frontline_api::V1::UserList]
+        def users(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @users ||= UserList.new self
+          else
+              UserContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::FrontlineApi::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,233 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserList < ListResource
+          ##
+          # Initialize the UserList
+          # @param [Version] version Version that contains the resource
+          # @return [UserList] UserList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FrontlineApi.V1.UserList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserPage < Page
+          ##
+          # Initialize the UserPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UserPage] UserPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UserInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UserInstance] UserInstance
+          def get_instance(payload)
+            UserInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FrontlineApi.V1.UserPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserContext < InstanceContext
+          ##
+          # Initialize the UserContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserContext] UserContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Users/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated` and defaults to `active`
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Avatar' => avatar, 'State' => state, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserInstance < InstanceResource
+          ##
+          # Initialize the UserInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserInstance] UserInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'identity' => payload['identity'],
+                'friendly_name' => payload['friendly_name'],
+                'avatar' => payload['avatar'],
+                'state' => payload['state'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [UserContext] UserContext for this UserInstance
+          def context
+            unless @instance_context
+              @instance_context = UserContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The string that identifies the resource's User
+          def identity
+            @properties['identity']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the User
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] The avatar URL which will be shown in Frontline application
+          def avatar
+            @properties['avatar']
+          end
+
+          ##
+          # @return [user.StateType] Current state of this user
+          def state
+            @properties['state']
+          end
+
+          ##
+          # @return [String] An absolute URL for this user.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated` and defaults to `active`
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset)
+            context.update(friendly_name: friendly_name, avatar: avatar, state: state, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end